IBM Cloud Docs
Terraform を使用した仮想サーバー・イメージのプライベート・カタログへのオンボード

Terraform を使用した仮想サーバー・イメージのプライベート・カタログへのオンボード

Terraform を使用した仮想サーバー・イメージのオンボードは推奨されません。 2024 年 3 月 29 日以降、Terraform を使用した仮想サーバー・イメージのオンボードは配信方式としてサポートされなくなりました。これは、Terraform を使用した新規仮想サーバー・イメージをオンボードできないことを意味します。 IBM Cloud カタログ内の既存の VSI を使用できますが、バージョン更新を利用し、継続的なサポートを確保するために、Virtual Private Cloud 用の仮想サーバー・イメージを直接オンボードします。 詳しくは、 VPC の仮想サーバー・イメージのオンボード を参照してください。

このチュートリアルでは、Terraform を使用してプライベート・カタログに仮想サーバー・イメージをプライベート・カタログにオンボードする方法について説明します。 このチュートリアルを完了することで、GitHub リポジトリーから仮想サーバー・イメージをインポートし、デプロイメントおよびその他の詳細を構成し、ターゲット IBM Cloud® Virtual Private Cloud (VPC) にイメージをデプロイできることを検証する方法を習得できます。

このチュートリアルは、 Terraform を使用したサンプル仮想サーバー・イメージ を IBM Cloud®にオンボードして公開する方法を示す一連の 4 つのチュートリアルのうちの 1 つです。 このチュートリアルを実行するときには、製品のニーズに合わせて各ステップを調整してください。

このチュートリアルには、ターゲット VPC への仮想サーバー・イメージのデプロイが含まれます。 そのため、関連する IBM Cloud インフラストラクチャー料金が発生します。

開始前に

  1. IBM Cloud オブジェクト・ストレージのインスタンスを作成して、イメージをバケットにアップロードします。

  2. VPC を作成します。

  3. ソフトウェアを使用可能にする すべての地域にカスタム・イメージをインポート します。

  4. Terraform テンプレートを作成します。

  5. Terraform テンプレートと README ファイルを GitHub リポジトリーにアップロードします。

    リポジトリーのセットアップ方法の例として、 サンプル Terraform コードの最新リリース を使用してください。

  6. 「カタログ管理」サービスと「パートナー・センター - 販売」サービスに対して IBM Cloud ID およびアクセス管理 (IAM) のエディター役割が割り当てられていることを確認してください。 詳細は、アカウント管理サービスへのアクセス権限の割り当てを参照してください。

  7. シリーズの前のチュートリアルの Partner Center での仮想サーバー・イメージの登録と仮想サーバー・イメージの製品の詳細の定義を完了しておきます。

プライベート・カタログへの仮想サーバー・イメージのインポート

以下の手順で、仮想サーバー・イメージを GitHub リポジトリーからプライベート・カタログにインポートします。このプライベート・カタログは、IBM Cloud Partner Center に仮想サーバー・イメージを登録したときに作成されたものです。

  1. IBM Cloud コンソールで、 「ナビゲーション・メニュー」 アイコン 「ナビゲーション・メニュー」アイコン > 「パートナー・センター」 > 「マイ製品」 をクリックします。

  2. 製品を選択します。

  3. 「ソフトウェア」ページで、 「バージョンのインポート」 をクリックします。

  4. デプロイメント方式として Terraform を使用する仮想サーバー・イメージ (Virtual server image with Terraform) を選択します。

  5. リポジトリー・タイプとして パブリック・リポジトリー が選択されていることを確認します。

  6. 「Terraform を使用した仮想サーバー・イメージ (Virtual server image with Terraform)」 をクリックして、 「ソース URL」 フィールドに値を入力します。

    あるいは、フィールドに https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz をコピーして貼り付けることもできます。

  7. ソフトウェア・バージョンとして 1.0.0 を入力します。

  8. バージョンを追加 をクリックします。

  9. 製品の名前をクリックします。

  10. 編集 アイコン 編集アイコンをクリックします。

  11. 配信方法が 「VPC VSI」 に設定されていることを確認します。

  12. 保存 をクリックします。

バージョンの詳細の確認

「バージョンの構成」タブから、バージョンの詳細を確認できます。 アクションは不要です。 バージョンの詳細を確認したら、次へをクリックします。

デプロイメント値を構成します。

