スーパーバイザーでの Velero Plugin for vSphere のインストールと構成

Velero Plugin for vSphere を使用して vSphere ポッドで実行されているワークロードをバックアップおよびリストアするには、スーパーバイザーに Velero Plugin for vSphere をインストールします。

概要

Velero Plugin for vSphere は、vSphere with Tanzu ワークロードをバックアップおよびリストアするためのソリューションを提供します。このソリューションを使用するには、いくつかのコンポーネントをインストールして構成する必要があります。スーパーバイザーに Velero Plugin for vSphere をインストールして構成すると、vSphere ポッドをバックアップおよびリストアできるようになります。パーシステントワークロードの場合は、Velero Plugin for vSphere でパーシステントボリュームのスナップショットを作成できます。

Velero Plugin for vSphere を使用して Tanzu Kubernetes クラスタワークロードをバックアップおよびリストアする場合も、スーパーバイザーに Velero Plugin for vSphere をインストールすることが前提条件となります。

注： Velero Plugin for vSphere を使用してスーパーバイザーの状態をバックアップおよびリストアすることはできません。 vSphere with Tanzu のバックアップとリストアに関する考慮事項を参照してください。

注： Velero Plugin for vSphere は、単独では増分バックアップを実行しません。Dell EMC PowerProtect は増分バックアップをサポートし、Velero と Velero Plugin for vSphere を利用します。

前提条件

Velero Plugin for vSphere をインストールする前に、次の前提条件を満たす必要があります。

スーパーバイザーがバージョン 1.21.1 以降である。
vSphere 名前空間が作成され、構成されている。
vSphere 管理者ロールのメンバーであるか、次の vSphere 権限を持っている必要がある。
- SupervisorServices.Manage
- Namespaces.Manage
- Namespaces.Configure

このスクリーンショットは、 Velero Plugin for vSphere インストールの終了状態を示しています。

NSX ネットワークは、vSphere ポッドのデプロイをサポートするために使用されている
Data Manager 仮想マシンがデプロイされている
Velero Operator が有効で、velero-vsphere-domain-cXX 名前空間で実行されている
velero という名前空間が構成されている
Velero Plugin for vSphere が velero 名前空間内で vSphere ポッドとして実行されている

このスクリーンショットは vSphere Client での Velero プラグインを示しています。

アップグレード

ここに示す手順では、vSphere 8 を実行していることが前提となります。Velero Plugin for vSphere を vSphere 7 U3 環境にすでにインストールしている場合は、アップグレード時に Data Manager 仮想マシンと [Velero vSphere Operator] が新しいフレームワークに移行されます。[Velero vSphere Operator] は、新しい vSphere サービス形式に変換されます。アクションは不要です。

バックアップおよびリストアトラフィック専用ネットワークの作成（オプション）

本番環境でバックアップトラフィックとリストアトラフィックを vSphere with Tanzu 管理ネットワークトラフィックから分離することは、必須ではありませんが、推奨です。この操作には、2 つの側面があります。

ネットワークファイルコピー (NFC) をサポートする ESXi ホストにタグを付ける
NSX-T Data Center を使用してバックアップおよびリストアネットワークを構成する

専用ネットワークブロックデバイス (NBD) の転送をサポートするように vSphere 8 ESXi ホストを構成するには、ワークロード管理が有効になっている vSphere クラスタ内の各 ESXi ホストに VMkernel NIC を追加して、その NIC に vSphereBackupNFC を設定します。タグ vSphereBackupNFC を VMkernel アダプタの NIC タイプに適用すると、バックアップトラフィックとリストアトラフィックは選択した仮想 NIC を経由するようになります。

この構成を実行するには、Virtual Disk Development Kit を使用します。 NBD のドキュメントを参照してください。

注： vSphereBackupNFC が VMkernel NIC で有効でない場合は、バックアップとリストアのネットワークが構成されているときでも、バックアップとリストアのトラフィックはこれらのネットワークを経由しません。 vSphereBackupNFC が有効でない場合、トラフィックは vSphere 管理ネットワークを経由します。

