アカウントへのソフトウェアのオンボーディング

ソフトウェアをご使用のアカウントにオンボードするプロセスには、プライベート・カタログにバージョンをインポートし、必要なターゲット・インフラストラクチャーにそのバージョンを正常にインストールできるかどうかを検証し、アカウントにソフトウェアを公開することが含まれます。そうすることで、そのソフトウェアをアカウント内のユーザーが使用できるようになります。

開始前に

コンテナー化アプリの場合は、以下の前提条件を実行します。

Kubernetes クラスターまたはRed Hat OpenShift クラスターを作成します。
IBM Cloud Kubernetes サービスへのデプロイメントの場合は、Helm チャートをセットアップします。
Red Hat OpenShift へのデプロイメントの場合は、Helm チャートまたはオペレーターをセットアップします。

仮想サーバー・イメージの場合は、以下の前提条件を実行します。

サポートされるイメージのリストを確認します。
必要に応じて、 Terraform テンプレートを作成します。 VPC の仮想サーバー・イメージには、Terraform テンプレートは必要ありません。
IBM Cloud オブジェクト・ストレージのインスタンスを作成して、イメージをバケットに追加します。

Terraform を使用してアカウントにソフトウェアをオンボードする前に、以下を完了していることを確認してください。

Terraform CLI をインストールし、Terraform 用の IBM Cloud プロバイダー・プラグインを構成します。詳しくは、 IBM Cloud® のチュートリアルを参照してください。このプラグインは、以下のタスクを実行するために使用される IBM Cloud API を抽象化します。
main.tfという名前の Terraform 構成ファイルを作成します。このファイルでは、 HashiCorp 構成言語を使用してリソースを定義します。詳細については、 Terraformのドキュメントを参照してください。

ソフトウェアを他のアカウントと共有するには、ソフトウェアが Partner Center で承認されている必要があります。詳しくは、ソフトウェアを販売するためのセットアップの準備を参照してください。

プライベート・カタログの作成

プライベート・カタログによって、アカウント内のユーザーの製品に対するアクセス権限を管理することができます。

IBM Cloud コンソールで［ 管理］ ＞［ カタログ ］に移動し、［ カタログを作成 ］をクリックします。
カタログの名前と説明を入力します。
IBM Cloud カタログ内のすべての製品をプライベート・カタログに含めるか除外するかを選択します。これがカタログ内の可視性に与える影響について詳しくは、カタログ設定の管理を参照してください。
「作成」 をクリックします。

プライベート・カタログへのソフトウェアのインポート

プライベート・カタログにソフトウェアをインポートするには、以下の手順を実行します。

カタログ・エントリーの詳細の追加

プライベート・カタログへのアクセス権限を持つユーザー向けに製品をカタログに公開すると、製品名およびオンボーディング中に追加されたその他の詳細を含むタイルが表示されます。ソフトウェアのインポート時に設定したカテゴリーに加えて、業界、コンプライアンス、処理対象のテクノロジーなどに関連する他のフィルターを追加することができます。これらの各フィルターは、ユーザーがニーズに合ったソフトウェアを見つけるためにカタログで使用されます。カタログ・エントリーの詳細セクションでは、簡略説明、文書 URL、さらにはキーワードを評価して更新することもできます。これにより、ユーザーは製品を素早く検索して見つけることができるようになります。

カタログ・エントリーの詳細セクションで、編集アイコンをクリックします。
製品とともにインポートされた情報を確認し、必要に応じて編集します。
フィルターおよび業界オプションを確認して、適用するカタログ・フィルターを選択します。最大 5 つの業界フィルターを選択できます。
カタログ・エントリーのプレビューを確認して、カタログ内のソフトウェアを評価するユーザーに対してカタログ・タイルがどのように表示されるかを確認します。
変更内容に問題がない場合は、保存をクリックします。

詳しくは、製品の詳細の定義を参照してください。

ソフトウェアの構成

Helm チャート

