Skip to main content

5.0.0 Release Notes

5.0.0 Release Notes

Name: "Denali brown apple"
Release Date: December 14th, 2023

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.

Upgrade Steps

Be sure to follow the Upgrade instructions when moving to version 5.0 or higher. There are new minimum Java versions and other important information.

Overview

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.

Runner Key Storage GUI for Resource Model Sources.

With version 4.16.0, the Enterprise Runner became capable of populating the Node Inventory with nodes that can only be accessed internally - such as VMware virtual machines and Kubernetes pods. Now, if accessing the inventory for these nodes requires a secret - such as an API Key for VMware - that secret can be retrieved by the Runner from a self-hosted secrets management provider, such as Hashicorp Vault. This allows users to populate the Node Inventory through the Runner - even when the source of those nodes are secured by a secret.

Jobs List Performance

The Job Lists UI has been fully refactored on the backend, resulting in a performance improvement of up to 85%. This will be most noticeable for Projects and a lot of grouped jobs.

Java 11 Minimum Required

To align the product with some of the foundational updates listed below the 5.0 version now requires Java 11.

Deprecations

Saved Job, Report, and Node filters are no longer stored in the database. Node Filters are now stored locally on the browser and we will be updating Job and Report filters to function the same way in a future release.

Apache Tomcat is no longer a supported Application Server platform for Rundeck or Runbook Automation.

API Changes

The new Current API version is now 46. The new API depreciation version is 17. This means that future Rundeck releases will have a minimum API version of 17. Customers should ensure that code using the API is updated accordingly.

XML Support on the API is being deprecated and starting with the 5.x series we will only be supporting the JSON input and output options. (Note: Job definitions in XML format are still supported)

Check the API Versions page for all the details.

Runner Versioning

With this release the versioning for the Enterprise Runner is now aligned with the build version of the product. The Runner version included in this release will be 5.0.0

“Under the hood” updates

  • Grails 6 is now the foundation for Rundeck and Runbook Automation products.
  • Builds are now completed using Node 18.
  • Started conversion of pages from old UI code to Vue. This effort will be on-going through the 5.x series and will bring performance improvements across the product.

Additional Improvements/Changes

  • Upgraded H2 database to resolve CVE-2022-45868. (Please see Upgrade Notes if using H2.)
  • Clearer logging messaging when running into Database Lock issues.
  • The rdCLI tool version 2.0.8 now supports JSON job definitions.

Also includes all Open Source updates from below

Rundeck Open Source Product Details

Here is a link to the full list of public PRs

Ansible Plugin Updates

Community Contributors

Submit your own Pull Requests to get recognition here!

Staff Contributors