CloudBees CD/RO v10.1.1 is a maintenance release (MR) applied to the v10.1.0 long-term release. As such, consult the following in combination with these notes for everything that this release provides.
CloudBees CD/RO v10.1.0 release notes, released 2021-02-26
- This release includes the following security updates
The Apache web server used in CloudBees CD/RO: no updates. Support version remains at v2.4.46. For details, see https://www.apache.org/dist/httpd/CHANGES_2.4.
PHP is upgraded from 7.4.13 to 7.4.16. For details, see https://www.php.net/releases/7_4_16.php. [BEE-3525]
OpenSSL is upgraded from 1.1.1i to 1.1.1k. For details, see https://www.openssl.org/news/openssl-1.1.1-notes.html. [BEE-3525]
- New plugins
EC-AWS-EC2: Replaces EC-EC2
- Deprecated plugins
EC-EC2: Replaced by EC-AWS-EC2
- Updated plugins
EC-Nexus 1.1.2: Plugin now correctly retrieves the version from
- Plugin support changes
This section lists new platform support. For the current list of supported platforms, consult Supported platforms for CloudBees CD/RO
- Server support
- Agent support
- CloudBees CD/RO on Kubernetes
- Database support
- Browser support
CloudBees CD/RO UI My Work auto-refresh for a user in a large number of groups generates a huge DB query for that slows all other DB queries, which causes long CD Server restart.
Problem resolved with
Background deleter was removing session still in use.
Updated a KB link that gets displayed under a MySQL database issue
Use of transaction block to runProcedure in a Service Catalog context does not work and fails with NPTR in CD 10.1.
No jobStep logs are viewable from UI after NullPointerException in agent. ServerRequestCompletionCallback.onError.
SAML credential wasn’t converted at time of upgrade to cd v10.0.
Error in generated DSL if a formalParameter contains a single quote char.
Main menu links not working as expected.
Fix the SearchGuard permissions for scroll. Multiple hours delay from exponental backoff when processing sendReportingData requests that fail with HTTP 400 errors in updating pipeline tags.
Running pipelines is offering the already run tasks detail as link but not redirecting to any url.
Problem resolved with preconditions not working with
For complete installation and upgrade information, see CloudBees CD/RO installation guide.
- CloudBees CD/RO on Kubernetes
Sample CloudBees CD/RO server and agent Helm chart values, found here, provide CloudBees’s default installation values. The CloudBees CD/RO
images.tagvalue associated with version 10.1.1 is
- Gateway agents
For gateway agents v10.1 and higher, you must configure the CloudBees CD/RO server IP address.
Select the System Settings from the left-hand menu.
Scroll to the Server IP address entry and add the fully qualified domain name of your CloudBees CD/RO server’s load balancer.
This setting controls how agents contact the CloudBees CD/RO server when they send results from job steps and similar prompts.
For more information about gateways, see Zones and gateways
- Configuring autostart services for Linux installations
Linux installations that you perform as a non-root user or without
sudopermissions cannot automatically start the CloudBees CD/RO server, web server, repository server, or agents. This means that you must set up service autostart after installation is complete. Learn more here.
- Upgrading your CloudBees CD/RO environment
IMPORTANT: 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 or any version before 9.0. Upgrades to version 10.x from version 4.2 or earlier are not supported. For upgrade instructions, see Upgrade roadmap.
- Upgrading an older CloudBees Analytics version
Upgrading from a CloudBees CD version 9.0.x , or earlier, requires upgrading the CloudBees Analytics server to 10.0. If upgrading from CloudBees CD version 9.1, then upgrading version 9.1 the CloudBees Analytics server is not required.
- Updating elements containing applicationServiceMapping [CEV-16237 and CEV-16158]
If your XML export file from CloudBees CD 8.0.1 or earlier versions has elements containing
applicationServiceMapping, you must change all instances of that string in the file to
serviceClusterMappingbefore importing the file into version 10.0. For example, change the following XML:
<applicationServiceMapping> <applicationServiceMappingId>9efcda31-a85f-11e7-8500-0800279f198d</applicationServiceMappingId> <applicationServiceMappingName>9efcda31-a85f-11e7-8500-0800279f198d</applicationServiceMappingName> … </applicationServiceMapping>
<serviceClusterMapping> <serviceClusterMappingId>9efcda31-a85f-11e7-8500-0800279f198d</serviceClusterMappingId> <serviceClusterMappingName>9efcda31-a85f-11e7-8500-0800279f198d</serviceClusterMappingName> … </serviceClusterMapping>
- Backing up and restoring custom settings
The CloudBees Analytics installer overwrites the
elasticsearch.ymlconfiguration file with a new file. As of CloudBees Analytics version 8.3, the file includes a
Custom Settingssection, which lets you add Elasticsearch settings not managed by the CloudBees Analytics server without being lost during an upgrade. If you added settings to this file in version 8.2 or earlier that you want to preserve, you must back up the file to a separate location before upgrading to version 9.2 or newer versions and then add the settings to the
Custom Settingssection after the upgrade. During future upgrades, the installer will preserve the settings in the
Custom Settingssection. [NMB-25850]
- 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
Since release 8.0.1, CloudBees has instructed customers using a MySQL database to ensure that the default collation for their database schema is set to
utf8_general_ciand that no table in their schema overrides this. As of release 9.0, 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, then entering non-ASCII text into CloudBees CD/RO might 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 in it are set to a non-UTF-8 collation order, see 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-groovyjob 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]
- Removing the SSL 2.0 Client Hello or SSLv2Hello protocol from your security configurations
CloudBees recommends removing the
SSL 2.0 Client Helloor
SSLv2Helloprotocol from your security configurations for all components. [NMB-27934, NMB-29326]
Upgrade agents older that fall into this category for security reasons:
Windows, Linux: 6.0.3 or older; 6.2 or older
Mac OS: 8.4 or older
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 from Version 7.3 to Version 10.1.
- Re-Specifying configuration settings
The installers (GUI, interactive console, and silent mode) for the CloudBees Analytics server do not preserve the configuration setting for the CloudBees Analytics server host name (
--hostName) or the setting for the Elasticsearch number of shards (
--elasticsearchNumberOfShards) during the upgrade from 7.3 to 9.2. If you specified non-default values during the 7.3 Reporting server installation, you must re-specify these settings during the upgrade. (All other settings are preserved.)
- 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) see CloudBees Analytics server with other components for details.
== 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 the 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.
When an application is cloned from one project (the original project) to another (the destination project), the tier maps for the application will 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
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:
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
(Windows platforms only) If the Elasticsearch cluster which is used by CloudBees Analytics is in the red state (in Elasticsearch this means that it only partly functions and some data is unavailable) then upgrade reconfigure or uninstall operations will not work. Because the Elasticsearch service can not be stopped when a cluster is in red state kill the Elasticsearch service process by the task manager before running the installer for these actions.
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 login via SAML 2.0.
Can’t ignore server mismatch and override passkey from Database Configuration page.
The LANG environment variable must be set to
In some cases, job step diagnostic information is not available and server reports 507 error,
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.
Error prompts for runtimes started by a schedule are not visible if the schedule was created with a missed configuration.
The stage inclusion status in the Release Dashboard changes color after a stage is renamed.
No error prompt appears for failed tasks and retry tasks during a pipeline runtime.
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.
The retry count for group tasks or rules using "automated retry on error" is missing from the Pipeline runtime page.
Multiple mapped environments with the same name from different projects are not supported in email notifications.
A project import might not include the path-to-production view.
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.
When you do a full import from version 8.0 to version 8.2 or newer and two or more releases have the same name (under different projects) and are associated to the same pipeline then after import the runs for all releases might become associated to the first imported release. This is because CloudBees CD/RO cannot differentiate runs between the releases since all runs are under the same pipeline project and have the same name. To work around this issue rename releases in the export file so that all their occurrences (in
All subreleases of a release must appear before the release in the DSL for the release-to-subrelease link to be created.
The ability to search by assignee in a Deployment Report is not available in the CloudBees Analytics report editor.
If Release Command Center was setup for JIRA for user-stories and defects and the JIRA project name was mapped to the release project name using the following 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:
Long custom labels in email notifications do not render correctly.
Approval by email on manual tasks should not expect parameters.
Navigation to a sub-release editor takes user to the parent release editor. As a workaround, select the subrelease from the left-hand navigation in the parent’s release editor.
When you use the Deploy UI to edit a resource pool and add a tag while renaming it at the same time, the operation fails with the following error:
Running an application process with a parallel manual application process step or running an application process with a parallel manual application and component process steps fails to delete the project.
If you are signed in to the Deploy UI and upgrade to CloudBees CD/RO 10.0, the version 10.0 sign-in page for the Automation Platform UI goes into an infinite redirect. This is because the version 10.0 Automation Platform UI thinks that your sign-in session expired even though it is active. To work around this issue, do one of the following:
Attempt to delete a project containing a
Users will not be able to delete a project if there are Jenkins builds associated with this project that are references in releases not in the project.
Attempt to delete a build from a pipeline run via
If you use the
These service catalog items are disabled because underlying plugin has been removed.
Single Sign on does not work unless PHP configuration is changed due to a security related request. Workaround: change
Because the default installation directories have changed in v10.1, running a jobStep may fail with the following error:
You can revert changes only for high-level design objects such as applications procedures procedure steps workflow definitions and state definitions.
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.
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 see change tracking.