製品の詳細ページに表示されるバージョン・リストで、対象のソフトウェアの行をクリックします。
バージョンの詳細を確認し、次へをクリックします。
プリインストールを構成し、次へをクリックします。
インストール・スクリプトの実行に必要なアクセス権限を設定し、デプロイメント値を設定することによって、デプロイメントの詳細を構成し、次へをクリックします。

Terraform

製品の詳細ページに表示されるバージョン・リストで、対象のソフトウェアの行をクリックします。
バージョンの詳細を確認し、次へをクリックします。
デプロイメント値を構成します。
該当する場合は、出力値の説明を編集し、 「次へ」 をクリックします。
必要な IAM アクセス権限を定義し、 「次へ」 をクリックします。

GitHub リポジトリーのオペレーター

製品の詳細ページに表示されるバージョン・リストで、対象のソフトウェアの行をクリックします。
バージョンの詳細を確認し、次へをクリックします。

Red Hat レジストリーのオペレーター

製品の詳細ページに表示されるバージョン・リストで、対象のソフトウェアの行をクリックします。
バージョンの詳細を確認し、次へをクリックします。

OVA イメージ

製品の詳細ページに表示されるバージョン・リストで、対象のソフトウェアの行をクリックします。
バージョンの詳細を確認し、次へをクリックします。

Terraform を使用した仮想サーバー・イメージ

製品の詳細ページに表示されるバージョン・リストで、対象のソフトウェアの行をクリックします。
バージョンの詳細を確認し、次へをクリックします。
デプロイメント値を構成します。
該当する場合は、出力値の説明を編集し、 「次へ」 をクリックします。
必要な IAM アクセス権限を定義し、 「次へ」 をクリックします。

Virtual Server for VPCのイメージ

製品の詳細ページに表示されるバージョン・リストで、対象のソフトウェアの行をクリックします。
イメージのリストを確認し、 「次へ」 をクリックします。
バージョンの詳細を確認し、次へをクリックします。

使用条件の追加

ユーザーがこの製品をインストールする際に同意する必要があるご使用条件の URL を指定します。ご使用条件は、IBM Cloud サービス契約に追加されます。

[ ライセンス契約の追加 ] > [ ライセンスの追加 ] をクリックします。
名前と URL を入力し、更新 >次へをクリックします。

README ファイルの編集

ユーザーがソフトウェアをインストールする際、Readmeファイルへのリンクを選択して製品情報を確認することができます。「Readme」リンクに記載されている情報は、ソースリポジトリにアップロードしたreadmeファイルから生成されたものです。

「README の編集」タブで、ソフトウェアのインストール時に README ファイル内の情報がユーザーにどのように表示されるかをプレビューします。
更新するには、「README」セクションのタイトルの横にある編集アイコンをクリックします。
保存をクリックします。
次へをクリックします。

VPC の仮想サーバー・イメージをインポートする場合、README ファイルは自動的に生成されません。 README ファイル・テンプレートの内容をコピーして貼り付け、必要に応じて更新します。

ソフトウェアの検証

ソフトウェアを検証する際は、現行バージョンをデプロイメント・ターゲットに正常にインストールできることを確認します。検証ステップは、デプロイメント方式によって異なります。

検証プロセスの進行状況をモニターするには、 ログを表示 をクリックします。

Helm チャート

「製品の検証」タブから、対象のクラスターを選択します。
デプロイメント・ターゲットが Kubernetes クラスターの場合は、名前空間を選択するか、新規作成します。デプロイメント・ターゲットが Red Hat OpenShift クラスターの場合は、プロジェクトを選択するか、新規作成します。
次へをクリックします。
IBM Cloud Schematics ワークスペースを構成します。
次へをクリックします。
該当する場合、ご使用条件を確認し、 以下のご使用条件を読み、同意します を選択します。
検証をクリックします。

Terraform

「製品の検証」タブで、IBM Cloud Schematics ワークスペースを構成します。
次へをクリックします。
該当する場合、ご使用条件を確認し、 以下のご使用条件を読み、同意します を選択します。
検証をクリックします。

