Edit

Share via

Upgrading CycleCloud

You can upgrade the Azure CycleCloud application in place when new versions are available.

CycleCloud 8

CycleCloud 8 uses a different package name, cyclecloud8, to prevent accidental upgrades between major versions. Major versions include incompatible changes. You can't install both cyclecloud and cyclecloud8 on the same machine.

To upgrade, remove the cyclecloud package and install cyclecloud8. When you remove the cyclecloud package, you keep your data and configuration directories in /opt/cycle_server. When you install cyclecloud8, the installation scripts find your existing data and configuration and automatically handle any upgrade migrations.

To switch to Insiders builds, follow the steps in Insiders Builds to add the Insiders repository. After that, use the upgrade commands in this article to upgrade to the latest Insiders build.

Upgrading on Debian or Ubuntu

Follow the instructions in Installing on Debian or Ubuntu to configure the Microsoft apt repository (if you didn't already configure it during installation).

Upgrade the CycleCloud package with the following command:

sudo apt update
sudo apt -y upgrade cyclecloud

To upgrade from one version of CycleCloud 8 to a newer version, run the following command:

sudo apt update
sudo apt -y upgrade cyclecloud8

To upgrade from CycleCloud 7 to CycleCloud 8, run the following command:

sudo apt update
sudo apt -y remove cyclecloud
sudo apt -y install cyclecloud8

Removing cyclecloud doesn't remove the data. Installing cyclecloud8 doesn't overwrite the data.

Upgrading on Enterprise Linux (RHEL) clones

Follow the instructions in Installing on Enterprise Linux (RHEL) clones to configure the Microsoft yum repository (if you didn't already configure it during installation).

Upgrade the CycleCloud package by running:

sudo yum -y upgrade cyclecloud

To upgrade from one version of CycleCloud 8 to a newer version, run the following command:

sudo yum -y upgrade cyclecloud8

To upgrade from CycleCloud 7 to CycleCloud 8, run the following command:

sudo yum -y remove cyclecloud
sudo yum -y install cyclecloud8

Removing cyclecloud doesn't remove the data. Installing cyclecloud8 doesn't overwrite the data.

Upgrading from the Microsoft Download Center

If you can't access the Microsoft package repositories or your policy doesn't allow it, you can manually download and install the CycleCloud packages.

CycleCloud is available at the Download Center as either a Debian or RPM package.

To upgrade, copy the installer to the host running CycleCloud and run the platform-specific package upgrade command.

For Debian, use:

dpkg -i cyclecloud_7.9.2-amd64.deb

For RedHat variants, use:

rpm -U cyclecloud_7.9.2.rpm

Important

Upgrading CycleCloud might cause issues in your environment and affect any running clusters. To reduce risk for production workloads, Microsoft recommends testing all upgrades in a development or staging environment.

Common upgrade questions

Will my old templates work with this new version?

Templates should work for minor version upgrades. For upgrades between major version releases, you might need to pin clusters to the older version that your templates are designed for.

Is there any downtime during the upgrade?

CycleCloud is unavailable while the upgrade happens. The upgrade usually takes 2-3 minutes.

Can I upgrade while clusters are running?

Yes, but clusters can't communicate with CycleCloud while it's down. This limitation means that autoscale, termination requests, and similar features don't work until the upgrade finishes.

Migrate CycleCloud to a new host

The first installation of CycleCloud sets up the service user and startup configuration. If you just copy the installation data from one host to another, you don't get these settings. The following instructions explain how to migrate a CycleCloud installation to another host.

Running clusters

Clusters that CycleCloud manages send information to CycleCloud through HTTPS and AMQP. The nodes get the access information to set up these communication protocols when they launch. If the hostname or IP address of CycleCloud changes while the nodes are running, communication might break. We recommend that you terminate all clusters before migrating.

One exception to this rule is nodes that you configure with IsReturnProxy = true. In this case, the communication channels start outbound from CycleCloud and automatically re-establish after migration.

To migrate a CycleCloud host:

  1. Stop cycle_server on the source host by running service cycle_server stop (LSB init scripts) or systemctl stop cycle_server (systemd init).
  2. Run groupadd cycle_server and useradd cycle_server on the target host. Use the original GID and UID if possible.
  3. Install OpenJDK version 8 on the target host by running apt-get -y install openjdk-8-jre-headless or yum install -y java-1.8.0-openjdk.
  4. Transfer the files to the target host by running rsync -a /opt/cycle_server username@remote_host:/opt/cycle_server or by using another metadata-preserving transfer tool.
  5. Enable the LSB init or systemd init for CycleCloud by running /opt/cycle_server/util/autostart.sh on.
  6. Start the CycleCloud service with either service cycle_server start or systemctl start cycle_server.

You can simplify these instructions if you're migrating an installation from a nonstandard directory to /opt/cycle_server:

  1. Stop cycle_server on the source host with service cycle_server stop (LSB init scripts) or systemctl stop cycle_server (systemd init).
  2. Transfer the files to the default location with rsync -a /usr/share/hpc/cycle_server /opt/cycle_server.
  3. Enable the LSB init or systemd init for CycleCloud by running /opt/cycle_server/util/autostart.sh on.
  4. Start the CycleCloud service with either service cycle_server start or systemctl start cycle_server.

After migrating to a new host or migrating to the default installation directory, perform upgrades as described in the first section.

  • Last updated on