CloudBees CD v10.0.1

Released: 2020-07-31

CloudBees CD v10.0.1 is a maintenance release (MR) applied to the v10.0.0 long-term release. As such, consult the CloudBees CD v10.0.0 release notes in combination with these notes for everything that this release provides.

For more details see CloudBees maintenance lifecycle policies.

Security fixes

None.

New features

Improved response time for Pipeline Runs and Release List pages

The UI response time when navigating to Pipeline Runs and Release List pages has been significantly improved, depending on the server configuration, when compared with previous releases. [CEV-25227, CEV-25238]

New email notification server settings

Two new server settings: [NMB-29439]

  • setFromEmailHeader: If true, set the From header in the email message. Default is true.

  • smtpSSLProtocols: Comma-separated list of protocols that are enabled for SSL connections to the SMTP server. Used to set mail.smtp.ssl.protocols system property. Default is TLSv1.2.

New platform support

None.

Database support

No changes.

Browser support

No changes.

Resolved issues

NMB-25780

Problem resolved that required the need for agents to be pinged after applying a new license file.

NMB-28182

After an upgrade, the ssl.conf file was not preserved. The values of these parameters reverted to default settings: SSLCertificateKeyFile, SSLCertificateFile.

NMB-29408

Problem resolve where, in some circumstances, jobs that ran ectool pingResource retried for several hours due to a DeadAgentException.

NMB-29422

Due to an error in the helm chart, the flow-agent container crashed in some circumstances.

NMB-29433

Executing Import DSL from Git catalog is failing due to ParameterMismatch: Extra parameter(s) to importDslFromGit.

NMB-29474

When configuring gmail, server returns the following message because the incorrect port was specified.

EmailNotificationFailure: Unable to send email. Mail server connection failed. Could not connect to SMTP host: smtp.gmail.com, port: 465

You must use port 465 for SMTPS and port 587 for SMTP.

CEV-22960

In some circumstances jobs hung after applying a new license file. Agents needed to be pinged in order to restart the jobs.

CEV-24374

Problem resolved where the resulting DSL script from the Export DSL Service Catalog item was different than the DSL script returned from ectool generateDsl. Now they return the same DSL.

CEV-25192

The message No available licenses. License doesn’t allow to create concurrent hosts was returned when attempting to create a resource from the CloudBees CD UI.

CEV-25196

Registered hosts did not appear in the license details list when accessed via the CloudBees CD main menu.

Plugin enhancements

Jetbrains CloudBees CD plugin

The CloudBees CD Plugin version 1.1 for IntelliJ, available at CloudBees CD plugin, replaces the Electric Flow plugin, which is no longer supported. This plugin includes the following improvements:

  • Support for newer versions starting from IntelliJ version 2020.1.X.

  • Ability to configure the CloudBees CD web URL separately from the server URL. [CEV-22857]

  • Ability to approve pending CloudBees CD Pipeline gate approvals or work items from inside of the Intellij IDE. [CEV-25036]

  • Updated configuration page with improved formatting.

  • Improved documentation for the plugin.

ServiceNow native extention

The CloudBees CD Native extension has been certified and now available in ServiceNow Store: https://store.servicenow.com/sn_appstore_store.do#!/store/application/41108e84dbe1e60060dff5f0cf9619d6/1.1.1

Plugin development framework

NOTE: Since Release 9.0, the CloudBees CD Plugin Development Framework is the recommended approach to develop plugins and replaces the Plugin Commander SDK. The Plugin Commander SDK, and its guide, is considered obsolete and is no longer supported.

New plugins

  • No changes.

Retired plugins

  • EC-AmazonECS

  • EC-AzureContainerService

  • EC-AzureContainerService-Docker

  • EC-CloudFoundry

  • EC-Dynatrace

  • EC-GoogleContainerEngine

