8.2. CodeReady Workspaces インスタンスの SFTP バックアップサーバーへのバックアップ

手順

1. パスワード付きのrepo-passwordキーを含むシークレットを作成します。

   apiVersion: v1
   kind: Secret
   metadata:
     name: backup-encryption-password-secret
     namespace: eclipse-che
   type: Opaque
   stringData:
     repo-password: <password>

   Copy to Clipboard Toggle word wrap

   (CodeReady Workspaces Operator は、CodeReady Workspaces Operator がバックアップサーバーのこのカスタムオブジェクトから作成するバックアップリポジトリーに対してこのパスワードを設定します。)

   警告

   バックアップリポジトリーのパスワードは、バックアップデータの暗号化に使用されます。このパスワードを紛失すると、バックアップデータが失われます。

2. パスワードなしで SFTP サーバーにログインするための SSH 秘密鍵と ssh-privatekey キーを含む Secret(例 : ssh-key-secret) を作成します。

3. CheBackupServerConfiguration カスタムオブジェクトを作成します。

   apiVersion: org.eclipse.che/v1
   kind: CheBackupServerConfiguration
   metadata:
     name: backup-server-configuration
     namespace: openshift-workspaces
   spec: 

   1

   
     sftp:
       username: <username> 

   2

   
       hostname: <hostname> 

   3

   
       port: 1234 

   4

   
       repositoryPath: red-hat-codeready-workspaces-backups 

   5

   
       repositoryPasswordSecretRef: backup-encryption-password-secret 

   6

   
       sshKeySecretRef: ssh-key-secret 

   7

   Copy to Clipboard Toggle word wrap

   1

   セクションは 1 つだけ含める必要があります (sftpなど)。

   2

   SSH プロトコルを使用してログインするためのリモートサーバーのユーザー名。

   3

   リモートサーバーのホスト名。

   4

   SFTP サーバーが実行しているポートを指定する任意のプロパティー。デフォルト値は 22 です。

   5

   バックアップスナップショットが保存されるサーバー上の絶対パスまたは相対パス。

   6

   手順 1 で作成したシークレット。

   7

   手順 2 で作成したシークレット。

4. オプション:複数のバックアップサーバーを設定するには、各バックアップサーバーに個別の CheBackupServerConfiguration カスタムオブジェクトを作成します。

手順

1. CheClusterBackup カスタムオブジェクトを作成して、バックアップスナップショットを作成します。

   apiVersion: org.eclipse.che/v1
   kind: CheClusterBackup
   metadata:
     name: red-hat-codeready-workspaces-backup
     namespace: openshift-workspaces
   spec:
     backupServerConfigRef: backup-server-configuration 

   1

   
     useInternalBackupServer: false 

   2

   Copy to Clipboard Toggle word wrap

   1

   使用するバックアップサーバーを定義する CheBackupServerConfiguration オブジェクトの名前。

   2

   CodeReady Workspaces が管理する内部バックアップサーバーまたは管理者が管理する外部バックアップサーバー (SFTP、Amazon S3 または S3 API 互換ストレージ、または REST) を使用するように、このカスタムリソースを使用して Operator を設定します。

   ヒント

   CheClusterBackup カスタムオブジェクトの 名前 を再利用する場合は、まず同じ 名前 の既存のカスタムオブジェクトを削除します。コマンドラインで削除するには、oc を使用します。

   $ oc delete CheClusterBackup <name> -n openshift-workspaces

   Copy to Clipboard Toggle word wrap

2. CheClusterBackup カスタムオブジェクトの status セクションを読み取り、バックアッププロセスを確認します。以下に例を示します。

   status:
     message: 'Backup is in progress. Start time: <timestamp>' 

   1

   
     stage: Collecting CodeReady Workspaces installation data 

   2

   
     state: InProgress 

   3

   Copy to Clipboard Toggle word wrap

   1

   バックアッププロセスの最新状態の概要。

   2

   現段階のバックアッププロセス (人間が判読できる形式)。

   3

   バックアッププロセスの状態。InProgress または Succeeded または Failed。

   CodeReady Workspaces インスタンスは、状態 が Succeeded の場合にスナップショットでバックアップされます。

   status:
     ...
     message: >-
       Backup successfully finished at 2021-12-03 10:07:51.151090621 +0000 UTC
       m=+999.553272281 

   1

   
     snapshotId: 9f0adce2 

   2

   
     state: Succeeded 

   3

   Copy to Clipboard Toggle word wrap

   1

   バックアッププロセスの最新状態の概要。

   2

   作成されたバックアップスナップショットの ID。このフィールドは、state が Succeeded の場合にのみ表示されます。

   3

   バックアッププロセスの状態。Succeeded (または Failed).