This 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.

Recent Changes

PR #10003

Fixed 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.

PR #9990

Updated Apache Commons Lang library to the latest version (commons-lang3) to address CVE-2025-48924, ensuring continued security and compatibility with modern Java standards.

PR #9981

A 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.

Subscribe to Updates

Stay informed about Rundeck development by subscribing to a feed:

• RSS Feed
• Atom Feed

These feeds are updated regularly to highlight changes that are available in Runbook Automation SaaS and will be included in upcoming Self Hosted releases.

About These Updates

The 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.

Note: 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.

Overview

Conditional 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:

• Job options (environment, configuration values)
• Node attributes (OS family, hostname, tags)
• Job context (project name, job name, execution user)
• Data captured from previous steps

This guide provides hands-on examples to help you understand how to use conditional logic effectively.

Prerequisites

1. Runbook Automation 5.20.0+ with the conditional logic feature enabled
2. Feature flag enabled in rundeck-config.properties:

   rundeck.feature.earlyAccessJobConditional.enabled=true
   
3. Basic understanding of job workflows and job options
4. Workflow strategy set to Sequential or Parallel (not Node First or Ruleset)

Understanding Conditional Logic

Conditional Logic steps come in two types:

• Node Conditional Logic: Evaluates conditions independently on each node based on node attributes
• Workflow Conditional Logic: Evaluates conditions once per job execution in a global context

Both types support:

• Multiple conditions with AND logic (all must be true)
• Multiple condition sets with OR logic (any set can be true)
• Various operators: equals, not equals, contains, matches (regex), greater than, less than

Hands-On Examples

The 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.

This 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.

This is a critical bug fix release that addresses the following issue:

Node 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.

In 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.

Rundeck Product Updates

• Fix node filter input not updating value correctly on reference jobs

Here is a link to the full list of public PRs

Links

• Download the Releases: Open Source | Self-Hosted
• Sign up for Release Notes
• Upgrade instructions

Version Info

Name: "Logan yellowgreen phone"

Release Date: August 18th, 2025

Staff Contributors

• Greg Schueler (gschueler)
• Carlos Eduardo (carlosrfranco)
• Eduardo Baltra (edbaltra)
• Forrest Evans (fdevans)
• Jake Cohen (jsboak)
• Jaya Singh (jayas006)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• José Vásquez (hiawvp)
• Luis Toledo (ltamaster)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)

This 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.

• Resolved an issue where changes made to runner node-filters were not being saved properly.
• Fixed the non-functioning key storage selector when using runner.
• Addressed a bug where persistent error messages in runner logs stating "Runner did not deliver reports in the configured timeout period" and resulted in jobs not continuing to run.

Links

• Download the Releases: Open Source | Self-Hosted
• Sign up for Release Notes
• Upgrade instructions
• Catch us on LinkedIn for the Live Stream Release Videos

Version Info

Name: "Kilimanjaro deeppink bullhorn"

Release Date: April 16, 2025

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors

• Greg Schueler (gschueler)
• Alexander Abarca (alexander-variacode)
• Alexander Grachtchouk (mrdubr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Charlie Crawford (ChuckCrawford)
• Forrest Evans (fdevans)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• José Vásquez (hiawvp)
• Luis Toledo (ltamaster)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)

This 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.

• Resolved an issue where changes made to runner node-filters were not being saved properly.
• Fixed the non-functioning key storage selector when using runner.
• Addressed a bug where persistent error messages in runner logs stating "Runner did not deliver reports in the configured timeout period" and resulted in jobs not continuing to run.

Links

• Download the Releases: Open Source | Self-Hosted
• Sign up for Release Notes
• Upgrade instructions

Version Info

Name: "K2 turquoise tower"

Release Date: April 15, 2025

Staff Contributors

• Greg Schueler (gschueler)
• Alexander Abarca (alexander-variacode)
• Alexander Grachtchouk (mrdubr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Charlie Crawford (ChuckCrawford)
• Forrest Evans (fdevans)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• José Vásquez (hiawvp)
• Luis Toledo (ltamaster)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)

The 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.

Project 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.

There are also quite a few package updates across the platform to address security findings submitted by the community.

This 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.

Links

• Download the Releases: Open Source | Self-Hosted
• Sign up for Release Notes
• Upgrade instructions

Version Info

Name: "Fansiban sandybrown camera"

