![\"Automated](\"/assets/img/diag-on-pd-timeline.png\")
Stay up to date with the latest changes and improvements from the Runbook Automation development team.
\nThis page shows recently merged pull requests from both the Runbook Automation product repository and the open source Rundeck repository merged since the last self-hosted release of 5.19.0 on February 2, 2026.
\nFixed a critical command injection vulnerability in exec commands where shell control characters in job option values were not properly escaped, now protecting against malicious input by applying shell escaping to all ${option.name} values by default while providing a compatibility flag for edge cases.
Introduces backend support for Conditional Logic workflow steps, enabling dynamic workflow execution based on runtime conditions such as job options, node attributes, and prior step outputs.
\nUpdated Apache Commons Lang library to the latest version (commons-lang3) to address CVE-2025-48924, ensuring continued security and compatibility with modern Java standards.
\nA new settings modal replaces the previous theme dropdown, providing a unified interface for switching themes and toggling Next UI mode, with visual indicators and notifications to help users understand when Next UI is available and active. Administrators can optionally enable Next UI by default for all users via system configuration.
\nStay informed about Rundeck development by subscribing to a feed:
\n\nThese feeds are updated regularly to highlight changes that are available in Runbook Automation SaaS and will be included in upcoming Self Hosted releases.
\nThe development updates are automatically generated from both our private repository for the commercial product and the public open source repository. These changes have been merged since the last GA release and provide insight into what's coming in the next Self Hosted release.
\nNote: These updates reflect changes merged since the last GA release. Self-hosted customers should refer to the Release Notes section for version-specific updates applicable to their installation.
\n", "date_published": "2026-03-09T21:10:20.760Z", "date_modified": "2026-03-09T21:10:51.000Z", "authors": [], "tags": [] }, { "title": "Using Conditional Logic in a Job", "url": "https://docs.rundeck.com/docs/learning/howto/using-conditional-logic.html", "id": "https://docs.rundeck.com/docs/learning/howto/using-conditional-logic.html", "summary": "Learn how to create dynamic workflows that make decisions at runtime using Conditional Logic steps. This guide walks through simple and complex examples of using conditions based on job options, node attributes, and environment settings.", "content_html": "\nEarly Access Feature - Available in Runbook Automation 5.20.0+
\nConditional Logic steps enable workflows to make decisions during execution based on runtime conditions. Instead of creating multiple jobs for different scenarios or writing complex scripts with if/then logic, you can use Conditional Logic steps to branch your workflow based on:
\nThis guide provides hands-on examples to help you understand how to use conditional logic effectively.
\nrundeck-config.properties:rundeck.feature.earlyAccessJobConditional.enabled=true\nNew to Rundeck?
\nIf you're new to Rundeck, we recommend completing the Getting Started Tutorial first. This guide assumes familiarity with creating jobs, adding steps, and using job options.
\nConditional Logic steps come in two types:
\nBoth types support:
\nThe following examples demonstrate conditional logic in action. Import these jobs to see how conditions work, then run them with different option values to observe the behavior.
\n\n", "date_published": "2026-03-09T00:00:00.000Z", "date_modified": "2026-03-09T21:10:39.000Z", "authors": [], "tags": [] }, { "title": "5.19.0 Release Notes", "url": "https://docs.rundeck.com/docs/history/5_x/version-5.19.0.html", "id": "https://docs.rundeck.com/docs/history/5_x/version-5.19.0.html", "summary": "Rundeck | Runbook Automation 5.19.0 release with Ansible output fixes, Vault timestamp corrections, extended AWS SSM timeouts, Azure storage security updates, and faster Job UI metrics.", "content_html": "\nThis release focuses on stability, performance, and security improvements across the platform. Key updates include enhanced AWS SSM execution timeouts (up to 12 hours), significant Job UI Metrics performance optimizations, and fixes for Ansible workflow output handling and Vault timestamp issues. Security updates address multiple CVEs in the Azure Storage plugin and Docker image dependencies.
\n", "date_published": "2026-02-02T00:00:00.000Z", "date_modified": "2026-02-18T17:13:15.000Z", "authors": [], "tags": [] }, { "title": "5.18.0 Release Notes", "url": "https://docs.rundeck.com/docs/history/5_x/version-5.18.0.html", "id": "https://docs.rundeck.com/docs/history/5_x/version-5.18.0.html", "summary": "Version 5.18.0 delivers important security patches addressing multiple CVEs, enhanced plugin functionality including configurable AWS SSM timeouts and Slack template support, a new beta Multiline Job Options feature, and comprehensive OpenAPI documentation improvements for better API integration. Additionally, we're releasing Terraform Provider 1.0.0—a complete modernization that eliminates all known plan drift issues and provides a stable foundation for infrastructure-as-code workflows.", "content_html": "\nThis is a critical bug fix release that addresses the following issue:
\nNode filter overrides in job reference steps would disappear from the GUI when editing parent jobs, with the filter field appearing empty even though filters were previously saved. Simply opening and saving a parent job (without any modifications) would clear all node filter overrides, causing child jobs to execute on all nodes instead of the intended filtered subset. This issue could lead to unintended job execution on incorrect nodes, potentially affecting production environments and job orchestration workflows.
\nIn this version node filter overrides are properly preserved and displayed when editing parent jobs, eliminating the need for manual re-entry and preventing unintended execution scope changes.
\nHere is a link to the full list of public PRs
\nName: \"Logan yellowgreen phone\"
\nRelease Date: August 18th, 2025
\nThis point release addresses three critical issues that were identified in versions 5.11.0. The fixes focus on improving runner functionality and key storage UI bugs.
\nName: \"Kilimanjaro deeppink bullhorn\"
\nRelease Date: April 16, 2025
\nSubmit your own Pull Requests to get recognition here!
\nThis point release addresses three critical issues that were identified in versions 5.10.0. The fixes focus on improving runner functionality and key storage UI bugs.
\nName: \"K2 turquoise tower\"
\nRelease Date: April 15, 2025
\nPlease Use 5.11.1
\n5.11.0 has been updated to fix some critical bugs. Please use the 5.11.1 Release.
\nThe updated Kubernetes Plugin Suite for Rundeck introduces powerful features including dynamic cluster discovery for EKS/AKS/GKE, cloud provider authentication, and native in-cluster support from Runner, all without Python dependencies. These enhancements enable automated cluster management, simplified authentication, and efficient bulk operations across multiple clusters, making it easier for teams to manage Kubernetes infrastructure at scale while reducing manual effort and improving security.
\n", "date_published": "2024-12-05T00:00:00.000Z", "date_modified": "2025-03-19T18:32:16.000Z", "authors": [], "tags": [] }, { "title": "5.7.0 Release Notes", "url": "https://docs.rundeck.com/docs/history/5_x/version-5.7.0.html", "id": "https://docs.rundeck.com/docs/history/5_x/version-5.7.0.html", "summary": "Project Runner Management is GA!", "content_html": "\nProject Runner Management, announced in version 5.3.0 is now Generally Available. We appreciate all the feedback during the Early Access program. Check out the docs on this feature here and watch a demo on the 5.3.0 release notes page.
\nThere are also quite a few package updates across the platform to address security findings submitted by the community.
\n", "date_published": "2024-10-21T00:00:00.000Z", "date_modified": "2025-03-19T18:32:16.000Z", "authors": [], "tags": [] }, { "title": "5.6.1 Release Notes", "url": "https://docs.rundeck.com/docs/history/5_x/version-5.6.1.html", "id": "https://docs.rundeck.com/docs/history/5_x/version-5.6.1.html", "summary": "Fix to Critical bug related to scheduled jobs.", "content_html": "\nThis release fixes a critical issue where scheduled jobs are no longer executed after making unrelated edits to the job. This can happen in version 5.6.0 when the jobs is edited via API, job/project imports, SCM, or direct job editing.
\nName: \"Fansiban sandybrown camera\"
\nRelease Date: October 14th, 2024
\nOur 5.6.0 release is focused on bug fixes, CVE remediation and testing. We have also continued our efforts into the UI code to modernize, and standardize it to Vue. This will bring performance improvements and simplify building future enhancements.
\nCaution
\nThis release contains a critical issue where scheduled jobs are no longer executed after making unrelated edits to the job. This can happen when the jobs is edited via API, job/project imports, SCM, or direct job editing. It is strongly recommended to use or upgrade to version 5.6.1.
\nCheck out the new features and enhancements for PagerDuty Runbook Automation commercial offerings and Rundeck Community included in this release.
\n", "image": "https://docs.rundeck.com/docs/assets/img/runner-node-dispatch.png", "date_published": "2024-08-08T00:00:00.000Z", "date_modified": "2025-03-19T18:32:16.000Z", "authors": [], "tags": [] }, { "title": "5.4.0 Release Notes", "url": "https://docs.rundeck.com/docs/history/5_x/version-5.4.0.html", "id": "https://docs.rundeck.com/docs/history/5_x/version-5.4.0.html", "summary": "Cyberark Integration can now use REST, Security Fixes", "content_html": "\nOur 5.4.0 release adds support for configuring separate endpoints for Credential Provider and API web-server, making it more flexible to integrate with different CyberArk deployment configurations while following security best practices.
\nWarning
\nIf you have updated from a Rundeck version of 4.16.0 or earlier to version 5.4.0 there is a UI bug that prevents the display of certain execution records. This issue is fixed with version 5.5.0 and there is no impact to the underlying data. Please see Release Notes for 5.5.0 here.
\nVersion 5.3.0 is here! These latest updates introduce Project Runner Management for enhanced team autonomy, new PagerDuty Incident Workflow integration for improved incident response, and SFTP support for more secure file transfers. These features collectively empower teams with better control over their automation workflows, strengthen incident management capabilities, and provide more secure options for script execution and file transfers in enterprise environments.
\nConcurrent Executions Performance Degradation
\nThere is a bug in this release that causes execution failures when there are 10 or more concurrent executions.\nTo mitigate this issue, add the following to Configuration Management or to rundeck-config.properties:
dataSource.properties.maximumPoolSize=100\nA permanent fix will be available in the next release.
\nOur 5.2.0 release is focused on bug fixes, CVE remediation and testing. The team spent time revamping our testing framework and migrating tests into that new model. There is also effort being put into the UI code to modernize, and standardize it to Vue to bring performance improvements and simplify building future enhancements.
\n", "date_published": "2024-04-10T00:00:00.000Z", "date_modified": "2025-03-19T18:32:16.000Z", "authors": [], "tags": [] }, { "title": "4.17.6 Release Notes", "url": "https://docs.rundeck.com/docs/history/4_x/version-4.17.6.html", "id": "https://docs.rundeck.com/docs/history/4_x/version-4.17.6.html", "summary": "4.17 Execution Deletion issues Fixed", "content_html": "\nName: \"Jörmungandr coral headphones\"\nRelease Date: April 2nd, 2024
\n\nFixes to a scenario when upgrading to versions after 4.17.0 would result in an inability to delete jobs.
\nHere is a link to the full list of public PRs
\nSubmit your own Pull Requests to get recognition here!
\nThis release fixes the following issues:
\nNodes were not showing properly in certain scenarios. If users didn't have system: read permissions, they wouldn't be able to see the project's nodes and would get a 403 error. Nodes would also have trouble being displayed if they contained a url to edit them (e.g AWS Nodes).
When AWS authentication was configured at the project level using plugin group config, AWS plugins would not properly authenticate in versions 5.1.0 and 5.1.1.
Fixes to a scenario when upgrading to versions after 4.17.0 would result in an inability to delete jobs properly.
\nHere is a link to the full list of public PRs
\nName: \"Elbrus orchid flag\"
\nRelease Date: March 28th, 2024
\nSubmit your own Pull Requests to get recognition here!
\nThis release patches the included Postgres JDBC Driver against the Critical CVE-2024-1597. There is also a fix to the Ansible libraries to address an issue when using Ansible and the SSHAgent.
\nUpgrade Runners
\nAfter upgrading the server software the Enterprise Runners will also need to be patched as they contain the driver file to facilitate running the SQL Run Step.
Here is a link to the full list of public PRs
\nName: \"Elbrus orange cutlery\"
\nRelease Date: March 5th, 2024
\nSubmit your own Pull Requests to get recognition here!
\nName: \"Jörmungandr brown grain\"\nRelease Date: March 4th, 2024
\n\nThis release patches the included Postgres JDBC Driver against the Critical CVE-2024-1597.
\nUpgrade Runners
\nAfter upgrading the server software the Enterprise Runners will also need to be patched as they contain the driver file to facilitate running the SQL Run Step.
Here is a link to the full list of public PRs
\nSubmit your own Pull Requests to get recognition here!
\nThe latest release introduces AWS Secrets Manager integration for seamless secret retrieval across multiple AWS accounts and regions, alongside new Enterprise Runner integrations with CyberArk Secrets Manager and Thycotic Secret Server. These key storage enhancements enable organizations to securely manage secrets within their existing infrastructure while using Runbook Automation, eliminating the need to store sensitive credentials directly within the platform.
\n", "image": "https://docs.rundeck.com/docs/assets/img/aws-secrets-highlight.gif", "date_published": "2024-02-14T00:00:00.000Z", "date_modified": "2025-03-19T18:32:16.000Z", "authors": [], "tags": [] }, { "title": "5.0.2 Release Notes", "url": "https://docs.rundeck.com/docs/history/5_x/version-5.0.2.html", "id": "https://docs.rundeck.com/docs/history/5_x/version-5.0.2.html", "summary": "Important Compatibility Updates for 5.X", "content_html": "\nThe 5.0 and 5.0.1 releases had some un-intended compatibility issues that this 5.0.2 version is meant to address. Details listed below about the issues from previous versions and the changes included.
\nUpgrade Steps
\nBe sure to follow the Upgrade instructions when moving to version 5.0 or higher. There are new minimum Java versions and other important information.
\nIt is no longer required to update the Enterprise Runner when upgrading to 5.x.
\nThis version does fix an issue where job definitions created in 5.x were not usable in older product versions. It's important to note that not all job definitions are backwards compatible if the job uses plugins or features not available on the older system, but this fix addressed some foundational issues with backwards compatibility for job definitions.
\nXML Support for the API is deprecated and future endpoints/enhancements will not support XML, but there is an option to turn it on for legacy needs. This version repaired an issue when enabling \"legacyXML\" feature of the API.
\nIn 5.0 we updated the JSON/JQ libraries and from that update the behavior of the filter improved in the form of performing much closer to a command line version of jq. This version adds an option flag to allow it to continue to add quotes as seen in previous product versions. New instances of the JSON/JQ Log filter will default to the new/improved behavior. Existing jobs will maintain the original behavior until a change is made to that log filter.
Name: \"Denali deeppink book\"
\nRelease Date: February 12th, 2024
\nSubmit your own Pull Requests to get recognition here!
\nPlease use version 5.0.2
\nWe have found some issues with Log Filters and passing data to the Enterprise Runner. Please use the 5.0.2 Release when upgrading.
\nUpgrade Steps
\nBe sure to follow the Upgrade instructions when moving to version 5.0 or higher. There are new minimum Java versions and other important information.
\nCheck out the new features and enhancements for PagerDuty Runbook Automation and Rundeck Community included in this release.
\nThis release fixes some key issues found in the 5.0.0 release. This release fixes the following issues:
\nThere is a new signing key to validate binaries starting with version 5.0.1. The new key can be downloaded here
\nHere is a link to the full list of public PRs
\nName: \"Denali coral bell\"
\nRelease Date: January 15th, 2024
\nSubmit your own Pull Requests to get recognition here!
\nRundeck/Runbook Automation 5.0 is here! This release updates the underlying foundations of the Rundeck and Runbook Automation platform to open up more opportunities for enhancements and improvements in the 5.x series.
\nOur major version releases typically center around updates to the foundational libraries we use to build Rundeck. The result is a more stable, extensible, and secure product from the extensive library updates. There are also commonly breaking changes or key upgrade steps to be aware of. For this 5.0 release, we still included some enhancements and have more planned throughout the 5.x release cycle.
\nPlease use version 5.0.2
\nWe have found some issues with Log Filters and passing data to the Enterprise Runner. Please use the 5.0.2 Release when upgrading.
\nUpgrade Steps
\nBe sure to follow the Upgrade instructions when moving to version 5.0 or higher. There are new minimum Java versions and other important information.
\nName: \"Basilisk yellowgreen globe\"\nRelease Date: December 13th, 2023
\n\nCheck out the new features and enhancements for PagerDuty Runbook Automation and Rundeck Community included in this release.
\n\n\nAlso includes all Open Source updates from below
\n
This release fixes a bug in 4.17.3 with Large Log files causing instability on browsers and causing a crash.
\nName: \"Basilisk violet glass\"\nRelease Date: November 13, 2023
\n\nThis release addresses two CVE announcements for Rundeck/Runbook Automation:
\nAlso includes other fixes for PagerDuty Runbook Automation and Rundeck Community included in this release.
\n\n\nAlso includes all Open Source updates from below
\n
Here is a link to the full list of public PRs
\nBundled Runner Version: 0.1.53
\nSubmit your own Pull Requests to get recognition here!
\nName: \"Basilisk turquoise gift\"\nRelease Date: November 7th, 2023
\n\nCheck out the new features and enhancements for PagerDuty Runbook Automation and Rundeck Community included in this release.
\nThis is a smaller point release version that fixes some urgent bugs.
\n\n\nAlso includes all Open Source updates from below
\n
Here is a link to the full list of public PRs
\nBundled Runner Version: 0.1.53
\nSubmit your own Pull Requests to get recognition here!
\nTerraform Provider Contributions (Cathcing up on these... If we missed anyone please let us know)
\nName: \"Basilisk slategray flash\"\nRelease Date: October 16, 2023
\nName: \"Basilisk sandybrown flag\"\nRelease Date: September, 25, 2023
\nName: \"Big Foot palevioletred book\"\nRelease Date: August 24th, 2023
\nName: \"Banshee fuchsia sunglasses\"\nRelease Date: July 25, 2023
\nName: \"Alicorn brown piggy-bank\"
\nRelease Date: July 13, 2023
\n\nPassword Reset operations over https were getting error messages on Enteprise versions of the product. Passwords were still being reset properly, but the user experience resulted in an error screen.
\nSubmit your own Pull Requests to get recognition here!
\nName: \"Wyvern red headphones\"
\nRelease Date:June 15th, 2023
\n\nThis release was created to fix a security vulnerability involving REMCO.
\nSubmit your own Pull Requests to get recognition here!
\nName: \"Wyvern red headphones\"
\nRelease Date: June 15th, 2023
\n\nCheck out the new features and enhancements for PagerDuty Runbook Automation, and Rundeck Community included in this release.This release includes new enhancements to the user experience, bug fixes around CyberArk, and new versioning for Twistlock security.
\nHere is a link to the full list of public PRs
\nSubmit your own Pull Requests to get recognition here!
\nName: \"Wyvern red headphones\"\nRelease Date: May 15th, 2023
\nName: \"Unicorn orchid gift\"\nRelease Date: May 10th, 2023
\nName: \"Unicorn orange flash\"\nRelease Date: April 17th, 2023
\nName: \"Satyr coral briefcase\"\nRelease Date: March 13th, 2023
\nName: \"Sphinx violet apple\"\nRelease Date: March 7th, 2023
\nName: \"Sphinx turquoise tower\"\nRelease Date: February 21, 2023
\nName: \"Sphinx slategray tent\"\nRelease Date: February 13, 2023
\nName: \"Quintaped peru phone\"\nRelease Date: January 11, 2023
\nIncubating: This feature or API is new! We may still have a few bugs or change some functionality in the future.
\nROI Metrics Data stores arbitrary key value pairs against your job to help understand your ROI per job execution. The metrics will be stored against the execution of the job, and accessible via API for further analysis. This article will walk through a setup scenario and provide some helpful example scripts to gather data from the API.
\nCustomer X has decided to track how much time is saved with their newly implemented Automation job (uniquely titled ROI Job). They know from historical ticket-data that doing the same work manually - prior to writing this job - took around 75 minutes across all teams, start to finish. The job now runs in just seconds. To configure the job follow the steps or download the job definition.
\n\n\n", "image": "https://docs.rundeck.com/docs/assets/img/roi-metrics-data.png", "date_published": "2023-01-07T00:00:00.000Z", "date_modified": "2024-06-14T16:49:05.000Z", "authors": [], "tags": [] }, { "title": "4.8.0 Release Notes", "url": "https://docs.rundeck.com/docs/history/4_x/version-4.8.0.html", "id": "https://docs.rundeck.com/docs/history/4_x/version-4.8.0.html", "summary": "Version 4.8.0 is here! Check out the new RSS Feed Plugin that will help streamline Automated Diagnostics and Resume Jobs using Ruleset and Parallel Strategies.", "content_html": "\nThis section assumes familiarity with fundamental Rundeck operations like Creating User API Tokens, editing/importing jobs, etc.
\n
Name: \"Phoenix green knight\"\nRelease Date: November 10, 2022
\nName: \"Orc yellowgreen gift\"\nRelease Date: October 6, 2022
\nAutomated diagnostics is a solution provided by integrating PagerDuty's Incident Response and Runbook Automation products. By automating the retrieval of “diagnostic” data during incidents, you can shorten the length of incidents, reduce the number of individuals paged to help with resolution, and gather evidence for fixing the root-cause after the incident.
\nThere are multiple use-cases and benefits to the Automated Diagnostics solution. Here are a few of the most common examples:
\nFor more details on these use-cases, see this section of the solution-guide.
\nPagerDuty provides a solution that helps users start automating diagnostics quickly. This Solution consists of prebuilt Automation Jobs that retrieve data from common infrastructure and services for investigating, debugging and diagnosing incidents:
\n![\"Verbose](\"/assets/img/diag-verbose-output.png\")
As an example, if an incident is triggered for a service running in Kubernetes, PagerDuty Runbook Automation can retrieve information from logs, API’s, databases and other sources that support this service. This could be triggered with the click of a button or through event-driven invocation.
\nDiagnostics retrieved using Runbook Automation can be made available in multiple interfaces such as PagerDuty's Mobil App, Slack, and Microsoft Teams:
\n![\"Diagnostics](\"/assets/img/diag_in_slack.png\")
This guide includes a full section on Examples & Best Practices - a preview of that is shown here:
\n| Examples |\n|
\n", "image": "https://docs.rundeck.com/docs/assets/img/diag-on-pd-timeline.png", "date_published": "2022-10-01T00:00:00.000Z", "date_modified": "2024-10-22T16:48:57.000Z", "authors": [], "tags": [] }, { "title": "Integrate with Ansible", "url": "https://docs.rundeck.com/docs/learning/howto/using-ansible.html", "id": "https://docs.rundeck.com/docs/learning/howto/using-ansible.html", "summary": "One popular pairing for Rundeck users is integrating Ansible playbooks into Rundeck to orchestrate and schedule workflows across multiple tools. Like Rundeck, Ansible's straightforward design and learning curve make it Operations friendly. Learn how you can integrate Rundeck with Ansible. ", "content_html": "\nIt’s common for Rundeck users to integrate Ansible into their Rundeck. Like Rundeck, Ansible's straightforward design and learning curve make it Operations friendly.
\nWhat does Rundeck do for Ansible users? Rundeck gives them a great GUI front-end experience and ties together their Ansible automation alongside different tools used by other groups. Rundeck's powerful access control capabilities can be used to safely provide other users and teams with self-service access to run automation (including Ansible playbooks) https://docs.ansible.com/ansible/latest/user_guide/playbooks.html.
\nAnsible is an automation solution developed by RedHat Inc, that handles configuration management, application deployment, cloud provisioning, ad-hoc task execution, network automation, and multi-node orchestration.
\nThe Ansible basic configuration is extremely easy. Ansible just needs two files to work: the configuration file (ansible.cfg, usually at /etc/ansible path) and the inventory file (where Ansible stores their remote nodes in this format, usually at /etc/ansible path too).
Ansible uses playbooks (essentially a defined blueprint for automation tasks), to manage configurations and deployments to remote machines.
\nThe full Ansible documentation is available here https://docs.ansible.com/.
\n\n\nNote: This How To assumes readers are very familiar with Rundeck. It is suggested to review and fully understand the Tutorial Exercises prior to attempting these steps.
\n
Both Rundeck versions (Community and Enterprise) use a built-in plugin for Ansible integrations. This plugin imports hosts from Ansible's inventory. It includes a bunch of facts and can run modules and playbooks. There is also a node executor and file copier for the project.
\nThis integration enables Rundeck users to:
\nrundeck user to the Ansible endpoints defined in the inventory file.\n\nNote: It is possible to use the Welcome Project environment with the Project File in the Additional Information section at the bottom of this page.
\n
Ansible needs two basic files to work, ansible.cfg (where Ansible configurations are located) and hosts (inventory).
In this guide we use three nodes defined as the Ansible inventory file: (Note-Your file will be different)
\n[ssh_farm]\n192.168.33.20\n192.168.33.21\n192.168.33.22\n![\"](\"/assets/img/howto-ansible-editconfig.png\")
/bin/bash) and define the Ansible config path (usually at /etc/ansible/ansible.cfg). Click on the Generate Inventory checkbox. Now scroll down and click on the Save button.\n![\"](\"/assets/img/howto-ansible-defaultnodeexec.png\")
rundeck user as the default user to connect to the Ansible remote inventory nodes. At this point, it’s possible to define the SSH authentication method (privatekey and password) and the specific Ansible SSH user to connect to the remote inventory nodes. You need to define the username in the SSH User textbox. Depending on the auth method you can select the password from the storage path or the ssh key (also from the filesystem path).\n![\"](\"/assets/img/howto-ansible-nodeexecauth.png\")
![\"](\"/assets/img/howto-ansible-addnodesource.png\")
/etc/ansible/hosts) and Ansible config path (usually at /etc/ansible/ansible.cfg).\n![\"](\"/assets/img/howto-ansible-ansiblenodesource.png\")
![\"](\"/assets/img/howto-ansible-ansiblesourceconfig.png\")
privatekey or password-based). Depending on the Authentication method, enter the user, ssh password, or the key file path.\n![\"](\"/assets/img/howto-ansible-ansiblesourceauth.png\")
![\"](\"/assets/img/howto-ansible-nodes.png\")
Time for a quick test.
\nls -la”).\n![\"](\"/assets/img/howto-ansible-runcommand.png\")
- name: test playbook\n hosts: all\n tasks:\n - shell: uname -a\n ignore_errors: yes\n register: uname_result\n - debug: msg=\"{{ uname_result.stdout }}\"\n![\"](\"/assets/img/howto-ansible-joboutput.png\")
To see the output you may need to switch to the Log Output view.
\nWhen Gather Facts is false, the inventory file is read as Yaml data.\nThis avoids connection validation, significantly saving time and reducing CPU and RAM usage.
\nThis parameter can be increased if necessary in this field:\n![\"](\"/assets/img/howto-ansible-yaml-data-size.png\")
When the limit is exceeded it throws this error in rundeck.log file:
\nResourceModelSourceException: Cannot load yaml data coming from Ansible: The incoming YAML document exceeds the limit: 10485760 code points.\nThis parameter can be increased if necessary in this field:\n![\"](\"/assets/img/howto-ansible-yaml-max-aliases.png\")
When the limit is exceeded it throws this error in rundeck.log file:
\nResourceModelSourceException: Cannot load yaml data coming from Ansible: Number of aliases for non-scalar nodes exceeds the specified max=1000.\nIt is possible to use the Welcome Project environment with this Project File.
\nansible (or another name if that one is taken)The other jobs have descriptions for what they do and are aligned with this tutorial.
\nIt's advisable to segment extensive inventories into smaller groups or files containing approximately 1000 nodes each. Consequently, for every 1000 nodes, establish a dedicated source node for the respective group.\nThe information described above is based on the recommendations described in the Ansible documentation.\nAnsible - Intro Inventory
\n", "image": "https://docs.rundeck.com/docs/assets/img/howto-ansible-editconfig.png", "date_published": "2022-09-20T00:00:00.000Z", "date_modified": "2024-12-03T16:25:33.000Z", "authors": [], "tags": [] }, { "title": "Pass Data Between Steps", "url": "https://docs.rundeck.com/docs/learning/howto/passing-variables.html", "id": "https://docs.rundeck.com/docs/learning/howto/passing-variables.html", "summary": "Multi-Step workflows often require sharing data from one step to another. Check out the examples in this 'How to' for the diffrerent ways data can be shared through out a workflow.", "content_html": "\nRundeck offers powerful Runbook Automation. Most Runbooks are complicated, multi-step processes.
\nThis guide will show various examples of how to share data from one step to another through the use of Log Filters.
\n\n\nNote: If you haven't followed the Exercise Steps in the Tutorial we encourage starting with that walk-through.
\n
When a Job step is executed, it has a set of context variables that you can access in the Job step. There are several sets of context variables, including: the Job context job, the Node context node, the Option context option, and the Step Data Context data.
Click here for more documentation on: Job Variables Reference
\nThese are some key terms we'll be using throughout this tour in addition to terms used in our Terminology documentation.
\nLog Filters are applied to a Job step to act on the output from that step. Certain Job Filters can set variables based on information in the log output. There is a separate guide (coming soon) to cover different types of Log Filters and how they are used.
\nLog Filters use Regular Expression syntax (RegEx) to collect information from the log output. Familiarity with Regex will be key to successfully gathering data from your own job steps. You will not need to know it for these Exercises.
\nAs part of the Welcome Projects we have built some example jobs to highlight how variables can be passed from one job step to another. For more information about the Welcome Projects check out the Learning Overview.
\nIt's important to note that Node Steps (which execute on each node) and Workflow Steps (which execute once on the Rundeck server) store variables differently. Node Steps capture data in Node Scope while Workflow Steps capture data in Global Scope. The examples will show how to use variables from different types of steps and highlight common trouble spots.
\nFor a detailed explanation of step types and variable scoping, see Job Step Plugins - Understanding Step Types.
\nImportant Exercise Prerequisite
\nIf you are new to Rundeck, we recommend finishing the exercises in the Getting Started Tutorial first. Terminology and actions in the following exercise will assume you have completed that Tutorial.
\nInput Option are values that are provided at the start of running a job. They may be represented as a form on the Job Execution page or populated by a Webhook or other call.
\n\nStep Data variables are data gathered using Log Filters and stored in memory while the job is running. (See the Log Filters How To for specifics on each type).
\nHow Step Data variables are referenced in Jobs depend on a few things:
\nThere are two types of Job Steps (see Understanding Step Types for complete details):
\nThis is important to keep in mind because when a job is run against more than one node, each Node Step creates a separate variable entry for each node it was run against.
\nReferencing variables from Command Steps use a different syntax than referencing them from within a Script. Most Job Steps are Command Steps and will follow a format of:\n${data.MyKeyName}. Scripts will reference variables by enclosing them in @ symbols: @data.MyKeyName@
The Using Step Data Variables job in the previous section was configured to only execute against the Rundeck Server.\nTo highlight the difference when running against multiple nodes, let's run the Multi-Node Example job and explore its output and configuration.
\n\n\n\nNote: It is recommended to configure multiple Nodes as detailed in the Getting Started Tutorial.
\n
A common sticking point is when Workflow Steps need to use a variable value from a Node Step.
\nAccessing the variable from the node would need to be called using ${data.MyKeyName@hostname} to get the specific value. Note the @hostname portion of that string.
If your job is run against a single node it is also possible to use the * character ${data.MyKeyName*}. The * is used in Step 4 but as you can see in the output when used on jobs with multiple nodes the variables are joined with a comma ,. If you want to use a character other than ,, you can add it after the * like ${data.MyKeyName*;} which will separate all values with ;.
Using other Context variables follows the same format.
\nTo see what variables might be available check out the list here:\nJob Variables Reference
\nTo check variable values during your workflow use the Workflow Step titled Log Data Step.
\n", "date_published": "2022-09-10T00:00:00.000Z", "date_modified": "2026-02-02T20:13:55.000Z", "authors": [], "tags": [] }, { "title": "Learn the Rundeck CLI", "url": "https://docs.rundeck.com/docs/learning/howto/learn-rd-cli.html", "id": "https://docs.rundeck.com/docs/learning/howto/learn-rd-cli.html", "summary": "The Rundeck CLI is a great way to streamline repeated Rundeck tasks or programmatically manage your installation. Learn more about using it today. ", "content_html": "\nRundeck CLI (RD-CLI) is a Java client to access and interact with a Rundeck Instance from the command line. In a few words, Rundeck CLI is a Rundeck API abstraction tool. With Rundeck CLI is possible to view system information, list executions, list and manage jobs, manage keys, list and manage node source, projects, and jobs in the command line.
\nRD-CLI is available as a separate install from Rundeck Open Source/Enterprise for multiple platforms. There are options to install it using a specific repository or just download the .zip file, uncompress it, and execute the binary directly (inside the bin folder).
curl https://raw.githubusercontent.com/rundeck/packaging/main/scripts/rpm-setup.sh 2> /dev/null | bash -s rundeck\nyum install rundeck-cli\nrd\ncurl -s https://packagecloud.io/install/repositories/pagerduty/rundeck/script.deb.sh | os=any dist=any bash\napt-get install rundeck-cli\nrd\n![\"rd](\"/assets/img/learn-rd-cli-1.png\")
Rundeck CLI needs the Rundeck instance connection information and valid credentials (via user/password method or using a valid token), check here to know how to generate a valid user token on Rundeck.
\nRD-CLI needs the Rundeck instance address and port, for this, the RD_URL environment variable is needed, to save it in your environment just do:
export RD_URL=http://rundeck:4440\nAlso, it’s possible to define the specific API version in the following way:
\nexport RD_URL=http://rundeck:4440/api/12\nThese env vars could be saved on .bashrc file directly or in ~/.rd/rd.conf config file (needs the following environment variable to get work: export RD_CONF=/path/to/rd.conf).
The following environment variables work to connect to the Rundeck instance via the user/password method.
\nexport RD_USER=rundeck_user\n\nexport RD_PASSWORD=password\nThe following environment variable it work to connect to the Rundeck instance via API token method, take a look at this to see how to create a new token in Rundeck.
\nexport RD_TOKEN=rundeck_token\nThis point is important because RD-CLI offers help for every option that includes. A good way to get help on any RD-CLI command is to put \"help\" after any action, for example, to get all options available to get jobs info just type:
\nrd jobs info help\nThat's applicable for any action. Another example, to see all system options available:
\nrd system help\n![\"rd](\"/assets/img/learn-rd-cli-2.png\")
Now you can see the available commands, so, if you need specific help for rd system info action, just do: rd system info help and now the command description is available.
![\"rd](\"/assets/img/learn-rd-cli-3.png\")
rd system info\n![\"System](\"/assets/img/learn-rd-cli-4.png\")
rd jobs info -v -i job_id\n-v is to increase the verbosity and -i is the parameter to define the job UUID.\n![\"Job](\"/assets/img/learn-rd-cli-5.png\")
rd jobs load -f SpaceCat.yaml -F yaml -p ProjectEXAMPLE\n![\"Job](\"/assets/img/learn-rd-cli-6.png\")
\nWhere -f is the parameter to define the yaml job definition file, -F is the file format, and -p is the project name parameter.rd executions info -v -e 17\n![\"Execution](\"/assets/img/learn-rd-cli-7.png\")
\nWhere -v is the parameter to increase the output verbosity, -i is the parameter to define the execution id and job_id is the job id.rd run -v -i job_id\n![\"Run](\"/assets/img/learn-rd-cli-8.png\")
\nWhere -v is the parameter to increase the output verbosity, -i is the parameter to define the execution id and job_id is the job id.rd run -v -i job_id -- -option_name option_value\n![\"Job](\"/assets/img/learn-rd-cli-9.png\")
\nWhere -v is the parameter to increase the output verbosity, -i is the parameter to define the execution id, job_id is the job id, -option_name is the job option name and option_value is the value of -option_name option.Just like our Rundeck Open Source solution, Rundeck Documentation is a shared resource that anyone can help contribute to. Anything from typo’s to feature clarifications are a helpful way to give back to the Rundeck community.
\n\n\nThe Rundeck documentation uses VuePress. Updates to the navigation menus may be necessary, but we ask that changes to the underlying VuePress be left to the Rundeck Team.
\n
For simple documentation fixes it’s possible to make the changes right in GitHub. Let’s get started with an example. For this example we have provided a page you are welcome to submit an update on at: https://docs.rundeck.com/docs/learning/howto/docs-update-exercise.html
\n![\"Edit](\"/assets/img/howto-updatedocs-githubedit.png\")
![\"Propose](\"/assets/img/howto-updatedocs-githubpropose.png\")
![\"Compare](\"/assets/img/howto-updatedocs-githubcompare.png\")
![\"Submit](\"/assets/img/howto-updatedocs-githubpullreq.png\")
Congratulations! Keep an eye out for comments/feedback via the comments section from our team.
\nThe steps above work great for small/simple changes. The Rundeck Docs is a public repository. If you are familiar with git commands and want to clone the repository and manage/push your own updates please feel free to do so.
/docs/assets/img folder. There is an example image call in the sample page. It is recommended to name the image in a way that ties it to the page/section it is used in. For example howto-example-joke.png. Be mindful of file sizes when creating images.Looking for content ideas to contribute? Check out https://github.com/rundeck/docs/issues for items that might need fixing.
\n", "image": "https://docs.rundeck.com/docs/assets/img/howto-updatedocs-githubedit.png", "date_published": "2022-08-01T00:00:00.000Z", "date_modified": "2023-10-03T23:58:50.000Z", "authors": [], "tags": [] } ] }