Privaten Katalog erstellen

Mit privaten Katalogen können Sie den Zugriff auf Produkte für Benutzer in Ihrem Konto verwalten.

1. Gehen Sie in der „ IBM Cloud “-Konsole zu „Verwalten“ > „ Kataloge “ und klicken Sie auf „ Katalog erstellen “.
2. Geben Sie einen Namen und eine Beschreibung für Ihren Katalog ein.
3. Wählen Sie aus, ob alle Produkte des IBM Cloud-Katalogs in Ihrem privaten Katalog ausgeschlossen oder eingeschlossen sein sollen. Weitere Informationen dazu, wie sich dies auf die Sichtbarkeit im Katalog auswirkt, finden Sie unter Katalogeinstellungen verwalten.
4. Klicken Sie auf Erstellen.

Software in privaten Katalog importieren

Führen Sie die folgenden Schritte aus, um Software in Ihren privaten Katalog zu importieren:

1. Klicken Sie auf der Seite mit den privaten Produkten auf Hinzufügen.

2. Wählen Sie Ihre Implementierungsmethode aus.

3. Wählen Sie aus, ob Sie Ihr Produkt aus einem privaten oder einem öffentlichen Repository hinzufügen. Wenn Sie das Onboarding für einen Operator aus einer Red Hat-Registry durchführen, wählen Sie alternativ den Typ Ihres Red Hat-Repositorys aus: Zertifiziert, Marktplatz, Community.

   Wenn Sie Ihr Produkt aus einem privaten Repository hinzufügen, können Sie ein persönliches Zugriffstoken bereitstellen oder einen geheimen Schlüssel verwenden. Statt Benutzern ein persönliches Zugriffstoken zu erteilen, können Sie den entsprechenden Benutzern Zugriff auf einen geheimen Schlüssel ermöglichen, das Token zu einem geheimen Schlüssel hinzufügen und alle Tokens sowie den vom geheimen Schlüssel ermöglichten Zugriff zentral verwalten.

   • Wählen Sie bei Verwendung eines persönlichen Zugriffstokens Nein aus, um anzugeben, dass Sie keinen geheimen Schlüssel verwenden und das persönliche Zugriffstoken zur Verfügung stellen.
   • Wählen Sie bei Verwendung eines geheimen Schlüssels Ja aus und klicken Sie auf In Secrets Manager auswählen. Wählen Sie Ihre Serviceinstanz, die Gruppe geheimer Schlüssel und den geheimen Schlüssel aus. Falls Ihr geheimer Schlüssel nicht angezeigt wird, vergewissern Sie sich, dass Sie die richtige Gruppe geheimer Schlüssel und Serviceinstanz verwenden.

   Möglicherweise wird die Nachricht No service instance available angezeigt, wenn Sie keinen geheimen Schlüssel erstellt haben oder nicht die richtige Zugriffsberechtigung für die Verwendung von geheimen Schlüssel besitzen (selbst dann, wenn Sie erstellte Serviceinstanzen verwenden).

4. Geben Sie Ihre Quellen-URL ein. Sie können die folgende Liste der unterstützten Formate nach Softwaretyp überprüfen:

   • Helm-Diagramm: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
   • Node-RED Operator: https://github.com/IBM-Cloud/operator-bundle-sample/archive/refs/tags/v0.0.3.tar.gz
   • Operator-Bundle aus einer „ Red Hat OpenShift on IBM Cloud “-Registrierung: Wählen Sie als Beispiel das „ Akka Cluster Operator “ aus der Liste der verfügbaren Operatoren im „Certified“-Repository aus.
   • OVA-Image: https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Terraform-Vorlage: https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • Image des virtuellen Servers mit Terraform: https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • Virtuelles Server-Image für VPC: Wählen Sie in der Liste der verfügbaren Images, die in Ihre VPC importiert wurden, ein Image aus oder importieren Sie ein neues Image in Ihr Konto.

   Ein virtuelles Server-Image für VPC kann jeweils nur einem Produkt in einem privaten Katalog hinzugefügt werden. Wenn das zu importierende Image des virtuellen Servers bereits in ein anderes Produkt importiert wurde, müssen Sie das Image aus diesem Produkt entfernen oder das Produkt löschen, bevor Sie das Image des virtuellen Servers einem neuen Produkt hinzufügen.

5. Geben Sie, sofern zutreffend, die Version der Software im Format mit Hauptversion, Nebenversion und Überarbeitung an. Geben Sie beispielsweise Version 1.1.2 ein.

