本頁面說明如何在單一地區還原 Cassandra。
在單一地區部署時,Apigee hybrid 會部署在單一資料中心或地區。如果部署中有多個 Apigee 機構,還原程序會還原所有機構的資料。在多機構設定中,您無法還原特定機構。
從備份還原區域
請根據您在 Apigee Hybrid 中使用的管理工具,選擇下方適用的操作說明:
Helm
-
更新
overrides.yaml檔案中的 Cassandra 還原詳細資料: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 ...
其中:
屬性 說明 namespaceYOUR_RESTORE_NAMESPACE
還原作業的命名空間。使用與原始叢集相同的命名空間。
cassandra:hostNetworkhostNetwork是必要參數,應一律設為false。restore:enabled還原功能預設為停用。您必須將這個屬性設為 true。restore:serviceAccountPathSA_JSON_FILE_PATH
您為備份作業建立的服務帳戶在檔案系統中的路徑。
restore:dbStorageBucketCLOUD_STORAGE_BUCKET_PATH
備份資料儲存位置的 Cloud Storage 值區路徑,格式如下:
gs://BUCKET_NAME。必須使用gs://。restore:cloudProviderGCP必須使用
cloudProvider: "GCP"屬性。restore:snapshotTimestampTIMESTAMP
要還原的備份快照時間戳記。如要查看可使用的時間戳記,請前往
dbStorageBucket,查看值區中的檔案。每個檔案名稱都包含時間戳記值。例如:backup_20210203213003_apigee-cassandra-default-0.tgz其中 20210203213003 是您要使用
snapshotTimestamp值的時間點,以便還原當時建立的備份。backup:enabled如果先前已將這個屬性設為 true,則應將其設為false。 -
如果您沒有可用來開始的乾淨叢集,請按照停用 helm 的混合區域說明文件操作,將現有的混合安裝作業轉為乾淨狀態 (您可以保留已安裝的 Cert Manager)。這會讓您處於相同狀態,就像您遵循 Helm 執行階段設定手冊的說明,直到步驟 11 開始為止。
-
確認 Apigee 命名空間中沒有任何 Pod:
kubectl get pods -n apigeekubectl get pods -n apigee-system -
如果您使用 CSI 備份,請務必執行下列指令,確認您可以查看要用於還原程序的磁區快照:
kubectl get volumesnapshot -n apigee -
按照安裝手冊的步驟 11所述,逐一安裝所有 Hybrid 元件。請注意,執行指令安裝
datastore後,系統會建立apigee-cassandra-restorePod,但只有在安裝apigee-org元件後,系統才會進入running狀態。
如要進一步瞭解 Cassandra 備份與還原作業,請參閱「Cassandra 備份總覽」。
apigeectl
在您的設定中,Cassandra 備份可以位於 Cloud Storage 或遠端伺服器。無論是哪種情況,請按照下列步驟進行還原作業:
- 確認混合式版本。
請確認版本與儲存空間中建立備份檔案的版本相同。apigeectl version
- 請確認您要還原至的 Kubernetes 叢集沒有先前的 Apigee 混合式安裝作業。如果您要還原至現有叢集,請使用下列指令刪除現有的 Apigee 混合式安裝:
apigeectl delete -f overrides.yamlkubectl -n apigee get apigeedatastore,apigeeredis,apigeetelemetry,org,env,arc # The output should be empty.apigeectl delete --all -f overrides.yaml - 開啟
overrides.yaml檔案,並將restore屬性設為所需值:Cloud Storage
參數
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 serviceAccountPath: "SA_JSON_FILE_PATH" dbStorageBucket: "CLOUD_STORAGE_BUCKET_PATH" cloudProvider: "GCP" # required verbatim "GCP" (all caps) schedule: "SCHEDULE"
範例
namespace: apigee cassandra: hostNetwork: false ... restore: enabled: true serviceAccountPath: "/Users/myhome/.ssh/my_cassandra_backup.json" dbStorageBucket: "gs://myname-cassandra-backup" cloudProvider: "GCP" snapshotTimestamp: "20201001183903" ... backup: enabled: false serviceAccountPath: "/Users/myhome/.ssh/my_cassandra_backup.json" dbStorageBucket: "gs://myname-cassandra-backup" cloudProvider: "GCP" schedule: "0 2 * * *" ...
其中:
屬性 說明 namespaceYOUR_RESTORE_NAMESPACE
還原作業的命名空間。使用與原始叢集相同的命名空間。
cassandra:hostNetworkhostNetwork是必要參數,應一律設為false。restore:enabled還原功能預設為停用。您必須將這個屬性設為 true。restore:serviceAccountPathSA_JSON_FILE_PATH
您為備份作業建立的服務帳戶在檔案系統中的路徑。
restore:dbStorageBucketCLOUD_STORAGE_BUCKET_PATH
備份資料儲存位置的 Cloud Storage 值區路徑,格式如下:
gs://BUCKET_NAME。必須使用gs://。restore:cloudProviderGCP必須使用
cloudProvider: "GCP"屬性。restore:snapshotTimestampTIMESTAMP
要還原的備份快照時間戳記。如要查看可使用的時間戳記,請前往
dbStorageBucket,查看值區中的檔案。每個檔案名稱都包含時間戳記值。例如:backup_20210203213003_apigee-cassandra-default-0.tgz其中 20210203213003 是您要使用
snapshotTimestamp值的時間點,以便還原當時建立的備份。backup:enabled如果先前已將這個屬性設為 true,則應將其設為false。backup:serviceAccountPathSA_JSON_FILE_PATH
您在執行
./tools/create-service-account時下載的服務帳戶 JSON 檔案在檔案系統中的路徑backup:dbStorageBucketCLOUD_STORAGE_BUCKET_PATH
Cloud Storage 值區路徑格式如下:
gs://BUCKET_NAME。 必須使用gs://。backup:cloudProviderGCP必須使用
cloudProvider: "GCP"屬性。backup:scheduleSCHEDULE
備份作業開始的時間,以 標準 crontab 語法指定。預設值:
0 2 * * *非 Cloud Storage
參數
namespace: YOUR_RESTORE_NAMESPACE # Use the same namespace as in your original cluster. cassandra: hostNetwork: false ... restore: enabled: true keyFile: "PATH_TO_PRIVATE_KEY_FILE" server: "BACKUP_SERVER_IP" storageDirectory: "/home/apigee/BACKUP_DIRECTORY" cloudProvider: "HYBRID" # required verbatim "HYBRID" (all caps) snapshotTimestamp: "TIMESTAMP" ... backup: enabled: false keyFile: "PATH_TO_PRIVATE_KEY_FILE" server: "BACKUP_SERVER_IP" storageDirectory: "/home/apigee/BACKUP_DIRECTORY" cloudProvider: "HYBRID" # required verbatim "HYBRID" (all caps) schedule: "SCHEDULE"範例
namespace: apigee cassandra: hostNetwork: false ... restore: enabled: true keyFile: "/Users/exampleuser/apigee-hybrid/hybrid-files/service-accounts/private.key" server: "34.56.78.90" storageDirectory: "/home/apigee/cassbackup" cloudProvider: "HYBRID" snapshotTimestamp: "20201001183903" ... backup: enabled: false keyFile: "/Users/exampleuser/apigee-hybrid/hybrid-files/service-accounts/private.key" server: "34.56.78.90" storageDirectory: "/home/apigee/cassbackup" cloudProvider: "HYBRID" schedule: "0 2 * * *" ...其中:
屬性 說明 namespaceYOUR_RESTORE_NAMESPACE
還原作業的命名空間。使用與原始叢集相同的命名空間名稱。
cassandra:hostNetworkhostNetwork是必要參數,應一律設為false。restore:enabled還原功能預設為停用。您必須將這個屬性設為 true。restore:keyFilePATH_TO_PRIVATE_KEY_FILE
本機檔案系統中安全殼層私密金鑰檔案的路徑 (在建立安全殼層金鑰組的步驟中命名為
ssh_key)。restore:serverBACKUP_SERVER_IP
備份伺服器的 IP 位址。
restore:storageDirectoryBACKUP_DIRECTORY
備份伺服器上的備份目錄名稱。這個目錄必須位於
home/apigee中 (在建立備份目錄的步驟中,備份目錄的名稱為cassandra_backup)。restore:cloudProviderHYBRID必須使用
cloudProvider: "HYBRID"屬性。restore:snapshotTimestampTIMESTAMP
要還原的備份快照時間戳記。如要查看可使用的時間戳記,請前往
dbStorageBucket,查看值區中的檔案。每個檔案名稱都包含時間戳記值。例如:backup_20210203213003_apigee-cassandra-default-0.tgz其中 20210203213003 是您要用來還原在該時間點建立的備份的
snapshotTimestamp值。backup:enabled如果先前已將這個屬性設為 true,則應將其設為false。backup:keyFilePATH_TO_PRIVATE_KEY_FILE
本機檔案系統中安全殼層私密金鑰檔案的路徑 (在建立安全殼層金鑰組的步驟中命名為
ssh_key)。backup:serverBACKUP_SERVER_IP
備份伺服器的 IP 位址。
backup:storageDirectoryBACKUP_DIRECTORY
備份伺服器上的備份目錄名稱。這個目錄必須位於
home/apigee中 (在建立備份目錄的步驟中,備份目錄的名稱為cassandra_backup)。backup:cloudProviderHYBRID必須使用
cloudProvider: "HYBRID"屬性。backup:scheduleSCHEDULE
備份作業開始的時間,以 標準 crontab 語法指定。預設值:
0 2 * * * - 建立新的混合式執行階段部署作業。這會建立新的 Cassandra 叢集,並開始將備份資料還原至叢集:
${APIGEECTL_HOME}/apigeectl init -f overrides/overrides.yaml${APIGEECTL_HOME}/apigeectl check-ready -f overrides/overrides.yaml${APIGEECTL_HOME}/apigeectl apply -f overrides/overrides.yaml --restore${APIGEECTL_HOME}/apigeectl check-ready -f overrides/overrides.yaml
確認還原工作進度,並確認 apigeeds 和所有其他 Pod 都已啟用:
- 檢查
apigeeds:kubectl get apigeeds -n apigee
- 檢查所有其他 pod:
kubectl get pods -n apigee
在成功完成還原作業並確認執行階段元件運作正常後,建議您在叢集中設定備份:
- 從
overrides-restore.yaml檔案中移除restore設定。 - 將
backup設定新增至overrides-restore.yaml檔案。 - 使用下列指令套用
backup設定:Helm
helm upgrade datastore apigee-datastore/ \ --install \ --namespace apigee \ --atomic \ -f overrides.yaml
apigeectl./apigeectl apply -f ../overrides.yaml