vSphereBackupNFC タグを有効にしたら、クラスタの既存の vSphere Distributed Switch (vDS) を次のように更新して、NSX-T を使用してバックアップおよびリストアネットワークを構成します。

vSphere Client で [メニュー] > [ネットワーク] の順に選択します。
クラスタの既存の Distributed Switch を選択します。
Distributed Switch を右クリックして、[分散ポートグループ] > [新規分散ポートグループ] の順に選択します。
[BackupRestoreNetwork] という名前の新しい分散ポートグループを作成します。
[BackupRestoreNetwork] 分散ポートグループに VMkernel アダプタを追加します。
ワークロード管理が有効になっている vCenter Server クラスタ内のすべての ESXi ホストを [BackupRestoreNetwork] 分散ポートグループに接続します。
vSphereBackupNFC タグを有効にします。

既存の Distributed Switch に NSX ネットワークを作成する方法については、vSphere with Tanzu で使用する NSX のインストールと構成を参照してください。

S3 互換オブジェクトストアの作成

パーシステントボリュームのバックアップおよびリストアを行うには、S3 互換オブジェクトストアを指定する必要があります。Velero は、複数のオブジェクトストアプロバイダをサポートしています。

Velero Plugin for vSphere をインストールするには、S3 互換オブジェクトストアに関する次の情報を指定する必要があります。

データ項目	値の例
s3Url	http://my-s3-store.example.com
aws_access_key_id	ACCESS-KEY-ID-STRING
aws_secret_access_key	SECRET-ACCESS-KEY-STRING

次の情報を使用して、 s3-credentials という名前のシークレットファイルを作成します。このファイルは、 Velero Plugin for vSphere をインストールするときに参照します。

[default]
aws_access_key_id = ACCESS-KEY-ID-STRING
aws_secret_access_key = SECRET-ACCESS-KEY-STRING

MinIO は、インストールと使用が容易な S3 互換オブジェクトストアです。vSphere with Tanzu には、ユーザーが有効にできる MinIO スーパーバイザーサービスが付属しています。詳細については、vSphere with Taznu でのステートフルサービスの有効化を参照してください。

Linux 仮想マシンに MinIO サーバを手動でインストールすることもできます。手順については、スーパーバイザー上の TKG 2 クラスタへのスタンドアローン Velero と Restic のインストールと構成を参照してください。

Data Manager のインストールと構成

Velero Plugin for vSphere を使用してバックアップとリストアを容易にするには、1 台以上の Data Manager 仮想マシンをデプロイして、S3 互換オブジェクトストレージとの間でパーシステントボリュームバックアップデータを移動します。Data Manager は、バックアップ時には vSphere ボリュームから耐久性のあるリモート S3 互換ストレージにボリュームスナップショットデータを移動し、リストア時にはリモート S3 互換ストレージから vSphere ボリュームに移動します。

vSphere with Tanzu 環境で、Data Manager を仮想マシンとしてインストールします。

注： Velero vSphere Operator を有効にするまで、Data Manager 仮想マシンをパワーオンしないでください。

