SB C&Sの最新技術情報 発信サイト

C&S ENGINEER VOICE

SB C&S

VCF Import Tool の紹介 ~使い方編~

VMware
2024.10.30

こんにちは。SB C&Sの大塚と申します。
VMware Cloud Foundation(VCF)のバージョン5.2から、新機能としてVCF Import Toolが実装されました。

本記事ではこのVCF Import Toolについて、使い方をお伝えさせていただきます。概要については「VCF Import Tool の紹介 ~概要編~」をご覧ください。

今回は下記2つの手順についてご紹介いたします。また、それぞれNSXの同時展開有り、無しの手順を紹介しております。

  • 管理ドメインへの変換(Convert)
  • VIドメインへの移行(Import)

事前準備

まずは、既存のvSphere環境を変換(Convert)・移行(Import)するための事前準備についてご紹介します。

画像2.jpg

変換・移行する環境に対して、上記のような設定を行っておきます。要件の詳細は「VCF Import Tool の紹介 ~概要編~」をご覧ください。

下記のソフトウェアをBroadcom Support Portalから事前にダウンロードしておきます。また、今回検証したVCFのバージョンは5.2となります。

  • SDDC ManagerのOVAファイル
  • VCF Import Tool(tarファイル)
  • NSXのインストールバンドル

管理ドメインへの変換(Convert)

この章では既存のvSphere環境を変換(Convert)する手順についてご紹介していきます。

SDDC Managerの展開

変換予定の既存vSphere環境へ、SDDC ManagerをOVAファイルから展開します。
SDDC ManagerのOVAファイルの展開手順の詳細についてはこちらのDocsからご確認ください。本記事では省略させていただきます。

処理が完了し、仮想マシンが展開されたらパワーオンしてください。
なお、このタイミングでSDDC ManagerのUIを見ようとしても以下の状態となり表示されません。UIは全て完了した後で確認可能になります。

画像3.jpg


VCF Import Toolの展開

SDDC ManagerVCF Import Tooltarファイルを転送し、展開を行っていきます。

SSHでSDDC Managerへログインします。

  • ユーザー名:vcf
  • パスワード:SDDC Manager展開時に指定した値


作業用フォルダを作成します。

 $ mkdir /home/vcf/vcfimport 

SCPコマンドなどを使用し、VCF Import Toolのtarファイルを先程作成した作業フォルダ配下に配置します。

 /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578.tar.gz 

ディレクトリを移動します。

 $ cd vcfimport/ 

VCF Import Toolのtarファイルを解凍します。

 $ tar -xvf vcf-brownfield-import-5.2.0.0-24108578.tar.gz 

VCF Import Toolの実行コマンドが格納されているディレクトリへ移動します。

 $ cd /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset 

以下を実行しコマンドが実行できるか確認します。

 $ python3 vcf_brownfield.py --help 

以降、コマンドの実行は以下のディレクトリから行ってください。

 /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset 


事前チェックの実施

VCF Import Toolを使用して、既存vSphere環境がVCFとして構成できるか事前チェックを行います。

下記コマンドを実行します。ここで入力する各パラメータは既存vSphere環境のものになります。

 $ python3 vcf_brownfield.py check --vcenter 'vCenterのFQDN' --sso-user 'SSOユーザー名' 


実行に成功すると下記のような結果になります。赤文字は手動入力が必要なところ、橙はチェック結果のyamlのパスになります。

[2024-09-10 07:24:11,631] [INFO] vcf_brownfield: Brownfield Import main version: 5.2.0.0-24108578
Enter vCenter SSO password: ※vCenter ServerのSSOパスワードを入力
Enter SDDC Manager local admin password: ※SDDC Managerのadminパスワードを入力
[2024-09-10 07:24:25,977] [INFO] sddc_manager_helper: Generating SDDC Manager public API token
<<中略>>
[2024-09-10 07:24:26,837] [INFO] request_helper: Response status from retrieving domain: 200
[2024-09-10 07:24:26,906] [INFO] trust_domain: Retrieved server sddc-up-vcf-vc-01.cas.lab thumbprint: 1C:67:76:13:AD:15:5A:C8:3D:30:39:AC:33:D7:2E:AA:C3:4A:8B:DA
Do you accept the thumbprint (yes/no): yes
[2024-09-10 07:24:29,909] [INFO] trust_domain: Loading CA root certificates from sddc-up-vcf-vc-01.cas.lab in truststore
[2024-09-10 07:24:29,910] [INFO] vcenter_rest_api_helper: Generating session to vCenter: sddc-up-vcf-vc-01.cas.lab
<<中略>>
[2024-09-10 07:25:07,309] [INFO] sddc_manager_helper: monitor import guardrails - IN_PROGRESS
[2024-09-10 07:25:12,564] [INFO] sddc_manager_helper: monitor import guardrails - COMPLETED
[2024-09-10 07:25:12,636] [INFO] check_domain_reporter: Total checks: 98, Successful checks: 97, Failed checks: 1, Internal errors: 0
[2024-09-10 07:25:12,637] [INFO] check_domain: For more details, please, check:
        Failed guardrails YML: /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset/output/guardrails_report_sddc-up-vcf-vc-01.cas.lab.yml
        Failed guardrails CSV: /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset/output/guardrails_report_sddc-up-vcf-vc-01.cas.lab.csv
        All guardrails CSV: /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset/output/guardrails_report_sddc-up-vcf-vc-01.cas.lab_all.csv