6. Wählen Sie eine Katalogkategorie für das Produkt aus. Mithilfe von Kategorien werden Produkte im IBM Cloud-Katalog anhand von Funktionen, Einsatzbereichen oder allgemeinen Lösungen organisiert.

7. Klicken Sie auf Produkt hinzufügen.

Details zum Katalogeintrag hinzufügen

Wenn Sie Ihr Produkt im Katalog für Benutzer mit Zugriff auf Ihren privaten Katalog veröffentlichen, wird eine Kachel mit dem Produktnamen und weiteren Details angezeigt, die während des Onboardings hinzugefügt wurden. Zusätzlich zu der Kategorie, die Sie festlegen, wenn Sie Ihre Software importieren, können Sie weitere Filter hinzufügen, die sich auf die Branche, Compliance, Technologien, mit denen die Software arbeitet, und weitere Informationen beziehen. Jeder dieser Filter wird im Katalog verwendet, damit Benutzer Software finden können, die ihren Anforderungen entspricht. Im Abschnitt mit den Details des Katalogeintrags können Sie auch die Kurzbeschreibungen, die Dokumentations-URL und auch Schlüsselwörter bewerten und aktualisieren, um die Benutzer bei der Suche nach Ihrem Produkt zu unterstützen.

1. Klicken Sie im Abschnitt "Details zum Katalogeintrag" auf das Symbol Bearbeiten .
2. Überprüfen Sie die Informationen, die mit Ihrem Produkt importiert wurden, und nehmen Sie bei Bedarf Änderungen vor.
3. Überprüfen Sie die Filter und Branchenoptionen, und wählen Sie die zutreffenden Katalogfilter aus. Sie können bis zu fünf Branchenfilter auswählen.
4. Überprüfen Sie die Vorschau des Katalogeintrags, um festzustellen, wie die Katalogkachel den Benutzern angezeigt wird, die Ihre Software im Katalog prüfen.
5. Klicken Sie auf Speichern, wenn Sie mit Ihren Änderungen zufrieden sind.

Weitere Informationen finden Sie unter Produktdetails definieren.

Software konfigurieren

Lizenzvereinbarungen hinzufügen

Stellen Sie die URLs zu den Lizenzvereinbarungen bereit, die die Benutzer akzeptieren müssen, wenn sie das Produkt installieren. Die Lizenzvereinbarungen gelten zusätzlich zur IBM Cloud-Servicevereinbarung.

1. Klicken Sie auf „ Lizenzvereinbarungen hinzufügen “ > „ Lizenz hinzufügen “.
2. Geben Sie den Namen und die URL ein und klicken Sie auf Aktualisieren > Weiter.

Bearbeiten Ihrer Readme-Datei

Wenn Nutzer die Software installieren, können sie den Link zu Ihrer Readme-Datei anklicken, um Produktinformationen anzuzeigen. Die Informationen unter dem Link „Readme“ werden aus der Readme-Datei generiert, die Sie in Ihr Quell-Repository hochgeladen haben.

1. Zeigen Sie auf der Registerkarte 'Readme bearbeiten' eine Vorschau an, wie die Informationen in der Readme-Datei den Benutzern angezeigt werden, wenn sie die Software installieren.
2. Um Aktualisierungen vorzunehmen, klicken Sie auf das Symbol Bearbeiten neben dem Titel des Readme-Abschnitts.
3. Klicken Sie auf Speichern.
4. Klicken Sie auf Weiter.

Wenn Sie ein virtuelles Server-Image für VPC importieren, wird die Readme-Datei nicht automatisch generiert. Kopieren und fügen Sie den Inhalt der Readme-Dateivorlage ein und nehmen Sie die gewünschten Aktualisierungen vor.

Validieren der Software

Wenn Sie Ihre Software validieren, bestätigen Sie damit, dass die aktuelle Version erfolgreich auf dem Bereitstellungsziel installiert werden kann. Die Validierungsschritte hängen von Ihrer Bereitstellungsmethode ab.

Klicken Sie auf Protokolle anzeigen, um den Fortschritt des Validierungsprozesses zu überwachen.

Compliance verwalten

Sie können Ihrer Software Profile und Steuerelemente hinzufügen, um zu beweisen, dass sie Sicherheits-und Konformitätsanforderungen erfüllt. Sie müssen Compliance Manager verwenden, um die während der Validierung erstellten Ressourcen zu scannen.

Nur Profile und Steuerelemente, die von den Scans Compliance Manager unterstützt und von Compliance Manager validiert werden, werden im Katalog angezeigt.

