CircleCI server v3.x upgrade guide

Upgrading your server v3.x installation requires that you have access to the Kubernetes cluster in which server is installed, and have an instance of KOTS admin running.

Before upgrading, ensure you have set up Backup and Restore.

A successful deployment will update the UI. Unless noted in the release notes, updates are rolling updates and there is no downtime.

We recommend that you do not skip releases.

Upgrade server v3.x

  1. Enter the KOTS admin console. To do this, run the following, substituting your CircleCI server namespace:

    kubectl kots admin-console -n <YOUR_CIRCLECI_NAMESPACE>
  2. Log in to the admin console with the password you created during the installation process.

  3. Select the Snapshots tab and take a snapshot of your installation. For more information, see the Backup and Restore guide.

  4. Select the Version History tab. Click Check for Updates before proceeding.

  5. Once you have the most recent versions visible, run through the following checklist before selecting Deploy for the version you would like to upgrade to.

    • Check the change log and make sure there are no actions you need to take before deploying a new version.

    • Check the config for the version you are deploying and make sure there are no new fields or features you may be interested in deploying (the gears next to the deploy button will take you to the config specific to that version).

  6. Deploy and run reality check in your test environment to ensure your installation is fully operational.

Help make this document better

This guide, as well as the rest of our docs, are open-source and available on GitHub. We welcome your contributions.