Onboarding von Software in Ihren privaten Katalog
Beim Prozess zum Onboarding Ihrer Software müssen Sie eine Version in Ihren privaten Katalog importieren, die Bereitstellungsdetails konfigurieren, alle gegebenenfalls bestehenden Lizenzvoraussetzungen festlegen und validieren, ob die Version erfolgreich in der Infrastruktur, die Sie voraussetzen, installiert werden kann.
Vorbereitende Schritte
-
Laden Sie Ihren Quellcode in eine Version Ihres Repositorys unter GitHub, GitLab, oder Azure hoch. Weitere Informationen finden Sie unter Einrichten Ihres Quellcode-Repositorys.
-
Stellen Sie sicher, dass Sie ein nutzungsabhängiges Konto oder ein Abonnementkonto nutzen. Weitere Informationen bietet der Abschnitt Kontotyp anzeigen.
-
Stellen Sie sicher, dass Ihnen die Rolle 'Bearbeiter' für den Katalogverwaltungsservice zugewiesen ist. Entsprechende Informationen enthält der Abschnitt Zugriff auf Kontoverwaltungsservices zuweisen.
-
Richten Sie die zuvor automatisch für Sie erstellte Testumgebung ein:
-
Installieren Sie die IBM Cloud-Befehlszeilenschnittstelle und das Plug-in für IBM Cloud Schematics. Weitere Informationen hierzu finden Sie unter Befehlszeilenschnittstelle einrichten.
-
Laden Sie eine Readme-Datei mit der Installationsanleitung für Ihr Produkt in Ihr Quell-Repository hoch. Weitere Informationen finden Sie in Quellcode-Repository einrichten.
-
Für containerisierte Apps:
- Erstellen Sie Ihren Kubernetes-Cluster oder Red Hat OpenShift-Cluster.
- Konfigurieren Sie für Bereitstellungen unter IBM Cloud Kubernetes Service Ihr Helm-Chart.
- Richten Sie für Bereitstellungen auf Red Hat OpenShift Ihr Helm-Diagramm oder Ihren Operator ein.
-
Für virtuelle Server-Images:
- Prüfen Sie die Liste der unterstützten Images.
- Erstellen Sie bei Bedarf Ihre Terraform-Vorlage. Images virtueller Server für VPC erfordern keine Terraform-Vorlage.
- Erstellen Sie eine Instanz von IBM Cloud Object Storage und fügen Sie Ihr Image zu einem Bucket hinzu.
-
Version in privaten Katalog importieren
Mit den folgenden Schritten können Sie eine Version Ihrer Software in Ihren privaten Katalog importieren. Ihr privater Katalog wurde für Sie im Rahmen der Vorbereitung zum Verkaufen von Services erstellt.
-
Klicken Sie in der IBM Cloud-Konsole auf das Symbol Navigationsmenü
> Partner Center > Meine Produkte.
-
Wählen Sie das Produkt aus, dessen Onboarding Sie durchführen.
-
Klicken Sie auf der Registerkarte 'Software' auf Version importieren.
-
Wählen Sie Ihre Implementierungsmethode aus.
-
Wählen Sie aus, ob Sie Ihr Produkt aus einem privaten oder einem öffentlichen Repository hinzufügen. Wählen Sie für Operatoren Ihr Quellenrepository aus und wählen Sie dann das nicht öffentliche oder das öffentlich zugängliche Repository aus.
-
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/archive/refs/tags/v1.1.0.tar.gz - 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 verfügbaren Images aus, die in Ihre VPC importiert wurden, 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 zu einem neuen Produkt hinzufügen.
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.
Wenn sich Ihre Software in befindet GitLab,, müssen Sie ein persönliches Zugriffstoken verwenden, da das Herunterladen von Releases GitLab mit Projektzugriffstoken nicht unterstützt. Sie können ein persönliches Zugangstoken mit der erforderlichen Berechtigung "
read_apierstellen, indem Sie den Anweisungen hier folgen.- 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 availableangezeigt, 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). - Helm-Diagramm:
-
Falls zutreffend, legen Sie Ihr Implementierungsziel fest und fügen Sie Ihre Softwareversion hinzu.
-
Klicken Sie auf Version hinzufügen.
Versionsdetails konfigurieren
- Klicken Sie in der Versionsliste auf die Zeile, die Ihre Software enthält.
- Prüfen Sie die Details der Version, und klicken Sie auf Weiter.
- Je nach Softwaretyp können zusätzliche Schritte erforderlich sein, z. B. das Festlegen von Implementierungswerten.
- Klicken Sie auf Weiter.
Bereitstellungswerte festlegen
Falls für Ihren Softwaretyp zutreffend, können Sie Implementierungswerte festlegen, die Benutzer bei der Installation der Software angeben müssen. Sie können neue Bereitstellungswerte hinzufügen oder Bereitstellungswerte aus einer vorhandenen Version importieren.
Neue Implementierungswerte hinzufügen
- Klicken Sie auf Version konfigurieren > Weiter.
- Klicken Sie auf Implementierungswerte hinzufügen.
- Wählen Sie in der Tabelle Parameter > Hinzufügen aus, um alle Optionen auszuwählen und hinzuzufügen.
- Bei Bedarf können Sie die Parameter anpassen, indem Sie sie aus der Tabelle auswählen und auf Bearbeiten klicken.
Vorhandene Werte importieren
Führen Sie die folgenden Schritte aus, wenn Sie zuvor Bereitstellungswerte für eine bestehende Version festgelegt haben und diese Werte in Ihre aktuelle Version importieren möchten.
Importierte Werte ersetzen keine Bereitstellungswerte, die Sie Ihrer aktuellen Version bereits hinzugefügt haben.
- Klicken Sie auf Version konfigurieren > Weiter.
- Klicken Sie auf Implementierungswerte hinzufügen.
- Klicken Sie auf „ Werte aus einer früheren Version importieren “
- Wählen Sie die Version aus, die die zu importierenden Werte enthält.
- Klicken Sie auf Importieren.
- Bei Bedarf können Sie die Parameter anpassen, indem Sie sie aus der Tabelle auswählen und auf Bearbeiten klicken.
Ausgabewertbeschreibungen bearbeiten
Sie können die Beschreibungen für die Ausgabewerte Ihrer Terraform-Vorlage verbessern, damit Benutzer den Zweck der Parameter besser verstehen. Die Beschreibung eines beliebigen Ausgabewerts, den Sie in Ihre Vorlage einschließen, kann aktualisiert werden.
Um Ausgabewerte hinzuzufügen, müssen Sie sie in eine neue importierte Version Ihrer Terraform-Vorlage einschließen.
Führen Sie die folgenden Schritte aus, um die Ausgabewertbeschreibungen des Produkts zu bearbeiten:
- Klicken Sie auf Version konfigurieren > Weiter.
- Geben Sie im Abschnitt "Ausgabewertbeschreibungen" eine neue Beschreibung für den Parameter an, den Sie aktualisieren wollen.
- Klicken Sie auf Weiter.
IAM-Zugriff definieren
Falls für Ihren Softwaretyp zutreffend, können Sie die Servicezugriffs-und Plattformzugriffsrollen, die für die Installation Ihres Produkts erforderlich sind, aus dem Katalog IBM Cloud hinzufügen. Sie können neuen IAM-Zugriff definieren oder importieren, den Sie in einer früheren Version festgelegt haben.
Neuen IAM-Zugriff definieren
Führen Sie die folgenden Schritte aus, um den Zugriff Ihres Produkts zu definieren:
- Klicken Sie auf „ Version konfigurieren “ > „ Weiter “ > „ Weiter “.
- Klicken Sie auf Hinzufügen.
- Wählen Sie den Service und den erforderlichen Service-und Plattformzugriff aus.
- Die Rolle „Servicezugriff“ gewährt Zugriff auf die Nutzung des Dienstes und die Durchführung von API-Aufrufen für diesen Dienst.
- Die Plattformzugriffsrolle ermöglicht die Durchführung von Aktionen an Plattformressourcen, wie beispielsweise das Erstellen einer Instanz, das Verbinden von Instanzen mit Apps und das Zuweisen von Benutzerzugriffen.
- Klicken Sie auf Speichern.
Vorhandenen IAM-Zugriff importieren
Führen Sie die folgenden Schritte aus, wenn Sie zuvor IAM-Zugriff für eine vorhandene Version definiert hatten und die Werte in Ihre aktuelle Version importieren wollen.
Der importierte IAM-Zugriff ersetzt keinen IAM-Zugriff, den Sie Ihrer aktuellen Version bereits hinzugefügt haben.
- Klicken Sie auf „ Version konfigurieren “ > „ Weiter “ > „ Weiter “.
- Klicken Sie auf Hinzufügen.
- Klicken Sie auf „ IAM-Zugriff aus einer früheren Version importieren “.
- Wählen Sie die Version aus, die den IAM-Zugriff enthält, den Sie importieren möchten.
- Klicken Sie auf Hinzufügen.
Lizenzvereinbarungen hinzufügen
Wenn Benutzer Lizenzvereinbarungen akzeptieren müssen, die über die IBM Cloud -Servicevereinbarung hinausgehen, wenn sie die Software installieren, geben Sie die URL zu jeder Vereinbarung an oder importieren Sie Lizenzen aus einer vorhandenen Version.
Neue Lizenzvereinbarungen hinzufügen
- Klicken Sie auf „ Lizenzvereinbarungen hinzufügen “ > „ Lizenz hinzufügen “.
- Geben Sie den Namen und die URL ein und klicken Sie auf Lizenz hinzufügen.
- Nachdem Sie alle zusätzlichen Lizenzvereinbarungen eingegeben haben, klicken Sie auf Weiter.
Lizenzvereinbarungen importieren
Führen Sie die folgenden Schritte aus, wenn Sie zuvor Lizenzvereinbarungen für eine vorhandene Version hinzugefügt haben und die Lizenzen in Ihre aktuelle Version importieren wollen.
Importierte Lizenzen ersetzen keine Lizenzvereinbarungen, die Sie Ihrer aktuellen Version bereits hinzugefügt haben.
- Klicken Sie auf „ Lizenzvereinbarungen hinzufügen “ > „ Lizenz hinzufügen “.
- Klicken Sie auf Lizenzen aus einer Vorgängerversion importieren.
- Wählen Sie die Version aus, die die zu importierenden Lizenzen enthält.
- Klicken Sie auf Importieren.
Readme-Datei prüfen
Wenn Benutzer die Software installieren, können sie Produktinformationen anzeigen, indem sie auf den Readme-Link klicken. Die Informationen unter dem Link „Readme“ werden aus der Readme-Datei generiert, die Sie in Ihr Quell-Repository hochgeladen haben.
- Klicken Sie auf der Registerkarte "Readme bearbeiten" auf das Symbol Bearbeiten
.
- Zeigen Sie in einer Vorschau an, wie die Informationen in der Readme-Datei den Benutzern bei der Installation der Software angezeigt werden.
- Um Aktualisierungen vorzunehmen, klicken Sie auf das Symbol Bearbeiten
neben dem Titel des Readme-Abschnitts.
- Klicken Sie auf Speichern.
- Klicken Sie auf Weiter.
Wenn Sie ein Image eines virtuellen Servers 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 erforderlichen Aktualisierungen vor.
Produkt prüfen
Die Schritte zur Prüfung Ihres Produkts können abhängig von der Art der Software, für die Sie ein Onboarding durchführen, variieren.
- Konfigurieren Sie auf der Registerkarte "Produkt validieren" Ihr Validierungsziel und klicken Sie auf Weiter. Dieser Schritt gilt nur für Helm-Diagramme und Operatoren.
- Konfigurieren Sie Ihren Arbeitsbereich und klicken Sie auf Weiter. Dieser Schritt gilt nur für Helm-Diagramme, Operatoren, Terraform-Vorlagen und Images virtueller Server mit Terraform.
- Klicken Sie auf Validieren.
Klicken Sie auf Protokolle anzeigen, um den Fortschritt des Validierungsprozesses zu überwachen.
Software mit der API überprüfen
Sie können Ihre Software validieren, indem Sie die Katalogverwaltungs-APIaufrufen.
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)
Verwaltung von Sicherheits- und Compliance-Kontrollen
Kontrollmechanismen dienen zum Erfüllen von Sicherheits- und Complianceanforderungen. Nur Steuerelemente, die von unterstützt Workload Protection werden, werden im Katalog angezeigt. Weitere Informationen finden Sie unter Steuerelemente in Ihrer Readme-Datei formatieren.
Steuerelemente hinzufügen
Um Steuerelemente hinzuzufügen, führen Sie die folgenden Schritte aus:
-
Wählen Sie auf der Seite „Compliance verwalten“ die Option „Kontrollen hinzufügen“ aus.
-
Wählen Sie eine Workload Protection Instanz und anschließend eine Richtlinie aus.
Wenn Sie noch keine Workload Protection Instanz bereitgestellt haben, müssen Sie eine aus dem IBM Cloud Katalog einrichten und Cloud Security Posture Management(CSPM) für Ihr IBM Cloud Konto aktivieren. Führen Sie anschließend die Schritte zur Integration mit einer bestehenden Workload Protection Instanz oder einer neuen Instanz durch.
-
Wählen Sie aus, ob Sie die gesamte Richtlinie oder nur einen Teil der Kontrollen hinzufügen möchten.
-
Wenn Sie eine gesamte Richtlinie hinzufügen möchten, fahren Sie mit dem nächsten Schritt fort. Wenn Sie eine Teilmenge von Steuerelementen hinzufügen möchten, wählen Sie die gewünschten Steuerelemente aus.
-
Klicken Sie auf Hinzufügen.
Hinzufügen von Inventarergebnissen aus Workload Protection
Sie können Inventarergebnisse aus Workload Protection hinzufügen, damit Benutzer die angegebene Konformität sehen können, wenn sie Ihr Produkt im Katalog bewerten.
In wird Workload Protection Ihr Inventar einmal täglich aktualisiert. Sie müssen Ihre Ressourcen bereitstellen und warten, bis das Inventar aktualisiert wurde, bevor Sie das Inventar zu Ihrem Katalog hinzufügen können. Weitere Informationen finden Sie unter „ Inventar “.
Um Bestandsergebnisse hinzuzufügen, führen Sie die folgenden Schritte aus:
- Klicken Sie auf der Seite „Compliance verwalten“ auf „ Ergebnisse hinzufügen “.
- Wählen Sie die zuvor Workload Protection bereitgestellte Instanz aus.
- Klicken Sie auf „Übernehmen“, um die neuesten Bestandsergebnisse zu übernehmen.