Gemeinsame Nutzung der Software

Wenn Sie Ihr Produkt für Ihr Konto oder Unternehmen freigeben möchten, klicken Sie auf den Namen des Produkts in der Navigation, um die Produktdetailseite aufzurufen. Klicken Sie im Menü „ Aktionen “ auf „ Teilen “. Wählen Sie aus, wo Sie Ihr Produkt teilen möchten, und klicken Sie auf Teilen.

Onboarding von Software in Ihren Katalog über die Befehlszeilenschnittstelle

Führen Sie die folgenden Schritte aus, um Ihre Software über die Befehlszeilenschnittstelle hinzuzufügen. Sie können diese Task in einem CI/CD-Prozess (CI/CD - Continuous Integration and Delivery) verwenden. Um Software aus einem privaten Repository hinzuzufügen, müssen Sie ein persönliches Zugriffstoken einschließen.

1. Führen Sie den Befehl ibmcloud catalog create zum Erstellen eines privaten Katalogs aus. Mit privaten Katalogen können Sie den Zugriff auf Produkte für Benutzer in Ihrem Konto verwalten.

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

2. Führen Sie den Befehl ibmcloud catalog offering create aus, um Software zu Ihrem privaten Katalog hinzuzufügen.

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

   Wenn Sie Software aus einem privaten Repository importieren möchten, können Sie ein persönliches Zugriffstoken verwenden, indem Sie [--token TOKEN] Ihrem Befehl hinzufügen.

3. Führen Sie den Befehl ibmcloud catalog offering add-category aus, um Ihrem Produkt eine Kategorie hinzuzufügen. Standardmäßig wird zu Ihrem Produkt die Kategorie Entwicklertools hinzugefügt.

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

4. Führen Sie den Befehl ibmcloud catalog offering import-version aus, um die Softwareversion zu importieren, die Sie in Ihrem Katalog verwenden wollen.

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

   Die folgende Liste enthält die unterstützten Formate nach Softwaretyp:

   • Helm-Diagramm: https://raw.githubusercontent.com/IBM/charts/master/repo/ibm-helm
   • Node-RED Operator: https://github.com/IBM-Cloud/operator-bundle-sample/archive/refs/tags/v0.0.3.tar.gz
   • Operator-Bundle aus einer „ Red Hat OpenShift on IBM Cloud “-Registrierung: Wählen Sie als Beispiel das „ Akka Cluster Operator “ aus der Liste der verfügbaren Operatoren im „Certified“-Repository aus.
   • OVA-Image: https://github.com/gcatalog/OVA-sample/blob/main/ova-sample.yaml
   • Terraform-Vorlage: https://github.com/IBM-Cloud/terraform-sample/releases/tag/v1.0.0
   • Image des virtuellen Servers mit Terraform: https://github.com/IBM-Cloud/isv-vsi-product-deploy-sample/releases/download/v1.0/isv-vsi-product-deploy-sample.tar.gz
   • Virtuelles Server-Image für VPC: Wählen Sie ein Image aus der Liste der Images aus, die in Ihre VPC importiert wurden, oder importieren Sie ein neues Image in Ihr Konto.

5. Führen Sie den Befehl ibmcloud catalog offering version validate aus, um die Software zu validieren.

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

   Die Bereitstellung der Software kann einige Minuten beanspruchen. Führen Sie den Befehl ibmcloud catalog offering version validate-status aus, um den Validierungsstatus durch Abfragen des Produktvalidierungsstatus zu überprüfen.

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

6. Führen Sie den Befehl ibmcloud catalog offering publish account aus, um Ihre Software für Benutzer in Ihrem Konto zu veröffentlichen.

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

Privaten Katalog mit der API erstellen

Mit privaten Katalogen können Sie den Zugriff auf Produkte für Benutzer in Ihrem Konto verwalten. Sie können einen privaten Katalog programmgesteuert erstellen, indem Sie die Katalogverwaltungs-API wie in der folgenden Beispielanforderung gezeigt aufrufen. Weitere Informationen zum Erstellen eines Katalogs finden Sie in der Katalogverwaltungs-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)

Software über die API in privaten Katalog importieren

Sie können Software programmgesteuert in Ihren Katalog importieren, indem Sie die Katalogverwaltungs-API wie in der folgenden Beispielanforderung gezeigt aufrufen. Diese API erstellt die Software und importiert sie ebenfalls. Detaillierte Informationen zur API finden Sie in Katalogverwaltungs-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)

