Scheduling backups in Cloud Storage

You are currently viewing version 1.11 of the Apigee hybrid documentation. For more information, see Supported versions.

Version 1.11 

   Supported versions:

• v1.13 (latest)                        
• v1.12                         
• v1.11                         
• List of supported versions

   Unsupported versions:

• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

This page describes how to schedule backups for Cassandra in Cloud Storage. In this method, backups are stored in the specified Cloud Storage bucket.

Note: After applying the backup configuration on the existing cluster, the Cassandra pods will restart one after another (rolling restart) from last to first.

To schedule Cassandra backups, perform the following steps:

1. Run the following create-service-account command to create a Google Cloud service account (SA) with the standard roles/storage.objectAdmin role. This SA role allows you to write backup data to Cloud Storage. E 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 named apigee-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, see Creating and managing service accounts.
2. The create-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.
3. Create a Cloud Storage bucket. Specify a reasonable data retention policy for the bucket. Apigee recommends a data retention policy of 15 days.
4. Open your overrides.yaml file.
5. Add the following cassandra.backup properties to enable backup. Do not remove any of the properties that are already configured.

   Parameters

   cassandra:
       ...
   
       backup:
         enabled: true
         serviceAccountPath: SA_JSON_FILE_PATH
         dbStorageBucket: CLOUD_STORAGE_BUCKET_PATH
         schedule: BACKUP_SCHEDULE_CODE
         cloudProvider: "GCP"  # For remote server backup set this to HYBRID (all caps)
   
       ...
       

   Example

     ...
   
     cassandra:
       storage:
         type: gcepd
         capacity: 50Gi
         gcepd:
           replicationType: regional-pd
       auth:
         default:
           password: "abc123"
         admin:
           password: "abc234"
         ddl:
           password: "abc345"
         dml:
           password: "abc456"
       nodeSelector:
         key: cloud.google.com/gke-nodepool
         value: apigee-data
       backup:
         enabled: true
         serviceAccountPath: "/Users/myhome/.ssh/my-cassandra-backup-sa.json"
         dbStorageBucket: "gs://myname-cassandra-backup"
         schedule: "45 23 * * 6"
         cloudProvider: "GCP"
         
   
   
       ... 

Where:

Property	Description
backup:enabled	Backup is disabled by default. You must set this property to true.
backup:serviceAccountPath	SA_JSON_FILE_PATH The path on your filesystem to the service account JSON file that was downloaded when you ran the create-service-account command. You can also provide a relative file path. The path will be relative to the hybrid-base-directory/hybrid-files directory.
backup:dbStorageBucket	CLOUD_STORAGE_BUCKET_PATH The Cloud Storage bucket path in this format: gs://BUCKET_NAME. The gs:// is required.
backup:cloudProvider	GCP/HYBRID For a Cloud Storage backup, set the property to GCP. For example, cloudProvider: "GCP". For a remote server backup, set the property to HYBRID. For example, cloudProvider: "HYBRID".
backup:schedule	BACKUP_SCHEDULE_CODE The time when the backup starts, specified in standard crontab syntax. Default: 0 2 * * * Note: Avoid scheduling a backup that starts a short time after you apply the backup configuration to your cluster. When you apply the backup configuration, Kubernetes recreates the Cassandra nodes. If the backup starts before the nodes restart, the first backup will fail and the subsequent backups will pass.

6. Apply the configuration changes to the new cluster. For example:

   Helm

   helm upgrade datastore apigee-datastore/ \
     --namespace apigee \
     --atomic \
     -f OVERRIDES_FILE.yaml
   

   Note: If you see an error saying Error: UPGRADE FAILED: "datastore" has no deployed releases, replace upgrade with install and try the command again.

   apigeectl

   $APIGEECTL_HOME/apigeectl apply -f OVERRIDES_FILE.yaml --datastore

   Where OVERRIDES_FILE is the path to the overrides file you just edited.

7. Verify the backup job. For example:

   kubectl get cronjob -n apigee

     NAME                      SCHEDULE     SUSPEND   ACTIVE   LAST SCHEDULE   AGE
     apigee-cassandra-backup   33 * * * *   False     0        <none>          94s

Launch a manual backup

Cassandra backups generate automatically according to the cron schedule set in the overrides.yaml file.

To initiate a manual backup, use this command:

kubectl create job -n APIGEE_NAMESPACE --from=cronjob/apigee-cassandra-backup BACKUP_POD_NAME