建立專用型錄

專用型錄可讓您管理帳戶中使用者對產品的存取權。

1. 移至 IBM Cloud 主控台中的 管理 > 型錄，然後按一下 建立型錄。
2. 請輸入目錄的名稱和說明。
3. 選取以在專用型錄中排除或併入 IBM Cloud 型錄中的所有產品。 如需如何影響型錄中的可見性的相關資訊，請參閱 管理型錄設定。
4. 按一下建立。

將軟體匯入您的私人目錄

請完成下列步驟，將軟體匯入至您的專用型錄:

1. 從「專用產品」頁面中，按一下 新增。

2. 選取部署方法。

3. 選取您是從專用或公用儲存庫新增產品。 或者，如果您要從 Red Hat 登錄中上線操作員，請選取 Red Hat 儲存庫類型: Certified、Marketplace、Community。

   如果您是從專用儲存庫新增產品，則可以提供個人存取記號，也可以使用密鑰。 您可以讓使用者存取密鑰、將記號新增至密鑰，以及集中管理所有記號和存取密鑰所容許的存取權，而不是提供個人存取記號給使用者。

   • 如果您使用個人存取記號，請選取 否，以指出您不是使用密鑰，並提供個人存取記號。
   • 如果您使用密鑰，請選取 是，然後按一下 從 Secrets Manager中選取。 選取服務實例、密碼群組及密碼。 如果您沒有看到密鑰，請確定您使用的是正確的密鑰群組及服務實例。

   如果您尚未建立密鑰，或者您沒有使用密鑰的正確存取權，則即使您具有已建立的服務實例，也可能會顯示訊息 No service instance available。

4. 請輸入您的來源網址 URL。 您可以檢閱每個軟體類型的下列受支援格式清單:

   • Helm 圖表: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
   • Node-RED 操作員: https://github.com/IBM-Cloud/operator-bundle-sample/archive/refs/tags/v0.0.3.tar.gz
   • 來自 Red Hat OpenShift on IBM Cloud 登錄的運算子組合: 例如，從「認證」儲存庫中可用的「運算子」清單中選取 Akka Cluster Operator。
   • OVA 映像檔: https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Terraform 範本: https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • 使用 Terraform 建立虛擬伺服器映像檔：https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • VPC 的虛擬伺服器映像檔: 從已匯入至 VPC 的可用映像檔清單中選取映像檔，或將新映像檔匯入至帳戶。

   VPC 的虛擬伺服器映像檔一次只能新增至一個專用型錄內的一個產品。 如果您要匯入的虛擬伺服器映像檔已匯入至另一個產品，則必須先從該產品移除映像檔或刪除產品，然後再將虛擬伺服器映像檔新增至新產品。

5. 如果適用，請以主要版本、次要版本及修訂格式輸入軟體版本。 例如，輸入 1.1.2版。

6. 選取產品的型錄種類。 「類別」是用來根據功能、用途或常見解決方案，將 IBM Cloud 產品目錄中的商品進行分類的。

7. 按一下 新增產品。

新增型錄項目詳細資料

當您針對具有專用型錄存取權的使用者將產品發佈至型錄時，他們會看到一個磚，其中包含在上線期間新增的產品名稱及其他詳細資料。 除了您在匯入軟體時設定的種類之外，您還可以新增與產業、相符性、它使用的技術等相關的其他過濾器。 每一個過濾器都在型錄中使用，供使用者尋找符合其需求的軟體。 在目錄項目詳細資訊部分，您也可以評估並更新簡短說明、文件 URL，甚至關鍵字，以協助使用者快速搜尋並找到您的產品。

1. 從「型錄項目詳細資料」區段中，按一下 編輯 圖示 。
2. 檢閱隨產品匯入的資訊，並視需要進行編輯。
3. 檢閱過濾器和產業選項，以選取套用的型錄過濾器。 您最多可以選取五個產業過濾器。
4. 請檢查型錄項目預覽，以查看型錄磚如何顯示給在型錄中評估您軟體的使用者。
5. 當您對變更感到滿意時，請按一下 儲存。

