リモートサーバーでのバックアップのスケジュール設定

このページでは、Cloud Storage を使用せずに Cassandra のバックアップをスケジュールする方法について説明します。この方法では、バックアップは Cloud Storage バケットではなく、ユーザーが指定したリモートサーバーに保存されます。Apigee は SSH を使用してリモートサーバーと通信します。

バックアップは cron ジョブとしてスケジュールする必要があります。バックアップスケジュールがハイブリッドクラスタに適用されると、ランタイムプレーンのスケジュールに従って Kubernetes バックアップジョブが定期的に実行されます。このジョブがハイブリッドクラスタ内の各 Cassandra ノードでトリガーするバックアップスクリプトにより、ノード上のすべてのデータが収集されてアーカイブ（圧縮）ファイルが作成され、overrides.yaml ファイルで指定されたサーバーに送信されます。

以下の手順には、SSH 認証鍵ペアの作成など、特定のタスクを完了するための一般的な例が含まれています。ご使用の環境に適した方法をお選びください。

このプロシージャは次のパートで構成されています。

サーバーと SSH を設定する
バックアップのスケジュールと宛先を設定する

サーバーと SSH を設定する

バックアップサーバーを選択する: バックアップ用に十分なストレージがある Linux サーバーまたは Unix サーバーを選択し、Apigee ハイブリッドランタイムプレーンから SSH 経由でアクセスできることを確認します。
SSH サーバーを構成する: SSH サーバーをインストールするか、既存の SSH サーバーが安全であることを確認します。

SSH 認証鍵ペアを作成する: パスフレーズなしで SSH 認証鍵ペアを生成します。次に例を示します。

ssh-keygen -t rsa -b 4096 -C exampleuser@example.com
  Enter file in which to save the key (/Users/exampleuser/.ssh/id_rsa): $APIGEE_HOME/hybrid-files/certs/ssh_key
  Enter passphrase (empty for no passphrase):
  Enter same passphrase again:
  Your identification has been saved in ssh_key
  Your public key has been saved in ssh_key.pub
  The key fingerprint is:
  SHA256:DWKo334XMZcZYLOLrd/8HNpjTERPJJ0mc11UYmrPvSA exampleuser@example.com
  The key's randomart image is:
  +---[RSA 4096]----+
  |          +.  ++X|
  |     .   . o.=.*+|
  |    . o . . o==o |
  |   . . . =oo+o...|
  |  .     S +E oo .|
  |   . .   .. . o .|
  |    . . .  . o.. |
  |     .  ...o ++. |
  |      .. .. +o+. |
  +----[SHA256]-----+

ここで、exampleuser@example.com は文字列です。ssh-keygen コマンドの -C に続く文字列はすべて、新しく作成された ssh キーに含まれるコメントになります。入力文字列には任意の文字列を指定できます。exampleuser@example.com の形式でアカウント名を使用すると、鍵に対応するアカウントをすばやく特定できます。

このコマンドは 2 つの SSH 認証鍵ファイルを生成します。これは、秘密鍵ファイル（ssh_key.rsa など）と公開鍵ファイル（ssh_key.pub など）です。

ランタイムプレーンがアクセスできる場所に秘密鍵を保存します。

ユーザーアカウントを追加する: バックアップサーバーで、/home/apigee にホームディレクトリを持つ apigee という名前のユーザーを作成します。新しい apigee ユーザーのホームディレクトリが /home の下にあることを確認します。
.ssh ディレクトリを設定する: バックアップサーバーで、/home/apigee/.ssh に .ssh ディレクトリを作成します。次に例を示します。
```
cd /home/apigee
      mkdir .ssh
      cd .ssh
      vi authorized_keys
```
公開鍵をインストールする: 公開鍵を /home/apigee/ ディレクトリ内の authorized_keys ファイルに配置します。バックアップディレクトリには、apigee ユーザーがアクセスできる任意のディレクトリを使用できます。ssh public key ファイルの内容をファイルに貼り付けます。
SSH アクセスを確認する: ローカルマシンまたはクラスタノードから接続をテストします。

ssh -i PATH_TO_PRIVATE_KEY_FILE apigee@BACKUP_SERVER_IP

バックアップのスケジュールと宛先を設定する

overrides.yaml ファイルでバックアップのスケジュールと宛先を設定します。

overrides.yaml ファイルに次のパラメータを追加します。

パラメータ

