Upgrading a non-clustered environment

3 minute readDeveloper productivity

This section describes how to upgrade the software. The procedure is the same as when you upgrade CloudBees CD/RO and upgrade cluster configurations at the same time, except that you do not need to perform additional tasks to upgrade the cluster.

To upgrade, use the CloudBeesFlow-<version> installer, which performs the following:

  • Collects the CloudBees CD/RO service account credentials.

  • Uninstalls the current release.

  • Installs the latest CloudBees CD/RO release.

  • Configures the system with all property values mined.

  • Restores custom files and data.

After preparing for the upgrade, make sure to shut down the CloudBees CD/RO server service before installing the newer version of CloudBees CD/RO.

These instructions presume you are upgrading from CloudBees CD/RO v5.x or later. To upgrade from v4.2.x or earlier, contact CloudBees Support directly for extra instructions.

Upgrading from version 9.1 or earlier

If you are upgrading CloudBees CD/RO from version 9.1 or earlier, to version 9.2 or later, a new passkey with AES 256-bit encryption is automatically generated, replacing the older 128-bit passkey. During the database upgrade phase of the process, the CloudBees CD/RO server re-encrypts the following using the newly generated passkey.

  • All the credentials in the system including the COMMANDER_DB_PASSWORD in database.properties

  • User credentials

  • Passwords in email configurations

  • CloudBees Analytics configuration passwords

If you encounter any issues with your passkey after completing this upgrade, do not apply your passkey from your previous system as this will likely cause your database credential data to become corrupted. Please contact CloudBees Support if you encounter issues to help analyze whether the upgrade can be salvaged or if a repeat of the effort may be required.

Upgrade testing

In most implementations, CloudBees CD/RO is being used in an environment that affects many users. We recommend that you test your upgrade on a separate test server to understand all aspects of the upgrade process. This minimizes the potential impacts to downstream users.

Backing up your existing CloudBees CD/RO data

If you are upgrading a CloudBees CD/RO server, it is extremely important that you back up your existing CloudBees CD/RO data before upgrading. See CloudBees CD/RO server backups for more information about backups.

  • Always back up any other files where you have created custom configurations, specified other custom information, or created any type of modification.

The CloudBees CD/RO files you might have modified are too numerous to list, so you should back up the entire data directory and other miscellaneous files that might have changed.
  • If you use an artifact repository, back up your CloudBees CD/RO repository configuration files in the conf/repository subdirectory.

  • Determine if any changes were made to the custom editor or preflight driver script properties (installed by default). Back up those files if changes were made.

These properties are stored in the server-level property sheet, which can be viewed in the web UI by accessing the Administration tab/ Server subtab.

Custom editors are stored in the nested sheet named ec_customEditors. Preflight driver scripts are stored in the nested sheet named ec_preflight. The upgrade process overwrites default custom editor and preflight driver scripts with current versions. We recommend backing up any custom properties you created by renaming the property. For example, change ec_preflight/clientDrivers/perforce to ec_preflight/clientDrivers/perforce_modified.

Saving the upgrade installer

After you back up your CloudBees CD/RO server, create a folder where you can download the CloudBeesFlow-<version> installation file.

Starting the installation process

Install the upgrade by choosing the correct upgrade method for your environment.

Copying repository contents

After you have updated CloudBees CD/RO, perform the following steps to copy the contents of an existing repository server into a newly installed repository server:

  1. Install the new repository server software.

  2. Stop the existing and new repository servers.

  3. Copy the entire contents of the repository backingstore directory from the existing repository server to the corresponding location on the newly installed repository server.

    The default location for the backingstore directory (<datadir>/repository-data) is:

    • UNIX: /opt/cloudbees/sda/repository-data

    • Windows: C:\ProgramData\CloudBees\Software Delivery Automation\repository-data

MySQL upgrades

CloudBees CD/RO upgrades involving a MySQL database can take several hours to complete if you have a significant data set. Do not interrupt the upgrade process. You can corrupt your database if the upgrade process is interrupted. A restore from a previous database backup will be required.

Use the ectool to view the upgrade progress. On a command line, enter:

ectool getServerStatus

An install/upgrade log file named installer.log is created in the logs subdirectory in the data directory.