Data Manager OVA をダウンロードします。
https://vsphere-velero-datamgr.s3-us-west-1.amazonaws.com/datamgr-ob-17253392-photon-3-release-1.1.ova
vSphere Client を使用して、ワークロード管理が有効になっている [データセンター] を右クリックし、[OVF テンプレートのデプロイ] を選択します。
ダウンロードした Data Manager OVA ファイルを選択して、vCenter Server にアップロードします。
たとえば、仮想マシンに DataManager という名前を付けます。
コンピューティングリソースとして、スーパーバイザーが構成されている vSphere クラスタを選択します。
仮想マシンのデプロイの詳細を確認し、[次へ] をクリックします。
使用許諾契約書を承諾して、[次へ] をクリックします。
ストレージを選択して、[次へ] をクリックします。
Data Manager 仮想マシンのターゲットネットワークを選択します。
- 専用のバックアップおよびリストアネットワークが構成されている場合は、[BackupRestoreNetwork] を選択します。バックアップおよびリストアトラフィック専用ネットワークの作成（オプション）を参照してください。
- 専用のバックアップおよびリストアネットワークが構成されていない場合は、[管理ネットワーク] を選択します。
選択内容を確認し、[終了] をクリックしてプロセスを完了します。
[最近のタスク] パネルを使用して、デプロイの進行状況を監視します。
注：「OVF 記述子が利用できません。」というエラーが表示される場合は、Chrome ブラウザを使用します。
Data Manager 仮想マシンがデプロイされたら、仮想マシンの入力パラメータを構成します。
仮想マシンを右クリックして、[設定の編集] を選択します。
[仮想ハードウェア] タブで、[CD/DVD ドライブ] を [ホストデバイス] から [クライアントデバイス] に変更します。
注：この操作を行わないと、必要な詳細設定を保存できません。
[設定の編集] > [仮想マシンオプション] タブで [詳細] > [構成パラメータの編集] の順に選択します。

次の各設定の入力パラメータを構成します。

パラメータ	値
`guestinfo.cnsdp.vcUser`	仮想マシンのデプロイに必要な権限を持っている vCenter Server ユーザーの名前を入力します。
`guestinfo.cnsdp.vcAddress`	vCenter Server IP アドレスまたは FQDN を入力します。
`guestinfo.cnsdp.vcPasswd`	vCenter Serverユーザーパスワードを入力します。
`guestinfo.cnsdp.vcPort`	デフォルトは `443` です。この値は変更しないでください。
`guestinfo.cnsdp.wcpControlPlaneIP`	スーパーバイザーの IP アドレスを入力します。この値を取得するには、ワークロード管理が有効になっている vCenter Server クラスタに移動して、[構成] > [名前空間] > [ネットワーク] > [管理ネットワーク] > [開始 IP アドレス] の順に選択します。
`guestinfo.cnsdp.updateKubectl`	デフォルトは `false` です。この値は変更しないでください。
`guestinfo.cnsdp.veleroNamespace`	デフォルトは `velero` です。変更する理由が特にない限り、そのままにします。プロセスの後半で、スーパーバイザークラスタに `velero` という名前の vSphere 名前空間を作成します。これらの名前が一致する必要があります。
`guestinfo.cnsdp.datamgrImage`	構成されていない（未設定の）システムでは、デフォルトで、`vsphereveleroplugin/data-manager-for-plugin:1.1.0` にある Docker ハブからコンテナイメージが取得されます。

[OK] をクリックして構成を保存し、もう一度 [OK] をクリックして仮想マシンの設定を保存します。
注： [CD/DVD ドライブ] を [ホストデバイス] から [クライアントデバイス] に変更しなかった場合は、設定を保存できません。この場合は、操作をキャンセルしてドライブを変更し、詳細設定を繰り返します。
Velero vSphere Operator を有効にするまで（次のセクションまで）、Data Manager 仮想マシンをパワーオンしないでください。

スーパーバイザーへの Velero vSphere Operator サービスのインストール

vSphere with Tanzu は、スーパーバイザーサービスとして Velero vSphere Operator を提供します。Velero vSphere Operator サービスは Velero Plugin for vSphere と連携して、パーシステントボリュームのスナップショット作成など、Kubernetes ワークロードのバックアップとリストアをサポートします。スーパーバイザーサービスの詳細については、vSphere with Tanzu を使用したスーパーバイザーサービスの管理を参照してください。

次の操作を実行して、 [Velero vSphere Operator] の仕様を [ワークロード管理] が有効になっている vCenter Server に登録し、 [Velero vSphere Operator] をスーパーバイザーにサービスとしてインストールします。

注： [Velero vSphere Operator] は vSphere ポッドとして実行されるため、NSX-T ネットワークが必要です。