バージョンの詳細を確認したら、デプロイメント値を構成することができます。

  1. Schematics で使用する Terraform ランタイムのバージョンを指定する必要がある場合は、デフォルトの Terraform ランタイム・バージョンのオーバーライド のチェック・ボックスをクリックし、バージョンを入力します。
  2. 「デプロイメントの詳細の構成」セクションで、デプロイメント値を追加 をクリックします。
  3. パラメーター チェック・ボックスを選択してすべてのオプションを選択し、 追加 をクリックします。
  4. ユーザーがインストール時に指定する必要があるパラメーターと、ユーザーに対して完全に非表示にするパラメーターをカスタマイズするには、パラメーターを選択して編集 をクリックします。 チェック・ボックスにマークを付けて値を構成し、保存 をクリックします。 このチュートリアルの目的に沿い、以下の表の説明に従って各パラメーターを構成します。
表 1. 仮想サーバー・イメージのデプロイメント値
パラメーター 説明 ユーザーが指定する必要があるか? ユーザーに対して非表示か?
TF_VERSION Schematics ワークスペースで使用される Terraform エンジンのバージョン。 いいえ はい
region 仮想プライベートクラウド(VPC) インスタンスを配置するリージョン。 はい いいえ
ssh_key_name 仮想サーバー・インスタンスの作成時に使用する SSH 公開鍵の名前。 はい いいえ
subnet_id 仮想サーバー・インスタンスが使用する VPC 内のサブネットの ID。 はい いいえ
vsi_instance_name 仮想サービス・インスタンスの名前。 はい いいえ
vsi_profile 仮想サーバー・インスタンスの作成時に使用するコンピュート CPU リソースおよびメモリー・リソースのプロファイル。 はい いいえ
vsi_security_group 作成されるセキュリティー・グループの名前。 はい いいえ

次に、 region パラメーターの構成タイプを更新します。

  1. 「デプロイメント値」表から、region パラメーターを選択し、編集 をクリックします。
  2. 値の詳細 (Value details) メニューを開き、 VPC リージョン (VPC region) を選択します。
  3. 保存 をクリックします。
  4. 次へ をクリックします。

出力値の説明の編集

Terraform テンプレートの出力値の説明を改善して、ユーザーがパラメーターの目的を理解しやすくすることができます。 テンプレートに含めるすべての出力値の説明を更新できます。

出力値を追加するには、Terraform テンプレートの新規インポート・バージョンに出力値を含める必要があります。

商品の出力値の説明を編集するには、以下のステップを実行します。

  1. バージョンの構成 > 次へ をクリックします。
  2. 「出力値の説明」セクションで、更新するパラメーターの新しい説明を指定します。
  3. 次へ をクリックします。

IAM アクセスの定義

デプロイメント値を構成した後、 IBM カタログから製品をインストールするために必要なサービス・アクセス役割とプラットフォーム・アクセス役割を追加できます。

製品のアクセス権限を定義するには、以下の手順を使用します。

  1. バージョンの構成 > 次へ > 次へ をクリックします。
  2. 追加 をクリックします。
  3. サービスと、必要なサービスおよびプラットフォームのアクセス権限を選択します。
    • サービスアクセスロールは、サービスの使用とサービスAPIコールの実行のためのアクセスを許可します。
    • プラットフォーム・アクセス・ロールは、インスタンスの作成、インスタンスとアプリの接続、ユーザー・アクセスの割り当てなど、プラットフォーム・リソースに対して実行されるアクションを可能にします。
  4. 保存 をクリックします。

使用条件の追加

ユーザーが IBM Cloud サービス契約以外の使用許諾契約書に同意する必要がある場合は、契約ごとに URL を指定します。

  1. 「ご使用条件の追加」ページで、 「ライセンスの追加」 をクリックします。
  2. 名前と URL を入力して、 ライセンスを追加 をクリックします。
  3. 追加のご使用条件をすべて入力し、 「次へ」 をクリックします。

README ファイルの確認

プライベート・カタログにインポートした TGZ ファイルには、仮想サーバー・イメージの製品情報を提供する README ファイルが含まれています。 README ファイルを更新する場合は、プライベート・カタログから直接編集することができます。 このチュートリアルでは、以下の手順で README ファイルの説明を編集することができます。

  1. 編集 アイコン編集アイコンをクリックし、以下の文で説明を更新します。

    Create and deploy a virtual server with ease by using a custom image.

  2. 保存 をクリックします。

  3. 次へ をクリックします。

