単一リージョンでの復元

このページでは、単一リージョンで Cassandra を復元する方法について説明します。

単一リージョンのデプロイでは、Apigee ハイブリッドは単一のデータセンターまたはリージョンにデプロイされます。デプロイに複数の Apigee 組織がある場合、復元プロセスではすべての組織のデータが復元されます。複数組織の設定で、特定の組織を復元することはできません。

注: 単一リージョンの復元を開始する前に、前提条件となる次の手順が該当するかどうかを検討してください。

トラブルシューティングと根本原因分析（RCA）のために既存の設定を保持する場合は、Apigee コントローラを除くすべての org および env コンポーネントを Kubernetes クラスタから削除してから、クラスタを保持する必要があります。クラスタには、トラブルシューティングに使用できる既存の Apigee データストア（Cassandra）が含まれます。新しい Kubernetes クラスタを作成し、その新しいクラスタに Cassandra を復元します。
ハイブリッドインストールが複数の組織で設定されている場合は、単一のリージョンで復元を続行する前に、各組織のオーバーライドファイルを取得します。手順 3 で説明する復元構成を、いずれか 1 つのオーバーライドファイルに追加できます。他のオーバーライドファイルには復元構成を追加しないでください。

リージョンをバックアップから復元する

Apigee ハイブリッドに使用している管理ツールに応じて、以下の手順を選択してください。

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
...

ここで

プロパティ	説明
`namespace`	`YOUR_RESTORE_NAMESPACE` 復元用の名前空間。元のクラスタと同じ名前空間を使用します。
`cassandra:hostNetwork`	`hostNetwork` は必須で、必ず `false` に設定する必要があります。
`restore:enabled`	デフォルトでは、復元は無効になっています。このプロパティを `true` に設定する必要があります。
`restore:serviceAccountPath`	`SA_JSON_FILE_PATH` バックアップ用に作成したサービスアカウントへのファイルシステム上のパス。
`restore:dbStorageBucket`	`CLOUD_STORAGE_BUCKET_PATH` バックアップデータが保存されている Cloud Storage バケットのパス。形式は `gs://BUCKET_NAME` です。必ず `gs://` を付ける必要があります。
`restore:cloudProvider`	`GCP` `cloudProvider: "GCP"` プロパティは必須です。
`restore:snapshotTimestamp`	`TIMESTAMP` 復元するバックアップスナップショットのタイムスタンプ。使用できるタイムスタンプを確認するには、`dbStorageBucket` に移動し、バケット内にあるファイルを確認します。各ファイル名にはタイムスタンプの値が含まれます。例: `backup_20210203213003_apigee-cassandra-default-0.tgz` ここで、`20210203213003` は、その時点で作成されたバックアップを復元する場合に使用する `snapshotTimestamp` の値です。
`backup:enabled`	このプロパティが以前 `true` に設定されていた場合は、`false` に設定する必要があります。注: Helm を使用している場合は、復元時にバックアップを有効にしないでください。`apigeectl` を使用している場合、この設定は省略可能です。

最初からクリーンなクラスタがない場合は、Helm のハイブリッドリージョンを廃止するのドキュメントに沿って、既存の Hybrid インストールをクリーンな状態にします（Cert Manager はインストールしたままにできます）。これにより、ステップ 11 の開始まで Helm ランタイムの設定マニュアルに従った場合と同じ状態になります。

Apigee の名前空間に Pod が残っていないことを確認します。

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

CSI バックアップを使用している場合は、次のコマンドを実行して、復元プロセスで使用する volumesnapshots が表示されることを確認します。
```
kubectl get volumesnapshot -n apigee
          
```
インストールマニュアルのステップ 11 に記載されているように、すべての Hybrid コンポーネントを 1 つずつインストールします。datastore をインストールするコマンドを実行すると、apigee-cassandra-restore Pod が作成されますが、apigee-org コンポーネントをインストールした後にのみ running 状態になります。

重要: 移行したクラスタのすべての upgrade コマンドに対して、‑‑atomic フラグを省略します。

Cassandra のバックアップと復元について詳しくは、Cassandra のバックアップの概要をご覧ください。

`apigeectl`

構成では、Cassandra のバックアップを Cloud Storage とリモートサーバーのいずれかに配置できます。いずれの場合も、復元は次の手順を実施します。

