第5章 コントロールプレーンのバックアップおよび復元

手順

1. 次の内容で、enable-tech-preview-no-upgrade.yaml という名前の FeatureGate カスタムリソース (CR) ファイルを作成します。

   apiVersion: config.openshift.io/v1
   kind: FeatureGate
   metadata:
     name: cluster
   spec:
     featureSet: TechPreviewNoUpgrade

2. CR を適用し、自動バックアップを有効にします。

   $ oc apply -f enable-tech-preview-no-upgrade.yaml

3. 関連する API を有効にするのに時間がかかります。次のコマンドを実行して、カスタムリソース定義 (CRD) が作成されたことを確認します。

   $ oc get crd | grep backup

   出力例

   backups.config.openshift.io 2023-10-25T13:32:43Z
   etcdbackups.operator.openshift.io 2023-10-25T13:32:04Z

手順

1. 次の例のような内容で、etcd-single-backup.yaml という名前の CR ファイルを作成します。

   apiVersion: operator.openshift.io/v1alpha1
   kind: EtcdBackup
   metadata:
     name: etcd-single-backup
     namespace: openshift-etcd
   spec:
     pvcName: etcd-backup-pvc 1

   1

   バックアップを保存する永続ボリューム要求 (PVC) の名前。この値は、使用している環境に応じて調整してください。

2. CR を適用してシングルバックアップを開始します。

   $ oc apply -f etcd-single-backup.yaml

手順

1. 動的にプロビジョニングされたストレージが利用可能な場合は、次の手順を実行して、自動化された繰り返しバックアップを作成します。

   1. 次の例のような内容で、etcd-backup-pvc.yaml という名前の永続ボリューム要求 (PVC) を作成します。

      kind: PersistentVolumeClaim
      apiVersion: v1
      metadata:
        name: etcd-backup-pvc
        namespace: openshift-etcd
      spec:
        accessModes:
          - ReadWriteOnce
        resources:
          requests:
            storage: 200Gi 1
        storageClassName: standard-csi 2
        volumeMode: Filesystem

      1

      PVC に利用できるストレージの量。この値は、要件に合わせて調整します。

      2

      要求で必要な StorageClass の名前。この値は、使用している環境に応じて調整してください。

      注記

      次の各プロバイダーでは、accessModes キーと storageClassName キーを変更する必要があります。

      Provider	accessModes 値	storageClassName 値
      versioned-installer-efc_operator-ci プロファイルを持つ AWS	- ReadWriteMany	efs-sc
      Google Cloud Platform	- ReadWriteMany	filestore-csi
      Microsoft Azure	- ReadWriteMany	azurefile-csi

   2. 以下のコマンドを実行して PVC を適用します。

      $ oc apply -f etcd-backup-pvc.yaml

   3. 次のコマンドを実行して、PVC が作成されたことを確認します。

      $ oc get pvc

      出力例

      NAME              STATUS    VOLUME   CAPACITY   ACCESS MODES   STORAGECLASS   AGE
      etcd-backup-pvc   Pending                                      standard-csi   51s

      注記

      動的 PVC は、マウントされるまで Pending 状態から遷移しません。