次の場所から [Velero vSphere Operator] の YAML をダウンロードします。
http://vmware.com/go/supervisor-service
サービス仕様ファイルの名前は、velero-supervisorservice-1.0.0.yaml です。
vSphere Client ホームメニューから、[ワークロード管理] を選択します。
[サービス] タブを選択します。
上部のドロップダウンメニューからターゲット vCenter Server インスタンスを選択します。
ダウンロードしたサービス仕様ファイル velero-supervisorservice-1.0.0.yaml を [サービスの新規追加] カードにドラッグアンドドロップします。
[追加] をクリックし、velero-supervisorservice-1.0.0.yaml ファイルを参照して選択することもできます。
[次へ] をクリックして、使用許諾契約書に同意します。
[終了] をクリックします。
[Velero vSphere Operator] が vCenter Server に登録されています。サービスが [有効] な状態になっていることを確認します。サービスが非アクティブな状態になっている場合は、インストールできません。
[サービス] タブで [Velero vSphere Operator] の仕様を見つけます。
[アクション] > [スーパーバイザーへのインストール] の順にクリックします。
サービスをインストールするターゲットスーパーバイザーを選択します。
注：スーパーバイザーが表示されない場合は、NSX ネットワークを使用していることを確認します。
次のように、[Velero vSphere Operator] サービスのインストールを構成します。
1. ドロップダウンからバージョン [1.1.0] を選択します。
2. [リポジトリエンドポイント] を指定しないでください。
3. ユーザー名またはパスワードを入力しないでください。
4. [次へ] をクリックします。
[完了] をクリックして、サービスのインストールを完了します。

スーパーバイザーで [Velero vSphere Operator] サービスを確認し、Data Manager 仮想マシンを起動します。

vSphere Client ホームメニューから、[ワークロード管理] を選択します。
[スーパーバイザー] タブをクリックし、[Velero vSphere Operator] をインストールしたスーパーバイザーを選択します。
[構成] タブをクリックし、[スーパーバイザーサービス] の [概要] をクリックします。
[Velero vSphere Operator] がインストールされていて、ステータスが [設定済み] になっていることを確認します。
[名前空間] タブに、svc-velero-vsphere-domain-xxx という名前の新しい名前空間が表示されていることを確認します。xxx は一意の英数字トークンです。これは、[Velero vSphere Operator] 用にシステムによって作成された名前空間です。
注：この名前空間を構成する必要はありません。編集しないでください。
[ホストおよびクラスタ] ビューで [Data Manager] 仮想マシンを選択します。
[Data Manager] 仮想マシンを右クリックして、パワーオンします。

Velero Plugin for vSphere の vSphere 名前空間の作成

vSphere Client を使用して、スーパーバイザーで vSphere 名前空間を手動で作成します。 Velero Plugin for vSphere を使用するには、この名前空間が必要です。ガイダンスについては、 vSphere 名前空間の作成と構成を参照してください。

名前空間に velero という名前を付けます。
[velero] 名前空間を選択して、構成します。
[velero] 名前空間のストレージを指定します。
適切な権限を持つユーザーに、[velero] 名前空間に対する編集権限を付与します。

Velero Plugin for vSphere のインストール

これで、 Velero Plugin for vSphere をインストールする準備ができました。インストールするには、 [velero-vsphere] CLI をダウンロードして実行します。

注：この手順には Linux 仮想マシンが必要です。 kubectl-vsphere と kubectl CLI を実行する Linux ジャンプホストに [velero-vsphere] をダウンロードして、実行する必要があります。

この CLI を実行できる Linux 仮想マシンを作成します。または、既存の Linux ジャンプホストを使用してスーパーバイザーにアクセスします。
次の場所から Velero Plugin for vSphere CLI をダウンロードします。
https://github.com/vmware-tanzu/velero-plugin-for-vsphere/releases/download/v1.1.0/velero-vsphere-1.1.0-linux-amd64.tar.gz

CLI を Linux ジャンプホストに安全にコピーします。例：

pscp -P 22 C:\temp\velero-vsphere-1.1.0-linux-amd64.tar.gz [email protected]:/home/ubuntu/tanzu

velero-vsphere CLI を抽出して、書き込み可能にします。