如需相關資訊，請參閱 定義產品詳細資料。

配置軟體

新增授權合約

提供使用者在安裝產品時需要接受的授權合約的 URL。 授權合約是 IBM Cloud 服務合約的補充。

1. 按一下 新增授權合約 > 新增授權。
2. 輸入名稱和 URL，然後按一下更新 > 下一步。

編輯 Readme 檔

當使用者安裝軟體時，他們可以選取 Readme 檔的鏈結，以檢視產品資訊。 Readme 鏈結中的資訊是從您上傳至來源儲存庫的 Readme 檔產生。

1. 從編輯 Readme 標籤中，預覽使用者在安裝軟體時如何顯示 Readme 檔中的資訊。
2. 若要進行更新，請按一下 Readme 區段標題旁邊的 編輯 圖示 。
3. 按一下儲存。
4. 按下一步。

如果您要匯入 VPC 的虛擬伺服器映像檔，則不會自動產生 Readme 檔。 複製並貼上 Readme 檔範本 的內容，並視需要進行更新。

驗證軟體

當您驗證軟體時，會確認現行版本可以順利安裝在部署目標上。 驗證步驟會根據您的部署方法而有所不同。

若要監視驗證處理程序的進度，請按一下 檢視日誌。

管理合規

您可以將設定檔及控制項新增至軟體，以證明它符合安全及相符性需求。 您必須使用 Compliance Manager 來掃描驗證期間建立的資源。

型錄中只會出現 Compliance Manager 支援並由 Compliance Manager 掃描驗證的設定檔和控制項。

共用軟體

如果您想要將產品提供給帳戶或企業共用，請在導覽中按一下產品名稱，以移至產品詳細資料頁面。 在「動作」選單中，點選「分享」。 選取您要共用產品的位置，然後按一下 共用。

使用 CLI 將軟體上線至型錄

請完成下列步驟，以使用 CLI 來新增軟體。 您可以在 CI/CD 處理程序中使用此作業。 若要從專用儲存庫新增軟體，您必須包括個人存取記號。

1. 執行 ibmcloud catalog create 指令以建立專用型錄。 專用型錄可讓您管理帳戶中使用者對產品的存取權。

   ibmcloud catalog create --name CATALOG [--catalog-description "DESCRIPTION"]
   

2. 執行 ibmcloud catalog offering create 指令，以將軟體新增至專用型錄。

   ibmcloud catalog offering create [--catalog CATALOG-NAME] [--zipurl URL]
   

   如果您想要從專用儲存庫匯入軟體，則可以透過將 [-- token TOKEN] 新增至指令來使用個人存取記號。

3. 執行 ibmcloud catalog offering add-category 指令，以將種類新增至產品。 依預設，開發人員工具 種類會新增至您的產品。

   ibmcloud catalog offering add-category --catalog CATALOG_NAME [--offering OFFERING] [--category CATEGORY]
   

4. 執行 ibmcloud catalog offering import-version 指令，以在型錄中匯入您想要的軟體版本。

   ibmcloud catalog offering import-version --catalog CATALOG --offering OFFERING_NAME --zipurl URL
   

   以下顯示每種軟體類型的受支援格式清單:

   • Helm 圖表: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
   • Node-RED 操作員: https://github.com/IBM-Cloud/operator-bundle-sample/archive/refs/tags/v0.0.3.tar.gz
   • 來自 Red Hat OpenShift on IBM Cloud 登錄的運算子組合: 例如，從「認證」儲存庫中可用的「運算子」清單中選取 Akka Cluster Operator。
   • OVA 映像檔: https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Terraform 範本: https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • 使用 Terraform 建立虛擬伺服器映像檔：https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • VPC 的虛擬伺服器映像檔: 從已匯入至 VPC 的映像檔清單中選取映像檔，或將新的映像檔匯入至帳戶。

