Restoring in a single region

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.

Note: Before you begin restoring a single region, consider whether the following prerequisite steps are applicable:

If you want to preserve an existing setup for troubleshooting and root cause analysis (RCA), you should delete all the org and env components from the Kubernetes cluster except the Apigee controller, and then retain the cluster. The cluster will contain the existing Apigee datastore (Cassandra) which you can use for troubleshooting. Create a new Kubernetes cluster and then restore Cassandra in the new cluster.
If your hybrid installation was set up with multiple organizations, get the overrides files for each organization before proceeding with restore in a single region. You can add the restore configuration as described in Step 3 to any one of the overrides files. Do not add the restore configuration to any other overrides file.

Restoring a region from a backup

Update the Cassandra restore details in the overrides.yaml file:

namespace: YOUR_RESTORE_NAMESPACE # Use the same namespace as in your original cluster.
cassandra:
  hostNetwork: false
...
restore:
  enabled: true
  serviceAccountPath: "SA_JSON_FILE_PATH"
  dbStorageBucket: "CLOUD_STORAGE_BUCKET_PATH"
  cloudProvider: "GCP"  # required verbatim "GCP" (all caps)
  snapshotTimestamp: "TIMESTAMP"
...
backup:
  enabled: false
...

Where:

Property	Description
`namespace`	`YOUR_RESTORE_NAMESPACE` 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_PATH` The Cloud Storage bucket path where your backup data is stored in the following format: `gs://BUCKET_NAME`. The `gs://` is required.
`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`. Note: Backup must not be enabled when restoring.

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 namespaces:

kubectl get pods -n apigee
kubectl get pods -n apigee-system

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
          
```
Install all Hybrid components one by one as described in Step 11 on the installation manual. 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.

Important: Omit the ‑‑atomic flag for all upgrade commands for migrated clusters.

See Cassandra backup overview for more details on Cassandra backup and restore.

Verify the restoration job progress and confirm that apigeeds and all the other pods are up:

Check apigeeds:
```
kubectl get apigeeds -n apigee
```
Check all other pods:
```
kubectl get pods -n apigee
```

Upon successful completion of the restore and confirmation that the runtime components are healthy, we recommend configuring a backup on the cluster:

Remove the restore configuration from the overrides-restore.yaml file.
Add the backup configuration to the overrides-restore.yaml file.

Apply the backup configuration with the following command:

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