2. 動的にプロビジョニングされたストレージが使用できない場合は、次の手順を実行してローカルストレージ PVC を作成します。

   警告

   保存されているバックアップデータが格納されたノードを削除するか、該当ノードへのアクセスを失うと、データが失われる可能性があります。

   1. 次の内容で、etcd-backup-local-storage.yaml という名前の StorageClass CR ファイルを作成します。

      apiVersion: storage.k8s.io/v1
      kind: StorageClass
      metadata:
        name: etcd-backup-local-storage
      provisioner: kubernetes.io/no-provisioner
      volumeBindingMode: WaitForFirstConsumer

   2. 次のコマンドを実行して、StorageClass CR を適用します。

      $ oc apply -f etcd-backup-local-storage.yaml

   3. 適用された StorageClass から、次の例のような内容で etcd-backup-pv-fs.yaml という名前の PV を作成します。

      apiVersion: v1
      kind: PersistentVolume
      metadata:
        name: etcd-backup-pv-fs
      spec:
        capacity:
          storage: 100Gi 1
        volumeMode: Filesystem
        accessModes:
        - ReadWriteMany
        persistentVolumeReclaimPolicy: Delete
        storageClassName: local-storage
        local:
          path: /mnt/
        nodeAffinity:
          required:
            nodeSelectorTerms:
            - matchExpressions:
              - key: kubernetes.io/hostname
                operator: In
                values:
                - <example-master-node> 2

      1

      PV が使用できるストレージの量。この値は、要件に合わせて調整します。

      2

      この値は、この PV を割り当てるノードに置き換えます。

      ヒント

      次のコマンドを実行して、使用可能なノードのリストを表示します。

      $ oc get nodes

   4. 次のコマンドを実行して、PV が作成されたことを確認します。

      $ oc get pv

      出力例

      NAME                    CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS      CLAIM   STORAGECLASS    REASON   AGE
      etcd-backup-pv-fs       100Gi      RWX            Delete           Available           local-storage            10s

   5. 次の例のような内容で、etcd-backup-pvc.yaml という名前の PVC を作成します。

      kind: PersistentVolumeClaim
      apiVersion: v1
      metadata:
        name: etcd-backup-pvc
      spec:
        accessModes:
        - ReadWriteMany
        volumeMode: Filesystem
        resources:
          requests:
            storage: 10Gi 1
        storageClassName: local-storage

      1

      PVC に利用できるストレージの量。この値は、要件に合わせて調整します。

   6. 以下のコマンドを実行して PVC を適用します。

      $ oc apply -f etcd-backup-pvc.yaml

3. etcd-recurring-backups.yaml という名前のカスタムリソース定義 (CRD) ファイルを作成します。作成された CRD の内容は、自動化されたバックアップのスケジュールと保持タイプを定義します。

   15 個のバックアップを保持する RetentionNumber のデフォルトの保持タイプでは、次の例のような内容を使用します。

   apiVersion: config.openshift.io/v1alpha1
   kind: Backup
   metadata:
     name: etcd-recurring-backup
   spec:
     etcd:
       schedule: "20 4 * * *" 1
       timeZone: "UTC"
       pvcName: etcd-backup-pvc

   1

   定期的なバックアップの CronTab スケジュール。この値は、必要に応じて調整します。

   バックアップの最大数に基づいて保持を使用するには、次のキーと値のペアを etcd キーに追加します。

   spec:
     etcd:
       retentionPolicy:
         retentionType: RetentionNumber 1
         retentionNumber:
           maxNumberOfBackups: 5 2

   1

   保持タイプ。指定しない場合、デフォルトは RetentionNumber です。

   2

   保持するバックアップの最大数。この値は、必要に応じて調整します。指定しない場合、デフォルトは 15 個のバックアップです。

   警告

   既知の問題により、保持されるバックアップの数が設定された値に 1 を加えた数になります。

   バックアップのファイルサイズに基いて保持する場合は、以下を使用します。

   spec:
     etcd:
       retentionPolicy:
         retentionType: RetentionSize
         retentionSize:
           maxSizeOfBackupsGb: 20 1

   1

   保持するバックアップの最大ファイルサイズ (ギガバイト単位)。この値は、必要に応じて調整します。指定しない場合、デフォルトは 10 GB になります。

   警告

   既知の問題により、保持されるバックアップの最大サイズが設定値より最大 10 GB 大きくなります。

4. 次のコマンドを実行して、CRD で定義される cron ジョブを作成します。

   $ oc create -f etcd-recurring-backup.yaml

5. 作成された cron ジョブを検索するには、次のコマンドを実行します。

   $ oc get cronjob -n openshift-etcd