チェック結果のyamlファイルをcatコマンド等で確認し、ERRORとなっているものは対応します。WARNINGについても対応は必要ですが、今回の検証では無視します。

 $ cat /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset/output/guardrails_report_sddc-up-vcf-vc-01.cas.lab.yml 


環境の変換(NSXの同時展開無し)

既存vSphere環境をVCFの管理ドメインへ変換させます。ここではNSXの展開オプションを指定せず行う手順を紹介します。

下記コマンドをSDDC Manager内にて実行します。ここで入力する各パラメータは既存vSphere環境のものになります。

 $ python3 vcf_brownfield.py convert --vcenter 'vCenterのFQDN' --sso-user 'SSOユーザー名' --domain-name '管理ドメインの名前' --skip-nsx-deployment 

事前チェック時と同じように、途中パスワードの入力やyes/noを聞かれます。全て自動で実行させたい場合には下記のオプションを実行時に付け足してください。

  • --sso-password 'SSOのパスワード'
  • --vcenter-root-password 'vCenterのrootパスワード'
  • --local-admin-password 'SDDC Managerのadmin@localのパスワード'
  • --backup-password 'SDDC Managerのbackup user のパスワード'
  • --suppress-warnings:警告を無視するパラメーターです
  • --accept-trust:SSH keyを自動で信頼するパラメーターです


実行後、SDDC Managerのサービスを再起動させるため、スーパーユーザーにチェンジします。
SDDC Manager展開時に設定したrootのパスワードを聞かれるため入力します。

 $ su - 


下記コマンドを実行してサービスの再起動を行います。

 $ echo 'y' | /opt/vmware/vcf/operationsmanager/scripts/cli/sddcmanager_restart_services.sh 


SDDC Managerへアクセスすると下記のように、無事に既存環境が管理ドメインへ変換され、新たなVCF環境が構成されたことが分かります。

画像4.jpg


環境の変換(NSXの同時展開有り)

既存vSphere環境をVCFの管理ドメインへ変換させる際に、環境へNSXを同時に展開する手順を紹介します。

ダウンロードした NSX Install Bundle をSDDC Manager の以下ディレクトリへ配置します。

 /nfs/vmware/vcf/nfs-mount/bundle


下記のようなNSX構成用のJSONファイルをSDDC Managerに作成します。
ファイル保存先:/home/vcf/nsx-config.json

{
  "license_key": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX", #NSXのライセンスキーを入力
  "form_factor": "medium",
  "admin_password": "SamplePassword1234!", #任意のadminパスワードを入力
  "install_bundle_path": "/nfs/vmware/vcf/nfs-mount/bundle/bundle-124941.zip", #ダウンロードしたNSX Install Bundleを指定
  "cluster_ip": "172.20.70.45", #仮想IPアドレスを指定
  "cluster_fqdn": "sddc-up-eval-vcf-w-nsx.cas.lab", #仮想IPのFQDNを指定
  "manager_specs": [{  #以下に3台分のNSX Managerの情報を入力していく
    "fqdn": "sddc-up-eval-vcf-w-nsx-01.cas.lab", #NSX ManagerのFQDN
    "name": "sddc-up-eval-vcf-w-nsx-01", #NSX Managerの名前
    "ip_address": "172.20.70.46", #NSX ManagerのIP
    "gateway": "172.20.70.1", #Gateway IP
    "subnet_mask": "255.255.255.0" #Subnet mask
  },
  {
    "fqdn": "sddc-up-eval-vcf-w-nsx-02.cas.lab",
    "name": "sddc-up-eval-vcf-w-nsx-02",
    "ip_address": "172.20.70.47",
    "gateway": "172.20.70.1",
    "subnet_mask": "255.255.255.0"
  },
  {
    "fqdn": "sddc-up-eval-vcf-w-nsx-03.cas.lab",
    "name": "sddc-up-eval-vcf-w-nsx-03",
    "ip_address": "172.20.70.48",
    "gateway": "172.20.70.1",
    "subnet_mask": "255.255.255.0"
  }]
}


