This page describes how to restore Cassandra in a single region.
In a single region deployment, Apigee hybrid is deployed in a single data center or a region. If you
have multiple Apigee organizations in your deployment, the restore process restores data for all the organizations.
In a multi-organization setup, you cannot restore a specific organization.
Restoring a region from a backup
Update the Cassandra restore details in the overrides.yaml file:
Namespace for restore. Use the same namespace as in your original cluster.
cassandra:hostNetwork
hostNetwork is required and should always be set to
false.
restore:enabled
Restore is disabled by default. You must set this
property to true.
restore:serviceAccountPath
SA_JSON_FILE_PATH
The path on your filesystem to the service account you created
for the backup.
restore:dbStorageBucket
CLOUD_STORAGE_BUCKET_NAME
The name of a Google Cloud Storage bucket that stores backup archives to be used
for data restoration.
restore:cloudProvider
GCP
The cloudProvider: "GCP" property is required.
restore:snapshotTimestamp
TIMESTAMP
The timestamp of the backup snapshot to restore. To check what timestamps can be used,
go to the dbStorageBucket and look at the files that are present in the
bucket. Each file name contains a timestamp value. For example,
backup_20210203213003_apigee-cassandra-default-0.tgz
Where 20210203213003 is the snapshotTimestamp value you would
use if you wanted to restore the backups created at that point in time.
backup:enabled
You should set this property to false in case it had been previously set
to true.
In case you do not have a clean cluster to start out with, follow the
Decommission a hybrid region for helm
documentation to bring your existing Hybrid installation into a clean state
(you can leave the Cert Manager installed). This would bring you to an equal state
as if you would have followed Helm runtime setup manual
until the beginning of Step 11.
Verify there are no pods remaining in the Apigee namespace:
kubectl get pods -n APIGEE_NAMESPACE
If you are using CSI backup, make sure that you can see
the volumesnapshots you want to use for the restoration process by running:
kubectl get volumesnapshot -n APIGEE_NAMESPACE
Install all Hybrid components one by one as described in
Step 10: Install Apigee hybrid using Helm . Note that the apigee-cassandra-restore pod will get
created once you run the command to install the datastore, but it will only
go into running state after you install the apigee-org component.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThis page details the process of restoring Cassandra in an Apigee hybrid single-region deployment, which impacts all organizations within that deployment.\u003c/p\u003e\n"],["\u003cp\u003eBefore initiating a restore, you may optionally preserve the existing setup for analysis by deleting \u003ccode\u003eorg\u003c/code\u003e and \u003ccode\u003eenv\u003c/code\u003e components while keeping the Apigee controller and Cassandra datastore, or you may completely decommission a region if you do not have a clean state to start out with.\u003c/p\u003e\n"],["\u003cp\u003eRestoring Cassandra involves updating the \u003ccode\u003eoverrides.yaml\u003c/code\u003e file with specific details like namespace, service account path, storage bucket, cloud provider, and snapshot timestamp, while ensuring backup is disabled.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eapigee-cassandra-restore\u003c/code\u003e pod will only go into a running state once the \u003ccode\u003eapigee-org\u003c/code\u003e component has been installed after the datastore component has been installed.\u003c/p\u003e\n"],["\u003cp\u003eAfter a successful restore and confirming the health of the runtime components, it is recommended that you configure the cluster for backups by removing the \u003ccode\u003erestore\u003c/code\u003e configurations and applying the \u003ccode\u003ebackup\u003c/code\u003e configurations.\u003c/p\u003e\n"]]],[],null,[]]