CloudBees CD/RO v10.9

CloudBees is pleased to announce the v10.9 long-term support (LTS) release of CloudBees CD/RO. With this release, we added several new features and system improvements, including:

  • Signed installation binaries for verification

  • Template-based object creation for releases

  • UI enhancements to the microservices editor, the Job details page, and the pipeline Properties page

  • New CloudBees CD/RO banner functionality

  • An Apache ZooKeeper update to recognize four-letter-word (4lw) test commands

  • The ability to configure trusted origins for cross-origin resource sharing (CORS)

Refer to New features below for more information.

Security fixes

This release includes the following security updates:
  • Improvements to ensure configuration files do not contain sensitive information. CloudBees removed the ability to launch CloudBees CD/RO with an empty commander.properties file. This feature was originally added with NMB-18383, but is removed with v10.9. [BEE-8706]

  • A process to verify installation binaries for each release. [BEE-12746]

  • Fixed an issue with JSON string values in the ec-groovy API call parameters. [BEE-16149]

New features

Installation binaries signature verification

CloudBees CD/RO server installation binaries are signed so that you can verify their origin and authenticity. Verifying binaries is an optional step in the installation process than can help ensure you are not the victim of a man-in-the-middle attack. For more information, refer to Verify installation binaries.

Parameterized template-based release creation

You can now create releases using Service Catalog items as release templates in the New Release dialog. You can add new release templates using the createOrModifyCatalogItem API. For more information, refer to Create catalog item.

Cross-origin resource sharing (CORS) trusted origins

You can now configure trusted origins for cross-origin resource sharing (CORS) using ecconfigure.

Feature enhancements

UI enhancements

This release includes the following UI enhancements:

  • The microservices wizard has been updated to improve ease of use. For more information, refer to Model and deploy microservice applications.

  • The Job details page enhancements include:

    • A link to the pipeline run (when applicable)

    • The addition of the snapshot name (when applicable)

    • Updated icons

    • Property sheets on the Properties tab are now collapsed by default

    • Data on the Diagnostics tab is now expanded by default

    • The job step details page now includes a View log button that opens the job log in a new browser tab. For more information, refer to cloudbees-cd:automation-platform:help-jobstepdetails.adoc.

      For more information, refer to CloudBees CD/RO job details.

  • The pipeline Properties page updates include:

    • The ability to select and delete multiple properties.

      All nested elements are included when you select an element. You cannot unselect nested elements from a parent element.
    • A new Create property button.

    • The three dots menu options for top-level properties are Access Control and Create nested sheet.

    • The three dots menu options for nested properties includes all actions available for the property sheet: Edit, Create property, Create nested sheet, Move to, Copy to, Access Control, and Delete.

      For more information, refer to Pipeline UI.

Enhanced banner functionality

A more prominent banner has been introduced, which includes the ability to set its color and icon. The banner configuration is accessed from a new UI Settings page under Server settings. To access UI settings, select Administration  Server Settings from the main menu, then select UI Settings. The new Edit UI Settings page allows you to enable and disable the CloudBees CD/RO banner, update the header label, and select a color and icon. For more information, refer to Server settings.

With this enhancement, you now access the UI auto-refresh frequency in seconds setting on the UI settings page. Prior to this release, you accessed the setting on the Server settings page.
Apache ZooKeeper four-letter-words (4lw)

Apache ZooKeeper has been updated to recognize four-letter-word (4lw) test commands. For more information, refer to Install ZooKeeper.

Performance improvements

None.

Plugin enhancements

CloudBees CD/RO plugins catalog

The CloudBees CD/RO plugins catalog is available on the CloudBees CD/RO documentation site.

For more information about plugin support and versioning, refer to Plugin Concepts.

Plugin updates

EC-AWS-EC2 1.0.16

Upgraded third-party dependencies.

EC-Bitbucket 1.2.1

Improved the trigger setup documentation.

EC-DslDeploy 4.1.5

Fixed an FileNotFoundException issue for entity names that end with a space.

EC-GitHub 4.5.2

Improved the trigger setup documentation.

EC-Rest 2.3.2

Upgraded third-party libraries.

EC-SendEmail 1.1.1

Fixed an issue with the extension link on the Parameters screen. Migrated the plugin from GWT to PDK. Upgraded from perl-5.8 to perl-5.32. There is no backward compatibility with releases prior to v10.3. Starting with this release, a new agent is required to run this plugin’s procedures.

EC-Tomcat 3.0.0

The plugin has been migrated to the PDK framework.

GitLab 1.0.0