Release Date: October 14th, 2024

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Alexander Grachtchouk (mrdubr)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Charlie Crawford (ChuckCrawford)
• Darwis Narvaez (DarwisNarvaezDev)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Oscar Cerda (ocerda)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

Our 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.

Check out the new features and enhancements for PagerDuty Runbook Automation commercial offerings and Rundeck Community included in this release.

Our 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.

Version 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.

dataSource.properties.maximumPoolSize=100

Our 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.

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions

Overview

Fixes to a scenario when upgrading to versions after 4.17.0 would result in an inability to delete jobs.

Rundeck Open Source Product Updates

• Fix error when deleting jobs after upgrade

Here is a link to the full list of public PRs

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

This release fixes the following issues:

Nodes 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.

Runbook/Runbook Automation Updates

• Fix AwsPluginGroup not working when the configuration was set at the project level.

Rundeck Open Source Product Updates

• Fix for nodes not showing
• Replace api call for fetching execution modes for nodes
• Fix error when deleting jobs after upgrade.

Here is a link to the full list of public PRs

Links

• Download the Release: Open Source | Self-Hosted
• Sign up for Release Notes
• Upgrade instructions

Version Info

Name: "Elbrus orchid flag"

Release Date: March 28th, 2024

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

This 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.

Rundeck Open Source Product Updates

• Update Postgres SQL JDBC driver to address CVE-2024-1597
• Fix: Issues with Ansible Plugin when using SSHAgent on 5.1.0

Here is a link to the full list of public PRs

Links

• Download the Release: Open Source | Self-Hosted
• Sign up for Release Notes
• Upgrade instructions

Version Info

Name: "Elbrus orange cutlery"

Release Date: March 5th, 2024

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions

Overview

This release patches the included Postgres JDBC Driver against the Critical CVE-2024-1597.

Rundeck Open Source Product Updates

• Update Postgres driver to patch CVE-2024-1597
• Rdcli is not working properly updating projects on severals rundeck versions
• Fix: Job option description too long

Here is a link to the full list of public PRs

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

The 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.

The 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.

Release Details

Remove mandatory Enterprise Runner upgrade.

It is no longer required to update the Enterprise Runner when upgrading to 5.x.

5.x job definitions can now work on 4.x

This 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.

XML API Support

XML 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.

JSON/JQ Filter Quoting Behavior

In 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.

Links

• Download the Release: Open Source | Self-Hosted
• Sign up for Release Notes
• Upgrade instructions

Version Info

Name: "Denali deeppink book"

Release Date: February 12th, 2024

Community Contributors

Submit your own Pull Requests to get recognition here!

• Rui Melo Amaro (rmeloamaro)

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

Please use version 5.0.2

We have found some issues with Log Filters and passing data to the Enterprise Runner. Please use the 5.0.2 Release when upgrading.

Overview

Check out the new features and enhancements for PagerDuty Runbook Automation and Rundeck Community included in this release.

Highlights

This release fixes some key issues found in the 5.0.0 release. This release fixes the following issues:

• The JSON/JQ Log Filter was not properly capturing data into workflow variables.
• Certain data context variables were not being passed properly to the Enterprise Runner resulting in jobs failing to execute.

There is a new signing key to validate binaries starting with version 5.0.1. The new key can be downloaded here

Rundeck Open Source Product Updates

• Update Jgit version for CVE-2023-4759
• fix: step labels unavailable for workflow strategy
• Fix replace token for command plugin

Here is a link to the full list of public PRs

Links

• Download the Release: Open Source | Self-Hosted
• Sign up for Release Notes
• Upgrade instructions

Version Info

Name: "Denali coral bell"

Release Date: January 15th, 2024

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

Rundeck/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.

Our 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.

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions

Overview

Check out the new features and enhancements for PagerDuty Runbook Automation and Rundeck Community included in this release.

Runbook Automation Updates

Also includes all Open Source updates from below

Overview

This release fixes a bug in 4.17.3 with Large Log files causing instability on browsers and causing a crash.

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions

Overview

This release addresses two CVE announcements for Rundeck/Runbook Automation:

• CVE-2023-48222
  Authenticated users can view or delete jobs for which they do not have authorization.
• CVE-2023-47112
  Authenticated users can view job names and groups for which they do not have read authorization.

Also includes other fixes for PagerDuty Runbook Automation and Rundeck Community included in this release.

Runbook Automation Updates

• Fix: Error with authentication using assume-role if using EC2/ECS credential provider
• Fix: ERROR 500 When creating ACL on Rundeck 4.16 + Postgres/Oracle

