Upgrade Config Sync

This page explains how to upgrade the Config Sync version installed on your clusters.

Manually upgrade Config Sync

To stay within the support window, we recommend that you upgrade at least every nine months. However, you can upgrade more frequently to get the latest features and security updates.

Upgrade from an unsupported version

If your version of Config Sync is unsupported, you can try to upgrade it by using one of the following options:

  • (Recommended) Perform a step-by-step upgrade with increments of no more than two minor versions at a time. For example, if you're on version N-4 (an unsupported version), you should upgrade to N-2 (a supported version), and then you can upgrade to N (a supported version). This approach is the safest method to upgrade, but only works if the first incremental upgrade is to a supported version.
  • Upgrade directly to a supported version. If you can't perform a step-by-step upgrade, you can try upgrading directly to a supported version. For example, if you're on version N-6 (an unsupported version), trying to perform an incremental upgrade to N-4 (an unsupported version) won't work. In this scenario, you can try upgrading directly to N-2 (the earliest supported version).
  • If your Config Sync version is significantly behind, and the previous options don't work, you can uninstall and reinstall Config Sync.

Upgrade Config Sync

Before you upgrade Config Sync, check the release notes for details on what's changed between versions.

To upgrade Config Sync, complete the following steps:

console

  1. In the Google Cloud console, go to the Config page under the Features section.

    Go to Config

  2. Under the Settings tab, next to the cluster whose Config Sync version you want to upgrade, select Edit cluster config.
  3. From the Version drop-down list, select the version that you want to upgrade to.
  4. Click Upgrade Config Sync.

gcloud

  1. (Optional) If you want to check which Config Sync version is installed on your clusters before you upgrade, run the following command:

    gcloud beta container fleet config-management version

  2. Run the following command:

    gcloud beta container fleet config-management upgrade \
    --version=VERSION \
    --membership=MEMBERSHIP_NAME

    Replace the following:

    • VERSION: the version that you want to upgrade to.
    • MEMBERSHIP_NAME: the fleet membership name that you chose when you registered your cluster. You can find the membership name by running gcloud container fleet memberships list.

Auto-upgrade Config Sync

Disable auto-upgrades

To disable Config Sync auto-upgrades, complete the following steps:

gcloud

Remove the upgrades field from your Google Cloud CLI apply spec file.

Terraform

Set the configmanagement.management field to MANAGEMENT_MANUAL in the google_gke_hub_feature_membership resource.

Config Connector

Set the configmanagement.management field to MANAGEMENT_MANUAL in the GKEHubFeatureMembership resource.