Migrate to the latest version of the AlloyDB Omni Kubernetes operator

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 it .

• 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 15.7.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.3.0 .

2. Download the latest AlloyDB Omni operator:

    gcloud  
   storage  
   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 
   

   To update the dbCluster , you need to update the databaseVersion and the controlPlaneAgentsVersion versions in the manifest file. The following is part of a manifest file that specifies version 15.7.0 of databaseVersion and version 1.3.0 of controlPlaneAgentsVersion :

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