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 クラスターにアクセスできる。

手順

  1. クラスターにアクセスできるユーザーとして OpenShift Container Platform Web コンソールにログインします。
  2. ツールバーの ? アイコンをクリックし、Command-line tools を選択します。
  3. お使いのオペレーティングシステムおよびアーキテクチャー用の oc-oadp バイナリーをダウンロードします。
  4. アーカイブを展開し、oc-oadp バイナリーを PATH のディレクトリーに配置します。
  5. インストールを確認します。

    $ oc oadp version

5.17.1.2. OADP CLI プラグインの設定

OADP コマンドラインインターフェイス(CLI)プラグインをインストールした後、セットアップコマンドを実行してユーザー権限用に設定する必要があります。

setup コマンドは、クラスター全体の管理者権限があるかどうかを自動的に検出し、それに応じて CLI を設定します。CLI は、次の 2 つのモードのいずれかで動作します。

  • 管理モード: クラスター全体の Velero バックアップおよび復元コマンドへのアクセスを提供します。
  • 管理者以外のモード: namespace スコープのセルフサービスバックアップおよび復元コマンドへのアクセスを提供します。

前提条件

  • OADP CLI プラグインがインストールされている。
  • oc login コマンドを使用して OpenShift Container Platform クラスターにログインしている。

手順

  1. setup コマンドを実行して、パーミッションを自動検出し、CLI を設定します。

    $ oc oadp setup

    CLI は、すべての namespace で backups.velero.io リソースを作成できるかどうかを確認します。可能であれば、管理モードが有効になります。それ以外の場合は、管理者以外のモードが有効になります。設定は ~/.config/velero/config.json に保存されます。

  2. パーミッションの変更後に CLI を再設定するには、the- force フラグを指定して setup コマンドを実行します。

    $ oc oadp setup --force

検証

  • 次のコマンドを実行して、使用可能なコマンドが設定されたモードと一致することを確認します。

    $ oc oadp --help
    注記

    OADP CLI コマンドは、noun-verb と Verb-noun ordering の両方をサポートします。たとえば、oc oadp backup createoc 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

      補完をインストールするシェルタイプ。サポートされる値は、bashzsh、および fish です。このフラグが指定されていない場合、現在のシェルは自動検出されます。

      zsh の補完のインストール例

      $ oc oadp completion install --shell zsh

    • インストールせずにシェルの補完スクリプトを生成するには、以下のコマンドを使用します。

      $ oc oadp completion <shell_name>

      各項目の説明:

      <shell_name>

      シェルの名前を指定します。サポートされる値は、bashzshfish、および 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]
Expand
表5.7 oc oadp backup create コマンドのフラグ
フラグ説明

--include-namespaces

バックアップに含める namespace。デフォルト値は * (すべての namespace)です。

--exclude-namespaces

バックアップから除外する namespace。

--include-resources

バックアップに含めるリソース。deployments,services などの単純な種類の名前を指定するか、resource.group 形式を多義性(例: deployments.apps )に使用することができます。デフォルト値は * (すべてのリソース)です。

--exclude-resources

バックアップから除外するリソース。このフラグは、the --include-resources フラグと同じ形式を使用します。

--storage-location

使用するバックアップストレージの場所の名前。

--volume-snapshot-locations

使用するボリュームスナップショットの場所または場所。

--selector, -l

リソースをフィルターするラベルセレクター。

--or-selector

ラベルセレクターの OR の組み合わせ。

--snapshot-volumes

永続ボリューム(PV)のスナップショットを取得するかどうかを指定します。デフォルト値は true です。

--snapshot-move-data

スナップショットデータをバックアップストレージの場所に移動するかどうかを指定します。

--default-volumes-to-fs-backup

すべてのボリュームにファイルシステムのバックアップを使用するかどうかを指定します。

--include-cluster-resources

クラスタースコープのリソースを含めるかどうかを指定します。

--ttl

バックアップ保持期間。デフォルト値は 720h です。

--csi-snapshot-timeout

Container Storage Interface (CSI)スナップショット作成のタイムアウト。

--item-operation-timeout

非同期プラグイン操作のタイムアウト。

--request-timeout

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]
Expand
表5.8 oc oadp backup get コマンドのフラグ
フラグ説明

-o

出力フォーマット。サポートされている値は json および yaml です。

5.17.1.5.4. バックアップの説明コマンド

バックアップの詳細を表示するには、次のコマンドを使用します。

$ oc oadp backup describe <backup_name> [flags]
Expand
表5.9 oc oadp backup describe コマンドのフラグ
フラグ説明