Initial version. The following functionality was added.

  • Continuous Integration (CI)

  • Continuous Delivery (CD)

  • Continuous Deployment (CD)

  • Trigger GitLab Pipeline

  • Webhook event processing support

Xray 1.0.0

Initial version.

Plugin Development Kit enhancements

None.

Resolved issues

BEE-9107

Fixed an issue that caused duplicate entries for applications created using the UI.

BEE-15397

All property sheet-based parameters are now listed as a property sheet. You can access definitionParameters, definitionSourceParameters, deployParameters, and rollbackParameters via property sheet.

BEE-21773

Empty file attachments no longer cause jobs to fail.

BEE-22800

The following APIs now include the ciConfigurationName argument:

  • breakAclInheritance

  • checkAccess

  • createAclEntry

  • deleteAclEntry

  • getAccess

  • getAclEntry

  • modifyAclEntry

  • restoreAclInheritance

BEE-23035

Fixed issues with renaming associated properties in formal parameters.

BEE-23092

Webhook secrets are now included as credential object references. You can use previously exported objects (pipelines, release, and procedures) to create objects that include webhook triggers with required webhookSecrets, including EC-GitHub webhook triggers.

BEE-23149

Master component definitions that include input parameters no longer fail.

BEE-23199

Service catalog parameters that were previously defined as a procedure now update correctly. With this fix, when a dslString and subprocedure are both passed into a create/modify operation, only the dslString is set. When you modify a DSL-type catalog item to a procedure-type, the dslString, dslParamForm, and endTargetJson are cleaned up. Input parameters are not deleted and are not used for the procedure. You can delete the input parameters using the deleteFormalParameter API or the UI.

BEE-23339

Fixed an issue with build_commit and quality statistics for CloudBees CI builds in the CloudBees Analytics server.

BEE-23858

SSO login tokens now inherit groups for the user signing in.

BEE-24005

Fixed an issue with new pipeline and release tasks that affected system performance.

BEE-24056

Added service account to the list of supported objects in the DSL Export catalog item.

Behavior changes

None.

Installation notes

For complete installation and upgrade information, refer to CloudBees CD/RO on Kubernetes and Install CloudBees CD/RO on traditional platforms.

Duplicate applications warning

CloudBees CD/RO v10.9 includes a fix for an issue that caused duplicate applications for applications created in the UI. The upgrade process fails when there are duplicate applications. CloudBees resolved this issue for MariaDB, MySQL, and Postgres databases. Ensure that your current installation does not contain applications with duplicate names. You can rename or delete the applications.

You must remove duplicate applications by ID using the deleteObjects API. You cannot delete duplicate applications by name.

Apache ZooKeeper required update

The ZooKeeper version bundled with CloudBees CD/RO v10.5 was updated from v3.4.6 to v3.8.0. CloudBees CD/RO v10.5+ requires ZooKeeper v3.8.0. For installation and upgrade instructions, refer to Install ZooKeeper and Upgrade a clustered environment.

Legacy services applications and container entities

In CloudBees CD/RO v10.3, the legacy Services applications and Traditional applications with containers were deprecated and removed. Before you upgrade to CloudBees CD/RO v10.3 or later, you must migrate your applications to the current microservices application model.

Also, before upgrading from CloudBees CD/RO v10.2 or earlier you must delete all legacy services and containers. This will prevent upgrade failure, a database consistency break or inability to run the validateDatabase API.

Legacy webhook triggers

As of v10.8, webhook triggers configured and scheduled before v10.1 have been deleted. Polling triggers configured and scheduled prior to v10.1 continue to work, but they are not available from the UI to review or run.

CloudBees CD/RO on Kubernetes

Sample CloudBees CD/RO server and agent Helm chart values provide CloudBees’s default installation values. The CloudBees CD/RO images.tag value associated with v10.9 is 10.9.0.157496_3.2.22_20220929.

CloudBees CD/RO Universal Base Image (UBI)

The actual UBI associated with v10.9 is 8.6-943.

Upgrading gateway agents

All gateway agents that meet the following criteria must be updated to CloudBees CD/RO v10.2+:

  • Your enterprise implements a multi-zone environment.

  • Agent versions are a combination of pre-v10.2 and v10.2+.

  • The access route to a v10.2+ agent is configured through a pre-v10.2 gateway agent.

Configuring autostart services for Linux installations

Linux installations that you perform as a non-root user or without sudo permissions cannot automatically start the CloudBees CD/RO server, web server, repository server, or agents. Instead, you must set up service autostart after installation is complete. Refer to Configure autostart for non-root/non-sudo Linux installations to learn more.

