You are currently viewing version 1.6 of the Apigee hybrid documentation.This version is end of life. You should upgrade to a newer version. For more information, seeSupported versions.

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 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 thehybrid-base-directory/hybrid-files directory:

   ./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.
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 youroverrides.yaml file.
5. Add the followingcassandra.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:gcepdcapacity:50Gigcepd:replicationType:regional-pdauth:default:password:"abc123"admin:password:"abc234"ddl:password:"abc345"dml:password:"abc456"nodeSelector:key:cloud.google.com/gke-nodepoolvalue:apigee-databackup:enabled:trueserviceAccountPath:"/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 totrue.
backup:serviceAccountPath	SA_JSON_FILE_PATH The path on your filesystem to the service account JSON file that was downloaded when you ran the./tools/create-service-account command. You can also provide a relative file path. The path will be relative to thehybrid-base-directory/hybrid-files directory.
backup:dbStorageBucket	CLOUD_STORAGE_BUCKET_PATH The Cloud Storage bucket path in this format:gs://BUCKET_NAME. Thegs:// is required.
backup:cloudProvider	GCP/HYBRID For a Cloud Storage backup, set the property toGCP. For example,cloudProvider: "GCP". For a remote server backup, set the property toHYBRID. For example,cloudProvider: "HYBRID".
backup:schedule	BACKUP_SCHEDULE_CODE The time when the backup starts, specified instandard 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:

   $APIGEECTL_HOME/apigeectl apply --datastore -fYOUR_OVERRIDES_FILE

   WhereYOUR_OVERRIDES_FILE is the path to the overrides file you just edited.

7. Verify the backup job. For example:

   kubectl get cronjob -n apigee

   NAMESCHEDULESUSPENDACTIVELASTSCHEDULEAGEapigee-cassandra-backup33****False0        <none>94s