ハイブリッドバージョンを確認します。
```
apigeectl version
```
バージョンが、ストレージにバックアップファイルを作成したバージョンと同じであることを確認します。
ヒント: 最初に --dry-run=true フラグを指定して、すべての apigeectl コマンドを実行し、apigeectl エラーがないか確認します。
復元先の Kubernetes クラスタに以前の Apigee ハイブリッドインストールが存在しないことを確認します。復元先が既存のクラスタの場合は、次のコマンドを使用して既存の Apigee ハイブリッドインストールを削除します。
```
apigeectl delete -f overrides.yaml
kubectl -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 * * *"
  ...

各要素の意味は次のとおりです。

プロパティ	説明
`namespace`	`YOUR_RESTORE_NAMESPACE` 復元用の名前空間。元のクラスタと同じ名前空間を使用します。
`cassandra:hostNetwork`	`hostNetwork` は必須で、必ず `false` に設定する必要があります。
`restore:enabled`	デフォルトでは、復元は無効になっています。このプロパティを `true` に設定する必要があります。
`restore:serviceAccountPath`	`SA_JSON_FILE_PATH` バックアップ用に作成したサービスアカウントへのファイルシステム上のパス。
`restore:dbStorageBucket`	`CLOUD_STORAGE_BUCKET_PATH` バックアップデータが保存されている Cloud Storage バケットのパス。形式は `gs://BUCKET_NAME` です。必ず `gs://` を付ける必要があります。
`restore:cloudProvider`	`GCP` `cloudProvider: "GCP"` プロパティは必須です。
`restore:snapshotTimestamp`	`TIMESTAMP` 復元するバックアップスナップショットのタイムスタンプ。使用できるタイムスタンプを確認するには、`dbStorageBucket` に移動し、バケット内にあるファイルを確認します。各ファイル名にはタイムスタンプの値が含まれます。例: `backup_20210203213003_apigee-cassandra-default-0.tgz` ここで、`20210203213003` は、その時点で作成されたバックアップを復元する場合に使用する `snapshotTimestamp` の値です。
`backup:enabled`	このプロパティが以前 `true` に設定されていた場合は、`false` に設定する必要があります。注: Helm を使用している場合は、復元時にバックアップを有効にしないでください。`apigeectl` を使用している場合、この設定は省略可能です。
`backup:serviceAccountPath`	`SA_JSON_FILE_PATH` `./tools/create-service-account` の実行時にダウンロードされたサービスアカウント JSON ファイルへのファイルシステム上のパス。
`backup:dbStorageBucket`	`CLOUD_STORAGE_BUCKET_PATH` Cloud Storage バケットのパス。形式は `gs://BUCKET_NAME` です。必ず `gs://` を付ける必要があります。
`backup:cloudProvider`	`GCP` `cloudProvider: "GCP"` プロパティは必須です。
`backup:schedule`	`SCHEDULE` バックアップの開始時刻。標準の crontab 構文で指定します。デフォルト: `0 2 * * *` 注: バックアップ構成をクラスタに適用した直後にバックアップを開始するようなスケジュールは設定しないでください。バックアップ構成を適用すると、Kubernetes によって Cassandra ノードが再作成されます。ノードが再起動する前にバックアップが開始すると、それが数分前であってもバックアップは失敗します。

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 * * *"
    ...

各要素の意味は次のとおりです。

プロパティ	説明
`namespace`	`YOUR_RESTORE_NAMESPACE` 復元用の名前空間。元のクラスタと同じ名前を持つ名前空間を使用します。
`cassandra:hostNetwork`	`hostNetwork` は必須で、必ず `false` に設定する必要があります。
`restore:enabled`	デフォルトでは、復元は無効になっています。このプロパティを `true` に設定する必要があります。
`restore:keyFile`	`PATH_TO_PRIVATE_KEY_FILE` ローカルファイルシステム上の SSH 秘密鍵ファイル（SSH 認証鍵ペアを作成した手順で `ssh_key` と名付けています）へのパス。
`restore:server`	`BACKUP_SERVER_IP` バックアップサーバーの IP アドレス。
`restore:storageDirectory`	`BACKUP_DIRECTORY` バックアップサーバー上のバックアップディレクトリの名前。これは、`home/apigee` 内のディレクトリにする必要があります（バックアップディレクトリを作成した手順でバックアップディレクトリに `cassandra_backup` という名前を付けています）。
`restore:cloudProvider`	`HYBRID` `cloudProvider: "HYBRID"` プロパティは必須です。
`restore:snapshotTimestamp`	`TIMESTAMP` 復元するバックアップスナップショットのタイムスタンプ。使用できるタイムスタンプを確認するには、`dbStorageBucket` に移動し、バケット内にあるファイルを確認します。各ファイル名にはタイムスタンプの値が含まれます。例: `backup_20210203213003_apigee-cassandra-default-0.tgz` ここで、`20210203213003` は、その時点で作成されたバックアップを復元する場合に使用する `snapshotTimestamp` の値です。
`backup:enabled`	このプロパティが以前 `true` に設定されていた場合は、`false` に設定する必要があります。注: Helm を使用している場合は、復元時にバックアップを有効にしないでください。`apigeectl` を使用している場合、この設定は省略可能です。
`backup:keyFile`	`PATH_TO_PRIVATE_KEY_FILE` ローカルファイルシステム上の SSH 秘密鍵ファイル（SSH 認証鍵ペアを作成した手順で `ssh_key` と名付けています）へのパス。
`backup:server`	`BACKUP_SERVER_IP` バックアップサーバーの IP アドレス。
`backup:storageDirectory`	`BACKUP_DIRECTORY` バックアップサーバー上のバックアップディレクトリの名前。これは、`home/apigee` 内のディレクトリにする必要があります（バックアップディレクトリを作成した手順でバックアップディレクトリに `cassandra_backup` という名前を付けています）。
`backup:cloudProvider`	`HYBRID` `cloudProvider: "HYBRID"` プロパティは必須です。
`backup:schedule`	`SCHEDULE` バックアップの開始時刻。標準の crontab 構文で指定します。デフォルト: `0 2 * * *` 注: バックアップ構成をクラスタに適用した直後にバックアップを開始するようなスケジュールは設定しないでください。バックアップ構成を適用すると、Kubernetes によって Cassandra ノードが再作成されます。ノードが再起動する前にバックアップが開始すると、それが数分前であってもバックアップは失敗します。

注: Apigee では、overrides.yaml ファイル内の backup の構成に基づいて、Cloud Storage バックアップまたはリモートサーバーのバックアップから Cassandra が復元されます。

新しいハイブリッドランタイムデプロイを作成します。これにより、新しい 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