Updated plugins

  • EC-GCP-ComputeEngine: performance was improved for the Teardown procedure.

  • EC-PluginManager: HTTPS proxy behaviour has been fixed (the catalog was now showing when behind HTTPS proxy) [CEV-25266]

  • EC-ServiceNow: New features have been added to CollectReportingData procedure: TableAPI support and "dot-walking" feature.

  • EC-JIRA: Enhancement for the CollectReportingData procedure: The transform() method receives additional parameter - refined issue fields.

  • EC-Jenkins:

    • Fixed an issue when artifacts that were downloaded by DownloadArtifacts were corrupted in some configurations.

    • GetBuildLog procedure has been improved by addition of "Last Log Lines Amount"

  • Third-party libraries were upgraded/removed to address critical vulnerabilities for these plugins [NMB-28838]:

    • EC-Artifactory

    • EC-EC2

    • EC-Docker

    • EC-Kubernetes

    • EC-Kubectl

    • EC-RemoteAccess

    • EC-OpenShift

    • EC-GCP-ComputeEngine

    • EC-FeatureFlags

CloudBees CD Jenkins plugin updates

Updated the following post build actions by Run and Wait option with possibility to depend on CD job or pipeline outcome:

  • Run Pipeline

  • Trigger Release

  • Deploy Application

  • Create and Deploy Application from Deployment Package

Behavior changes

None.

Installation notes

For complete installation and upgrade information, see CloudBees CD installation guide.

Upgrading your CloudBees CD environment

IMPORTANT: Before starting an upgrade, make sure to back up your existing CloudBees CD data.

Upgradable versions

  • Upgrades to CloudBees CD 10.x are only supported only from ElectricCommander 5.0 or later.

  • Upgrades from version 4.2 or earlier are not supported.

For upgrade instructions, see Upgrade on traditional platforms.

Upgrading an older DevOps Insight version

  • Upgrades from version 9.0.x, or earlier: requires upgrading the DevOps Insight server to 10.0.1.

  • Upgrades from version 9.1, or later: upgrading is not required.

Updating elements containing applicationServiceMapping

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 serviceClusterMapping before importing the file into version 10.0.1. For example, change the following XML:

<applicationServiceMapping>
  <applicationServiceMappingId>9efcda31-a85f-11e7-8500-0800279f198d</applicationServiceMappingId>
  <applicationServiceMappingName>9efcda31-a85f-11e7-8500-0800279f198d</applicationServiceMappingName>
  …
</applicationServiceMapping>

to

<serviceClusterMapping>
  <serviceClusterMappingId>9efcda31-a85f-11e7-8500-0800279f198d</serviceClusterMappingId>
  <serviceClusterMappingName>9efcda31-a85f-11e7-8500-0800279f198d</serviceClusterMappingName>
  …
</serviceClusterMapping>
Backing up and restoring custom settings

The DevOps Insight installer overwrites the elasticsearch.yml configuration file with a new file. As of DevOps Insight version 8.3, the file includes a Custom Settings section, which lets you add Elasticsearch settings not managed by the DevOps Insight server without being lost during an upgrade. [NMB-25850]

  • Upgrading from version 8.2, or earlier: if you added settings to this file that you want to preserve, you must back up the file to a separate location before upgrading to version 10.0, or newer, and then add the settings to the Custom Settings section after the upgrade.

  • Upgrading from version 8.3, or later: No action required. The installer preserves the settings in the Custom Settings section.

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

If upgrading from version 8.5, or later, you must remove these lines or comment them out. Otherwise, jobs will not start.

Ensuring the correct default MySQL 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_unicode_ci or utf8_general_ci and that no table in their schema overrides this. As of version 9.0, the CloudBees CD 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 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 deployments, CloudBees CD agents that are in a different zone than the CloudBees CD 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 [NMB-27934, NMB-29326]

CloudBees recommends removing the SSL 2.0 Client Hello or SSLv2Hello protocol from your security configurations for all components.

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

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

    $ ecconfigure --serverTLSEnabledProtocol=TLSv1.2
    ▼
Upgrading the DevOps Insight server

This section provides information about upgrading the DevOps Insight server from Version 7.3 to Version 10.0.

Re-Specifying configuration settings

The installers (GUI, interactive console, and silent mode) for the DevOps Insight server do not preserve the configuration setting for the DevOps Insight 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 nondefault values during the 7.3 Reporting server installation, you must re-specify these settings during the upgrade. (All other settings are preserved.)

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

Updating application component plugins

Application components are based on plugins (EC-Artifact, EC-Maven and EC-FileSysRepo) with plugin details (such as name, procedure, and parameters) stored in properties on the component. Before version 5.4, the value for the pluginProjectName property included the plugin name and version (for example, EC-Artifact-1.0.3.4), which closely tied components to specific versions.