仮想サーバー・イメージの検証

仮想サーバー・イメージを VPC にデプロイできることを確認します。

  1. 「バージョンの検証」ページで、 Schematics ワークスペースの名前を入力し、リソース・グループを選択し、 Schematics 領域を選択して、 「次へ」 をクリックします。

    タグ フィールドに、仮想サーバー・イメージに付ける特定のタグの名前を入力できます。 タグを使用すると、アカウントのリソースを編成したり、使用料金を追跡したり、リソースへのアクセスを管理したりできます。

  2. 「デプロイメント値」セクションで、パラメーター値を確認して、次へ をクリックします。

  3. 「製品の検証」セクションで、以下のご使用条件を読み、同意します を選択します。

  4. 検証 をクリックします。

    「ログを表示」 をクリックすると、検証プロセスの進行状況をモニターすることができます。

検証が正常に完了したら、「コンプライアンスの管理」ページに戻り、検証中にコントロールに対して実行された Code Risk Analyzer スキャンの結果を表示できます。 次に、オプションで、アカウントで既に構成したプロファイルに基づいて IBM Cloud Security and Compliance Center スキャンの結果を追加して、コンプライアンスの追加証拠を得ることができます。

  1. 「バージョンの検証」ページで、 「スキャンの実行依頼」 タブに移動します。
  2. 使用可能なスキャンを選択し、 「スキャンの実行依頼」 をクリックします。 選択できるプロファイル・オプションがない場合は、 カスタム・プロファイルの作成 を参照してください。

「コンプライアンスの管理」ページで、このスキャンを適用した結果を表示できます。

コンプライアンスの管理

プロファイルとコントロールをソフトウェアに追加して、セキュリティーとコンプライアンスの要件を満たしていることを証明することができます。 検証中に作成されたリソースをスキャンするには、 Security and Compliance Center を使用する必要があります。

Security and Compliance Center スキャンでサポートされ、 Security and Compliance Center スキャンで検証されたプロファイルとコントロールのみがカタログに表示されます。

Security and Compliance Centerのスキャンを実行する

プロファイルとコントロールを要求する場合は、検証中に作成されたリソースを評価して、コンプライアンスを確認する必要があります。 スキャンを実行するには、以下の手順を完了する：

  1. IBM Cloudコンソールで、メニューアイコン Menu icon > Security and Compliaceをnクリックして、Security and Compliance Centerにアクセスします。
  2. ナビゲーションで「プロフィール」をクリックします。
  3. 評価するプロファイルの行にある 「オーバーフロー」 メニューをクリックし、 「スキャンの実行」 を選択します。
  4. スキャンの実行をクリックします。

スキャンが完了したら、プライベート・カタログに戻ってオンボーディング・プロセスを続行できます。

コンプライアンス制御の追加

要求するプロファイルとコントロールを追加します。

  1. 製品の「コンプライアンスの管理」セクションで、 「クレームの追加」 を選択します。
  2. 追加したいプロファイルを選択します。
  3. プロファイル全体を追加するか、コントロールのサブセットを追加するかを選択します。
  4. プロファイル全体を選択する場合は、次のステップに進みます。 コントロールのサブセットを追加することを選択した場合は、追加するコントロールを選択します。
  5. 追加 をクリックします。

Security and Compliance Center スキャンの適用

以前に Security and Compliance Center. Security and Compliance Center スキャンで実行したスキャンを追加して、規制管理への準拠性を判別します。 詳細については、オンデマンドスキャンの実行 を参照してください。

  1. スキャンの追加 をクリックします。
  2. 評価に使用したプロファイルを選択します。
  3. Security and Compliance Center スキャンを選択します。
  4. 「スキャンの適用」 をクリックします。
  5. 次へ をクリックします。

要件の確認

仮想サーバー・イメージを公開するには、検証およびその他の要件を完了する必要があります。

次のステップ

仮想サーバー・イメージは、まだ他のアカウントに公開されていません。 REST API を使用してイメージを公開し、ユーザーがそのイメージを使用して仮想サーバー・インスタンスを作成できるようにします。 詳しくは、 イメージの可視性の更新を参照してください。

仮想サーバー・イメージを公開したら、Partner Center に戻ってカタログに公開することができます。 詳しくは、IBM Cloud カタログへの仮想サーバー・イメージの公開を参照してください。