5. 執行 ibmcloud catalog offering version validate 指令以驗證軟體。

   ibmcloud catalog offering version validate --version-locator VERSION_NUMBER --cluster CLUSTER_ID --namespace NAME [--timeout TIMEOUT] [--wait WAIT]
   

   部署該軟體可能需要幾分鐘。 執行 ibmcloud catalog offering version validate-status，以查詢產品驗證狀態來檢查驗證狀態。

   ibmcloud catalog offering version validate-status --version-locator VERSION_NUMBER [--output FORMAT]
   

6. 執行 ibmcloud catalog offering publish account，以將軟體發佈至帳戶中的使用者。

   ibmcloud catalog offering publish account [--catalog CATALOG][--offering OFFERING]
   

使用 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 的詳細資訊，請參閱 型錄管理 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 的詳細資訊，請參閱 型錄管理 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 來建立專用型錄。

1. 將引數新增至 main.tf 檔案。 下列範例會使用 ibm_cm_catalog 資源來建立專用型錄，其中 label 是用來識別型錄的顯示名稱。

   resource "ibm_cm_catalog" "cm_catalog" {
   label = "label"
   short_description = "short_description"
   }
   

   如需相關資訊，請參閱 Terraform 型錄管理 頁面上的引數參照詳細資料。

2. 完成建置配置檔之後，請起始設定 Terraform CLI。 如需相關資訊，請參閱 起始設定工作目錄。

   terraform init
   

3. 從 main.tf 檔案供應資源。 如需相關資訊，請參閱 使用 Terraform 佈建基礎架構。

   1. 執行 terraform plan 以產生 Terraform 執行計劃來預覽提出的動作。

      terraform plan
   

   1. 執行 terraform apply，以建立計劃中定義的資源。

      terraform apply
   

使用 Terraform 將產品匯入至型錄

請使用下列步驟，使用 Terraform 將產品匯入至專用型錄。

1. 將引數新增至 main.tf 檔案。 下列範例使用 ibm_cm_offering 資源來新增產品，其中 label 是用來識別產品的顯示名稱。

   resource "ibm_cm_offering" "cm_offering" {
   catalog_id = "catalog_id"
   label = "label"
   tags = [ "tags" ]
   }
   

   如需相關資訊，請參閱 Terraform 型錄管理 頁面上的引數參照詳細資料。

2. 完成建置配置檔之後，請起始設定 Terraform CLI。 如需相關資訊，請參閱 起始設定工作目錄。

   terraform init
   

3. 從 main.tf 檔案供應資源。 如需相關資訊，請參閱 使用 Terraform 佈建基礎架構。

   1. 執行 terraform plan 以產生 Terraform 執行計劃來預覽提出的動作。

      terraform plan
   

   1. 執行 terraform apply，以建立計劃中定義的資源。

      terraform apply
   

使用 Terraform 匯入軟體版本

新增產品之後，請使用下列步驟，以使用 Terraform 來新增軟體版本。

1. 將引數新增至 main.tf 檔案。 下列範例使用 cm_version 資源來存取軟體版本，其中 offering_id 識別軟體。

   resource "cm_version" "cm_version" {
   catalog_identifier = "catalog_identifier"
   offering_id = "offering_id"
   zipurl = "zipurl"
   }
   

   如需相關資訊，請參閱 Terraform 型錄管理 頁面上的引數參照詳細資料。

2. 完成建置配置檔之後，請起始設定 Terraform CLI。 如需相關資訊，請參閱 起始設定工作目錄。

   terraform init
   

3. 從 main.tf 檔案供應資源。 如需相關資訊，請參閱 使用 Terraform 佈建基礎架構。

   1. 執行 terraform plan 以產生 Terraform 執行計劃來預覽提出的動作。

      terraform plan
   

   1. 執行 terraform apply，以建立計劃中定義的資源。

      terraform apply