Skip to main content
Version: V2-Next

Updating

warning

Since this is the first version no stable update process is guaranteed.

This guide provides step-by-step instructions to help you upgrade your CORE installation.

General Update Process​

1. Backup your data​

Ensure your Backups are up to date and working.

Information on ways to back up the platform can be found in the Backups Guide.

2. Review the release notes​

  1. Check below for release notes and update instructions for all versions
  2. Pull the latest changes from the core repository or check out the specific version you want to update to.
  3. Look for changes in the defaults/environment/global.yaml file, as these may require adjustments in your custom configuration.
  4. If you changed any other default configuration files, check for changes in those files as well.
  5. If you changed helm values directly via rawValues, check for changes in the corresponding helm charts.

3. Update your deployment​

To see what will change between the current version and the new version you can use the helmfile diff command:

$ helmfile -e <environment> diff

To update and approve all changes interactively, use the helmfile apply command:

$ helmfile -e <environment> apply -i

Sometimes an update via "apply" might not be enough. For example when changes to the deployment were done manually in the cluster, or when the deployment requires more changes. In this case, you can use the helmfile sync command to sync all deployments with the helmfile configuration:

$ helmfile -e <environment> sync

Multi-instance deployments​

If you run multiple instances on one cluster, remember the two-layer split when updating:

  • Instances are updated independently — run the commands above against deployment/helmfile-instance.yaml.gotmpl per instance.
  • Shared operators are updated once per cluster with helmfile -f deployment/helmfile-operators.yaml sync -e <env>. An operator/CRD upgrade affects all instances simultaneously, so apply it before any instance starts using new custom-resource fields. See Deployment → Operations.

Version Specific Update Process​