GitHub リポジトリーのオペレーター

「製品の検証」タブで Red Hat OpenShift クラスターを選択します。
プロジェクトを選択するか、新規作成します。プロジェクトは Kubernetes クラスター名前空間に似ており、ご使用の Red Hat OpenShift 環境からリストが取り込まれます。
次へをクリックします。
IBM Cloud Schematics ワークスペースを構成します。
次へをクリックします。
該当する場合、ご使用条件を確認し、 以下のご使用条件を読み、同意します を選択します。
検証をクリックします。

Red Hat レジストリーのオペレーター

「製品の検証」タブで更新チャネルを選択します。
承認戦略を選択します。
Red Hat OpenShift クラスターを選択します。
プロジェクトを選択するか、新規作成します。プロジェクトは Kubernetes クラスター名前空間に似ており、ご使用の Red Hat OpenShift 環境からリストが取り込まれます。
次へをクリックします。
IBM Cloud Schematics ワークスペースを構成します。
次へをクリックします。
該当する場合、ご使用条件を確認し、 以下のご使用条件を読み、同意します を選択します。
検証をクリックします。

OVA イメージ

「製品の検証」タブでご使用条件を確認し、 以下のご使用条件を読み、同意します を選択します。
検証をクリックします。

Terraform を使用した仮想サーバー・イメージ

「製品の検証」タブで、IBM Cloud Schematics ワークスペースを構成します。
次へをクリックします。
該当する場合、ご使用条件を確認し、 以下のご使用条件を読み、同意します を選択します。
検証をクリックします。

Virtual Server for VPCのイメージ

[検証バージョンの] タブで、検証対象を設定し、 [次へ ] をクリックします。
必要に応じて、 Schematics のワークスペースを設定し、「次へ」をクリックします。
該当する場合、ご使用条件を確認し、 以下のご使用条件を読み、同意します を選択します。
検証をクリックします。

コンプライアンスの管理

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

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

コントロールの追加

コントロールを追加するには、以下の手順を実行してください

コンプライアンス管理ページで、 [コントロールの追加] を選択します。
Workload Protection インスタンスを選択し、次にポリシーを選択します。

Workload Protection インスタンスをまだプロビジョニングしていない場合は、 IBM Cloud カタログからインスタンスを設定し、 IBM CloudアカウントでCloud Security Posture Management （CSPM）を有効にする必要があります。次に、既存の Workload Protection インスタンスまたは新規インスタンスのいずれかと統合するための手順を完了してください。
ポリシー全体を追加するか、またはコントロールの一部のみを追加するかを選択してください。
ポリシー全体を追加することを選択した場合は、次のステップに進んでください。コントロールの一部を追加する場合、追加したいコントロールを選択してください。
追加をクリックします。

Workload Protection からの在庫結果を追加

Workload Protection の在庫結果を追加することで、ユーザーがカタログで製品を評価する際に、主張されているコンプライアンスを確認できるようになります。

Workload Protection では、インベントリは1日1回更新されます。在庫をカタログ掲載に追加する前に、リソースを展開し、在庫の更新を待機する必要があります。詳しくは、コンプライアンスを参照してください。

在庫の結果を追加するには、以下の手順に従ってください：

[コンプライアンスの管理] ページで、[ 結果を追加 ] をクリックします。
以前にプロビジョニングした Workload Protection インスタンスを選択してください。
「適用」をクリックして最新の在庫結果を適用します。

要件の確認

アカウントで共有するには、検証手続きおよびその他の要件をすべて満たす必要があります。プライベート・カタログにアクセスできるすべてのユーザーが製品を使用できるようにする準備ができたら、 「共有の準備ができました」 をクリックします。

ソフトウェアの共有

製品をアカウントまたはエンタープライズで共有する場合は、ナビゲーションで製品の名前をクリックして、製品の詳細ページに移動します。 [アクション ] メニューから、[ 共有 ] をクリックします。製品を共有する場所を選択し、 「共有」 をクリックします。