Upgrading your CloudBees CD/RO environment
Before starting an upgrade, make sure to back up your existing CloudBees CD/RO data.
Upgradable versions

Upgrades to CloudBees CD/RO 10.x are supported only from ElectricCommander 5.0. For upgrade instructions, refer to the Upgrade on traditional platforms.

Updating the MySQL configuration before upgrading

Since release 8.0.1, CloudBees has instructed customers using a MySQL database to use the following two lines in their MySQL configuration:

init_connect='SET collation_connection = utf8_unicode_ci, NAMES utf8'
skip-character-set-client-handshake

Before upgrading CloudBees CD/RO, you must remove these lines or comment them out. Otherwise, jobs will not start.

Ensuring the correct default MySQL default collation

Make sure that the default collation for the MySQL database schema is set to utf8_unicode_ci or utf8_general_ci and that no table in the schema overrides this. The CloudBees CD/RO server checks this configuration on startup and logs errors in the server log if it is not set correctly.

If the collation is not configured correctly, entering non-ASCII text into CloudBees CD/RO can cause errors. For example, setting a release name to a non-ASCII value, and attempting a search, causes an exception.

If your MySQL database schema, or any tables within, are set to a non-UTF-8 collation order, refer to the Knowledge Base article KBEC-00385 - Converting a MySQL Database From Latin-1 to UTF-8 for detailed instructions about safely converting your schema to UTF-8. [NMB-26521, NMB-27459]

Upgrading agents that run the ec-groovy job step in multizone deployments

In multizone CloudBees CD/RO deployments, CloudBees CD/RO agents that are in a different zone than the CloudBees CD/RO server must be upgraded to version 9.0 or later for the ec-groovy job step to run successfully on those agents. You must also upgrade the gateway agents that lead back to the server’s zone, including those in any zones in between the agent’s zone and the server’s zone. [NMB-27490]

For details about multiple zones and gateway agents, refer to Zones and gateways.

Removing the SSL 2.0 Client Hello or SSLv2Hello protocol from your security configurations

CloudBees recommends removing the SSL 2.0 Client Hello or SSLv2Hello protocol from your security configurations for all components. [NMB-27934, NMB-29326]

  1. Upgrade agents to the latest operating system version for security reasons.

  2. If this warning appears on the Automation Platform UI:

    Note: We recommend removing `SSL 2.0 Client Hello` format from server configuration and upgrade older agents as indicated on the Cloud/Resources Page to avoid security risk.

    then enter the following command on the CloudBees CD/RO server:

    $ ecconfigure --serverTLSEnabledProtocol=TLSv1.2
Upgrading the CloudBees Analytics server

This section provides information about upgrading the CloudBees Analytics server.

Potential breaking change: Elasticsearch update

The Elasticsearch version shipped with CloudBees Analytics v10.2 has been updated from v6.6.2 to v7.10.2. As such, this update may create breaking changes in your custom reports. All changes related to the new version are described in Elasticsearch documentation. The following change may affect your reports the most. [BEE-2717]

  • Accessing missing document values throws an error. The doc['field'].value throws an exception if the document is missing a value for the field field.

    To check if a document is missing a value, you can use doc['field'].size() == 0.

  • It is not possible to upgrade CloudBees Analytics v9.0.1 and below to CloudBees Analytics v10.2.0 and above. The installer exits with an error and an appropriate message when such an update is attempted. If you need to upgrade CloudBees Analytics v9.0.1 and below, you must first upgrade to a version between 9.1.0 and 10.1.0, or 9.0.2 and above. After that, you can upgrade CloudBees Analytics to v10.3.0 or higher. [NMB-31030]

  • For previous CloudBees Analytics upgrades from v9.0.1 and below: CloudBees Analytics data may contain obsolete indices that are incompatible with CloudBees Analytics v10.2.0 and above. To work correctly, it is necessary to re-index these indexes before an upgrade. The installer prompts you to do this before upgrading.

    • In console mode and UI mode, the installer displays the following prompt if outdated indexes are detected:

      One or more Elasticsearch indices were created in an obsolete version of Elasticsearch.
      These indexes must be re-indexed for the upgrade to be successful.
      
      Do you want to start the reindexation? [n/Y]

      After an affirmative answer, the installer automatically re-indexes and continues the upgrade.

    • In silent mode, the installer reindexes automatically.

  • Backing up and restoring custom settings

    The CloudBees Analytics installer overwrites the elasticsearch.yml configuration file with a new file. This file includes a Custom Settings section, which lets you add Elasticsearch settings not managed by the CloudBees Analytics server without being lost during an upgrade. The installer preserves the settings in the Custom Settings section. [NMB-25850]

  • Upgrading CloudBees Analytics clusters

    The principle of forming a cluster in CloudBees Analytics has changed in v10.2 due to the update of Elasticsearch v7.10.2. In this regard, an additional action is required to upgrade to CloudBees Analytics v10.2 or later:

    When updating the first master node, you must explicitly specify that it is the first node to be updated. If this action is not performed, any cluster that is being updated is placed out of service.

    All installers have been instrumented to accommodate this change. Refer to Upgrade the CloudBees Analytics server for more details. [BEE-2717]

  • CloudBees Analytics server configuration notes

    For a production environment, CloudBees recommends that you install the CloudBees Analytics server on a system other than systems running other CloudBees CD/RO components (such as the CloudBees CD/RO server, web server, repository server, or agent). If you must install it on the same system (such as for testing or other non-production or trial-basis situations), refer to CloudBees Analytics server with other components for details.

    If your CloudBees Analytics server is configured with multiple nodes in a Kubernetes environment, you must pre-generate your certificates. For more information, refer to Install CloudBees CD/RO within Kubernetes.
