Upgrading and Downgrading

The upgrade and downgrade processes are only performed on the Primary Coordinator. After the version of your Primary Coordinator is changed, all associated Agents and the Secondary Coordinator are automatically changed to the same version within a few minutes.

Note: For 3.17 and later, if you installed Incredibuild as an initiator only, you cannot downgrade to earlier versions that do not support initiator only machines.

Overview

Both upgrading and downgrading are performed using the same command. If Incredibuild detects that the version of the installer you are using is earlier than your current version, a downgrade will be performed. If the installer is using a later version than your current version, an upgrade will be performed.

Note: Do not use the procedure below when downgrading from 4.x to 3.x, rather see Downgrading from Version 4.x to 3.x.

By default, upgrading or downgrading Incredibuild for Linux will abort any running builds: verify there are no running builds before following the procedure below.

If you have a Secondary Coordinator, you can upgrade online, that is, Agents will be upgraded only when they finish the builds they are currently running. This allows you to perform upgrades with zero downtime. See Upgrading Online for details.

Upgrading and Downgrading to Version 4.x

  1. Verify that there are no running builds. If there are running builds during the upgrade, they will be aborted.

  2. Copy the installation file for the target version to your Coordinator machine.

  3. Run the installation file. This must be done with a user who has root user permissions.

    You can use the --accept-eula flag to pre-approve the end user license agreement.

    sudo incredibuild-<version>.run --action upgrade --accept-eula true

  4. Go to the Coordinator Manager's help menu and verify that the version was changed.

Upgrading Online

Note: Online upgrades are supported when upgrading between releases 4.18 and later.

Note: To upgrade your system without interrupting running builds, your system must include a Secondary Coordinator, and it must be ready.

During the upgrade process, Agents are controlled by the Secondary Coordinator as long as they are running a build and are automatically controlled by the Primary Coordinator when they finish the build. When all Agents have been upgraded, the Secondary Coordinator will be upgraded as well.

Once an Agent is upgraded, it can only receive help from other Agents (Helpers) running the same version. Therefore, you have the option to control how many Helpers to keep at the current version, to allow builds to continue running with full acceleration.

Note: During the upgrade process, while Agents are controlled by the Secondary Coordinator they cannot be managed from the Coordinator Manager Agents page.

Use the following procedure to upgrade your Incredibuild for Linux online.

  1. Copy the installation file for the target version to your Coordinator machine.

  2. Prepare the system for online upgrade by running the following on the Primary Coordinator:

    sudo /opt/incredibuild/management/upgrade_mode.sh enable <helpers>

    Replace <helpers> with the number of helpers you need to keep for each running build (these helpers will remain with the current version until the build ends, and the Initiator is upgraded).

  3. Run the installation file. This must be done with a user who has root user permissions.

    You can use the --accept-eula flag to pre-approve the end user license agreement, and opt-out of data collection during this process by adding the --disable-telemetry flag to the installation or upgrade command. For more details, see telemetry.htm.

    sudo incredibuild-<version>.run --action upgrade --accept-eula true

  4. Go to the Coordinator Manager's help menu and verify that the version was changed.

If you enabled the upgrade mode and decide to postpone the upgrade, you can revert this by running the following on the Primary Coordinator, so that all Agents will be controlled by the Primary Coordinator:

sudo /opt/incredibuild/management/upgrade_mode.sh disable

Downgrading from Version 4.x to 3.x

  1. Verify that there are no running builds. If there are running builds during the upgrade, they will be aborted.

  2. Copy the installation file for the target version to your Coordinator machine.

  3. Uninstall Incredibuild Manager using the following command

    sudo /opt/incredibuild_management/ib_manager/uninstall

  4. Run the 3.x installation file. This must be done with a user who has root user permissions.

    You can use the -P flag to pre-approve the end user license agreement, and opt-out of data collection during this process by adding the -T flag to the installation or upgrade command.

    sudo ./incredibuild_<version>.ubin upgrade -P

  5. Go to the Coordinator Manager's help menu and verify that the version was changed.