以下のコマンドを実行し、環境の変換とNSXの展開を同時に行います。ここで入力する各パラメータは既存vSphere環境のものになります。

 $ python3 vcf_brownfield.py convert --vcenter 'vCenterのFQDN' --sso-user 'SSOユーザー名' --domain-name '管理ドメインの名前' --nsx-deployment-spec-path '/home/vcf/nsx-config.json' 


途中パスワードの入力やyes/noを聞かれます。全て自動で進めたい場合は以下のオプションを実行時に付け足してください。

  • --sso-password 'SSOのパスワード'
  • --vcenter-root-password 'vCenterのrootパスワード'
  • --local-admin-password 'SDDC Managerのadmin@localのパスワード'
  • --backup-password 'SDDC Managerのbackup user のパスワード'
  • --suppress-warnings:警告を無視するパラメーターです
  • --accept-trust:SSH keyを自動で信頼するパラメーターです


実行後、SDDC Managerのサービスを再起動させるため、スーパーユーザーにチェンジします。
SDDC Manager展開時に設定したrootのパスワードを聞かれるため入力します。

 $ su - 


下記コマンドを入力し、サービスを再起動します。

 $ echo 'y' | /opt/vmware/vcf/operationsmanager/scripts/cli/sddcmanager_restart_services.sh 

以上で既存vSphere環境の管理ドメインへの変換とNSXの展開が完了しました。



VIドメインへの移行(Import)

この章では、既存のvSphere環境をVIドメインへ移行(Import)する手順について紹介します。

事前チェックの実施

まずは既存の管理ドメインのSDDC ManagerへVCF Import Toolを展開します。VCF Import Tool の展開手順は、「管理ドメインへの変換(Convert)」章の項目「VCF Import Toolの展開」をご覧ください。

次に、移行対象のvCenter Serverに対して事前チェックの実施を行います。
VCF Import Toolの実行コマンドが格納されているディレクトリへ移動します。

 $ cd /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset 


事前チェックのコマンドを実行します。ここで入力する各パラメータは移行元の既存vSphere環境のものになります。

 $ python3 vcf_brownfield.py check --vcenter 'vCenterのFQDN' --sso-user 'SSOユーザーの名前'


実行に成功すると下記のような結果になります。赤文字は手動入力が必要なところ、橙はチェック結果のyamlのパスになります。

[2024-09-10 07:24:11,631] [INFO] vcf_brownfield: Brownfield Import main version: 5.2.0.0-24108578
Enter vCenter SSO password: ※vCenter ServerのSSOパスワードを入力
Enter SDDC Manager local admin password: ※SDDC Managerのadminパスワードを入力
[2024-09-10 07:24:25,977] [INFO] sddc_manager_helper: Generating SDDC Manager public API token <<中略>> [2024-09-10 07:24:26,837] [INFO] request_helper: Response status from retrieving domain: 200 [2024-09-10 07:24:26,906] [INFO] trust_domain: Retrieved server sddc-up-vcf-vc-01.cas.lab thumbprint: 1C:67:76:13:AD:15:5A:C8:3D:30:39:AC:33:D7:2E:AA:C3:4A:8B:DA Do you accept the thumbprint (yes/no): yes [2024-09-10 07:24:29,909] [INFO] trust_domain: Loading CA root certificates from sddc-up-vcf-vc-01.cas.lab in truststore [2024-09-10 07:24:29,910] [INFO] vcenter_rest_api_helper: Generating session to vCenter: sddc-up-vcf-vc-01.cas.lab <<中略>> [2024-09-10 07:25:07,309] [INFO] sddc_manager_helper: monitor import guardrails - IN_PROGRESS [2024-09-10 07:25:12,564] [INFO] sddc_manager_helper: monitor import guardrails - COMPLETED [2024-09-10 07:25:12,636] [INFO] check_domain_reporter: Total checks: 98, Successful checks: 97, Failed checks: 1, Internal errors: 0 [2024-09-10 07:25:12,637] [INFO] check_domain: For more details, please, check: Failed guardrails YML: /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset/output/guardrails_report_sddc-up-vcf-vc-01.cas.lab.yml Failed guardrails CSV: /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset/output/guardrails_report_sddc-up-vcf-vc-01.cas.lab.csv All guardrails CSV: /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset/output/guardrails_report_sddc-up-vcf-vc-01.cas.lab_all.csv