When you export your project data before upgrading from ElectricCommander 5.0, 5.1, 5.2, or 5.3 to CloudBees CD 8.x, or later, you must update the application component plugin versions in the export file to the versions on the target CloudBees CD server before importing the data to CloudBees CD 10.0.

For example, if the promoted EC-Artifact plugin version is 1.0.4.1, then in the snippet below, you would change EC-Artifact-1.0.3.4 to EC-Artifact-1.0.4.1:

<property>
  <propertyId>3f509ffd-506b-11e6-9960-f01faf2c26a3</propertyId>
  <propertyName>pluginProjectName</propertyName>
  <counter>0</counter>
  <createTime>2016-07-23T00:20:20.829Z</createTime>
  <expandable>1</expandable>
  <lastModifiedBy>admin</lastModifiedBy>
  <modifyTime>2016-07-23T00:20:20.829Z</modifyTime>
  <owner>admin</owner>
  <tracked>1</tracked>
  <value>EC-Artifact-1.0.3.4</value>
  </property>
<property>

Starting with release 5.4, CloudBees CD uses the plugin key, which does not include the version, when defining a component. [CEV-6679]

DevOps Insight server configuration notes

For a production environment, CloudBees recommends that you install the DevOps Insight server on a system other than systems running other CloudBees CD components (such as the CloudBees CD 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 DevOps Insight server with other components for details.

Limitations

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

NMB-21550

Some antivirus software might flag parl.exe and delete it, which causes the installation to fail. The workaround is to register this file in the acceptlist of the antivirus.

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 do not appear properly in user details (in the Automation Platform UI, the Deploy UI, or ectool ) until the CloudBees CD server is restarted.

NMB-26962

(Windows platforms only) If the Elasticsearch cluster which is used by DevOps Insight 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.

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 login via SAML 2.0.

NMB-28380

Can’t ignore server mismatch and override passkey from Database Configuration page.

NMB-28381

The ec-groovy command line utility fails when invoking createArtifactVersion with error This server cannot handle version <x> messages.

NMB-29391

The warning, WARNING: An illegal reflective access operation has occurred is logged by Java 11 for the cglib library.

NMB-29486

The LANG environment variable must be set to en.US.UTF-8; otherwise, the upgrade fails. See KBEC-00452 - Error installing CloudBees CD 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 6.1 or earlier is cloned and a project containing this application is imported to CloudBees CD 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 missed 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 DevOps Insight Microservices Dashboard if the service does not contain a deploy step in the process.

CEV-17164

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 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 deploymentHistoryItem flowRuntime and so on) are unique.

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 DevOps Insight report editor.

CEV-21426

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: "release-project-name-in-CloudBees CD":releaseProjectName

CEV-22379

Long custom labels in email notifications do not render correctly.

CEV-23624

Approval by email on manual tasks should not expect parameters.

CEV-22644

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.

CEV-23957

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: Resource pool 'oldPoolName' does not exist . To work around this issue, rename the resource pool, then save the change, and then add the tag to the resource pool.

CEV-23958

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.

CEV-23960

If you are signed in to the Deploy UI and upgrade to CloudBees CD 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:

  • Before upgrading, sign out from the Deploy UI and the Automation Platform UI.

  • After upgrading, sign out from the Deploy UI and then sign in.

  • After upgrading, clean your browser cache and cookies to kill the pre-upgrade sign-in session.

As documented at KBEC-00443 - Login page goes to infinite redirect after upgrading Flow to 10.0

CEV-24712

Attempt to delete a project containing a CIBuildDetails object (injected by Jenkins LTS or CloudBees CI) results in the error: The DELETE statement conflicted with the REFERENCE constraint.

CEV-24710

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.

CEV-24617

Attempt to delete a build from a pipeline run via buildname and flowRuntimeId results in the error deleted object would be re-saved by cascade.

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 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 CD server UI. It is recommended to use ectool export and ectool import only between servers at the same version.

CEV-25400

These service catalog items are disabled because underlying plugin has been removed.

  • Azure Container Service Discovery

  • Amazon ECS Dynamic Cluster

  • GCE Dynamic Cluster

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 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 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 see change tracking.