5.17. OADP CLI プラグイン
5.17.1. OADP CLI プラグイン
OpenShift CLI (oc) 用の OpenShift API for Data Protection (OADP) コマンドラインインターフェイス (CLI) プラグインは、OpenShift Container Platform クラスターでのバックアップおよび復元操作を管理するための kubectl ネイティブインターフェイスを提供します。
このプラグインは oc oadp で利用可能で、クラスター管理者と非管理者両方のワークフローをサポートしています。管理者パースペクティブでは、Velero リソースを使用してクラスター全体のバックアップおよび復元操作を実行できます。これらのコマンドは、OADP CLI が管理者モードで設定されている場合に使用できます。
5.17.1.1. OADP CLI プラグインのインストール
OADP コマンドラインインターフェイス (CLI) プラグインは、OADP Operator がインストールされている場合、OpenShift Container Platform の Web コンソールの Command-line tools ページから利用できます。
前提条件
- OADP Operator がインストールされた OpenShift Container Platform クラスターにアクセスできる。
手順
- クラスターへのアクセス権を持つユーザーとして、OpenShift Container Platform の Web コンソールにログインします。
- ツールバーの ? アイコンをクリックし、Command-line tools を選択します。
-
お使いのオペレーティングシステムとアーキテクチャーに対応した
oc-oadpバイナリーをダウンロードします。 -
アーカイブを展開し、
oc-oadpバイナリーをPATHが通っているディレクトリディレクトリーに配置します。 インストールを確認します。
$ oc oadp version
5.17.1.2. OADP CLI プラグインのセットアップ
OADP コマンドラインインターフェイス (CLI) プラグインをインストールした後、セットアップコマンドを実行して、ユーザー権限を設定する必要があります。
セットアップコマンドは、クラスター全体の管理者権限を持っているかどうかを自動的に検出し、それに応じて CLI を設定します。CLI は、以下の 2 つのモードのいずれかで動作します。
- 管理者モード: クラスター全体の Velero バックアップおよび復元コマンドへのアクセスを提供します。
- 非管理者モード: namespace スコープのセルフサービスバックアップおよび復元コマンドへのアクセスを提供します。
前提条件
- OADP CLI プラグインがインストールされている。
-
oc loginコマンドを使用して、OpenShift Container Platform クラスターにログインしている。
手順
セットアップコマンドを実行して、権限を自動検出し、CLI を設定します。
$ oc oadp setupCLI は、すべての namespace に
backups.velero.ioリソースを作成できるかどうかを確認します。可能であれば、管理者モードが有効になります。可能でない場合は、非管理者モードが有効になります。設定は~/.config/velero/config.jsonに保存されます。権限変更後に CLI を再設定するには、
--forceフラグを付けてセットアップコマンドを実行します。$ oc oadp setup --force
検証
以下のコマンドを実行して、使用可能なコマンドが設定済みのモードと一致していることを確認します。
$ oc oadp --help注記OADP CLI コマンドは、名詞 - 動詞と動詞 - 名詞の両方の語順をサポートしています。たとえば、
oc oadp backup createとoc oadp create backupは同等です。
5.17.1.3. OADP CLI のクライアント設定コマンド
OADP コマンドラインインターフェイス (CLI) を使用すると、クライアント設定を表示および変更できます。設定は ~/.config/velero/config.json に保存されます。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインがインストールされている。
5.17.1.3.1. 現在の設定を表示するコマンド
現在のクライアント設定を表示するには、以下のコマンドを使用します。
$ oc oadp client config get5.17.1.3.2. 設定値を設定するコマンド
設定値を設定するには、以下のコマンドを使用します。
$ oc oadp client config set <key>=<value>各項目の説明:
<key>- 設定する設定のキーを指定します。
<value>- 設定のキーの値を指定します。
デフォルトの namespace を設定する例
$ oc oadp client config set namespace=openshift-adp5.17.1.4. OADP CLI のシェル補完の有効化
OADP のコマンドラインインターフェイス (CLI) を使用すると、コマンド自動補完のためのシェル補完スクリプトを生成およびインストールできます。
前提条件
- OADP CLI プラグインがインストールされている。
手順
シェル補完を有効にする方法を以下の中から 1 つ選択します。
現在のシェルにシェル補完を自動的にインストールするには、以下のコマンドを使用します。
$ oc oadp completion install [flags]表5.6 oc oadp completion install コマンドのフラグ フラグ 説明 --shell補完をインストールするシェルのタイプ。サポートされている値は、
bash、zsh、およびfishです。このフラグが指定されていない場合、現在のシェルは自動的に検出されます。zsh の補完をインストールする例
$ oc oadp completion install --shell zshシェルに補完スクリプトをインストールせずに生成するには、以下のコマンドを使用します。
$ oc oadp completion <shell_name>各項目の説明:
<shell_name>シェル名を指定します。サポートされている値は、
bash、zsh、fish、およびpowershellです。出力をファイルにリダイレクトすることも、直接 source することもできます。
bash 補完スクリプトの作成方法の例
$ oc oadp completion bash > /etc/bash_completion.d/oc-oadp
5.17.1.5. バックアップ管理コマンド
OADP コマンドラインインターフェイス (CLI) を使用すると、バックアップの作成、確認、詳細表示、ダウンロード、および削除を行うことができます。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインが管理者モードでインストールおよび設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。
5.17.1.5.1. バックアップ作成コマンド
クラスターリソースのバックアップを作成するには、以下のコマンドを使用します。
$ oc oadp backup create <backup_name> [flags]| フラグ | 説明 |
|---|---|
|
|
バックアップに含める namespace。デフォルト値は |
|
| バックアップから除外する namespace。 |
|
|
バックアップに含めるリソース。種類の名前 ( |
|
|
バックアップから除外するリソース。このフラグは、 |
|
| バックアップストレージロケーションの名前。 |
|
| 使用するボリュームスナップショットロケーション (複数可)。 |
|
| リソースをフィルタリングするためのラベルセレクター。 |
|
| ラベルセレクターの OR 条件による組み合わせ。 |
|
|
永続ボリューム (PV) のスナップショットを作成するかどうかを指定します。デフォルト値は |
|
| スナップショットデータをバックアップストレージロケーションに移動するかどうかを指定します。 |
|
| すべてのボリュームに対してファイルシステムバックアップを使用するかどうかを指定します。 |
|
| クラスタースコープのリソースを含めるかどうかを指定します。 |
|
|
バックアップの保存期間。デフォルト値は |
|
| Container Storage Interface (CSI) スナップショット作成のタイムアウト。 |
|
| 非同期プラグイン操作のタイムアウト。 |
|
| Kubernetes API サーバーへのリクエストのタイムアウト。 |
バックアップ作成コマンドの例
$ oc oadp backup create my-backup \
--include-namespaces my-namespace \
--snapshot-volumes \
--ttl 720h5.17.1.5.2. バックアップリスト表示コマンド
すべてのバックアップをリスト表示するには、以下のコマンドを使用します。
$ oc oadp backup get [<backup_name>] [flags]| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は、 |
5.17.1.5.3. バックアップ詳細表示コマンド
バックアップの詳細を表示するには、以下のコマンドを使用します。
$ oc oadp backup describe <backup_name> [flags]| フラグ | 説明 |
|---|---|
|
| 出力に追加の詳細情報を表示するかどうかを指定します。 |
5.17.1.5.4. バックアップログコマンド
バックアップのログを表示するには、以下のコマンドを使用します。
$ oc oadp backup logs <backup_name>5.17.1.5.5. バックアップダウンロードコマンド
バックアップの内容をダウンロードするには、以下のコマンドを使用します。
$ oc oadp backup download <backup_name> [flags]5.17.1.5.6. バックアップ削除コマンド
バックアップを削除するには、以下のコマンドを使用します。
$ oc oadp backup delete <backup_name> [flags]| フラグ | 説明 |
|---|---|
|
| 確認メッセージを表示せずに削除を確定するかどうかを指定します。 |
5.17.1.6. 復元管理コマンド
OADP コマンドラインインターフェイス (CLI) を使用すると、復元の作成、確認、詳細表示、および削除を行うことができます。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインが管理者モードでインストールおよび設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。 - 復元可能な完全なバックアップが存在する。
5.17.1.6.1. 復元作成コマンド
既存のバックアップから復元を作成するには、以下のコマンドを使用します。
$ oc oadp restore create <restore_name> [flags]| フラグ | 説明 |
|---|---|
|
| 復元元のバックアップの名前。 |
|
| 復元元のスケジュールの名前。このフラグは最新のバックアップを使用します。 |
|
|
復元に含める namespace。デフォルト値は |
|
| 復元から除外する namespace。 |
|
|
復元に含めるリソース。種類の名前 ( |
|
|
復元から除外するリソース。このフラグは、 |
|
| リソースをフィルタリングするためのラベルセレクター。 |
|
| ラベルセレクターの OR 条件による組み合わせ。 |
|
| クラスタースコープのリソースを含めるかどうかを指定します。 |
|
| スナップショットから永続ボリューム (PV) データを復元するかどうかを指定します。 |
|
| NodePort サービスポートの割り当てを保持するかどうかを指定します。 |
|
| 非同期プラグイン操作のタイムアウト。 |
|
| Kubernetes API サーバーへのリクエストのタイムアウト。 |
復元作成コマンドの例
$ oc oadp restore create my-restore \
--from-backup my-backup \
--include-namespaces my-namespace5.17.1.6.2. 復元リスト表示コマンド
すべての復元をリスト表示するには、以下のコマンドを使用します。
$ oc oadp restore get [<restore_name>] [flags]| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は、 |
5.17.1.6.3. 復元詳細表示コマンド
復元の詳細を表示するには、以下のコマンドを使用します。
$ oc oadp restore describe <restore_name> [flags]| フラグ | 説明 |
|---|---|
|
| 出力に追加の詳細情報を表示するかどうかを指定します。 |
5.17.1.6.4. 復元ログコマンド
復元のログを表示するには、以下のコマンドを使用します。
$ oc oadp restore logs <restore_name>5.17.1.6.5. 復元削除コマンド
復元を削除するには、以下のコマンドを使用します。
$ oc oadp restore delete <restore_name> [flags]| フラグ | 説明 |
|---|---|
|
| 確認メッセージを表示せずに削除を確定するかどうかを指定します。 |
5.17.1.7. スケジュール管理コマンド
OADP のコマンドラインインターフェイス (CLI) を使用すると、バックアップスケジュールの作成、確認、詳細表示、および削除を行うことができます。スケジュール機能は、cron 式を使用して、指定された間隔でバックアップの作成を自動化します。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインが管理者モードでインストールおよび設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。
5.17.1.7.1. スケジュール作成コマンド
バックアップスケジュールを作成するには、以下のコマンドを使用します。
$ oc oadp schedule create <schedule_name> [flags]| フラグ | 説明 |
|---|---|
|
|
スケジュールの cron 式。たとえば、毎日午前 1 時の場合は |
|
|
スケジュールするバックアップに含める namespace。デフォルト値は |
|
| スケジュールするバックアップから除外する namespace。 |
|
|
スケジュールするバックアップに含めるリソース。種類の名前 ( |
|
|
スケジュールするバックアップから除外するリソース。このフラグは、 |
|
| バックアップストレージロケーションの名前。 |
|
| 使用するボリュームスナップショットロケーション (複数可)。 |
|
| リソースをフィルタリングするためのラベルセレクター。 |
|
|
永続ボリューム (PV) のスナップショットを作成するかどうかを指定します。デフォルト値は |
|
| スナップショットデータをバックアップストレージロケーションに移動するかどうかを指定します。 |
|
| すべてのボリュームに対してファイルシステムバックアップを使用するかどうかを指定します。 |
|
| クラスタースコープのリソースを含めるかどうかを指定します。 |
|
|
バックアップの保存期間。デフォルト値は |
|
| Kubernetes API サーバーへのリクエストのタイムアウト。 |
スケジュール作成コマンドの例
$ oc oadp schedule create daily-backup \
--schedule "0 1 * * *" \
--include-namespaces my-namespace \
--ttl 720h5.17.1.7.2. スケジュールリスト表示コマンド
すべてのスケジュールをリスト表示するには、以下のコマンドを使用します。
$ oc oadp schedule get [<schedule_name>] [flags]| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は、 |
5.17.1.7.3. スケジュール詳細表示コマンド
スケジュールの詳細を表示するには、以下のコマンドを使用します。
$ oc oadp schedule describe <schedule_name>5.17.1.7.4. スケジュール削除コマンド
スケジュールを削除するには、以下のコマンドを使用します。
$ oc oadp schedule delete <schedule_name> [flags]| フラグ | 説明 |
|---|---|
|
| 確認メッセージを表示せずに削除を確定するかどうかを指定します。 |
5.17.1.8. バックアップストレージロケーション管理コマンド
OADP コマンドラインインターフェイス (CLI) を使用すると、バックアップストレージロケーション (BSL) の作成、確認、設定、および削除を行うことができます。バックアップストレージロケーションは、オブジェクトストレージバケットなど、バックアップデータが保存される場所を定義します。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインが管理者モードでインストールおよび設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。
5.17.1.8.1. バックアップストレージロケーション作成コマンド
バックアップストレージロケーションを作成するには、以下のコマンドを使用します。
$ oc oadp backup-location create <bsl_name> [flags]| フラグ | 説明 |
|---|---|
|
|
クラウドプロバイダーの名前。たとえば、 |
|
| オブジェクトストレージバケットの名前。 |
|
| バケット内のパスのプレフィックス。 |
|
|
プロバイダー認証情報のシークレットとキー。 |
|
|
プロバイダー固有の設定 ( |
|
| オブジェクトストレージからバックアップコンテンツを同期する頻度。 |
|
| Kubernetes API サーバーへのリクエストのタイムアウト。 |
バックアップストレージロケーション作成コマンドの例
$ oc oadp backup-location create my-bsl \
--provider aws \
--bucket my-velero-bucket \
--prefix velero \
--credential cloud-credentials=cloud5.17.1.8.2. バックアップストレージロケーションリスト表示コマンド
バックアップストレージロケーションをすべてリスト表示するには、以下のコマンドを使用します。
$ oc oadp backup-location get [<bsl_name>] [flags]| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は、 |
5.17.1.8.3. デフォルトのバックアップストレージロケーションコマンド
デフォルトのバックアップストレージロケーションを設定するには、以下のコマンドを使用します。
$ oc oadp backup-location set <bsl_name>5.17.1.8.4. バックアップストレージロケーション削除コマンド
バックアップストレージロケーションを削除するには、以下のコマンドを使用します。
$ oc oadp backup-location delete <bsl_name> [flags]| フラグ | 説明 |
|---|---|
|
| 確認メッセージを表示せずに削除を確定するかどうかを指定します。 |
5.17.1.9. ボリュームスナップショットロケーション管理コマンド
OADP コマンドラインインターフェイス (CLI) を使用すると、ボリュームスナップショットロケーション (VSL) の作成、確認、設定、および削除を行うことができます。ボリュームスナップショットロケーションは、永続ボリューム (PV) スナップショットが保存される場所を定義します。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインが管理者モードでインストールおよび設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。
5.17.1.9.1. ボリュームスナップショットロケーション作成コマンド
ボリュームスナップショットロケーションを作成するには、以下のコマンドを使用します。
$ oc oadp snapshot-location create <vsl_name> [flags]| フラグ | 説明 |
|---|---|
|
|
クラウドプロバイダーの名前。たとえば、 |
|
|
プロバイダー固有の設定 ( |
|
| Kubernetes API サーバーへのリクエストのタイムアウト。 |
ボリュームスナップショットロケーション作成コマンドの例
$ oc oadp snapshot-location create my-vsl \
--provider aws \
--config region=us-east-15.17.1.9.2. ボリュームスナップショットロケーションリスト表示コマンド
ボリュームスナップショットロケーションをすべてリスト表示するには、以下のコマンドを使用します。
$ oc oadp snapshot-location get [<vsl_name>] [flags]| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は、 |
5.17.1.9.3. デフォルトのボリュームスナップショットロケーションコマンド
デフォルトのボリュームスナップショットロケーションを設定するには、以下のコマンドを使用します。
$ oc oadp snapshot-location set <vsl_name>5.17.1.9.4. ボリュームスナップショットロケーション削除コマンド
ボリュームスナップショットロケーションを削除するには、以下のコマンドを使用します。
$ oc oadp snapshot-location delete <vsl_name> [flags]| フラグ | 説明 |
|---|---|
|
| 確認メッセージを表示せずに削除を確定するかどうかを指定します。 |
5.17.1.10. NonAdminBackupStorageLocation 承認リクエストコマンド
OADP Operator が nonAdmin.requireApprovalForBSL: true を使用して設定されている場合、非管理者ユーザーが NonAdminBackupStorageLocation (NABSL) オブジェクトを作成すると、承認リクエストがトリガーされます。OADP のコマンドラインインターフェイス (CLI) を使用すると、このリクエストの確認、詳細表示、承認、および拒否を行うことができます。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインが管理者モードでインストールおよび設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。 -
DataProtectionApplicationカスタムリソース (CR) が、nonAdmin.enable: trueおよびnonAdmin.requireApprovalForBSL: trueを使用して設定されている。
5.17.1.10.1. NABSL 承認リクエストリスト表示コマンド
保留中の NABSL 承認リクエストをすべてリスト表示するには、以下のコマンドを使用します。
$ oc oadp nabsl-request get [<request_name>] [flags]| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は、 |
出力には、リクエスト名、namespace、フェーズ、要求された NABSL 名、要求された namespace、および経過時間が表示されます。
5.17.1.10.2. NABSL 承認リクエスト詳細表示コマンド
承認リクエストの詳細 (要求されたバックアップストレージロケーションの指定を含む) を表示するには、以下のコマンドを使用します。
$ oc oadp nabsl-request describe <request_name>NABSL 名または完全な UUID のどちらかを使用してリクエストを指定できます。
5.17.1.10.3. NABSL 承認リクエスト承認コマンド
保留中のリクエストを承認し、コントローラーが対応する BackupStorageLocation オブジェクトを作成することを許可するには、以下のコマンドを使用します。
$ oc oadp nabsl-request approve <request_name> [flags]| フラグ | 説明 |
|---|---|
|
| 承認の理由。このフラグは任意です。 |
NABSL 名または完全な UUID のどちらかを使用してリクエストを指定できます。
NABSL 承認リクエスト承認コマンドの例
$ oc oadp nabsl-request approve user-test-bsl --reason "Approved for production use"5.17.1.10.4. NABSL 承認リクエスト拒否コマンド
保留中のリクエストを拒否し、バックアップストレージロケーションに関するユーザーのリクエストを拒否するには、以下のコマンドを使用します。
$ oc oadp nabsl-request reject <request_name> [flags]| フラグ | 説明 |
|---|---|
|
| 拒否の理由。このフラグは推奨されています。 |
NABSL 名または完全な UUID のどちらかを使用してリクエストを指定できます。
NABSL 承認リクエスト拒否コマンドの例
$ oc oadp nabsl-request reject user-test-bsl --reason "Invalid configuration"5.17.1.11. 診断データの収集
OADP コマンドラインインターフェイス (CLI) を使用すると、OADP インストールの診断情報を収集できます。must-gather コマンドは、OADP must-gather ツールを実行して、トラブルシューティングやサポートに必要なログとクラスターの状態に関する情報を収集します。
前提条件
- OADP CLI プラグインが管理者モードでインストールおよび設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。 -
ocCLI がインストールされており、PATHで利用できる状態になっている。
手順
OADP の診断情報を収集します。
$ oc oadp must-gather [flags]表5.27 oc oadp must-gather コマンドのフラグ フラグ 説明 --dest-dirmust-gather の出力を保存するディレクトリー。デフォルト値は
./must-gatherです。--request-timeout収集スクリプトのタイムアウト (
30sや1mなど)。--skip-tlsTransport Layer Security (TLS) の検証をスキップするかどうかを指定します。
must-gather コマンドの例
$ oc oadp must-gather --dest-dir=/tmp/oadp-diagnostics --request-timeout=1m
5.17.1.12. OADP Self-Service
管理者以外のユーザーは、OADP Self-Service を使用して、クラスター全体の管理者特権を必要とせずに、許可された namespace でバックアップおよび復元操作を実行できます。
この機能は、バックアップおよび復元操作に対する管理者の制御を維持しながら、セキュアなセルフサービス型データ保護を提供します。
OADP Self-Service を使用すると、以下のタスクを完了できます。
- namespace スコープのバックアップと復元を作成および管理する。
- バックアップと復元のステータスおよびログを表示する。
- ユーザーが所有するバケットと認証情報を使用して、専用のバックアップストレージロケーションを作成する。
5.17.1.12.1. 制限事項
- 非管理者ユーザーによるクラスターをまたぐ操作およびデータ移行はサポートされていません。
-
管理者以外のユーザーのボリュームスナップショットロケーション (VSL) はサポートされていません。クラスター管理者が
DataProtectionApplicationカスタムリソース (CR) で設定した VSL が使用されます。 - バックアップと復元の対象範囲は、コマンドが実行された namespace に限定されます。別の namespace を指定することはできません。
- クラスタースコープのリソースをバックアップまたは復元に含めることはできません。
-
ResourceModifiersとボリュームポリシーは、非管理者バックアップおよび復元操作ではサポートされていません。 -
NonAdminDownloadRequestオブジェクトを使用したログのバックアップおよび復元は、デフォルトのバックアップストレージロケーション (BSL) ではサポートされていません。ログにアクセスするには、NonAdminBackupStorageLocationオブジェクトを作成する必要があります。
ユーザーが OADP Self-Service を使用する前に、クラスター管理者が以下のタスクを完了する必要があります。
-
DataProtectionApplicationCR 仕様でnonAdmin.enable: trueを指定して OADP Operator をインストールおよび設定します。 - ユーザーアカウント、namespace、および namespace 管理者などの namespace 特権を作成します。
namespace 内の以下のリソースに対して、編集者ロールを付与します。
-
nonadminbackups.oadp.openshift.io -
nonadminrestores.oadp.openshift.io -
nonadminbackupstoragelocations.oadp.openshift.io -
nonadmindownloadrequests.oadp.openshift.io
-
-
必要に応じて、自身の namespace 用の
NonAdminBackupStorageLocationオブジェクトを作成します。
5.17.1.13. 非管理者バックアップ管理コマンド
OADP コマンドラインインターフェイス (CLI) を使用すると、自身の namespace 内で非管理者バックアップの作成、確認、詳細表示、および削除を行うことができます。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインが、非管理者モードでインストールおよび設定されている。
- OpenShift Container Platform クラスターにログインしており、現在の namespace コンテキストがバックアップ対象の namespace に設定されている。
-
自身の namespace に
nonadminbackups.oadp.openshift.ioの編集者ロールが付与されている。 -
自身の namespace に
NonAdminBackupStorageLocationオブジェクトが存在するか、oc oadp client config set default-nabsl=<name>コマンドを実行してデフォルトが設定されている。
5.17.1.13.1. 非管理者バックアップ作成コマンド
現在の namespace 内のリソースのバックアップを作成するには、以下のコマンドを使用します。
$ oc oadp nonadmin backup create <backup_name> [flags]| フラグ | 説明 |
|---|---|
|
|
使用する |
|
|
バックアップに含めるリソース。種類の名前 ( |
|
|
バックアップから除外するリソース。このフラグは、 |
|
| このラベルセレクターに一致するリソースのみをバックアップするように指定します。 |
|
|
|
|
|
バックアップがガベージコレクションされるまでの時間。デフォルト値は |
|
| Container Storage Interface (CSI) スナップショット作成のタイムアウト。 |
|
| 非同期プラグイン操作のタイムアウト。 |
|
| バックアップの一環として、永続ボリューム (PV) のスナップショットを作成するかどうかを指定します。 |
|
| スナップショットデータをバックアップストレージロケーションに移動するかどうかを指定します。 |
|
| すべてのボリュームに対して、デフォルトで Pod ボリュームのファイルシステムバックアップを使用するかどうかを指定します。 |
非管理者バックアップ作成コマンドの例
$ oc oadp nonadmin backup create my-backup \
--storage-location my-nabsl \
--include-resources deployments,services \
--selector app=myapp \
--snapshot-volumes \
--ttl 720hバックアップごとにストレージロケーションを指定する必要がないように、以下のコマンドを実行してデフォルトを設定します。
$ oc oadp client config set default-nabsl=<nabsl_name>5.17.1.13.2. 非管理者バックアップリスト表示コマンド
現在の namespace 内のバックアップをすべてリスト表示するには、以下のコマンドを使用します。
$ oc oadp nonadmin backup get [<backup_name>] [flags]| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は、 |
5.17.1.13.3. 非管理者バックアップ詳細表示コマンド
バックアップの詳細を表示するには、以下のコマンドを使用します。
$ oc oadp nonadmin backup describe <backup_name> [flags]| フラグ | 説明 |
|---|---|
|
| ボリュームスナップショット、リソースリスト、アイテム操作など、追加のバックアップ詳細を表示するかどうかを指定します。 |
|
| サーバーからバックアップの詳細を取得する際のタイムアウト時間。 |
5.17.1.13.4. 非管理者バックアップログコマンド
バックアップのログを表示するには、以下のコマンドを使用します。
$ oc oadp nonadmin backup logs <backup_name> [flags]| フラグ | 説明 |
|---|---|
|
| サーバーからログを取得する際のタイムアウト時間。 |
バックアップログは、NonAdminBackupStorageLocation オブジェクトを使用している場合にのみ利用可能です。デフォルトのクラスターバックアップストレージロケーションを使用するバックアップでは、ログは利用できません。
5.17.1.13.5. 非管理者バックアップ削除コマンド
1 つまたは複数のバックアップを削除するには、以下のコマンドを使用します。
$ oc oadp nonadmin backup delete [<backup_name>...] [flags]| フラグ | 説明 |
|---|---|
|
| 確認プロンプトをスキップしてすぐに削除するかどうかを指定します。 |
|
| 現在の namespace にあるすべてのバックアップを削除するかどうかを指定します。 |
バックアップの削除は、OADP の非管理者コントローラーによって非同期的に実行されます。
非管理者バックアップ削除コマンドの例
$ oc oadp nonadmin backup delete my-backup --confirm5.17.1.14. 非管理者復元管理コマンド
OADP コマンドラインインターフェイス (CLI) を使用すると、自身の namespace 内で非管理者復元の作成、確認、詳細表示、および削除を行うことができます。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインが、非管理者モードでインストールおよび設定されている。
- OpenShift Container Platform クラスターにログインしており、現在の namespace コンテキストが復元対象の namespace に設定されている。
-
自身の namespace に
nonadminrestores.oadp.openshift.ioの編集者ロールが付与されている。 - 復元元となる非管理者バックアップが完了している。
5.17.1.14.1. 非管理者復元作成コマンド
既存の非管理者バックアップから復元を作成するには、以下のコマンドを使用します。
$ oc oadp nonadmin restore create [<restore_name>] [flags]各項目の説明:
<restore_name>- 復元の名前を指定します。この値はオプションです。名前を入力しない場合は、自動的に名前が生成されます。
| フラグ | 説明 |
|---|---|
|
| 復元元の非管理者バックアップの名前。このフラグは必須です。 |
|
|
復元に含めるリソース。種類の名前 ( |
|
|
復元から除外するリソース。このフラグは、 |
|
| このラベルセレクターに一致するリソースだけを復元することを指定します。 |
|
|
|
|
| 非同期プラグイン操作のタイムアウト。 |
非管理者復元作成コマンドの例
$ oc oadp nonadmin restore create my-restore \
--backup-name my-backup \
--include-resources deployments,services \
--selector app=myapp5.17.1.14.2. 非管理者復元リスト表示コマンド
現在の namespace 内の復元をすべてリスト表示するには、以下のコマンドを使用します。
$ oc oadp nonadmin restore get [<restore_name>] [flags]各項目の説明:
<restore_name>- 復元の名前を指定します。この値はオプションです。
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は、 |
5.17.1.14.3. 非管理者復元詳細表示コマンド
復元の詳細を表示するには、以下のコマンドを使用します。
$ oc oadp nonadmin restore describe <restore_name> [flags]各項目の説明:
<restore_name>- 復元の名前を指定します。
| フラグ | 説明 |
|---|---|
|
| 追加の復元の詳細を表示するかどうかを指定します。 |
|
| サーバーから復元情報を取得する際のタイムアウト時間。 |
5.17.1.14.4. 非管理者復元ログコマンド
復元のログを表示するには、以下のコマンドを使用します。
$ oc oadp nonadmin restore logs <restore_name> [flags]各項目の説明:
<restore_name>- 復元の名前を指定します。
| フラグ | 説明 |
|---|---|
|
| サーバーからログを取得する際のタイムアウト時間。 |
復元ログは、NonAdminBackupStorageLocation オブジェクトを使用している場合にのみ利用可能です。デフォルトのクラスターバックアップストレージロケーションを使用するバックアップに関連付けられた復元では、ログは利用できません。
5.17.1.14.5. 非管理者復元削除コマンド
1 つまたは複数の復元を削除するには、以下のコマンドを使用します。
$ oc oadp nonadmin restore delete [<restore_name>...] [flags]各項目の説明:
<restore_name>- 復元の名前を指定します。複数の復元を指定できます。
| フラグ | 説明 |
|---|---|
|
| 確認プロンプトをスキップしてすぐに削除するかどうかを指定します。 |
|
| 現在の namespace 内の復元をすべて削除するかどうかを指定します。 |
復元の削除は、OADP の非管理者コントローラーによって非同期的に実行されます。
非管理者復元削除コマンドの例
$ oc oadp nonadmin restore delete my-restore --confirm5.17.1.15. NonAdminBackupStorageLocation 管理コマンド
OADP コマンドラインインターフェイス (CLI) を使用すると、自身の namespace 内で NonAdminBackupStorageLocation (NABSL) オブジェクトを作成および確認できます。NABSL は、ユーザーが所有および管理するオブジェクトストレージを使用して、バックアップデータの保存場所を定義します。
非管理者ユーザーによる作成後の NABSL の更新または削除はサポートされていません。
これらのコマンドを使用する前に、以下の条件が満たされていることを確認してください。
- OADP CLI プラグインが、非管理者モードでインストールおよび設定されている。
- OpenShift Container Platform クラスターにログインしており、現在の namespace コンテキストがターゲット namespace に設定されている。
-
自身の namespace に
nonadminbackupstoragelocations.oadp.openshift.ioの編集者ロールが付与されている。 -
自身の namespace に、オブジェクトストレージプロバイダーの認証情報を含む Kubernetes
Secretオブジェクトが存在する。
5.17.1.15.1. NonAdminBackupStorageLocation 作成コマンド
非管理者バックアップストレージロケーションを作成するには、以下のコマンドを使用します。
$ oc oadp nonadmin bsl create <bsl_name> [flags]各項目の説明:
<bsl_name>- バックアップストレージロケーションの名前を指定します。
| フラグ | 説明 |
|---|---|
|
|
ストレージプロバイダー ( |
|
| オブジェクトストレージバケットの名前。このフラグは必須です。 |
|
|
このロケーションの認証情報。 |
|
| バケット内のバックアップオブジェクトのプレフィックス。 |
|
| ストレージのリージョン。このフラグは、AWS などの一部のプロバイダーで必須です。 |
|
|
プロバイダー固有の追加設定。 |
クラスター管理者が requireApprovalForBSL パラメーターを有効にしている場合、管理者がリクエストを承認するまで NABSL は保留状態のままになります。
NABSL 作成コマンドの例
$ oc oadp nonadmin bsl create my-storage \
--provider aws \
--bucket my-velero-bucket \
--prefix velero-backups \
--credential cloud-credentials=cloud \
--region us-east-1バックアップストレージロケーション (BSL) を作成したら、バックアップごとにストレージロケーションを指定する必要がないように、以下のコマンドを実行してその BSL をデフォルトに設定します。
$ oc oadp client config set default-nabsl=<bsl_name>各項目の説明:
<bsl_name>- バックアップストレージロケーションの名前を指定します。
5.17.1.15.2. NonAdminBackupStorageLocation リスト表示コマンド
現在の namespace 内の非管理者バックアップストレージロケーションをすべてリスト表示するには、以下のコマンドを使用します。
$ oc oadp nonadmin bsl get [<bsl_name>] [flags]各項目の説明:
<bsl_name>- バックアップストレージロケーションの名前を指定します。この値はオプションです。
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は、 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}