Also includes all Open Source updates from below

Rundeck Open Source Product Updates

• Fix: CVE-2023-47112 and CVE-2023-48222 | Job information endpoints not properly authorized
• Fix runtimeException Error on Script Resource Model

Here is a link to the full list of public PRs

Enterprise Runner Updates

Bundled Runner Version: 0.1.53

Community Contributors

Submit your own Pull Requests to get recognition here!

• (rmeloamaro)
• Jai Govindani (jai)
• Bruno Dias (brmdias)

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions

Overview

Check out the new features and enhancements for PagerDuty Runbook Automation and Rundeck Community included in this release.

This is a smaller point release version that fixes some urgent bugs.

Runbook Automation Updates

Also includes all Open Source updates from below

Additional Updates

• S3 Log Import Issue in Clustered Environments.
• Fix: Switch to active mode with remote execution enabled kills all "run job later" executions
• Add assumeRoleArn property to ECS Node Source plugin and ECS Node Step plugins
• Fix: ServiceNow Quick filter not pulling all nodes after 4.17
• Azure group source plugin fix: avoid including null in groups result
• Webhook Debug Activity Not showing up in 4.17
• Fix: Performance issues - HealthStatus Node Enhancer

Rundeck Open Source Product Updates

• Upgrade Ansible plugin to 3.2.8
• Fix AVERAGE_DURATION_EXCEEDED execution status when using API
• Fix: Scheduled Editor not showing helper messages
• Improve Project config plugin validation issue from API request
• Update snakeyaml usage to be forward compatible with snakeyaml 2.0
• Avoid NPE if UserGroupSourcePlugin returns a null entry
• Fix exception in job start can cause system logs to stop
• Fix: flickering execution log view
• Fix Project Component Export
• Fix: Adjust infomation on 500 error page and replace with SpaceCat
• Fix: not importing logs from s3logstore
• Fix: node step with workflow error handler missing top level step state

Here is a link to the full list of public PRs

Ansible Plugin Updates

• Ansible Playbook Inline Workflow step couldn't run in a node dispatched from a Remote Runner

Enterprise Runner Updates

Bundled Runner Version: 0.1.53

Community Contributors

Submit your own Pull Requests to get recognition here!

• Connor McBrine-Ellis (mcbrineellis)
• Reiner (MegaDrive68k)
• Bruno Dias (brmdias)
• Tiago Barbosa (t1agob)

Terraform Provider Contributions (Cathcing up on these... If we missed anyone please let us know)

• Nathan Neulinger (nneul)
• Sander Descamps (sanderdescamps)
• Oliver Borchertborchero (borchero)
• Chris M (tebriel)
• Søren Mathiasen (sorenmat)
• Dmitriy Kostikov (rumatavz)
• Daniel B (dbrowneihg)
• Stéphane Bruckert (stephanebruckert)
• Adam Brett (adambrett)

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Eric He (ehe-pd)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Sarah Martinelli Benedetti (smartinellibenedetti)
• Stephen Joyner (sjrd218)

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

Release Date: July 13, 2023

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions

Overview

Password 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.

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Eric He (ehe-pd)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Stephen Joyner (sjrd218)

Release Date:June 15th, 2023

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions

Overview

This release was created to fix a security vulnerability involving REMCO.

Rundeck Open Source Product Updates

• Upgrade to REMCO 0.12.4

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Eric He (ehe-pd)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Stephen Joyner (sjrd218)

Release Date: June 15th, 2023

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions

Overview

Check 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.

Highlights

• Enhanced user experience for managing large projects. Previously, when removing existing projects from the system, users would have to wait for the delete operation to complete. For large projects – such as those with 100,00 executions – this could take upwards of 25 minutes or more. Now, when users delete a project, the operation takes place in the background, eliminating user wait times for the delete operation to complete.
• Major bug fixes for CyberArk. Two major fixes were implemented that make the Key Storage integration with CyberArk more reliable for the user.
• Improved security with additional vulnerability scanning coverage. 45 new CVEs have been addressed.

Additional Enterprise Updates

• Fix: Cyberark key storage plugin exceptions on startup and null initialization
• Fix: ECS plugin updated
• Fix: SSO error causes "White label" error page release-notes/include to-jira
• Update Azure plugin group name to be capitalized like other plugin groups
• Job Runner user-class allowed to read Nodes

Rundeck Open Source Product Updates

