Upgrade server
| If your CircleCI server installation is on GKE, do not upgrade to v4.5 at this time. GKE support will be announced in a future release. |
This page describes the steps needed to upgrade your CircleCI server installation to v4.5.
Upgrade paths
We recommend that you do not skip releases when upgrading, however some patch releases can be skipped. Your upgrade path will depend on your current version, and the currently available version releases.
When upgrading from one minor version to the next, ensure your upgrade path includes the last patch release for your current minor version.
To see some common upgrade path options, see this support article.
Recommendations
We have moved away from Vault to Tink for encryption. The process for migration is documented here. The migration includes a convenience script to move existing secrets. If you are using Vault, you should complete the migration to Tink on your v4.3.x installation before backing up your server installation in preparation for upgrading to v4.5. Customers that do not perform this step may have issues restoring Vault from backup in v4.5.
Prerequisites
-
Ensure you have access to the Kubernetes cluster in which server is installed.
-
Ensure you have set up Backup and Restore.
-
Ensure there is a recent backup. For more information, see the Backup and Restore guide.
Upgrade steps
-
Ensure your cluster is running a compatible Kubernetes version for this release (1.26 - 1.29).
-
Check the changelog and make sure there are no actions you need to take before deploying a new version.
-
Optionally, confirm what the update is going to do using Helm Diff:
helm diff upgrade circleci-server oci://cciserver.azurecr.io/circleci-server -n $namespace --version 4.5.5 -f <path-to-values.yaml> --username $USERNAME --password $PASSWORD -
Perform the upgrade:
helm upgrade circleci-server oci://cciserver.azurecr.io/circleci-server -n $namespace --version 4.5.5 -f <path-to-values.yaml> --username $USERNAME --password $PASSWORD -
Deploy and run
reality checkin your test environment to ensure your installation is fully operational.