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 として利用でき、クラスター管理者および非管理者ワークフローの両方をサポートします。Administrator パースペクティブは、Velero リソースを使用してクラスター全体のバックアップと復元操作を提供します。これらのコマンドは、OADP CLI が管理モードで設定されている場合に使用できます。
5.17.1.1. OADP CLI プラグインのインストール リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)プラグインは、OADP Operator のインストール時に、OpenShift Container Platform Web コンソールのコマンド ラインツール ページから利用できます。
前提条件
- 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)プラグインをインストールした後、セットアップコマンドを実行してユーザー権限用に設定する必要があります。
setup コマンドは、クラスター全体の管理者権限があるかどうかを自動的に検出し、それに応じて CLI を設定します。CLI は、次の 2 つのモードのいずれかで動作します。
- 管理モード: クラスター全体の Velero バックアップおよび復元コマンドへのアクセスを提供します。
- 管理者以外のモード: namespace スコープのセルフサービスバックアップおよび復元コマンドへのアクセスを提供します。
前提条件
- OADP CLI プラグインがインストールされている。
-
oc loginコマンドを使用して OpenShift Container Platform クラスターにログインしている。
手順
setup コマンドを実行して、パーミッションを自動検出し、CLI を設定します。
$ oc oadp setupCLI は、すべての namespace で
backups.velero.ioリソースを作成できるかどうかを確認します。可能であれば、管理モードが有効になります。それ以外の場合は、管理者以外のモードが有効になります。設定は~/.config/velero/config.jsonに保存されます。パーミッションの変更後に CLI を再設定するには、the-
forceフラグを指定して setup コマンドを実行します。$ oc oadp setup --force
検証
次のコマンドを実行して、使用可能なコマンドが設定されたモードと一致することを確認します。
$ oc oadp --help注記OADP CLI コマンドは、noun-verb と Verb-noun ordering の両方をサポートします。たとえば、
oc oadp backup createとoc oadp create backupは同等です。
5.17.1.3. OADP CLI クライアント設定コマンド リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、クライアント設定を表示および変更できます。設定は ~/.config/velero/config.json に保存されます。
5.17.1.3.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインがインストールされている。
5.17.1.3.2. 現在の設定表示コマンド リンクのコピーリンクがクリップボードにコピーされました!
現在のクライアント設定を表示するには、以下のコマンドを使用します。
$ oc oadp client config get
5.17.1.3.3. 設定値設定コマンド リンクのコピーリンクがクリップボードにコピーされました!
設定値を設定するには、以下のコマンドを使用します。
$ oc oadp client config set <key>=<value>
各項目の説明:
<key>- 設定する設定キーを指定します。
<value>- 設定キーの値を指定します。
デフォルトの namespace の設定例
$ oc oadp client config set namespace=openshift-adp
5.17.1.4. OADP CLI のシェル補完を有効にする リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、コマンドの自動補完のシェルスクリプトを生成してインストールできます。
前提条件
- OADP CLI プラグインがインストールされている。
手順
シェル補完を有効にするには、次のいずれかの方法を選択します。
現在のシェルでシェル補完を自動的にインストールするには、次のコマンドを使用します。
$ oc oadp completion install [flags]Expand 表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です。出力は、ファイルまたはソースに直接リダイレクトできます。
bash 補完スクリプトの作成例
$ oc oadp completion bash > /etc/bash_completion.d/oc-oadp
5.17.1.5. バックアップ管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、バックアップを作成、表示、説明、ダウンロード、および削除できます。
5.17.1.5.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインがインストールされており、管理モードに設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。
5.17.1.5.2. バックアップ作成コマンド リンクのコピーリンクがクリップボードにコピーされました!
クラスターリソースのバックアップを作成するには、次のコマンドを使用します。
$ oc oadp backup create <backup_name> [flags]
| フラグ | 説明 |
|---|---|
|
|
バックアップに含める namespace。デフォルト値は |
|
| バックアップから除外する namespace。 |
|
|
バックアップに含めるリソース。 |
|
|
バックアップから除外するリソース。このフラグは、the |
|
| 使用するバックアップストレージの場所の名前。 |
|
| 使用するボリュームスナップショットの場所または場所。 |
|
| リソースをフィルターするラベルセレクター。 |
|
| ラベルセレクターの OR の組み合わせ。 |
|
|
永続ボリューム(PV)のスナップショットを取得するかどうかを指定します。デフォルト値は |
|
| スナップショットデータをバックアップストレージの場所に移動するかどうかを指定します。 |
|
| すべてのボリュームにファイルシステムのバックアップを使用するかどうかを指定します。 |
|
| クラスタースコープのリソースを含めるかどうかを指定します。 |
|
|
バックアップ保持期間。デフォルト値は |
|
| Container Storage Interface (CSI)スナップショット作成のタイムアウト。 |
|
| 非同期プラグイン操作のタイムアウト。 |
|
| Kubernetes API サーバーへのリクエストのタイムアウト。 |
バックアップ作成コマンドの例
$ oc oadp backup create my-backup \
--include-namespaces my-namespace \
--snapshot-volumes \
--ttl 720h
5.17.1.5.3. backup listing コマンド リンクのコピーリンクがクリップボードにコピーされました!
すべてのバックアップを一覧表示するには、次のコマンドを使用します。
$ oc oadp backup get [<backup_name>] [flags]
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は |
5.17.1.5.4. バックアップの説明コマンド リンクのコピーリンクがクリップボードにコピーされました!
バックアップの詳細を表示するには、次のコマンドを使用します。
$ oc oadp backup describe <backup_name> [flags]
| フラグ | 説明 |
|---|---|
|
| 出力で追加の詳細を表示するかどうかを指定します。 |
5.17.1.5.5. backup logs コマンド リンクのコピーリンクがクリップボードにコピーされました!
バックアップのログを表示するには、次のコマンドを使用します。
$ oc oadp backup logs <backup_name>
5.17.1.5.6. バックアップダウンロードコマンド リンクのコピーリンクがクリップボードにコピーされました!
バックアップの内容をダウンロードするには、次のコマンドを使用します。
$ oc oadp backup download <backup_name> [flags]
5.17.1.5.7. バックアップの削除コマンド リンクのコピーリンクがクリップボードにコピーされました!
バックアップを削除するには、次のコマンドを使用します。
$ oc oadp backup delete <backup_name> [flags]
| フラグ | 説明 |
|---|---|
|
| プロンプトなしで削除を確認するかどうかを指定します。 |
5.17.1.6. 管理コマンドの復元 リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、復元を作成、表示、説明、および削除できます。
5.17.1.6.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインがインストールされており、管理モードに設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。 - 復元元となる完全なバックアップが存在します。
5.17.1.6.2. 復元作成コマンド リンクのコピーリンクがクリップボードにコピーされました!
既存のバックアップから復元を作成するには、次のコマンドを使用します。
$ oc oadp restore create <restore_name> [flags]
| フラグ | 説明 |
|---|---|
|
| 復元元のバックアップの名前。 |
|
| 復元元となるスケジュールの名前です。このフラグは最新のバックアップを使用します。 |
|
|
復元に含める namespace。デフォルト値は |
|
| 復元から除外する namespace。 |
|
|
復元に含めるリソース。 |
|
|
復元から除外するリソース。このフラグは、the |
|
| リソースをフィルターするラベルセレクター。 |
|
| ラベルセレクターの OR の組み合わせ。 |
|
| クラスタースコープのリソースを含めるかどうかを指定します。 |
|
| スナップショットから永続ボリューム(PV)データを復元するかどうかを指定します。 |
|
| NodePort サービスポートの割り当てを保持するかどうかを指定します。 |
|
| 非同期プラグイン操作のタイムアウト。 |
|
| Kubernetes API サーバーへのリクエストのタイムアウト。 |
復元作成コマンドの例
$ oc oadp restore create my-restore \
--from-backup my-backup \
--include-namespaces my-namespace
5.17.1.6.3. restore listing コマンド リンクのコピーリンクがクリップボードにコピーされました!
すべての復元を一覧表示するには、次のコマンドを使用します。
$ oc oadp restore get [<restore_name>] [flags]
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は |
5.17.1.6.4. restore description コマンド リンクのコピーリンクがクリップボードにコピーされました!
復元の詳細を表示するには、次のコマンドを使用します。
$ oc oadp restore describe <restore_name> [flags]
| フラグ | 説明 |
|---|---|
|
| 出力で追加の詳細を表示するかどうかを指定します。 |
5.17.1.6.5. Restore logs コマンド リンクのコピーリンクがクリップボードにコピーされました!
復元のログを表示するには、次のコマンドを使用します。
$ oc oadp restore logs <restore_name>
5.17.1.6.6. 復元削除コマンド リンクのコピーリンクがクリップボードにコピーされました!
復元を削除するには、次のコマンドを使用します。
$ oc oadp restore delete <restore_name> [flags]
| フラグ | 説明 |
|---|---|
|
| プロンプトなしで削除を確認するかどうかを指定します。 |
5.17.1.7. 管理コマンドのスケジュール リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、バックアップスケジュールを作成、表示、説明、および削除できます。スケジュールは、cron 式を使用して、指定された間隔でバックアップの作成を自動化します。
5.17.1.7.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインがインストールされており、管理モードに設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。
5.17.1.7.2. Schedule creation command リンクのコピーリンクがクリップボードにコピーされました!
バックアップスケジュールを作成するには、次のコマンドを使用します。
$ oc oadp schedule create <schedule_name> [flags]
| フラグ | 説明 |
|---|---|
|
|
スケジュールの cron 式。たとえば、dailly at 1 AM の場合は |
|
|
スケジュールされたバックアップに追加する namespace。デフォルト値は |
|
| スケジュールされたバックアップから除外する namespace。 |
|
|
スケジュールされたバックアップに含めるリソース。 |
|
|
スケジュールされたバックアップから除外するリソース。このフラグは、the |
|
| 使用するバックアップストレージの場所の名前。 |
|
| 使用するボリュームスナップショットの場所または場所。 |
|
| リソースをフィルターするラベルセレクター。 |
|
|
永続ボリューム(PV)のスナップショットを取得するかどうかを指定します。デフォルト値は |
|
| スナップショットデータをバックアップストレージの場所に移動するかどうかを指定します。 |
|
| すべてのボリュームにファイルシステムのバックアップを使用するかどうかを指定します。 |
|
| クラスタースコープのリソースを含めるかどうかを指定します。 |
|
|
バックアップ保持期間。デフォルト値は |
|
| Kubernetes API サーバーへのリクエストのタイムアウト。 |
スケジュール作成コマンドの例
$ oc oadp schedule create daily-backup \
--schedule "0 1 * * *" \
--include-namespaces my-namespace \
--ttl 720h
5.17.1.7.3. schedule listing コマンド リンクのコピーリンクがクリップボードにコピーされました!
すべてのスケジュールを一覧表示するには、以下のコマンドを使用します。
$ oc oadp schedule get [<schedule_name>] [flags]
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は |
5.17.1.7.4. schedule description コマンド リンクのコピーリンクがクリップボードにコピーされました!
スケジュールの詳細を表示するには、次のコマンドを使用します。
$ oc oadp schedule describe <schedule_name>
5.17.1.7.5. 削除のコマンドのスケジュール設定 リンクのコピーリンクがクリップボードにコピーされました!
スケジュールを削除するには、次のコマンドを使用します。
$ oc oadp schedule delete <schedule_name> [flags]
| フラグ | 説明 |
|---|---|
|
| プロンプトなしで削除を確認するかどうかを指定します。 |
5.17.1.8. バックアップストレージロケーション管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、バックアップストレージロケーション(BSL)を作成、表示、設定、および削除できます。バックアップストレージの場所は、オブジェクトストレージバケットなどのバックアップデータの保存場所を定義します。
5.17.1.8.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインがインストールされており、管理モードに設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。
5.17.1.8.2. バックアップストレージの場所の作成コマンド リンクのコピーリンクがクリップボードにコピーされました!
バックアップストレージの場所を作成するには、次のコマンドを使用します。
$ 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=cloud
5.17.1.8.3. backup storage location listing コマンド リンクのコピーリンクがクリップボードにコピーされました!
バックアップストレージの場所の一覧を表示するには、次のコマンドを使用します。
$ oc oadp backup-location get [<bsl_name>] [flags]
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は |
5.17.1.8.4. デフォルトのバックアップストレージの場所コマンド リンクのコピーリンクがクリップボードにコピーされました!
デフォルトのバックアップストレージの場所を設定するには、次のコマンドを使用します。
$ oc oadp backup-location set <bsl_name>
5.17.1.8.5. バックアップストレージの場所の削除コマンド リンクのコピーリンクがクリップボードにコピーされました!
バックアップストレージの場所を削除するには、次のコマンドを使用します。
$ oc oadp backup-location delete <bsl_name> [flags]
| フラグ | 説明 |
|---|---|
|
| プロンプトなしで削除を確認するかどうかを指定します。 |
5.17.1.9. ボリュームスナップショットのロケーション管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、ボリュームスナップショットの場所(VSL)を作成、表示、設定、および削除できます。ボリュームスナップショットの場所は、永続ボリューム(PV)スナップショットの保存先を定義します。
5.17.1.9.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインがインストールされており、管理モードに設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。
5.17.1.9.2. ボリュームスナップショットの場所の作成コマンド リンクのコピーリンクがクリップボードにコピーされました!
ボリュームスナップショットの場所を作成するには、以下のコマンドを使用します。
$ oc oadp snapshot-location create <vsl_name> [flags]
| フラグ | 説明 |
|---|---|
|
|
クラウドプロバイダーの名前( |
|
|
|
|
| Kubernetes API サーバーへのリクエストのタイムアウト。 |
ボリュームスナップショットの場所作成コマンドの例
$ oc oadp snapshot-location create my-vsl \
--provider aws \
--config region=us-east-1
5.17.1.9.3. volume snapshot location list コマンド リンクのコピーリンクがクリップボードにコピーされました!
すべてのボリュームスナップショットの場所を一覧表示するには、以下のコマンドを使用します。
$ oc oadp snapshot-location get [<vsl_name>] [flags]
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は |
5.17.1.9.4. デフォルトのボリュームスナップショットの場所コマンド リンクのコピーリンクがクリップボードにコピーされました!
デフォルトのボリュームスナップショットの場所を設定するには、以下のコマンドを使用します。
$ oc oadp snapshot-location set <vsl_name>
5.17.1.9.5. ボリュームスナップショットの場所の削除コマンド リンクのコピーリンクがクリップボードにコピーされました!
ボリュームスナップショットの場所を削除するには、以下のコマンドを使用します。
$ oc oadp snapshot-location delete <vsl_name> [flags]
| フラグ | 説明 |
|---|---|
|
| プロンプトなしで削除を確認するかどうかを指定します。 |
5.17.1.10. NonAdminBackupStorageLocation 承認ストラテジーコマンド リンクのコピーリンクがクリップボードにコピーされました!
OADP Operator が nonAdmin.requireApprovalForBSL: true で設定されている場合、NonAdminBackupStorageLocation (NABSL)オブジェクトを作成する管理者以外のユーザーは認可要求をトリガーします。OADP コマンドラインインターフェイス(CLI)を使用して、これらのリクエストを表示、説明、承認、および拒否できます。
5.17.1.10.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインがインストールされており、管理モードに設定されている。
-
cluster-admin権限を持つユーザーとして OpenShift Container Platform クラスターにログインしている。 -
DataProtectionApplicationカスタムリソース(CR)は、nonAdmin.enable: trueおよびnonAdmin.requireApprovalForBSL: trueで設定されます。
5.17.1.10.2. NABSL 認可要求のリストコマンド リンクのコピーリンクがクリップボードにコピーされました!
保留中の NABSL 承認要求の一覧を表示するには、次のコマンドを使用します。
$ oc oadp nabsl-request get [<request_name>] [flags]
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は |
出力には、要求名、namespace、フェーズ、要求された NABSL 名、要求された namespace、および経過時間が表示されます。
5.17.1.10.3. NABSL approval request description コマンド リンクのコピーリンクがクリップボードにコピーされました!
要求されたバックアップストレージの場所の指定など、承認要求の完全な情報を表示するには、次のコマンドを使用します。
$ oc oadp nabsl-request describe <request_name>
要求は、NABSL 名または完全な UUID のいずれかを使用して指定できます。
5.17.1.10.4. NABSL approval request approval コマンド リンクのコピーリンクがクリップボードにコピーされました!
保留中の要求を承認し、コントローラーが対応する 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.5. 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]Expand 表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 セルフサービス リンクのコピーリンクがクリップボードにコピーされました!
管理者以外のユーザーは、OADP のセルフサービスを使用して、クラスター全体の管理者権限を必要とせずに、承認された namespace でバックアップおよび復元操作を実行できます。
この機能は、バックアップと復元の操作に対する管理者制御を維持しつつ、安全なセルフサービスのデータ保護を提供します。
OADP セルフサービスを使用して、次のタスクを実行できます。
- namespace スコープのバックアップおよび復元を作成および管理します。
- バックアップおよび復元のステータスとログを表示します。
- ユーザーが所有するバケットと認証情報を使用して、専用のバックアップストレージの場所を作成します。
5.17.1.12.1. 制限 リンクのコピーリンクがクリップボードにコピーされました!
- 管理者以外のユーザーは、クラスター間の操作と移行はサポートされません。
-
管理者以外のボリュームスナップショットの場所(VSL)はサポートされていません。
DataProtectionApplicationカスタムリソース(CR)でクラスター管理者が設定する VSL が使用されます。 - バックアップと復元のスコープは、コマンドの実行元の namespace に限定されます。別の namespace は指定できません。
- クラスタースコープのリソースをバックアップまたは復元に含めることはできません。
-
ResourceModifiersとボリュームポリシーは、管理者以外のバックアップおよび復元操作ではサポートされません。 -
NonAdminDownloadRequestオブジェクトを使用したログのバックアップと復元は、デフォルトのバックアップストレージの場所(BSL)ではサポートされていません。ログにアクセスするには、NonAdminBackupStorageLocationオブジェクトを作成する必要があります。
5.17.1.12.2. 管理者以外のユーザーの前提条件 リンクのコピーリンクがクリップボードにコピーされました!
OADP セルフサービスを使用する前に、クラスター管理者は次のタスクを完了する必要があります。
-
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
-
-
必要に応じて、名前空間の
NonAdminBackupStorageLocationオブジェクトを作成します。
5.17.1.13. 管理者でないバックアップ管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、namespace 内の管理者以外のバックアップを作成、表示、説明、および削除できます。
5.17.1.13.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインが管理者以外のモードでインストールおよび設定されている。
- OpenShift Container Platform クラスターにログインし、現在の namespace コンテキストがバックアップする namespace に設定されている。
-
namespace に
nonadminbackups.oadp.openshift.ioのエディターロールがある。 -
NonAdminBackupStorageLocationオブジェクトが namespace に存在するか、またはoc oadp client config set default-nabsl=<name> コマンドを実行してデフォルトが設定されています。
5.17.1.13.2. 管理者でないバックアップ作成コマンド リンクのコピーリンクがクリップボードにコピーされました!
現在の namespace にリソースのバックアップを作成するには、次のコマンドを使用します。
$ oc oadp nonadmin backup create <backup_name> [flags]
| フラグ | 説明 |
|---|---|
|
|
使用する |
|
|
バックアップに含めるリソース。 |
|
|
バックアップから除外するリソース。このフラグは、the |
|
| このラベルセレクターに一致するリソースのみをバックアップするように指定します。 |
|
|
またはで区切られた、1 つ以上のラベルセレクターに一致するリソースをバックアップするかどう |
|
|
バックアップがガベージコレクションされる前の時間。デフォルト値は |
|
| 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.3. 管理者以外のバックアップリストコマンド リンクのコピーリンクがクリップボードにコピーされました!
現在の namespace のすべてのバックアップを一覧表示するには、次のコマンドを使用します。
$ oc oadp nonadmin backup get [<backup_name>] [flags]
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は |
5.17.1.13.4. 管理者でないバックアップの説明コマンド リンクのコピーリンクがクリップボードにコピーされました!
バックアップの詳細を表示するには、次のコマンドを使用します。
$ oc oadp nonadmin backup describe <backup_name> [flags]
| フラグ | 説明 |
|---|---|
|
| ボリュームスナップショット、リソースリスト、および項目操作など、追加のバックアップ詳細を表示するかどうかを指定します。 |
|
| サーバーからバックアップの詳細を取得する際のタイムアウト。 |
5.17.1.13.5. 管理者でないバックアップログコマンド リンクのコピーリンクがクリップボードにコピーされました!
バックアップのログを表示するには、次のコマンドを使用します。
$ oc oadp nonadmin backup logs <backup_name> [flags]
| フラグ | 説明 |
|---|---|
|
| サーバーからログを取得するためのタイムアウト。 |
バックアップログは、NonAdminBackupStorageLocation オブジェクトを使用する場合にのみ利用できます。デフォルトのクラスターのバックアップストレージの場所を使用するバックアップでは、ログは利用できません。
5.17.1.13.6. 管理者でないバックアップ削除コマンド リンクのコピーリンクがクリップボードにコピーされました!
1 つ以上のバックアップを削除するには、次のコマンドを使用します。
$ oc oadp nonadmin backup delete [<backup_name>...] [flags]
| フラグ | 説明 |
|---|---|
|
| 確認プロンプトをスキップして、すぐに削除するかどうかを指定します。 |
|
| 現在の namespace 内のすべてのバックアップを削除するかどうかを指定します。 |
バックアップの削除は、OADP の管理者でないコントローラーによって非同期に実行されます。
管理者でないバックアップ削除コマンドの例
$ oc oadp nonadmin backup delete my-backup --confirm
5.17.1.14. 管理者以外の復元管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、namespace で非管理者復元を作成、表示、説明、および削除できます。
5.17.1.14.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインが管理者以外のモードでインストールおよび設定されている。
- OpenShift Container Platform クラスターにログインし、現在の namespace コンテキストが復元する namespace に設定されている。
-
namespace に
nonadminrestores.oadp.openshift.ioのエディターロールがある。 - 復元元となる管理者以外のバックアップが存在する。
5.17.1.14.2. 管理者以外の復元作成コマンド リンクのコピーリンクがクリップボードにコピーされました!
既存の非管理者バックアップから復元を作成するには、次のコマンドを使用します。
$ oc oadp nonadmin restore create [<restore_name>] [flags]
各項目の説明:
<restore_name>- 復元の名前を指定します。この値はオプションです。名前を指定しないと、名前が自動的に生成されます。
| フラグ | 説明 |
|---|---|
|
| 復元元となる管理者以外のバックアップの名前。このフラグは必須です。 |
|
|
復元に含めるリソース。 |
|
|
復元から除外するリソース。このフラグは、the |
|
| このラベルセレクターに一致するリソースのみが復元されることを指定します。 |
|
|
|
|
| 非同期プラグイン操作のタイムアウト。 |
管理者以外の復元作成コマンドの例
$ oc oadp nonadmin restore create my-restore \
--backup-name my-backup \
--include-resources deployments,services \
--selector app=myapp
5.17.1.14.3. 管理者以外の復元リストコマンド リンクのコピーリンクがクリップボードにコピーされました!
現在の名前空間内のすべての復元を一覧表示するには、次のコマンドを使用します。
$ oc oadp nonadmin restore get [<restore_name>] [flags]
各項目の説明:
<restore_name>- 復元の名前を指定します。この値はオプションです。
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は |
5.17.1.14.4. 管理者以外の復元の説明コマンド リンクのコピーリンクがクリップボードにコピーされました!
復元の詳細を表示するには、次のコマンドを使用します。
$ oc oadp nonadmin restore describe <restore_name> [flags]
各項目の説明:
<restore_name>- 復元の名前を指定します。
| フラグ | 説明 |
|---|---|
|
| 追加の復元の詳細を表示するかどうかを指定します。 |
|
| サーバーから復元詳細をフェッチするためのタイムアウト。 |
5.17.1.14.5. 管理者以外の restore logs コマンド リンクのコピーリンクがクリップボードにコピーされました!
復元のログを表示するには、次のコマンドを使用します。
$ oc oadp nonadmin restore logs <restore_name> [flags]
各項目の説明:
<restore_name>- 復元の名前を指定します。
| フラグ | 説明 |
|---|---|
|
| サーバーからログを取得するためのタイムアウト。 |
Restore ログは、NonAdminBackupStorageLocation オブジェクトを使用する場合にのみ利用できます。デフォルトのクラスターバックアップストレージの場所を使用するバックアップに関連付けられた復元には、ログは利用できません。
5.17.1.14.6. 管理者以外の復元削除コマンド リンクのコピーリンクがクリップボードにコピーされました!
1 つ以上の復元を削除するには、以下のコマンドを使用します。
$ oc oadp nonadmin restore delete [<restore_name>...] [flags]
各項目の説明:
<restore_name>- 復元の名前を指定します。複数の復元を指定できます。
| フラグ | 説明 |
|---|---|
|
| 確認プロンプトをスキップして、すぐに削除するかどうかを指定します。 |
|
| 現在の namespace のすべての復元を削除するかどうかを指定します。 |
復元の削除は、OADP 非管理者コントローラーによって非同期に実行されます。
管理者以外の復元削除コマンドの例
$ oc oadp nonadmin restore delete my-restore --confirm
5.17.1.15. NonAdminBackupStorageLocation 管理コマンド リンクのコピーリンクがクリップボードにコピーされました!
OADP コマンドラインインターフェイス(CLI)を使用して、namespace に NonAdminBackupStorageLocation (NABSL)オブジェクトを作成して表示できます。NABSLs は、所有し、管理するオブジェクトストレージを使用して、バックアップデータの保存先を定義します。
作成後の NABSL の更新または削除は、管理者以外のユーザーではサポートされません。
5.17.1.15.1. 前提条件 リンクのコピーリンクがクリップボードにコピーされました!
- OADP CLI プラグインが管理者以外のモードでインストールおよび設定されている。
- OpenShift Container Platform クラスターにログインし、現在の namespace コンテキストがターゲット namespace に設定されている。
-
namespace に
nonadminbackupstoragelocations.oadp.openshift.ioのエディターロールがある。 -
オブジェクトストレージプロバイダーの認証情報を含む namespace に Kubernetes
Secretオブジェクトがある。
5.17.1.15.2. NonAdminBackupStorageLocation 作成コマンド リンクのコピーリンクがクリップボードにコピーされました!
管理者のバックアップストレージの場所を作成するには、次のコマンドを使用します。
$ oc oadp nonadmin bsl create <bsl_name> [flags]
各項目の説明:
<bsl_name>- バックアップの保存場所の名前を指定します。
| フラグ | 説明 |
|---|---|
|
|
ストレージプロバイダー( |
|
| オブジェクトストレージバケットの名前。このフラグは必須です。 |
|
|
|
|
| バケットのバックアップオブジェクトの接頭辞。 |
|
| ストレージリージョン。このフラグは、AWS などの一部のプロバイダーに必要です。 |
|
|
|
クラスター管理者が requireApprovalForBSL パラメーターを有効にしている場合、NABSL は管理者が要求を承認するまで pending 状態のままになります。
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)を作成したら、次のコマンドを実行してデフォルトとして設定し、各バックアップでストレージの場所を指定しないようにします。
$ oc oadp client config set default-nabsl=<bsl_name>
各項目の説明:
<bsl_name>- バックアップの保存場所の名前を指定します。
5.17.1.15.3. NonAdminBackupStorageLocation list コマンド リンクのコピーリンクがクリップボードにコピーされました!
現在の namespace 内のすべての管理者のバックアップストレージの場所を一覧表示するには、次のコマンドを使用します。
$ oc oadp nonadmin bsl get [<bsl_name>] [flags]
各項目の説明:
<bsl_name>- バックアップの保存場所の名前を指定します。この値はオプションです。
| フラグ | 説明 |
|---|---|
|
|
出力フォーマット。サポートされている値は |