• Upgrade to spring boot 2.7.12
• Fix: references to ctxProject.
• Fix: notifications not triggering
• Fix: RSS feed generation not working
• Fix: Job Step plugin that uses ${config.*} variables within are no longer resolving
• Fix: Key Storage Making Call to List Keys Twice
• Fix: Import status not consistent in cluster after importing jobs through UI
• Fix: SCM Options in Job Menu Not Loading
• Fix: SCM General Disconnection Issues
• Fix: SCM import plugin does not refresh status in API unless GUI is refreshed
• Fix: Successful remote job import from API but getting error in SCM API response
• Upgrade ansible plugin to v3.2.5 and sshj plugin to 0.1.7
• AzureObjectStore update to exclude json-smart and upgrade nimbus-jose
• Improve UI performance with local assets support in UI plugins by using asset: prefix
• Update aws-s3-model-source plugin version 1.0.8
• Upgrade to spring-boot 2.7.11
• Upgrade libraries azure plugin libraries for azure 1.41.4 and azure-storage to 8.6.6
• Update Postgres driver version to 42.3.8
• Add additional DB index to improve performance
• Add database changeset preconditions
• Put webpack copied jquery autocomplete asset in the vendor folder.
• Minor improvements on spring security plugin config.
• Turn off storage rewrite by default
• Convert project node source edit page to Vue
• Java11 compatibility core
• Change user summary UI attach to use ui-socket
• Deferred project delete
• Add OpenAPI Spec annotations

Here is a link to the full list of public PRs

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors

• Greg Schueler (gschueler)
• Alberto Hormazabal Cespedes (ahormazabal)
• Alexander Abarca (alexander-variacode)
• Antony Velasquez Ruiz (avelasquezr)
• Carlos Eduardo (carlosrfranco)
• Christopher McCarroll-Gilbert (chrismcg14)
• Darwis Narvaez (DarwisNarvaezDev)
• Eric He (ehe-pd)
• Forrest Evans (fdevans)
• Imad Jafir (imad6639)
• Jake Cohen (jsboak)
• Jason Brooks (jbrookspd)
• Jesus Osuna (Jesus-Osuna-M)
• Leonel Juarez (L2JE)
• Luis Toledo (ltamaster)
• Osman Albarran (Oalbarran94)
• Rodrigo Navarro (ronaveva)
• Stephen Joyner (sjrd218)

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

Incubating: This feature or API is new! We may still have a few bugs or change some functionality in the future.

ROI 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.

Configuring the Metrics

Example Scenario:

Customer 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.

Gathering Data

This section assumes familiarity with fundamental Rundeck operations like Creating User API Tokens, editing/importing jobs, etc.

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

• Download the Releases
• Sign up for Release Notes
• Upgrade instructions
• Watch the Live Stream Release Recap

Automated 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.

Use Cases

There are multiple use-cases and benefits to the Automated Diagnostics solution. Here are a few of the most common examples:

• Improve Triage: surfacing diagnostic data can improve the time spent troubleshooting and the number of people pulled into incidents.
• Capture Environment State: by capturing the environment or application "state" during an incident, operations engineers and developers have evidence to help them fix code-level bugs and configuration errors - perhaps a while after the incident has been resolved.
• Realtime Updates: by querying backend services in realtime, an Incident Commander can more easily provide updates to stakeholders during an incident.

For more details on these use-cases, see this section of the solution-guide.

Prebuilt Automation

PagerDuty 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:

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.

Simplifying and Sharing Diagnostics

Diagnostics retrieved using Runbook Automation can be made available in multiple interfaces such as PagerDuty's Mobil App, Slack, and Microsoft Teams:

Examples & Templates

This guide includes a full section on Examples & Best Practices - a preview of that is shown here:

| Examples | |

What 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.

What is Ansible?

Ansible 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.

The 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.

The full Ansible documentation is available here https://docs.ansible.com/.

How to Integrate Ansible with Rundeck

Note: 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.

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.

This integration enables Rundeck users to:

• Call Ansible playbooks and modules from Rundeck. Rundeck returns output from Ansible's command line, however in an easier to consume format within Rundeck’s GUI and users can utilize the Rundeck API and access control features.
• Use Ansible as the underlying execution framework. Run any command or script and output will be collated by node and step like typical Rundeck output.

Pre-Requisites

• Rundeck installed with version 5.19.0
• Ansible binaries installed on Rundeck Server based on Ansible documentation.
• Confirmation that Rundeck can SSH as rundeck user to the Ansible endpoints defined in the inventory file.