CloudBees CI operations center configurations

After upgrading to CloudBees CD/RO v10.7 from v10.0.x, you may need to rework your CloudBees CI operations center configurations.

  • In v10.0.x, CloudBees CI operations center URLs specified in configurations are silently appended at runtime with the /cjoc path component.

  • In v10.1, URLs are used as defined in configurations. The /cjoc component is not appended.

To maintain pre-v10.1 runtime compatibility, the v10.1 upgrade process modifies CloudBees CI operations center URLs in existing configurations by hardcoding the /cjoc path component. You need to rework existing URLs in configurations where appending the /cjoc path component is inappropriate.

Configuration notes

Performing a full import

During a full import, the import operation might hang in the following scenarios. To import successfully into CloudBees CD/RO 8.0 and newer versions, perform the appropriate workarounds [CEV-15447, CEV-11873]:

  • A manual process step in a process has formal parameters. The workaround is to remove the entry related to the property sheet for the job step that is associated with the manual process step.

  • In the exported XML file from an earlier release, two pipelines are in different projects, and both pipelines have no gate tasks. The flow associated with the pipeline is duplicated under both projects. The workaround is to remove the flow element under the projects.

Limitations

When an application is cloned from one project (the original project) to another (the destination project), the tier maps for the application point to the environments with the same names in the destination project. To deploy the application to the environments in the original project, you must create tier maps connecting the application to those environments.

Known issues

BEE-7512

With CloudBees CD/RO v10.2.1 and earlier, the DSL Import service catalog fails for grouped tasks.

BEE-14581

The MeanLeadTime report does not work correctly when Elasticsearch only has pipeline runs but no release runs.

BEE-14933

The UI does not allow the transfer of artifacts across zones.

BEE-17259

When a custom data retention policy schedule is set to run once, the data is not purged after archiving. To purge data after archiving, use a repeat schedule or the global data retention setting.

BEE-19742

When you save DSL for a dropdown menu, the code is evaluated to catch syntax errors. This evaluation is not the same as when the parameter is used. This can result in a property reference error because the properties may only be available when the parameter values are set. A workaround is to use a try-catch statement where the property path is a property that is not available in the definition context:

def value
try {
  value = getProperty(propertyName: 'property path').value
} catch (e) {
  return []
}

BEE-20205

CloudBees CI job tasks fail with a $[] branchName in the definition.

BEE-20536

When using Postgres with change tracking enabled, EcAuditStrategy errors may appear in the server log. This is a known issue, but is not expected to affect system performance.

BEE-21997

CloudBees CI job tasks fail when the Single sign-on via CloudBees Software Delivery Automation setting is enabled in CloudBees CI.

BEE-24274

Fixed an issue with FileNotFoundException for entity names that end with spaces.

NMB-30095

Browser redirects to port 2080 during first navigation to CloudBees CD/RO deployed from CloudBees Software Delivery Automation and Flow Helm charts.

NMB-24734

SyncArtifactVersions procedure completes with success, rather than showing a warning, when manifest is missing and overwrite = false.

NMB-24949

When you use the Automation Platform UI to upload and publish artifact files with non-English characters in their file names, the operation fails with the following error: Upload file: Exit code 1: ERROR: Publish failure: Unexpected retrieval exception for repository error.

NMB-26021