tar -xf velero-vsphere-1.1.0-linux-amd64.tar.gz
chmod +x velero-vsphere

次の内容の s3-credentials ファイルを作成します。

aws_access_key_id = ACCESS-KEY-ID-STRING
aws_secret_access_key = SECRET-ACCESS-KEY-STRING

S3 互換オブジェクトストアのリージョン、URL、バケット名を取得します。
kubectl 向けの vSphere プラグインを使用して、スーパーバイザーにログインします。
コンテキストをスーパーバイザーに切り替えます。
```
kubectl config use-context SUPERVISOR-CLUSTER-IP-ADDRESS
```
作成した [velero] 名前空間で、Velero Plugin for vSphere をインストールするクラスタのフレーバーとして SUPERVISOR を指定する構成マップファイルをインストールします。
```
% cat <<EOF | kubectl -n velero apply -f -
apiVersion: v1
kind: ConfigMap
metadata:
  name: velero-vsphere-plugin-config
data:
  cluster_flavor: SUPERVISOR
EOF
```
次の velero-vsphere CLI コマンドを実行して、[velero] 名前空間に Velero Plugin for vSphere をインストールします。
BUCKET-NAME、REGION（2 つのインスタンス）、および s3Url フィールドのプレースホルダ値を適切な値に置き換えます。前述のいずれかの手順に従わなかった場合は、シークレットファイルの名前や場所、手動で作成した velero 名前空間の名前などの値を調整します。
```
./velero-vsphere install \
    --namespace velero \
    --image velero/velero:v1.5.1 \
    --provider aws \
    --plugins velero/velero-plugin-for-aws:v1.1.0,vsphereveleroplugin/velero-plugin-for-vsphere:1.1.0 \
    --bucket BUCKET-NAME \
    --secret-file s3-credentials \
    --snapshot-location-config region=REGION \
    --backup-location-config region=REGION,s3ForcePathStyle="true",s3Url=http://my-s3-store.example.com
```
注：たとえば、 vsphereveleroplugin/velero-plugin-for-vsphere:v1.1.1 や vsphereveleroplugin/velero-plugin-for-vsphere:v1.2.0 のように、スーパーバイザーで Velero Plugin for vSphere v1.1.0 以降を使用することができます。Velero のバージョンは、v1.5.1 ( velero/velero:v1.5.1) である必要があります。
Velero Plugin for vSphere が正常にインストールされたことを確認します。
インストールが正常に完了すると、次のメッセージが表示されます。
```
Send the request to the operator about installing Velero in namespace velero
```
次のコマンドを実行して、さらに確認します。「完了」と表示されて、バージョンが表示されます。
```
kubectl -n velero get veleroservice default -o json | jq '.status'
```
予期される結果：
```
{
  "enabled": true,
  "installphase": "Completed",
  "version": "v1.5.1"
}
```
注：上記のコマンドでは、ターミナルに送信される JSON 出力をフォーマットする jq ユーティリティがインストールされていることが前提となります。 jq がインストールされていない場合は、インストールするか、コマンドのこの部分（ json 以降のすべて）を削除します。
必要に応じてトラブルシューティングを行います。
インストールに失敗した場合は、インストールを削除して、再試行してください。インストールを削除するには、次のセクションに記載されている手順を記載されている順序で実行します。

エアギャップ環境への Velero プラグインのインストール

エアギャップ環境に Velero Plugin for vSphere をインストールする場合は、カスタマイズされたイメージとともにインストールする必要があります。カスタマイズされたイメージのうち backup-driver および data-manager-for-plugin の対応するイメージが想定されるレジストリ内にあり、Kubernetes クラスタからアクセスできることを確認する必要があります。エアギャップ環境では、Docker ハブ内のリリース済みイメージにアクセスできないため、プライベートレジストリ内にあるカスタマイズ済みイメージが使用されます。

プラグインをインストールするには、次の手順を実行します。