CLI を使用したカタログへのソフトウェアのオンボード

以下の手順を実行して、CLI を使用してソフトウェアを追加します。このタスクは、CI/CD プロセスで使用できます。プライベートリポジトリからソフトウェアを追加するには、個人アクセストークンを含める必要があります。

API を使用したプライベート・カタログの作成

プライベート・カタログによって、アカウント内のユーザーの製品に対するアクセス権限を管理することができます。以下のサンプル要求に示すように、カタログ管理 API を呼び出すことによって、プライベート・カタログをプログラマチックに作成できます。カタログの作成について詳しくは、「カタログ管理 API」を参照してください。

String label = "{label}";
String shortDesc = "{shortDesc}";
CreateCatalogOptions createOptions = new CreateCatalogOptions.Builder().label(label).shortDescription(shortDesc).build();
Response<Catalog> response = service.createCatalog(createOptions).execute();
System.out.println(response.getResult());

label = "{label}";
shortDesc = "{shortDesc}";
response = await service.createCatalog({ 'label': label, 'shortDescription': shortDesc });
console.log(response);

label = "{label}"
shortDesc = "{shortDesc}"
response = self.service.create_catalog(label=label, short_description=shortDesc)
print(response)

label := "{label}"
shortDesc := "{shortDesc}"
createOptions := service.NewCreateCatalogOptions()
createOptions.SetLabel(label)
createOptions.SetShortDescription(shortDesc)
_, response, _ := service.CreateCatalog(createOptions)
fmt.Println(response)

API を使用したプライベート・カタログへのソフトウェアのインポート

以下のサンプル要求に示すように、カタログ管理 API を呼び出すことによって、ソフトウェアをカタログにプログラマチックにインポートできます。この API は、ソフトウェアを作成し、それもインポートします。この API について詳しくは、Catalog Management API を参照してください。

id = "{id}";
offeringURL = "{offeringURL}";
ImportOfferingOptions offeringOptions = new ImportOfferingOptions.Builder().catalogIdentifier(id).zipurl(offeringURL).build();
Response<Offering> response = service.importOffering(offeringOptions).execute();
System.out.println(response.getResult());

id = "{id}";
offeringURL = "{offeringURL}";
response = await service.importOffering({ 'catalogIdentifier': id, 'zipurl': offeringURL });
console.log(response);

id = "{id}"
offeringURL = "{offeringURL}"
response = self.service.import_offering(catalog_identifier=id, zipurl=offeringURL)
print(response)

id := "{id}"
offeringURL := "{offeringURL}"
offeringOptions := service.NewImportOfferingOptions(id, offeringURL)
_, response, _ := service.ImportOffering(offeringOptions)
fmt.Println(response)

API を使用したソフトウェアの検証

以下のサンプル要求に示すように、カタログ管理 API を呼び出すことにより、製品をプログラマチックに検証できます。この処理には数分かかることがあります。この API について詳しくは、Catalog Management API を参照してください。

String authRefreshToken = "{authRefreshToken}";
String versionLocator = "{versionLocator}";
ValidationInstallOptions installOptions = new ValidationInstallOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocId(versionLocator).build();
Response<Void> response = service.validationInstall(installOptions).execute();
System.out.println(response.getResult());

versionLocator = "{versionLocator}";
authRefreshToken = "{authRefreshToken}";
response = await service.validationInstall({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });
console.log(response);

authRefreshToken="{authRefreshToken}"
versionLocator = "{versionLocator}"
response = self.service.validation_install(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken)
print(response)

versionLocator := "{versionLocator}"
authRefreshToken := "{authRefreshToken}"
installOptions := service.NewValidationInstallOptions(versionLocator, authRefreshToken)
response, _ := service.ValidationInstall(installOptions)
fmt.Println(response)

API を使用したアカウントへのソフトウェアの公開

以下のサンプル要求に示すように、カタログ管理 API を呼び出すことにより、ソフトウェアをアカウントにプログラマチックに公開できます。