Software mit der API überprüfen

Sie können Ihr Produkt programmgesteuert validieren, indem Sie die Katalogverwaltungs-API aufrufen, wie in der folgenden Beispielanforderung dargestellt. Dieser Vorgang kann einige Minuten dauern. Detaillierte Informationen zur API finden Sie in Katalogverwaltungs-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)

Veröffentlichung Ihrer Software in Ihrem Konto über die API

Sie können Ihre Software programmgesteuert in Ihrem Konto veröffentlichen, indem Sie die Katalogverwaltungs-API wie in der folgenden Beispielanforderung gezeigt aufrufen.

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)

Erstellen eines privaten Katalogs mithilfe von Terraform

Verwenden Sie die folgenden Schritte, um einen privaten Katalog mit Terraform zu erstellen.

1. Fügen Sie Ihr Argument zur Datei main.tf hinzu. Im folgenden Beispiel wird ein privater Katalog mithilfe der Ressource ibm_cm_catalog erstellt, wobei label ein Anzeigename zur Identifizierung des Katalogs ist.

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

   Weitere Informationen finden Sie in der Argumentreferenz auf der Seite „ Terraform-Katalogverwaltung “.

2. Nachdem Sie Ihre Konfigurationsdatei erstellt haben, initialisieren Sie die Terraform-CLI. Weitere Informationen finden Sie unter Arbeitsverzeichnisse initialisieren.

   terraform init
   

3. Stellen Sie die Ressourcen aus der Datei main.tf bereit. Weitere Informationen finden Sie unter Infrastruktur mit Terraform bereitstellen.

   1. Führen Sie terraform plan aus, um einen Terraform-Ausführungsplan für die Vorschau der vorgeschlagenen Aktionen zu generieren.

      terraform plan
   

   1. Führen Sie terraform apply aus, um die Ressourcen zu erstellen, die im Plan definiert sind.

      terraform apply
   

Importieren eines Produkts in Ihren Katalog mithilfe von Terraform

Verwenden Sie die folgenden Schritte, um ein Produkt mithilfe von Terraform in Ihren privaten Katalog zu importieren.

1. Fügen Sie Ihr Argument zur Datei main.tf hinzu. Das folgende Beispiel fügt Ihr Produkt mithilfe der Ressource ibm_cm_offering hinzu, wobei label ein Anzeigename zur Identifizierung des Produkts ist.

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

   Weitere Informationen finden Sie in der Argumentreferenz auf der Seite „ Terraform-Katalogverwaltung “.

2. Nachdem Sie Ihre Konfigurationsdatei erstellt haben, initialisieren Sie die Terraform-CLI. Weitere Informationen finden Sie unter Arbeitsverzeichnisse initialisieren.

   terraform init
   

3. Stellen Sie die Ressourcen aus der Datei main.tf bereit. Weitere Informationen finden Sie unter Infrastruktur mit Terraform bereitstellen.

   1. Führen Sie terraform plan aus, um einen Terraform-Ausführungsplan für die Vorschau der vorgeschlagenen Aktionen zu generieren.

      terraform plan
   

   1. Führen Sie terraform apply aus, um die Ressourcen zu erstellen, die im Plan definiert sind.

      terraform apply
   

Importieren einer Version Ihrer Software mithilfe von Terraform

Nachdem Sie Ihr Produkt hinzugefügt haben, führen Sie die folgenden Schritte aus, um eine Version Ihrer Software mit Terraform hinzuzufügen.

1. Fügen Sie Ihr Argument zur Datei main.tf hinzu. Das folgende Beispiel verwendet für den Zugriff auf die Softwareversion die Ressource cm_version, wobei offering_id die Software angibt.

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

   Weitere Informationen finden Sie in der Argumentreferenz auf der Seite „ Terraform-Katalogverwaltung “.

2. Nachdem Sie Ihre Konfigurationsdatei erstellt haben, initialisieren Sie die Terraform-CLI. Weitere Informationen finden Sie unter Arbeitsverzeichnisse initialisieren.

   terraform init
   

3. Stellen Sie die Ressourcen aus der Datei main.tf bereit. Weitere Informationen finden Sie unter Infrastruktur mit Terraform bereitstellen.

   1. Führen Sie terraform plan aus, um einen Terraform-Ausführungsplan für die Vorschau der vorgeschlagenen Aktionen zu generieren.

      terraform plan
   

   1. Führen Sie terraform apply aus, um die Ressourcen zu erstellen, die im Plan definiert sind.

      terraform apply