Note: It is possible to use the Welcome Project environment with the Project File in the Additional Information section at the bottom of this page.

Ansible Configuration

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)

[ssh_farm]
192.168.33.20
192.168.33.21
192.168.33.22

Rundeck/Ansible Integration

1. To run commands via the "Commands" menu or the default "Command" node step in a Rundeck job, we can configure a project with the Ansible node executor as a default. Create a new project, go to the Default Node Executor tab and select Ansible Ad-hoc Node Executor.
   
   
   
   
2. In the Ansible Node Executor configuration, set the Executable (usually /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.
   
   
   
   The Rundeck-Ansible plugin uses the 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).
   
   
   
   
3. Add the Ansible inventory nodes by clicking on Project Settings > Edit Nodes... and then on Add new Node Source +.
   
   
   
   
4. Choose Ansible Resource Model Source and define the Ansible inventory file path on your Rundeck Server (usually at /etc/ansible/hosts) and Ansible config path (usually at /etc/ansible/ansible.cfg).
   
   
   
   
   
   
   
   Similar to the node executor configuration, in the “SSH Connection” section it’s possible to define the Authentication method (privatekey or password-based). Depending on the Authentication method, enter the user, ssh password, or the key file path.
   
   
   
   
5. Now, scroll down and click on the Save button.
6. Click on the Nodes option in the left panel to see the nodes defined in the Ansible inventory.
   
   
   
   

Time for a quick test.

1. Go to the Commands option in the left panel in the Nodes section, select an Ansible node defined in your Ansible inventory, and run some command (in this example we used “ls -la”).
   
   
   
   
2. Now you can run any command/playbooks/inline-playbooks over your Ansible inventory.

First Inline-Playbook Inside a Rundeck Job

1. Create a new Job
2. Give it any name
3. In the Workflow tab select Ansible Playbook Inline Workflow Node Step
4. Put the following playbook:

   - name: test playbook
     hosts: all
     tasks:
       - shell: uname -a
         ignore_errors: yes
         register: uname_result
       - debug: msg="{{ uname_result.stdout }}"
   
5. Go to the Nodes tab in the Job Definition and type the name of an Ansible node as a Node Filter.
6. Save the Job
7. Run the job
   
   
   
   

To see the output you may need to switch to the Log Output view.

Inventory Yaml

When Gather Facts is false, the inventory file is read as Yaml data. This avoids connection validation, significantly saving time and reducing CPU and RAM usage.

• Data Size It supports up to 10MB of data by default, which supports around 19,000 nodes. However, it depends on the operating system.

This parameter can be increased if necessary in this field:

When the limit is exceeded it throws this error in rundeck.log file:

ResourceModelSourceException: Cannot load yaml data coming from Ansible: The incoming YAML document exceeds the limit: 10485760 code points.

• Max Aliases It supports up to 1000 of aliases by default. This is to avoid the application vulnerable to certain types of attacks.

This parameter can be increased if necessary in this field:

When the limit is exceeded it throws this error in rundeck.log file:

ResourceModelSourceException: Cannot load yaml data coming from Ansible: Number of aliases for non-scalar nodes exceeds the specified max=1000.

Additional Information

It is possible to use the Welcome Project environment with this Project File.

1. Create a new project called ansible (or another name if that one is taken)
2. Open the Ansible Project and use Project Settings > Import Archive to import the file.
3. Run the Install Ansible on Rundeck Server Job to install Ansible.

The other jobs have descriptions for what they do and are aligned with this tutorial.

Notes

It'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. The information described above is based on the recommendations described in the Ansible documentation. Ansible - Intro Inventory

Rundeck offers powerful Runbook Automation. Most Runbooks are complicated, multi-step processes.

This guide will show various examples of how to share data from one step to another through the use of Log Filters.

Note: If you haven't followed the Exercise Steps in the Tutorial we encourage starting with that walk-through.

Type of Variables

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

Other Terminology

These are some key terms we'll be using throughout this tour in addition to terms used in our Terminology documentation.

Log Filters

Log 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.

RegEx

Log 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.

Exercises Intro

As 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.

It'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.

For a detailed explanation of step types and variable scoping, see Job Step Plugins - Understanding Step Types.

Using Input Option Variables

Input 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.

Using Step Data Variables

Step 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).

How Step Data variables are referenced in Jobs depend on a few things:

• The type of Job Step we are running (Node Step vs. Workflow Step)
• Whether the variable is being accessed from a Command Step or a Script