チェック結果のyamlファイルをcatコマンド等で確認し、ERRORとなっているものは対応します。WARNINGについても対応は必要ですが、今回の検証では無視します。

 $ cat /home/vcf/vcfimport/vcf-brownfield-import-5.2.0.0-24108578/vcf-brownfield-toolset/output/guardrails_report_sddc-up-vcf-vc-01.cas.lab.yml 


環境の移行(NSXの同時展開無し)

既存vSphere環境をVCFのVIドメインへ移行させます。ここではNSXの展開オプションを指定せずに行う手順を紹介します。

下記コマンドをSDDC Manager内にて実行します。ここで入力する各パラメータは移行元の既存vSphere環境のものになります。

 $ python3 vcf_brownfield.py import --vcenter 'vCenterのFQDN' --sso-user 'SSOユーザー名' --domain-name '管理ドメインの名前' --skip-nsx-deployment 


事前チェック時と同じように、途中パスワードの入力やyes/noを聞かれます。全て自動で実行させたい場合には下記のオプションを実行時に付け足してください。

  • --sso-password 'SSOのパスワード'
  • --vcenter-root-password 'vCenterのrootパスワード'
  • --local-admin-password 'SDDC Managerのadmin@localのパスワード'
  • --backup-password 'SDDC Managerのbackup user のパスワード'
  • --suppress-warnings:警告を無視するパラメーターです
  • --accept-trust:SSH keyを自動で信頼するパラメーターです


実行後、SDDC Managerのサービスを再起動させるため、スーパーユーザーにチェンジします。
SDDC Manager展開時に設定したrootのパスワードを聞かれるため入力します

 $ su - 


下記コマンドを入力し、サービスを再起動します。

 $ echo 'y' | /opt/vmware/vcf/operationsmanager/scripts/cli/sddcmanager_restart_services.sh 

SDDC Managerへアクセスすると無事に既存環境がVIドメインへ移行されたことが分かります。


環境の移行(NSXの同時展開有り)

既存vSphere環境をVCFのVIドメインへ移行させる際に、環境へNSXを同時に展開する手順を紹介します。

NSX展開用のJSONファイルを作成します。内容は「管理ドメインへの変換(Convert)」章の項目「環境の変換(NSXの同時展開有り)」にてご紹介したものと同じものになります。ただ、IPアドレスやFQDNはVIドメイン用として変更する必要があります。

以下のコマンドを実行し、環境の移行とNSXの展開を同時に行います。ここで入力する各パラメータは移行元の既存vSphere環境のものになります。

 $ python3 vcf_brownfield.py import --vcenter 'vCenterのFQDN' --sso-user 'SSOユーザー名' --domain-name '管理ドメインの名前' --nsx-deployment-spec-path '/home/vcf/nsx-config.json' 


途中パスワードの入力やyes/noを聞かれます。全て自動で進めたい場合は以下のオプションを実行時に付け足してください。

  • --sso-password 'SSOのパスワード'
  • --vcenter-root-password 'vCenterのrootパスワード'
  • --local-admin-password 'SDDC Managerのadmin@localのパスワード'
  • --backup-password 'SDDC Managerのbackup user のパスワード'
  • --suppress-warnings:警告を無視するパラメーターです
  • --accept-trust:SSH keyを自動で信頼するパラメーターです


実行後、SDDC Managerのサービスを再起動させるため、スーパーユーザーにチェンジします。
SDDC Manager展開時に設定したrootのパスワードを聞かれるため入力します

 $ su - 


下記コマンドを入力し、サービスを再起動します。

 $ echo 'y' | /opt/vmware/vcf/operationsmanager/scripts/cli/sddcmanager_restart_services.sh 


以上で既存vSphere環境のVIドメインへの移行とNSXの展開が完了しました。

著者紹介

SB C&S株式会社
ICT事業本部 技術本部 技術統括部
第1技術部 1課
大塚 亜人夢 - Atomu Otsuka -

VMware vExpert