velero-plugin-for-vsphere、backup-driver、および data-manager-for-plugin のリリース済みイメージをダウンロードします。
イメージの名前を変更します。つまり、対応する <Registry endpoint and path> および <Version tag> をイメージにタグ付けして、カスタマイズされたリポジトリにアップロードします。
カスタマイズした velero-plugin-for-vsphere イメージを使用してプラグインをインストールします。
vanilla クラスタに Velero Plugin for vSphere をインストールすると、backup-driver 環境と data-manager-for-plugin デーモンセットという 2 つの追加コンポーネントがバックグラウンドでデプロイされます。スーパーバイザーおよび Tanzu Kubernetes クラスタでは、backup-driver 環境のみがデプロイされます。
velero-plugin-for-vsphere のコンテナイメージを指定した場合は、イメージ解析メカニズムを使用して対応する backup-driver および data-manager-for-plugin イメージが解析されます。
コンテナイメージは、次のパターンの形式になります。
```
<Registry endpoint and path>/<Container name>:<Version tag>
```
velero-plugin-for-vsphere コンテナイメージを指定した場合は、backup-driver および data-manager-for-plugin の対応するイメージのうち、<Registry endpoint and path> および <Version tag> が一致しているものが解析されます。
たとえば、次の velero-plugin-for-vsphere コンテナイメージについて考えます。
```
abc.io:8989/x/y/.../z/velero-plugin-for-vsphere:vX.Y.Z
```
次に示す backup-driver と data-manager-for-plugin の対応するイメージが取得されると想定されます。
```
abc.io:8989/x/y/.../z/backup-driver:vX.Y.Z
abc.io:8989/x/y/.../z/data-manager-for-plugin:vX.Y.Z
```
インストールのトラブルシューティングを行います。
backup-driver と data-manager-for-plugin の対応するイメージの解析中に問題やエラーが発生した場合、インストールは Docker ハブの公式 velerovsphereplugin リポジトリ内の対応するイメージにフォールバックされます。次の問題が発生すると、フォールバックメカニズムがトリガされます。
1. ユーザー入力内のカスタマイズされた velero-plugin-for-vsphere イメージに、予期しないコンテナ名が使用されています。
  たとえば、x/y/velero-velero-plugin-for-vsphere:v1.1.1 が使用されています。
2. Velero のデプロイ名が、velero 以外の名前にカスタマイズされています。たとえば、Velero をデプロイする前に、Velero manifests ファイルで Velero のデプロイ名が velero-server に更新された場合は、問題がトリガされます。
  velero-plugin-for-vsphere の既存のイメージ解析メカニズムで認識できるのは、velero という固定された名前を持つ Velero 環境のみです。

Velero Plugin for vSphere のアンインストール

次の手順を実行して、 Velero Plugin for vSphere をアンインストールします。これらの手順は、記載されている順序で実行します。

velero-vsphere CLI を実行して、Velero Plugin for vSphere をアンインストールします。
```
./velero-vsphere uninstall -n velero
```
velero という名前の vSphere ポッドが削除されたことを確認します。
```
kubectl get pods -n velero
```
ポッドが「終了しています」と表示されている場合は、ポッドが削除されるまで待機してから続行します。
vSphere Client を使用して、手動で作成した velero という名前の vSphere 名前空間を削除します。
注：名前空間の削除が完了するまで、次の手順に進まないでください。kubectl を使用して、 velero 名前空間が削除されていることを確認できます（ただし、kubectl を使用して velero 名前空間を削除しないでください）。
vSphere Client を使用して、スーパーバイザーから [Velero vSphere Operator] をアンインストールします。
1. [ワークロード管理] が有効になっている vCenter Server クラスタを指定します。
2. [構成] > [vSphere サービス] > [概要] の順に選択します。
3. [Velero vSphere Operator] を選択します。
4. [アンインストール] をクリックします。
  このアクションを行うと、スーパーバイザーから [Velero vSphere Operator] がアンインストールされます。Operator は、[ワークロード管理] > [サービス] ページで引き続き再インストールできます。サービスを完全に削除するには、[アクション] > [削除] の順に選択します。

概要