cassandra:
  backup:
    enabled: true
    keyFile: "PATH_TO_PRIVATE_KEY_FILE"
    server: "BACKUP_SERVER_IP"
    storageDirectory: "/home/apigee/BACKUP_DIRECTORY"
    cloudProvider: "HYBRID" # required verbatim "HYBRID" (all caps)
    schedule: "SCHEDULE"

例

cassandra:
  backup:
    enabled: true
    keyFile: "private.key" # path relative to apigee-datastore path
    server: "34.56.78.90"
    storageDirectory: "/home/apigee/cassbackup"
    cloudProvider: "HYBRID"
    schedule: "0 2 * * *"

ここで

プロパティ	説明
`backup:enabled`	バックアップはデフォルトでは無効になっています。このプロパティを `true` に設定する必要があります。
`backup:keyFile`	`PATH_TO_PRIVATE_KEY_FILE` ローカルファイルシステム上の SSH 秘密鍵ファイルへのパス（SSH 認証鍵ペアを作成した手順の `ssh_key`）。このパスは、`apigee-datastore` チャートディレクトリを基準にした相対パスにする必要があります。
`backup:server`	`BACKUP_SERVER_IP` バックアップサーバーの IP アドレス。
`backup:storageDirectory`	`BACKUP_DIRECTORY` バックアップサーバー上のバックアップディレクトリの名前。これは、`home/apigee` 内のディレクトリにする必要があります（バックアップディレクトリを作成したステップでバックアップディレクトリに `cassandra_backup` という名前を付けています）。
`backup:cloudProvider`	`GCP/HYBRID` Cloud Storage バックアップの場合は `GCP` に設定します。たとえば、`cloudProvider: "GCP"` です。リモートサーバーのバックアップの場合は、プロパティを `HYBRID` に設定します。たとえば、`cloudProvider: "HYBRID"` です。
`backup:schedule`	`SCHEDULE` バックアップの開始時刻。標準の crontab 構文で指定します。時刻は Kubernetes クラスタのローカルタイムゾーンで指定します。デフォルト: `0 2 * * *` 注: バックアップ構成をクラスタに適用した後、すぐにバックアップを開始するようなスケジュールは設定しないでください。バックアップ構成を適用すると、Kubernetes によって Cassandra ノードが再作成されます。ノードが再起動する前にバックアップが開始されると、最初のバックアップが失敗します（後続のバックアップは成功します）。

バックアップ構成をクラスタのストレージスコープに適用します。
```
helm upgrade datastore apigee-datastore/ \
  --namespace apigee \
  --atomic \
  -f OVERRIDES_FILE.yaml
```
注: 「Error: UPGRADE FAILED: "datastore" has no deployed releases」というエラーが表示された場合は、upgrade を install に置き換えて、コマンドを再度実行してみてください。
ここで、OVERRIDES_FILE は、先ほど編集したオーバーライドファイルのパスです。

バックアップジョブを確認します。次に例を示します。

kubectl get cronjob -n apigee

NAME                      SCHEDULE     SUSPEND   ACTIVE   LAST SCHEDULE   AGE
apigee-cassandra-backup   33 * * * *   False     0        <none>          94s

トラブルシューティング

Cassandra Pod から接続をテストします。Cassandra Pod が SSH を使用してバックアップサーバーに接続できることを確認する必要があります。
1. Cassandra Pod のシェルにログインします。次に例を示します。
```
kubectl exec -it -n apigee APIGEE_CASSANDRA_DEFAULT_0 -- /bin/bash
```
  ここで、APIGEE_CASSANDRA_DEFAULT_0 は Cassandra Pod の名前です。この名前を接続元の Pod の名前に変更します。
2. Cassandra Pod にマウントした SSH 秘密鍵とサーバーの IP アドレスを使用して、SSH でバックアップサーバーに接続します。
```
ssh -i /var/secrets/keys/key apigee@BACKUP_SERVER_IP
```
  注: この時点で、サーバーのフィンガープリントが認識されないという警告が表示され、続行するかどうか確認される場合があります。そのようなプロンプトが表示されたら操作を続行し、SSH の構成を確認します。
Cassandra Pod からリモートサーバーにアクセスできない場合は、リモートサーバーの SSH 構成を再度確認し、データストアのアップグレードが正常に終了したことを確認してください。
Cassandra が正しい秘密鍵を使用しているかどうかは、Cassandra Pod にログインしているときに次のコマンドを実行し、出力を作成した秘密鍵と比較することで確認できます。
```
cat /var/secrets/keys/key
```