You can back up and restore yourhybrid data usingCSI (Container Storage Interface) snapshots. CSI backup triggers disk snapshots taken by the underlying storage system using the provided CSI driver. CSI backup does not need a Google Cloud Storage bucket or a remote server to store backup data.

CSI backup is recommended for hybrid instances hosted in Google Cloud, AWS, or Azure.

This page describes the steps to use hybrid CSI backup and restore. For an overview of hybrid back up and restore in general, see theCassandra backup and restore overview.

• The CSI driver used by the configured storage class must support CSI snapshots. See thisKubernetes CSI driver list for driver information.
• Not all platforms are supported. Only Google Cloud, AWS, and Azure platforms are supported.
• OpenShift Container Platform is not supported due to volume snapshotlimitations.
• Only cloud platforms are supported. On-prem platforms are not supported.
• CSI backup data and non-CSI hybrid backup data are incompatible. Non-CSI backups cannot be used with CSI restore and CSI backups cannot be used with non-CSI restore.
• CSI driver installation and functionality is the responsibility of the CSI driver vendor.
• Users are responsible for ensuring adequate cluster resources are available for provisioning CSI snapshots.
• Users are responsible for removing old snapshot data.

Set up CSI backups

To schedule hybrid backups using CSI, perform the following steps:

1. If you have not previously set up hybrid backup:
   1. Run the followingcreate-service-account command to create a Google Cloud service account (SA) with the standardroles/storage.objectAdmin role. This SA role allows you to write backup data to Cloud Storage. Execute the following command in the directory appropriate for your management tool:
      • Helm charts:$APIGEE_HELM_CHARTS_HOME/apigee-operator/etc/
      • apigeectl:HYBRID_BASE_DIRECTORY/hybrid-files/

      ./tools/create-service-account --env non-prod --dir ./service-accounts

      This command creates a single service account namedapigee-non-prod for use in non-production environments and places the downloaded key file in the./service-accounts directory.

      Note: If you prefer to create all the individual service accounts for a production environment, use the following command:

      ./tools/create-service-account--env prod --dir ./service-accounts

      For more information about Google Cloud service accounts, seeCreating and managing service accounts.

   2. Thecreate-service-account command saves a JSON file containing the service account private key. The file is saved in the same directory where the command executes. You will need the path to this file in the following steps.
2. Open youroverrides.yaml file. Set the follow parameters, as shown inExample overrides files.
   1. Set the general parameters shown below in thebackup block. If you've already set these parameters for the non-CSI hybrid back up solution, you can use the same parameters for your CSI snapshots. Seebackup properties reference table for more information about each value.
      

      Forbackup:

      • enabled: Set totrue to enable scheduled backups.
      • pullPolicy in image: Set toAlways.
      • schedule: Provide acron expression schedule.
   2. Set these parameters for CSI-specific backup:
      • Cassandra storage group values: The configured Cassandra storage class must support CSI snapshots for CSI backup and restore to work. To check if a storage class supports CSI snapshots, run the following command to get the available storage classes:

        kubectl get sc

        Look at the "Provisioner" output for each storage class. Provisioners using CSI usually have a ".csi." part to their name like "pd.csi.storage.gke.io". Look for the provisioner name in thisKubernetes CSI driver list. If the "Other Features" column for the provisioner contains the word "SNAPSHOT", then the storage class using the provisioner supports CSI snapshots.

        Add these parameters in the storage group. Both values are required.

        • storageclass: A CSI snapshot-enabled storage class name.
        • capacity: The capacity of the disk.
      • Cloud provider type:

        Once the CSI snapshot capability has been verified, modify the overrides file to use CSI backup and restore:

        • cloudProvider: SetcloudProvider inbackup andrestore toCSI.

Example backup config

cassandra:hostNetwork:falsereplicaCount:3storage:storageclass:standard-rwocapacity:100Giimage:pullPolicy:Alwaysbackup:enabled:trueimage:pullPolicy:AlwayscloudProvider:"CSI"schedule:"0 * * 11 *"

kubectl create job -nAPIGEE_NAMESPACE --from=cronjob/apigee-cassandra-backupBACKUP_POD_NAME

kubectl get volumesnapshot -nAPIGEE_NAMESPACE

Use this process to restore a previously generated CSI backup. For general information on restoring backups and an overview of the process, see therestore overview page.

To initiate a restore of a CSI backup, follow the instructions for thehybrid non-CSI single region restore, but use these values in therestore block in youroverrides.yaml. See thebackup properties reference table for more information about each value and theexample restore configuration for an example.

• enabled: Set totrue to enable restore for the backup referenced with thesnapshotTimestamp timestamp.
• snapshotTimestamp: Provide the timestamp of a previous CSI backup.
• pullPolicy in image: Set toAlways.

To find thesnapshotTimestamp value to restore, run this command to get the list of available snapshots:

kubectl get volumesnapshot -nAPIGEE_NAMESPACE

pvc-us-west2-b-20220803004907-47beff0e306d8861

cassandra:hostNetwork:falsereplicaCount:3storage:storageclass:standard-rwocapacity:100Giimage:pullPolicy:Alwaysrestore:enabled:truesnapshotTimestamp:"20220908222130"cloudProvider:"CSI"image:pullPolicy:Always

If you have not previously used hybrid backup and restore, you can follow the instructions inSet up CSI backups to create a new CSI backups without the steps in this section. These steps guide you through migrating from the non-CSI backup and restore solution to CSI backups.

1. Generate a new backup using the currently configured non-CSI backup method.
2. Change the backup configuration in the hybridoverrides.yaml file to use the CSI backup overrides as shown in theexample backup config.
3. Apply the changes in theoverrides.yaml file:

   helm upgrade datastore apigee-datastore/ \  --namespaceAPIGEE_NAMESPACE \  --atomic \  -fOVERRIDES_FILE.yaml

   Note: If you see an error sayingError: UPGRADE FAILED: "datastore" has no deployed releases, replaceupgrade withinstall and try the command again.
4. Verify the backup job:

   kubectl get cronjob -nAPIGEE_NAMESPACE

5. After a backup job completes, verify snapshots have been created. The number of generated snapshots should be equivalent to the number of Cassandra nodes in the Hybrid instance.

   kubectl get volumesnapshot -nAPIGEE_NAMESPACE