--details

出力で追加の詳細を表示するかどうかを指定します。

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]
Expand
表5.10 oc oadp backup delete コマンドのフラグ
フラグ説明

--confirm

プロンプトなしで削除を確認するかどうかを指定します。

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]
Expand
表5.11 oc oadp restore create コマンドのフラグ
フラグ説明

--from-backup

復元元のバックアップの名前。

--from-schedule

復元元となるスケジュールの名前です。このフラグは最新のバックアップを使用します。

--include-namespaces

復元に含める namespace。デフォルト値は * (すべての namespace)です。

--exclude-namespaces

復元から除外する namespace。

--include-resources

復元に含めるリソース。deployments,services などの単純な種類の名前を指定するか、resource.group 形式を多義性(例: deployments.apps )に使用することができます。デフォルト値は * (すべてのリソース)です。

--exclude-resources

復元から除外するリソース。このフラグは、the --include-resources フラグと同じ形式を使用します。

--selector, -l

リソースをフィルターするラベルセレクター。

--or-selector

ラベルセレクターの OR の組み合わせ。

--include-cluster-resources

クラスタースコープのリソースを含めるかどうかを指定します。

--restore-volumes

スナップショットから永続ボリューム(PV)データを復元するかどうかを指定します。

--preserve-nodeports

NodePort サービスポートの割り当てを保持するかどうかを指定します。

--item-operation-timeout

非同期プラグイン操作のタイムアウト。

--request-timeout

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]
Expand
表5.12 oc oadp restore get コマンドのフラグ
フラグ説明

-o

出力フォーマット。サポートされている値は json および yaml です。

5.17.1.6.4. restore description コマンド

復元の詳細を表示するには、次のコマンドを使用します。

$ oc oadp restore describe <restore_name> [flags]
Expand
表5.13 oc oadp restore describe コマンドのフラグ
フラグ説明

--details

出力で追加の詳細を表示するかどうかを指定します。

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]
Expand
表5.14 oc oadp restore delete コマンドのフラグ
フラグ説明

--confirm

プロンプトなしで削除を確認するかどうかを指定します。

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]
Expand
表5.15 oc oadp schedule create コマンドのフラグ
フラグ説明

--schedule

スケジュールの cron 式。たとえば、dailly at 1 AM の場合は 0 1 * * * です。

--include-namespaces

スケジュールされたバックアップに追加する namespace。デフォルト値は * (すべての namespace)です。

--exclude-namespaces

スケジュールされたバックアップから除外する namespace。

--include-resources

スケジュールされたバックアップに含めるリソース。deployments,services などの単純な種類の名前を指定するか、resource.group 形式を多義性(例: deployments.apps )に使用することができます。デフォルト値は * (すべてのリソース)です。

--exclude-resources

スケジュールされたバックアップから除外するリソース。このフラグは、the --include-resources フラグと同じ形式を使用します。

--storage-location

使用するバックアップストレージの場所の名前。

--volume-snapshot-locations

使用するボリュームスナップショットの場所または場所。

--selector, -l

リソースをフィルターするラベルセレクター。

--snapshot-volumes

永続ボリューム(PV)のスナップショットを取得するかどうかを指定します。デフォルト値は true です。

--snapshot-move-data

スナップショットデータをバックアップストレージの場所に移動するかどうかを指定します。

--default-volumes-to-fs-backup

すべてのボリュームにファイルシステムのバックアップを使用するかどうかを指定します。

--include-cluster-resources

クラスタースコープのリソースを含めるかどうかを指定します。

--ttl

バックアップ保持期間。デフォルト値は 720h です。

--request-timeout

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]
Expand
表5.16 oc oadp schedule get コマンドのフラグ
フラグ説明

-o

出力フォーマット。サポートされている値は json および yaml です。

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]
Expand
表5.17 oc oadp schedule delete コマンドのフラグ
フラグ説明

--confirm

プロンプトなしで削除を確認するかどうかを指定します。

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]
Expand
表5.18 oc oadp backup-location create コマンドのフラグ
フラグ説明

--provider

クラウドプロバイダーの名前( awsgcpazure など)。

--bucket

オブジェクトストレージバケットの名前。

--prefix

バケット内のパス接頭辞。

--credential

SECRET_NAME=KEY 形式のプロバイダー認証情報の秘密鍵およびキー。

--config

key=value ペアとしてのプロバイダー固有の設定。

--backup-sync-period

オブジェクトストレージからバックアップコンテンツを同期する頻度。

--request-timeout

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]
Expand
表5.19 oc oadp backup-location get コマンドのフラグ
フラグ説明

