You are currently viewing version 1.9 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 without the Cloud Storage.In this method, backups are stored on a remote server specified by you instead of a Cloud Storage bucket. Apigee uses SSH to communicate with the remote server.

You must schedule the backups ascron jobs. Once a backup schedule has been applied to your hybrid cluster, a Kubernetes backup job is periodically executed according to the schedule in the runtime plane. The job triggers a backup script on each Cassandra node in your hybrid cluster that collects all the data on the node, creates an archive (compressed) file of the data, and sends the archive to the server specified in youroverrides.yaml file.

Note:

• You must ensure there is enough space on the file system for the backups, and adjust the frequency of the backups to avoid unnecessarily filling the allotted storage space. Apigee does not dictate a retention policy for the backup files. You may want to create a retention policy for files appropriate to your installation.
• Applying backup configuration on the existing cluster will rolling restart Cassandra pods.

The following steps include common examples for completing specific tasks, like creating an SSH key pair. Use the methods that are appropriate to your installation.

The procedure has the following parts:

• Set up the server and SSH
• Set the schedule and destination for backup

Set up the server and SSH

1. Designate a Linux or Unix server for your backups. This server must be reachable using SSH from your Apigee hybrid runtime plane. It must have enough storage for your backups.
2. Set up an SSH server on the server, or ensure that it has a secure SSH server configured.Caution: For security purposes, make sure your SSH server is up to date.
3. Create an SSH key pair and store the private key file in a path that is accessible from your hybrid runtime plane.You must use a blank password for your key pair or the backup will fail. For example:

   ssh-keygen-trsa-b4096-Cexampleuser@example.comEnterfileinwhichtosavethekey(/Users/exampleuser/.ssh/id_rsa):$APIGEE_HOME/hybrid-files/certs/ssh_keyEnterpassphrase(emptyfornopassphrase):Entersamepassphraseagain:Youridentificationhasbeensavedinssh_keyYourpublickeyhasbeensavedinssh_key.pubThekeyfingerprintis:SHA256:DWKo334XMZcZYLOLrd/8HNpjTERPJJ0mc11UYmrPvSAexampleuser@example.comThekey'srandomartimageis:+---[RSA 4096]----+|+.++X||..o.=.*+||.o..o==o||...=oo+o...||.S+Eoo.||.....o.||....o..||....o++.||....+o+.|+----[SHA256]-----+

   Where:exampleuser@example.com is a string. Any string that follows-C in thessh-keygen command becomes a comment included in the newly createdssh key. The input string can be any string. When you use an account name in the form ofexampleuser@example.com, you can quickly identify which account goes with the key.

4. Create a user account on the backup server with the nameapigee. Make sure the newapigee user has a home directory under/home.
5. On the backup server, create an.ssh directory in the new/home/apigee directory.
6. Copy the public key (ssh_key.pub in the previous example) into a file namedauthorized_keys in the new/home/apigee/.ssh directory. For example:

   cd /home/apigeemkdir .sshcd .sshvi authorized_keys

7. On your backup server, create a backup directory within the/home/apigee/ directory. The backup directory can be any directory as long as theapigee user has access to it. For example:

   cd /home/apigeemkdir cassandra-backup

8. Test the connection. You need to make sure that your Cassandra pods can connect to your backup server using SSH:
   1. Log into the shell of your Cassandra pod. For example:

      kubectl exec -it -n apigeeAPIGEE_CASSANDRA_DEFAULT_0 -- /bin/bash

      WhereAPIGEE_CASSANDRA_DEFAULT_0 is the name of a Cassandra pod. Change this to the name of the pod you want to connect from.

   2. Connect by SSH to your backup server, using the private SSH key mounted the Cassandra pod and server IP address:

      ssh -i /var/secrets/keys/key apigee@BACKUP_SERVER_IP

      Note: You may see a warning at this point saying your server's fingerprint is unrecognized and asks if you would like to continue. You can continue at that prompt and verify the SSH configuration.

Set the schedule and destination for backup

You set the schedule and destination for backups in youroverrides.yaml file.

1. Add the following parameters to youroverrides.yaml file:

   Parameters

   cassandra:backup:enabled:truekeyFile:"PATH_TO_PRIVATE_KEY_FILE"server:"BACKUP_SERVER_IP"storageDirectory:"/home/apigee/BACKUP_DIRECTORY"cloudProvider:"HYBRID"#requiredverbatim"HYBRID"(allcaps)schedule:"SCHEDULE"

   Example

   cassandra:backup:enabled:truekeyFile:"/Users/exampleuser/apigee-hybrid/hybrid-files/service-accounts/private.key"server:"34.56.78.90"storageDirectory:"/home/apigee/cassbackup"cloudProvider:"HYBRID"schedule:"0 2 * * *"

   Where:

   Property	Description
   backup:enabled	Backup is disabled by default. You must set this property totrue.
   backup:keyFile	PATH_TO_PRIVATE_KEY_FILE The path on your local file system to the SSH private key file (namedssh_key inthe step where you created the SSH key pair).
   backup:server	BACKUP_SERVER_IP The IP address of your backup server.
   backup:storageDirectory	BACKUP_DIRECTORY The name of the backup directory on your backup server. This must be a directory withinhome/apigee (the backup directory is namedcassandra_backup inthe step where you created the backup directory).
   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	SCHEDULE 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.

2. Useapigeectl to apply the backup configuration to the storage scope of your cluster:

   $APIGEECTL_HOME/apigeectl apply --datastore -fYOUR_OVERRIDES_FILE

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

3. Verify the backup job. For example:

   kubectl get cronjob -n apigee

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