String versionLocator = "{versionLocator}";
AccountPublishVersionOptions publishOption = new AccountPublishVersionOptions.Builder().versionLocId(versionLocator).build();
Response<Void> response = service.accountPublishVersion(publishOption).execute();
System.out.println(response.getResult());

versionLocator = "{versionLocator}";
response = await service.accountPublishVersion({ 'versionLocId': versionLocator});
console.log(response);

versionLocator = "{versionLocator}"
response = self.service.account_publish_version(version_loc_id=versionLocator)
print(response)

versionLocator := "{versionLocator}"
publishOptions := service.NewAccountPublishVersionOptions(versionLocator)
response, _ := service.AccountPublishVersion(publishOptions)
fmt.Println(response)

Terraform を使用したプライベート・カタログの作成

Terraform を使用してプライベート・カタログを作成するには、以下の手順を使用します。

引数を main.tf ファイルに追加します。以下の例では、ibm_cm_catalog リソースを使用してプライベート・カタログを作成します。ここで、label はカタログを識別する表示名です。
```
resource "ibm_cm_catalog" "cm_catalog" {
label = "label"
short_description = "short_description"
}
```
詳細については、 Terraform カタログ管理ページの引数リファレンスを参照してください。
構成ファイルの作成が完了したら、Terraform CLI を初期化します。詳しくは、作業ディレクトリーの初期化を参照してください。
```
terraform init
```
main.tf ファイルからリソースをプロビジョンします。詳しくは、 Terraform を使用したインフラストラクチャーのプロビジョニングを参照してください。
1. terraform plan を実行して、提案されたアクションをプレビューするための Terraform 実行プランを生成します。
```
   terraform plan
```
1. terraform apply を実行して、計画に定義されているリソースを作成します。
```
   terraform apply
```

Terraform を使用したカタログへの製品のインポート

Terraform を使用して製品をプライベート・カタログにインポートするには、以下の手順を使用します。

引数を main.tf ファイルに追加します。以下の例では、ibm_cm_offering リソースを使用して製品を追加します。ここで、label は製品を識別する表示名です。
```
resource "ibm_cm_offering" "cm_offering" {
catalog_id = "catalog_id"
label = "label"
tags = [ "tags" ]
}
```
詳細については、 Terraform カタログ管理ページの引数リファレンスを参照してください。
構成ファイルの作成が完了したら、Terraform CLI を初期化します。詳しくは、作業ディレクトリーの初期化を参照してください。
```
terraform init
```
main.tf ファイルからリソースをプロビジョンします。詳しくは、 Terraform を使用したインフラストラクチャーのプロビジョニングを参照してください。
1. terraform plan を実行して、提案されたアクションをプレビューするための Terraform 実行プランを生成します。
```
   terraform plan
```
1. terraform apply を実行して、計画に定義されているリソースを作成します。
```
   terraform apply
```

Terraform を使用したソフトウェアのバージョンのインポート

製品を追加した後、以下の手順を使用して、Terraform を使用してソフトウェアのバージョンを追加します。

引数を main.tf ファイルに追加します。以下の例では、cm_version リソースを使用してソフトウェアのバージョンにアクセスします。ここで、offering_id はソフトウェアを識別します。
```
resource "cm_version" "cm_version" {
catalog_identifier = "catalog_identifier"
offering_id = "offering_id"
zipurl = "zipurl"
}
```
詳細については、 Terraform カタログ管理ページの引数リファレンスを参照してください。
構成ファイルの作成が完了したら、Terraform CLI を初期化します。詳しくは、作業ディレクトリーの初期化を参照してください。
```
terraform init
```
main.tf ファイルからリソースをプロビジョンします。詳しくは、 Terraform を使用したインフラストラクチャーのプロビジョニングを参照してください。
1. terraform plan を実行して、提案されたアクションをプレビューするための Terraform 実行プランを生成します。
```
   terraform plan
```
1. terraform apply を実行して、計画に定義されているリソースを作成します。
```
   terraform apply
```