Upgrade your AlloyDB Omni Kubernetes operator to version 1.4.0

Stay organized with collections Save and categorize content based on your preferences.

This page describes how to upgrade the AlloyDB Omni operator to version 1.4.0. The steps to upgrade depend on your current version of AlloyDB Omni and the version that you upgrade to.

Before you begin

When you upgrade the AlloyDB Omni operator, the database restarts unless all of the following are true:

• You're upgrading the AlloyDB Omni operator version 1.1.1 to a newer version.
• You're using the AlloyDB Omni database version 15.5.5 or later.
• AlloyDB AI is not enabled.

If the database restarts, no data loss is expected.

Starting from the AlloyDB Omni database version 15.7.1, high availability (HA) on your Kubernetes-based AlloyDB Omni database clusters uses a new architecture to provide more hardening and improvements for HA automatic setup, failover, and healing capabilities.

If you're upgrading the AlloyDB Omni database version from 15.7.0 (or earlier) to version 15.7.1 (or later), or if you're downgrading versions, you must disable HA before upgrading, and you must re-enable HA after the upgrade completes.

Determine your current versions

To check the version of AlloyDB Omni used by your database cluster, run the following command:

kubectl get dbclusters.alloydbomni.dbadmin.goog DB_CLUSTER_NAME -n NAMESPACE -o jsonpath='{.status.primary.currentDatabaseVersion}'

Make the following replacements:

• DB_CLUSTER_NAME: the name of your database cluster. It's the same database cluster name that you declared when you created the cluster.

• NAMESPACE: the Kubernetes namespace of your database cluster.

If you run version 1.0.0 or later of the AlloyDB Omni operator, then this command prints the version of AlloyDB Omni used by your database cluster.

To check the version of the AlloyDB Omni operator installed on your Kubernetes cluster, run the following command:

kubectl get dbclusters.alloydbomni.dbadmin.goog DB_CLUSTER_NAME -n NAMESPACE -o jsonpath='{.status.primary.currentControlPlaneAgentsVersion}'

If you run version 1.0.0 or later of the AlloyDB Omni operator, the output is the version number of the AlloyDB Omni operator running on your Kubernetes cluster.

If you run a version of AlloyDB Omni operator earlier than 1.0.0, follow the instructions in Upgrade from a pre-1.0.0 AlloyDB Omni operator. Otherwise, continue with Check your target version numbers.

Check your target version numbers

If you run a version of AlloyDB Omni operator 1.0.0 or later, then your next steps depend on the version of AlloyDB Omni that you want to upgrade to. The AlloyDB Omni version number has the following components:

• The major version number of its PostgreSQL compatibility
• The minor version number of its PostgreSQL compatibility
• The patch version number of this AlloyDB Omni release

For example, AlloyDB Omni version 16.3.0 supports PostgreSQL version 15.7 and doesn't have a AlloyDB Omni release patch.

Choose the installation option that works for your target version:

Upgrade the AlloyDB Omni operator

To upgrade the AlloyDB Omni operator, follow these steps:

1. Define the environment variables:

   export GCS_BUCKET=alloydb-omni-operator
   export OPERATOR_VERSION=OPERATOR_VERSION
   export HELM_PATH=$OPERATOR_VERSION/alloydbomni-operator-$OPERATOR_VERSION.tgz

   Replace OPERATOR_VERSION with the version of the AlloyDB Omni operator that you're upgrading to—for example, 1.4.0.

2. Download the latest AlloyDB Omni operator:

   gsutil cp -r gs://$GCS_BUCKET/$HELM_PATH ./
   tar -xvzf alloydbomni-operator-${OPERATOR_VERSION}.tgz

3. Apply the latest AlloyDB Omni operator custom resource definitions:

   kubectl apply -f alloydbomni-operator/crds

4. Upgrade the AlloyDB Omni operator Helm chart:

   helm upgrade alloydbomni-operator alloydbomni-operator-${OPERATOR_VERSION}.tgz \
   --namespace alloydb-omni-system \
   --atomic \
   --timeout 5m

Update the database clusters

To update the dbCluster, follow these steps:

1. If you're upgrading an HA AlloyDB Omni database cluster from database version 15.7.0 (or earlier) to version 15.7.1 (or later), set the numberOfStandbys to 0 in the cluster's manifest and re-apply the manifest to disable HA:

   spec:
     availability:
       numberOfStandbys: 0
   

   You don't need to disable HA if you're upgrading from an older version to version 15.7.0 (or earlier), or from version 15.7.1 (or later) to a newer version.

2. Update the databaseVersion and the controlPlaneAgentsVersion versions in the cluster's manifest, and re-apply the manifest.

   The following is part of a manifest file that specifies version 16.3.0 of databaseVersion and version 1.4.0 of controlPlaneAgentsVersion:

   apiVersion: alloydbomni.dbadmin.goog/v1
   kind: DBCluster
   metadata:
     name: DB_CLUSTER_NAME
   spec:
     databaseVersion: "16.3.0"
     controlPlaneAgentsVersion: "1.4.0"
   ...

3. Wait for the upgrade to complete successfully.

4. If you disabled HA before the upgrade, you can set the numberOfStandbys back to the number prior to upgrade in the cluster's manifest and re-apply the manifest to re-enable HA.

Update alloydb_omni_instance_postgresql_wait_time_second_total

If you're using the alloydb_omni_instance_postgresql_wait_time_second_total metric, you must update it to alloydb_omni_instance_postgresql_wait_time_us_total. To consume both metrics, use the Prometheus OR operator.

(promQL A) OR (promQL A, but replace all occurrences of alloydb_omni_instance_postgresql_wait_time_second_total to alloydb_omni_instance_postgresql_wait_time_us_total)

If you use seconds as the unit for this metric, you must convert it to us.

For more information, see the release notes.