-o

出力フォーマット。サポートされている値は json および yaml です。

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]
Expand
表5.20 oc oadp backup-location delete コマンドのフラグ
フラグ説明

--confirm

プロンプトなしで削除を確認するかどうかを指定します。

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]
Expand
表5.21 oc oadp snapshot-location create コマンドのフラグ
フラグ説明

--provider

クラウドプロバイダーの名前( awsgcpazure など)。

--config

key=value ペアとしてのプロバイダー固有の設定。

--request-timeout

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]
Expand
表5.22 oc oadp snapshot-location get コマンドのフラグ
フラグ説明

-o

出力フォーマット。サポートされている値は json および yaml です。

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]
Expand
表5.23 oc oadp snapshot-location delete コマンドのフラグ
フラグ説明

--confirm

プロンプトなしで削除を確認するかどうかを指定します。

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]
Expand
表5.24 oc oadp nabsl-request get コマンドのフラグ
フラグ説明

-o

出力フォーマット。サポートされている値は json および yaml です。

出力には、要求名、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]
Expand
表5.25 oc oadp nabsl-request approve コマンドのフラグ
フラグ説明

--reason

承認の理由です。このフラグは任意です。

要求は、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]
Expand
表5.26 oc oadp nabsl-request reject コマンドのフラグ
フラグ説明

--reason

拒否の理由です。このフラグが推奨されます。

要求は、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 クラスターにログインしている。
  • oc CLI が PATH にインストールされており、利用可能な。

手順

  • OADP 診断情報を収集します。

    $ oc oadp must-gather [flags]
    Expand
    表5.27 oc oadp must-gather コマンドのフラグ
    フラグ説明

    --dest-dir

    must-gather 出力が保存されるディレクトリー。デフォルト値は ./must-gather です。

    --request-timeout

    収集スクリプトのタイムアウト(例: 30s または 1m )。

    --skip-tls

    Transport 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 セルフサービスを使用する前に、クラスター管理者は次のタスクを完了する必要があります。

  • DataProtectionApplication CR 仕様で、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]
Expand
表5.28 oc oadp nonadmin backup create コマンドのフラグ
フラグ説明

--storage-location

使用する NonAdminBackupStorageLocation オブジェクトの名前。このフラグは、デフォルトが設定されていない必要があります。

--include-resources

バックアップに含めるリソース。deployments,services などの単純な種類の名前を指定するか、resource.group 形式を多義性(例: deployments.apps )に使用することができます。デフォルト値は * (すべてのリソース)です。

--exclude-resources

バックアップから除外するリソース。このフラグは、the --include-resources フラグと同じ形式を使用します。

--selector, -l

このラベルセレクターに一致するリソースのみをバックアップするように指定します。

--or-selector

またはで区切られた、1 つ以上のラベルセレクターに一致するリソースをバックアップするかどう を指定します。

--ttl

バックアップがガベージコレクションされる前の時間。デフォルト値は 720h です。

--csi-snapshot-timeout

Container Storage Interface (CSI)スナップショット作成のタイムアウト。

--item-operation-timeout

非同期プラグイン操作のタイムアウト。

--snapshot-volumes

バックアップの一部として永続ボリューム(PV)のスナップショットを作成するかどうかを指定します。

--snapshot-move-data

スナップショットデータをバックアップストレージの場所に移動するかどうかを指定します。

--default-volumes-to-fs-backup

すべてのボリュームにデフォルトで 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]
Expand
表5.29 oc oadp nonadmin backup get コマンドのフラグ
フラグ説明

-o

出力フォーマット。サポートされている値は json および yaml です。

5.17.1.13.4. 管理者でないバックアップの説明コマンド

バックアップの詳細を表示するには、次のコマンドを使用します。

$ oc oadp nonadmin backup describe <backup_name> [flags]
Expand
表5.30 oc oadp nonadmin backup describe コマンドのフラグ
フラグ説明

--details

ボリュームスナップショット、リソースリスト、および項目操作など、追加のバックアップ詳細を表示するかどうかを指定します。

--request-timeout

サーバーからバックアップの詳細を取得する際のタイムアウト。

5.17.1.13.5. 管理者でないバックアップログコマンド

バックアップのログを表示するには、次のコマンドを使用します。

$ oc oadp nonadmin backup logs <backup_name> [flags]
Expand
表5.31 oc oadp nonadmin backup logs コマンドのフラグ
フラグ説明

--request-timeout

サーバーからログを取得するためのタイムアウト。

注記