Modifications of LDAP user data (such as email addresses) on an Active Directory server after registration in CloudBees CD/RO do not appear properly in user details (in the Automation Platform UI, the Deploy UI, or ectool) until the CloudBees CD/RO server is restarted.

NMB-26962

(Microsoft Windows platforms only) If the Elasticsearch cluster used by CloudBees Analytics is in the red state (meaning that it only partly functions and some data is unavailable), then upgrade, reconfigure, and uninstall operations will not work. Since the Elasticsearch service cannot be stopped when a cluster is in a red state, you must stop the Elasticsearch service process from the task manager before running the installer for these actions.

NMB-28135

The Microsoft Edge browser does not work with SAML 2.0 and a self-signed certificate during redirection from the identity provider to the service provider. Edge is not recommended for sign-in via SAML 2.0.

NMB-29486

The LANG environment variable must be set to en.US.UTF-8; otherwise, the upgrade fails. Refer to KBEC-00452 - Error installing CloudBees CD/RO 10.0.x when Lang environment variable is different than en.US.UTF-8 for details.

CEV-11106

When an application with snapshots created in CloudBees CD/RO 6.1 or earlier is cloned and a project containing this application is imported to CloudBees CD/RO 6.3 or higher, the import operation fails.

CEV-12363

Error prompts for runtimes started by a schedule are not visible if the schedule was created with a missing configuration.

CEV-12429

The stage inclusion status in the Release Dashboard changes color after a stage is renamed.

CEV-14689

No error prompt appears for failed tasks and retry tasks during a pipeline runtime.

CEV-15122

If an application process step cannot expand to its child steps (because of an invalid run condition or an invalid formal parameter) then the step is not retried even if it uses "retry on error" error handling. The job eventually completes with an error.

CEV-15829

The retry count for group tasks or rules using "automated retry on error" is missing from the Pipeline runtime page.

CEV-16245

Multiple mapped environments with the same name from different projects are not supported in email notifications.

CEV-16250

A project import might not include the path-to-production view.

CEV-16930

Jobs might not appear upon drill-down into the "Clusters With Most Deployments" widget in the CloudBees Analytics Microservices Dashboard if the service does not contain a deploy step in the process.

CEV-18531

All subreleases of a release must appear before the release in the DSL for the release-to-subrelease link to be created.

CEV-19239 CEV-19259

The ability to search by assignee in a Deployment Report is not available in the CloudBees Analytics report editor.

CEV-21426

If Release Command Center was set up for JIRA for user stories and defects, and the JIRA project name was mapped to the release project name using the field mapping projectName:releaseProjectName, then before upgrading to 10.0, the field mapping must be updated to mention the actual release project name using the following field mapping format: "release-project-name-in-CloudBees CD/RO":releaseProjectName.

CEV-23624

Approval by email on manual tasks should not expect parameters.

CEV-25150

If you use the ectool export to export your system configuration from a previous release and then use ectool import to import the same configuration to a CloudBees CD/RO 10.0 server, some out-of-the-box content introduced in the releases since the version from which the full export was done, such as new or updated plugins, new catalog items, and persona-based menu items, may be missing in the CloudBees CD/RO server UI. It is recommended to use ectool export and ectool import only between servers at the same version.

CEV-26700

SSO does not work unless PHP configuration is changed due to a security-related request. Workaround: Change session.cookie_samesite to "Strict" in /opt/electriccloud/electriccommander/apache/conf/php.ini and restart the web server.

CEV-28704

CloudBees CD/RO v10.1 introduced new triggers and an updated UI for them. Pre-v10.1 triggers will continue to work but there is no UI to review or run them.

CEV-28779

Before using the export command to perform a full data export from the CloudBees CD/RO database, delete any legacy definitions and references to service objects from applications and releases.

N/A

You can revert changes only for high-level design objects such as applications procedures, procedure steps, workflow definitions, and state definitions.

Restarting the CloudBees CD/RO server while new records are created for all tracked objects might take at least as long as an export or import of all projects (10 to 40 minutes for a large project).

N/A

Enabling Recursively Traverse Group Hierarchy might impact system performance when the LDAP group hierarchy is traversed. The amount of impact varies with the configurations of the CloudBees CD/RO and LDAP servers, the depth of group hierarchy in the LDAP server and the network latency between the servers. Make sure that your directory provider can handle the additional load for supporting nested group hierarchy traversal.

N/A

System performance might decrease if you disable change tracking at the server level and then re-enable it. Change tracking is enabled by default. For details about using change tracking, refer to change tracking.