Upgrade to AlloyDB Omni version 16.8.0 on Kubernetes

This page describes how to upgrade to AlloyDB Omni version 16.8.0 on Kubernetes.

Before you begin

• Ensure that your AlloyDB Omni Kubernetes operator version is 1.5.0. To upgrade your AlloyDB Omni operator version, see Migrate to the latest AlloyDB Omni Kubernetes operator version.

• Ensure that you have at least 5GB of free disk space.

• If you run external or remote backup systems, perform a full backup and pause any scheduled backups to avoid backing up during the upgrade process.

• For high availability (HA) and data resilience (DR) environments, decouple your database clusters before upgrading them.

Upgrade your AlloyDB Omni version

To upgrade your AlloyDB Omni version using pg_upgrade, do one of the following:

• Run the Bash script that performs the upgrade for you.

• Run the upgrade instructions manually.

Upgrade script

You can find a script that performs the manual upgrade steps in the AlloyDB Omni samples on GitHub.

To use the upgrade script, download the script and run the following command:

./MVU.sh 16.8.0 1.5.0 NAME NAMESPACE

Replace the following variables:

• NAME: the name of your database cluster.
• NAMESPACE: the namespace for your database cluster.

Manual upgrade steps

1. Back up your data to avoid any data loss.

2. Remove your backup plan.

3. Terminate all replication processes. This includes physical replication used for high availability (HA) and data resilience (DR) as well as all logical replication streams.

4. Annotate your database cluster to specify a manual version upgrade.

   kubectl annotate dbclusters.alloydbomni.dbadmin.goog NAME dbs.dbadmin.goog.com/manualmvu=true
   

   Replace the following variable:

   • NAME: the name of your database cluster.

5. Stop the PostgreSQL process so that data can be moved for the upgrade.

   k exec -ti POD_NAME -- /bin/Bash
   # Shut down postgres
   postgres@POD_NAME:~$ supervisorctl.par stop postgres
   
   postgres@POD_NAME:~$ mkdir /mnt/disks/pgsql/15; mv /mnt/disks/pgsql/data /mnt/disks/pgsql/15/data; cp -r /usr/lib/postgresql/15/bin /mnt/disks/pgsql/15/.; cp -r /usr/lib/postgresql/15/lib /mnt/disks/pgsql/15/.; cp -r /usr/share/postgresql/15 /mnt/disks/pgsql/15/share; rm /mnt/disks/pgsql/15/share/postgresql.conf.sample; cp /usr/share/postgresql/postgresql.conf.sample /mnt/disks/pgsql/15/share/postgresql.conf.sample; chmod 2740 /mnt/disks/pgsql/15/data
   

   Replace the following variable:

   • POD_NAME: the name of your pod.

6. Patch your database cluster to version 16.8.0 and your control plane agents (CPA) to 1.5.0.

   kubectl patch dbclusters.alloydbomni.dbadmin.goog NAME --type=merge -p '{"spec":{"databaseVersion":"16.8.0","controlPlaneAgentsVersion":"omni_control_plane_agents_version"}}'
   

   Replace the following variable:

   • NAME: the name of your database cluster.

7. Create an empty database cluster for the new AlloyDB Omni version.

   k exec -ti POD_NAME -- /bin/Bash
   
   postgres@POD_NAME:~$ supervisorctl.par stop postgres
   
   # Initialize a new, empty database cluster for the new version.
   postgres@POD_NAME:~$ rm -fr /mnt/disks/pgsql/data; initdb -D /mnt/disks/pgsql/data -U alloydbadmin --data-checksums --encoding=UTF8 --locale=C --locale-provider=icu --icu-locale=und-x-icu --auth-host=trust --auth-local=reject; cd ~
   

   Replace the following variable:

   • POD_NAME: the name of your pod.

8. Modify pg_hba.conf in your pre-existing database cluster to provide the upgrade process the permissions and connections it needs.

   # Backup pg_hba.conf of the pg15 cluster
   postgres@POD_NAME:~$ cp /mnt/disks/pgsql/15/data/pg_hba.conf /mnt/disks/pgsql/15/data/pg_hba.conf.bak
   
   # Update pg15 configurations
   postgres@POD_NAME:~$ echo "local      all           all                      trust" >> /mnt/disks/pgsql/15/data/pg_hba.conf; echo "host       all           all      127.0.0.1/32    trust" >> /mnt/disks/pgsql/15/data/pg_hba.conf
   

   Replace the following variable:

   • POD_NAME: the name of your pod.

9. Modify pg_hba.conf in the new database cluster to provide the upgrade process the permissions and connections it needs.

   postgres@POD_NAME:~$ rm /mnt/disks/pgsql/data/pg_hba.conf; echo "local      all           all                      trust" >> /mnt/disks/pgsql/data/pg_hba.conf; echo "host       all           all      127.0.0.1/32    trust" >> /mnt/disks/pgsql/data/pg_hba.conf; chmod 2740 /mnt/disks/pgsql/15/data
   

   Replace the following variable:

   • POD_NAME: the name of your pod.

10. Upgrade your database cluster.

    # (optional) Make sure postgres is stopped
    postgres@POD_NAME:~$ supervisorctl.par stop postgres
    
    # (optional) Check to verify that data can be upgraded.
    postgres@POD_NAME:~$ pg_upgrade -U alloydbadmin --check -b /mnt/disks/pgsql/15/bin -B /usr/lib/postgresql/16/bin -d /mnt/disks/pgsql/15/data -D /mnt/disks/pgsql/data --link -v
    
    postgres@POD_NAME:~$ pg_upgrade -U alloydbadmin -b /mnt/disks/pgsql/15/bin -B /usr/lib/postgresql/16/bin -d /mnt/disks/pgsql/15/data -D /mnt/disks/pgsql/data --link -v
    
    # Need to recover pg15 configurations
    postgres@POD_NAME:~$ cp /mnt/disks/pgsql/15/data/pg_hba.conf.bak /mnt/disks/pgsql/data/pg_hba.conf; cp -r /mnt/disks/pgsql/15/data/postgresql.conf /mnt/disks/pgsql/data/.; cp -r /mnt/disks/pgsql/15/data/postgresql.conf.d /mnt/disks/pgsql/data/.; cp -r /mnt/disks/pgsql/15/data/parambackup /mnt/disks/pgsql/data/.
    
    # Start postgres
    postgres@POD_NAME:~$ supervisorctl.par start postgres
    
    # Clean up backup data
    postgres@POD_NAME:~$ rm -fr /mnt/disks/pgsql/15/
    

    Replace the following variable:

    • POD_NAME: the name of your pod.

11. Remove the manual version upgrade annotation from your database cluster.

    kubectl annotate dbclusters.alloydbomni.dbadmin.goog NAME dbs.dbadmin.goog.com/manualmvu-
    

    Replace the following variable:

    • NAME: the name of your database cluster.

12. Resume normal operations and re-enable any backups, backup plans, or replication processes disabled in steps one to three.