This page describes how to schedule backups for Cassandra in Cloud Storage. In this method, backups are stored in the specified Cloud Storage bucket.
To schedule Cassandra backups, perform the following steps:
- Run the following
create-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. For more information about Google Cloud service accounts, see Creating and managing service accounts. - 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. - Create a Cloud Storage bucket. Specify a reasonable data retention policy for the bucket. Apigee recommends a data retention policy of 15 days.
- Open your
overrides.yaml
file. - 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:
- Apply the configuration changes to the new cluster. For example:
$APIGEECTL_HOME/apigeectl apply --datastore -f YOUR_OVERRIDES_FILE
Where YOUR_OVERRIDES_FILE is the path to the overrides file you just edited.
- 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
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 You can also provide a relative file path. The path will be relative
to the |
backup:dbStorageBucket |
CLOUD_STORAGE_BUCKET_PATH The Cloud Storage bucket path in this format: |
backup:cloudProvider |
For a Cloud Storage backup, set the property to For a remote server backup, set the property to |
backup:schedule |
BACKUP_SCHEDULE_CODE The time when the backup starts, specified in
standard crontab syntax. Default: |