バックアップログは、NonAdminBackupStorageLocation オブジェクトを使用する場合にのみ利用できます。デフォルトのクラスターのバックアップストレージの場所を使用するバックアップでは、ログは利用できません。

5.17.1.13.6. 管理者でないバックアップ削除コマンド

1 つ以上のバックアップを削除するには、次のコマンドを使用します。

$ oc oadp nonadmin backup delete [<backup_name>...] [flags]
Expand
表5.32 oc oadp nonadmin backup delete コマンドのフラグ
フラグ説明

--confirm

確認プロンプトをスキップして、すぐに削除するかどうかを指定します。

--all

現在の 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>
復元の名前を指定します。この値はオプションです。名前を指定しないと、名前が自動的に生成されます。
Expand
表5.33 oc oadp nonadmin restore restore create コマンドのフラグ
フラグ説明

--backup-name

復元元となる管理者以外のバックアップの名前。このフラグは必須です。

--include-resources

復元に含めるリソース。deployments,services などの単純な種類の名前を指定するか、resource.group 形式を多義性(例: deployments.apps )に使用することができます。デフォルト値は * (すべてのリソース)です。

--exclude-resources

復元から除外するリソース。このフラグは、the --include-resources フラグと同じ形式を使用します。

--selector, -l

このラベルセレクターに一致するリソースのみが復元されることを指定します。

--or-selector

また はで区切られた 1 つ以上のラベルセレクターに一致するリソースを復元することを指定します。

--item-operation-timeout

非同期プラグイン操作のタイムアウト。

管理者以外の復元作成コマンドの例

$ 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>
復元の名前を指定します。この値はオプションです。
Expand
表5.34 oc oadp nonadmin restore get コマンドのフラグ
フラグ説明

-o

出力フォーマット。サポートされている値は json および yaml です。

5.17.1.14.4. 管理者以外の復元の説明コマンド

復元の詳細を表示するには、次のコマンドを使用します。

$ oc oadp nonadmin restore describe <restore_name> [flags]

各項目の説明:

<restore_name>
復元の名前を指定します。
Expand
表5.35 oc oadp nonadmin restore describe コマンドのフラグ
フラグ説明

--details

追加の復元の詳細を表示するかどうかを指定します。

--request-timeout

サーバーから復元詳細をフェッチするためのタイムアウト。

5.17.1.14.5. 管理者以外の restore logs コマンド

復元のログを表示するには、次のコマンドを使用します。

$ oc oadp nonadmin restore logs <restore_name> [flags]

各項目の説明:

<restore_name>
復元の名前を指定します。
Expand
表5.36 oc oadp nonadmin restore logs コマンドのフラグ
フラグ説明

--request-timeout

サーバーからログを取得するためのタイムアウト。

注記

Restore ログは、NonAdminBackupStorageLocation オブジェクトを使用する場合にのみ利用できます。デフォルトのクラスターバックアップストレージの場所を使用するバックアップに関連付けられた復元には、ログは利用できません。

5.17.1.14.6. 管理者以外の復元削除コマンド

1 つ以上の復元を削除するには、以下のコマンドを使用します。

$ oc oadp nonadmin restore delete [<restore_name>...] [flags]

各項目の説明:

<restore_name>
復元の名前を指定します。複数の復元を指定できます。
Expand
表5.37 oc oadp nonadmin restore delete コマンドのフラグ
フラグ説明

--confirm

確認プロンプトをスキップして、すぐに削除するかどうかを指定します。

--all

現在の 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>
バックアップの保存場所の名前を指定します。
Expand
表5.38 oc oadp nonadmin bsl create コマンドのフラグ
フラグ説明

--provider

ストレージプロバイダー( awsazure、または gcp )。このフラグは必須です。

--bucket

オブジェクトストレージバケットの名前。このフラグは必須です。

--credential

SECRET_NAME=KEY 形式のこの場所の認証情報。ここで、SECRET_NAME は Kubernetes Secret オブジェクトの名前、KEY はシークレット内のデータキーです。このフラグは必須です。

--prefix

バケットのバックアップオブジェクトの接頭辞。

--region

ストレージリージョン。このフラグは、AWS などの一部のプロバイダーに必要です。

--config

key=value ペアとしての追加のプロバイダー固有の設定。

クラスター管理者が 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>
バックアップの保存場所の名前を指定します。この値はオプションです。
Expand
表5.39 oc oadp nonadmin bsl get コマンドのフラグ
フラグ説明

-o

出力フォーマット。サポートされている値は json および yaml です。

Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

Red Hat ドキュメントについて

Legal Notice

Theme

© 2026 Red Hat
トップに戻る