Job Step Types

There are two types of Job Steps (see Understanding Step Types for complete details):

• Node Steps: Execute once on each node that matches the job's node filter
• Workflow Steps: Execute exactly once per job invocation on the Rundeck server

This 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.

Command Steps vs Scripts

Referencing 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: ${data.MyKeyName}. Scripts will reference variables by enclosing them in @ symbols: @data.MyKeyName@

Node vs Workflow Steps (Multi-Node Example)

The Using Step Data Variables job in the previous section was configured to only execute against the Rundeck Server. To highlight the difference when running against multiple nodes, let's run the Multi-Node Example job and explore its output and configuration.

Note: It is recommended to configure multiple Nodes as detailed in the Getting Started Tutorial.

A common sticking point is when Workflow Steps need to use a variable value from a Node Step.

Accessing 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

Using other Context variables follows the same format.

To see what variables might be available check out the list here: Job Variables Reference

To check variable values during your workflow use the Workflow Step titled Log Data Step.

Rundeck 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.

Installation

RD-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).

CentOS/Redhat based operating systems:

1. Add the repository with:

   curl https://raw.githubusercontent.com/rundeck/packaging/main/scripts/rpm-setup.sh 2> /dev/null | bash -s rundeck
   
2. Then install with the following command:

   yum install rundeck-cli
   
3. Test RD-CLI with the following command:

   rd
   

Debian/Ubuntu based operating systems

1. Add the repository with the following command:

   curl -s https://packagecloud.io/install/repositories/pagerduty/rundeck/script.deb.sh | os=any dist=any bash
   
2. Install with:

   apt-get install rundeck-cli
   
3. Test the installation with the following command:

   rd
   
   

Configuration

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.

Connection info env vars

RD-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

Also, it’s possible to define the specific API version in the following way:

export RD_URL=http://rundeck:4440/api/12

These 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).

Using the User/password method

The following environment variables work to connect to the Rundeck instance via the user/password method.

export RD_USER=rundeck_user

export RD_PASSWORD=password

Using the Rundeck token method

The 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.

export RD_TOKEN=rundeck_token

How to use the help on RD-CLI

This 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:

rd jobs info help

That's applicable for any action. Another example, to see all system options available:

rd system help

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.

First Steps with RD-CLI

1. See a complete Rundeck instance information rd system info
2. See a job information

   rd jobs info -v -i job_id
   
   Where -v is to increase the verbosity and -i is the parameter to define the job UUID.
3. Upload a job from a file (also updates a job with the same UUID).

   rd jobs load -f SpaceCat.yaml -F yaml -p ProjectEXAMPLE
   
   Where -f is the parameter to define the yaml job definition file, -F is the file format, and -p is the project name parameter.
4. See an execution info

   rd executions info -v -e 17
   
   Where -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.
5. Run a job

   rd run -v -i job_id
   
   Where -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.
6. Run a job with options

   rd run -v -i job_id -- -option_name option_value
   
   Where -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.

Prerequisites / Background

• Need a GitHub account. Sign Up at this link: https://github.com/
• Understanding of Markdown Language. Learn more about it here: https://www.markdowntutorial.com/

The 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.

Quick Doc Fixes

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

1. Navigate to https://github.com/rundeck/docs/.
2. The content pages are in the /docs/ sub folder. The folder structure here will match what is shown in the URL of the page to be edited. (https://github.com/rundeck/docs/tree/3.4.x/docs)
3. Navigate to the page that needs to be updated by going to learning > howto and finding the docs-update-exercise.md file
4. Feel free to add/edit content below the specified heading by clicking on the pencil icon on the GitHub page.
5. Add content below where it reads “Edits welcome below this section” then fill out the Propose Changes section with a Subject Line and details explaining the update.
6. This form will commit the change and provide a comparison view. Click on Create Pull Request to finalize and send to the Rundeck team for approval.
7. Confirm the details in the Pull Request submission and click Create Pull Request.

Congratulations! Keep an eye out for comments/feedback via the comments section from our team.

Sharing bigger content updates

The 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.

Tips

• Images are stored in the /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.
• Screenshots should be done in the most current version of Rundeck available. Easiest way to get those is by using the Welcome Projects.
• Look at the markdown code on other pages for examples on how to incorporate tabs, and other Vue specific items.

Looking for content ideas to contribute? Check out https://github.com/rundeck/docs/issues for items that might need fixing.