Cloud Storage でのバックアップのスケジュール設定

このページでは、Cloud Storage で Cassandra のバックアップをスケジュールする方法について説明します。この方法では、バックアップは指定した Cloud Storage バケットに保存されます。

Cassandra のバックアップをスケジュールするには、次の手順を実施します。

  1. 次の create-service-account コマンドを実行して、標準の roles/storage.objectAdmin ロールを持つ Google Cloud サービス アカウント（SA）を作成します。この SA ロールを使用すると、バックアップ データを Cloud Storage に書き込むことができます。$APIGEE_HELM_CHARTS_HOME/apigee-operator/etc/ ディレクトリで次のコマンドを実行します。
    ./tools/create-service-account --env non-prod --dir ./

    このコマンドにより、非本番環境で使用する apigee-non-prod という名前の 1 つのサービス アカウントが作成され、ダウンロードしたキーファイルが ./ ディレクトリに配置されます。

    Google Cloud サービス アカウントの詳細については、サービス アカウントの作成と管理をご覧ください。

  2. create-service-account コマンドにより、サービス アカウントの秘密鍵を含む JSON ファイルが保存されます。このファイルは、コマンドを実行したのと同じディレクトリに保存されます。以降のステップでこのファイルのパスが必要になります。
  3. Cloud Storage バケットを作成します。バケットに適したデータ保持ポリシーを指定してください。15 日のデータ保持ポリシーを使用することをおすすめします。
  4. overrides.yaml ファイルを開きます。
  5. 次の cassandra.backup プロパティを追加してバックアップを有効にします。すでに構成されているプロパティは削除しないでください。

    パラメータ

    cassandra:
    ...

    backup:
      enabled: true
      serviceAccountPath: SA_JSON_FILE_PATH
      dbStorageBucket: CLOUD_STORAGE_BUCKET_PATH
      schedule: BACKUP_SCHEDULE_CODE
      cloudProvider: "GCP" # required verbatim "GCP" (all caps)

    ...

    例

      ...

  cassandra:
    storage:
      type: gcepd
      capacity: 50Gi
      gcepd:
        replicationType: regional-pd
    auth:
      default:
        password: "abc123"
      admin:
        password: "abc234"
      ddl:
        password: "abc345"
      dml:
        password: "abc456"
    nodeSelector:
      key: cloud.google.com/gke-nodepool
      value: apigee-data
    backup:
      enabled: true
      serviceAccountPath: "/Users/myhome/.ssh/my-cassandra-backup-sa.json"
      dbStorageBucket: "gs://myname-cassandra-backup"
      schedule: "45 23 * * 6"
      cloudProvider: "GCP"
      


    ...
    6. ここで
    プロパティ 説明
    backup:enabled バックアップはデフォルトでは無効になっています。このプロパティを true に設定する必要があります。
    backup:serviceAccountPath

    SA_JSON_FILE_PATH

    create-service-account コマンドを実行したときにダウンロードされたサービス アカウント JSON ファイルへのファイル システム上のパス。

    パスは、apigee-datastore チャート ディレクトリからの相対パスにする必要があります。例: serviceAccountPath: myproject-apigee-cassandra.json

    backup:dbStorageBucket

    CLOUD_STORAGE_BUCKET_PATH

    Cloud Storage バケットのパス。形式は gs://BUCKET_NAME です。必ず gs:// を付ける必要があります。
    backup:cloudProvider

    GCP

    Cloud Storage へのバックアップの場合は、プロパティを GCP に設定します。

    backup:schedule

    BACKUP_SCHEDULE_CODE

    バックアップの開始時刻。標準の crontab 構文で指定します。デフォルト: 0 2 * * *
  6. 構成の変更を新しいクラスタに適用します。次に例を示します。
    helm upgrade datastore apigee-datastore/ \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f OVERRIDES_FILE.yaml

    ここで、OVERRIDES_FILE は、先ほど編集したオーバーライド ファイルのパスです。

  7. バックアップ ジョブを確認します。次に例を示します。
    kubectl get cronjob -n APIGEE_NAMESPACE
     
      NAME                      SCHEDULE     SUSPEND   ACTIVE   LAST SCHEDULE   AGE
  apigee-cassandra-backup   33 * * * *   False     0        <none>          94s

手動バックアップを開始する

バックアップ ジョブは、overrides.yaml ファイルの cassandra.backup.schedule で設定された cron スケジュールに従って自動的にトリガーされます。ただし、必要に応じて、次のコマンドを使用してバックアップ ジョブを手動で開始することもできます。

kubectl create job -n APIGEE_NAMESPACE --from=cronjob/apigee-cassandra-backup MANUAL_BACKUP_JOB_NAME

ここで、MANUAL_BACKUP_JOB_NAME は作成する手動バックアップ ジョブの名前です。