Onboarding einer einsatzfähigen Architektur in einen privaten Katalog

Wenn Sie Ihre einsatzfähige Architektur mit anderen Mitgliedern Ihrer Organisation teilen möchten, können Sie sie einem privaten Katalog hinzufügen. Außerdem können Sie den Onboarding-Flow nutzen, um Ihre Architektur zu validieren.

Das Onboarding Ihrer einsatzfähigen Architektur in einen privaten Katalog umfasst das Hinzufügen Ihres Quellcodes zum Katalog, die Bearbeitung der Details Ihrer einsatzfähigen Architektur und die anschließende Validierung. Anschließend überprüfen Sie die Kostenschätzung und die Informationen zur Einhaltung der Vorschriften für Ihre einsatzfähige Architektur. Wenn Sie fertig sind, können Sie die einsatzbereite Architektur gemeinsam nutzen oder sie auf IBM Cloud veröffentlichen.

High-Level-Prozess für das Einbinden einer einsatzfähigen Architektur in einen privaten Katalog

Vorbereitende Schritte

Bevor Sie Ihre verteilbare Architektur in Betrieb nehmen können, müssen Sie die folgenden Voraussetzungen erfüllen.

Stellen Sie sicher, dass Sie ein nutzungsabhängiges Konto oder ein Abonnementkonto nutzen. Weitere Informationen finden Sie unter Kontotyp anzeigen.
Vergewissern Sie sich, dass Sie den erforderlichen Zugriff haben, um mit privaten Katalogen und einsatzfähigen Architekturen zu arbeiten.
- Manager-Rolle im IBM Cloud Schematics-Dienst
- Bearbeiterrolle für den Katalogverwaltungsservice
- Rolle eines Anzeigeberechtigten für alle Ressourcengruppen in Ihrem Konto
- SecretsReader rolle auf dem Dienst Secrets Manager, wenn Sie planen, Ihre sicheren Werte in einer Instanz von Secrets Manager
- Leserrolle im Dienst Workload Protection
- Andere Rollen, die für bestimmte Ressourcen in Ihrer individuellen verteilbaren Architektur erforderlich sind
Privaten Katalog erstellen.
Stellen Sie sicher, dass Sie den Quellcode für Ihre einsatzfähige Architektur in einem GitHub oder GitLab Repository gespeichert haben. Hilfe bei der Aufnahme Ihres Quellcodes in ein Repository finden Sie unter Einrichten Ihres Quellcode-Repositorys.

Sie möchten sehen, wie es funktioniert, haben aber noch keine einsatzbereite Architektur zur Hand? Verwenden Sie unser Beispiel für eine einsatzfähige Architektur.

Verpackung Ihres Quellcodes

Um die Datei .tgz zu erstellen, die Sie benötigen, um Ihre einsatzfähige Architektur in einen privaten Katalog einzubinden, müssen Sie eine Release-Version Ihres Quellcodes erstellen. Hilfe bei der Erstellung eines Releases finden Sie unter Verwaltung von Releases in einem Repository.

Wenn Sie ein privates Quellcode-Repository verwenden, stellen Sie sicher, dass Sie ein Git persönliches Zugriffstoken oder ein Geheimnis haben, das in Secrets Manager.

Hinzufügen einer verteilbaren Architektur zu einem privaten Katalog

Um Ihre verteilbare Architektur zu einem privaten Katalog hinzuzufügen, können Sie die folgenden Schritte durchführen.

Gehen Sie in der Konsole IBM Cloud auf die Seite Verwalten > Kataloge > Private Kataloge der Konsole.
Wählen Sie den privaten Katalog aus, dem Sie ein Produkt hinzufügen möchten. Die Detailseite des Katalogs wird geöffnet.
Klicken Sie auf Produkt hinzufügen. Eine Seitenanzeige wird geöffnet.
Wählen Sie als Produkttyp die einsatzfähige Architektur.
Wählen Sie Terraform oder Stack als Ihre Bereitstellungsmethode.
Wählen Sie den Typ des Repositorys, in dem sich Ihr Quellcode befindet.

Wenn sich Ihr Quellcode in einem privaten Repository befindet, müssen Sie sich mit einem persönlichen Zugriffstoken von Git oder mit einem Geheimnis von Secrets Manager.
Fügen Sie einen Link zu Ihrem Quellcode in das Feld Quelle URL ein. Sie sollte ähnlich aussehen wie https://github.com/IBM-Cloud/terraform-sample/archive/refs/tags/v1.1.0.tar.gz.

Wenn Sie Ihre einsatzfähige Architektur zu Testzwecken einbinden, benötigen Sie keine .tgz Datei. Sie können den Link zur Stammebene Ihrer Architektur angeben.
Wählen Sie eine Variante aus.

Eine Variation ist eine Art von einsatzfähiger Architektur, die eine bestehende einsatzfähige Architektur mit unterschiedlichen Fähigkeiten oder Komplexität versieht. So könnte es beispielsweise eine Schnellstart-Variante Ihrer einsatzfähigen Architektur geben, die über grundlegende Funktionen für einen einfachen, kostengünstigen Einsatz zu internen Tests verfügt. Und vielleicht haben Sie eine etwas komplexere Standardvariante, die für die Produktion geeignet ist.
Geben Sie die Softwareversion im Format Hauptversion, Nebenversion und Revisionsnummer ein. Beispiel: 1.0.0. In der Regel entspricht diese Version der Versionsnummer Ihres Release-Snapshots.
Wählen Sie die Kategorie aus, in der Ihre einsatzfähige Architektur im Katalog gruppiert werden soll.
Klicken Sie auf Produkt hinzufügen. Die Produktübersichtsseite wird angezeigt.

Bearbeiten Sie Ihren Katalogeintrag

Nachdem Sie Ihre verteilbare Architektur erfolgreich in Ihren privaten Katalog aufgenommen haben, müssen Sie die Informationen angeben, die ein Benutzer sieht, wenn er versucht, die Architektur zu verwenden. Die Informationen umfassen Produktbeschreibungen, Links zur Dokumentation und Schlüsselwörter, die sicherstellen, dass Ihr Produkt leicht zu finden ist.

Angabe von Details über die Konsole

Ihre Benutzer sehen die Informationen auf Versionsniveau, die Sie als Teil des Katalogeintrags für Ihr Produkt definieren. Die Informationen, die als Teil dieses Flusses bereitgestellt werden, können Ihren Benutzern helfen, die Funktionalität der einzelnen Komponenten zu verstehen, die mit ihm verbunden sind.

Um sicherzustellen, dass Ihre Auswahlen in die nächste Version übernommen werden, können Sie eine Manifestdatei erstellen. Die Manifestdatei, ibm_catalog.json, ist die Quelle der Wahrheit für Ihren Katalogeintrag. Sie enthält alle Informationen über Ihr Produkt und die von Ihnen getroffenen Auswahlen. Nachdem Sie die Datei erzeugt haben, müssen Sie sie der Stammebene Ihres Quellcode-Repositorys hinzufügen. Wenn Sie es vorziehen, im Code zu arbeiten, können die folgenden Abschnitte direkt über die mainfest-Datei konfiguriert werden. Weitere Informationen über die Strukturierung der Datei finden Sie unter Lokale Bearbeitung der Manifestdatei.

Zu den Details

Nachdem Sie Ihre einsatzfähige Architektur zu einem privaten Katalog hinzugefügt haben, können Sie die allgemeinen Informationen zu Ihrem Produkt mithilfe einer Schritt-für-Schritt-Anleitung in der Konsole aktualisieren. Um zur Konsolenseite zu gelangen, können Sie die folgenden Schritte ausführen.

Gehen Sie in der Konsole auf die Seite Verwalten > Kataloge > Private Kataloge.
Wählen Sie den privaten Katalog aus, in den Sie Ihr Produkt hinzugefügt haben. Die Detailseite des Katalogs wird geöffnet.
Wählen Sie das Produkt aus, das Sie zuvor in die Datenbank aufgenommen haben.
Wählen Sie auf der Registerkarte Versionen die Version Ihres Produkts aus, für die Sie Informationen bereitstellen möchten.
Verwenden Sie die folgenden Informationen als Leitfaden für die Konfiguration Ihrer einsatzfähigen Architekturdetails.

Konfigurieren der Versionsdetails

Auf der Registerkarte Version konfigurieren können Sie Informationen über die spezifische Version Ihrer Architektur überprüfen und aktualisieren. Sie konfigurieren die Bereitstellungsdetails, definieren den erforderlichen IAM-Zugriff und geben die Änderungshinweise an, die Ihre Benutzer zur Kenntnis nehmen sollen.

Wenn Sie Ihre einsatzfähige Architektur erweitern möchten, können Sie sie mit anderen Architekturen stapeln. Sie können Abhängigkeiten einbeziehen, die für Ihre Architektur erforderlich sind, sowie optionale Architekturen, die Ihre Lösung für einen bestimmten Anwendungsfall erweitern. Weitere Informationen finden Sie unter Erweitern einer verteilbaren Architektur während des Onboardings.

Wenn Ihre verteilbare Architektur eine bestimmte Terraform-Laufzeitversion erfordert, können Sie die Standardversion außer Kraft setzen. Wenn Sie TF_VERSION als Eingabevariable in Ihr Quellcode-Repository aufgenommen haben, sollte sie automatisch aktualisiert worden sein, als Sie Ihren Katalogeintrag erstellt haben.

Eingabevariablen sind die Parameter, die die Benutzer angeben, wenn sie Ihr Produkt verwenden. Sie können die Eingabe- und Ausgabevariablen, die mit Ihrem Quellcode importiert wurden, überprüfen und ändern, oder Sie können in diesem Schritt Variablen zu Ihrer einsatzfähigen Architektur hinzufügen. Wenn Variablen hinzugefügt werden, können Sie aktualisieren, ob sie erforderlich oder sichtbar sind, oder in welchem Format sie bereitgestellt werden müssen.

Wenn Sie eine neue Version Ihres Produkts herausgeben, gibt es möglicherweise Änderungen, über die Sie Ihre Benutzer informieren möchten, bevor sie mit der neuen Version arbeiten. Sie können die Informationen in drei Kategorien unterteilen - wichtige Änderungen, neue Funktionen und allgemeine Aktualisierungen.

Brüchige Änderungen: Geben Sie alle Änderungen am Code der neuen Version an, die für Ihre Benutzer, die mit einer früheren Version arbeiten, störend sein können.
Neue Funktionen: Heben Sie alle neuen Funktionen der neuen Version hervor, die ein Benutzer möglicherweise nutzen möchte.
Aktualisierungen: Beschreiben Sie alle allgemeinen Aktualisierungen, die an der neuen Version vorgenommen wurden. Zum Beispiel Fehlerkorrekturen oder Verbesserungen an bestehenden Funktionen.

Einschließlich Vor- und Nachskripten

Sie können ein Pre-Skript oder Post-Skript für Ihre verteilbaren Architekturen vor oder nach der Validierung, Verteilung und Rücknahme der Verteilung ausführen lassen. Skripte werden für eine bestimmte Version Ihrer einsatzfähigen Architektur konfiguriert, wie in der Katalogmanifestdatei angegeben, und müssen über Projekte ausgeführt und validiert werden.

Skripte sind für ein Angebot optional, aber wenn sie verwendet werden, müssen sie sich im Repository in einem Verzeichnis namens scripts befinden. Die Skriptdateien selbst müssen der folgenden Namenskonvention entsprechen: <action>-<stage>-ansible-playbook.yaml. Zu den Optionen für action gehören deploy, validate und undeploy. Zu den Optionen für stage gehören pre und post. Zurzeit werden nur Ansible-Skripte im Playbook-Format unterstützt.

Alle Skripte müssen mehr als einmal ausgeführt werden können, ohne zu scheitern. So muss beispielsweise ein Skript vor oder nach der Bereitstellung korrekt funktionieren, auch wenn es mehrmals ausgeführt wird. Post-Deployment-Skripte können Ressourcen zu einer Katalogverwaltungsdatenbank hinzufügen und müssen sicherstellen, dass sie keine doppelten Ressourcen hinzufügen, wenn sie mehr als einmal ausgeführt werden.

Weitere Informationen und Beispiele finden Sie unter Erstellen von Skripten für eine verteilbare Architektur.

Hinzufügen von einsatzfähigen Architekturdetails

Wenn Sie eine einsatzfähige Architektur anderen Benutzern in der Cloud zur Verfügung stellen, müssen Sie die folgenden Informationen bereitstellen:

Ein Architekturdiagramm, das detailliert aufzeigt, wie die Komponenten in Ihrer einsatzfähigen Architektur zusammenarbeiten.
Alle Highlights, die den Nutzern dabei helfen können, zu unterscheiden, welche Version oder Variante Ihrer Architektur für ihre Bedürfnisse am besten geeignet sein könnte.

Lizenzvereinbarungen hinzufügen

Wenn Benutzer Lizenzvereinbarungen akzeptieren müssen, die über die Vereinbarung für IBM Cloud-Services hinaus gehen, geben Sie die URL für die jeweilige Vereinbarung an.

Bearbeiten Ihrer Readme-Datei

Dokumentieren Sie die Anweisungen für die Installation Ihrer einsatzfähigen Architektur in der Readme-Datei.

Validierung der Version

Wählen Sie das Ziel für die Validierung aus. Wenn ein Produkt validiert ist, werden die Ressourcen bereitgestellt. Bei einer eigenständig einsetzbaren Architektur kann das Ziel entweder ein Schematics Arbeitsbereich in Ihrem aktuellen Konto oder ein bestimmtes Projekt sein. Für einen einsatzfähigen Architektur-Stack müssen Sie ein Projekt verwenden. Je nach der von Ihnen gewählten Option sind möglicherweise weitere Konfigurationsinformationen erforderlich. Nachdem Ihr Ziel konfiguriert ist, müssen Sie die Werte für die Eingabe- und Ausgabevariablen angeben, die für eine erfolgreiche Bereitstellung Ihrer Architektur auf dem Ziel erforderlich sind. Nachdem Ihre Variablen konfiguriert sind, können Sie die Version validieren.

Bereinigen Sie die Ressourcen in Ihrem Konto erst, nachdem Sie die Bewertung der Konformität im Abschnitt Verwaltung von Sicherheit und Konformität durchgeführt haben.

Wenn die Validierung der Version aufgrund einer CRA-Überprüfung fehlschlägt, kann ein Administrator für das Konto den Fehler aufheben und die Version trotzdem bereitstellen. Wenn die Validierung aus einem anderen Grund fehlschlägt, sollten Sie alle gefundenen Probleme beheben, bevor Sie Ihr Angebot veröffentlichen.

Überprüfung der Kosten

Vergewissern Sie sich, dass Sie die Kosten, die mit der Bereitstellung Ihrer Architektur verbunden sind, genau kennen. Die Version muss validiert werden, bevor Sie einen Kostenvoranschlag erstellen können.

Konformität verwalten

Wenn Sie eine verteilbare Architektur anderen in Ihrer Organisation zur Verfügung stellen, können Sie die spezifischen Konformitätskontrollen angeben, die Ihre Architektur durch die Verwendung der Standardinstallation erfüllt. Die Einhaltung der vorgeschriebenen Kontrollen wird von IBM Cloud® Security and Compliance Center Workload Protection bewertet.

Klicken Sie auf Steuerelemente hinzufügen.
Wählen Sie Ihre Workload Protection Instanz und Richtlinie. Sie können eine vordefinierte Richtlinie auswählen oder unter Workload Protection eine eigene Richtlinie erstellen.
Geben Sie an, ob Ihre einsatzfähige Architektur alle Kontrollen in der Richtlinie erfüllt oder ob sie die Anforderungen für eine Teilmenge der Kontrollen erfüllen kann.
Wenn Ihre Architektur nur eine Teilmenge der Steuerelemente erfüllen kann, müssen Sie die Steuerelemente auswählen, die erfüllt werden können, und diese hinzufügen.
Verwenden Sie Workload Protection, um die Einhaltung der von Ihnen identifizierten Kontrollen zu bestätigen. Workload Protection verwendet ein Inventar, um die Einhaltung zu verfolgen. Die Ergebnisse der Bestandsaufnahme werden täglich aktualisiert. Stellen Sie die von Ihrer Architektur erstellten Ressourcen bereit, und warten Sie auf die Aktualisierung der Inventarisierungsergebnisse. Weitere Informationen finden Sie unter Maßnahmen prüfen und priorisieren.
Klicken Sie auf der Registerkarte Konformität verwalten der Katalog-Benutzeroberfläche auf Ergebnisse hinzufügen.
Wählen Sie eine Instanz aus und klicken Sie auf Anwenden, um die neuesten Inventarisierungsergebnisse anzuwenden.

Überprüfung der Anforderungen

Wenn Sie den Durchgang abgeschlossen haben, müssen Sie Ihre Auswahl überprüfen und bestätigen, dass Sie bereit sind, Ihr Produkt für Ihren Katalog freizugeben. Wenn Sie bereit sind, klicken Sie auf Bereit zum Teilen.

Herunterladen des Manifests

Wenn Sie über die Konsole Änderungen an Ihrer Produktkonfiguration vornehmen, empfiehlt es sich, Ihre Manifestdatei zu erstellen und herunterzuladen, um sicherzustellen, dass Ihre Änderungen in künftigen Versionen Ihres Produkts übernommen werden.

Um ein Manifest herunterzuladen, können Sie die folgenden Schritte ausführen.

Gehen Sie in der Konsole auf die Seite Verwalten > Kataloge > Private Kataloge.
Wählen Sie das Produkt aus, das zuvor in das System aufgenommen wurde. Eine Detailseite wird geöffnet.
Wählen Sie auf der Registerkarte Versionen die Version aus, für die Sie ein Manifest erstellen möchten.
Wählen Sie im Dropdown-Menü Aktionen die Option Manifest erstellen aus.
Fügen Sie die Datei als ibm_catalog.json in den Stammordner Ihres Quellcode-Repositorys ein.

Herunterladen Ihrer Katalogkonfiguration

Wenn Sie gestapelte einsatzfähige Architekturen aus einem Projekt einbinden, gibt es zusätzliche Dateien, die zusätzlich zu Ihrer Manifestdatei erzeugt werden. Wenn Sie Ihre Katalogkonfiguration über die Konsole aktualisiert haben, laden Sie die Dateien am besten herunter und fügen Sie sie Ihrem Quellcode-Repository hinzu, damit Ihre Änderungen in die nächste Version übernommen werden.

Gehen Sie in der Konsole auf die Seite Verwalten > Kataloge > Private Kataloge.
Wählen Sie das Produkt aus, das zuvor in das System aufgenommen wurde. Eine Detailseite wird geöffnet.
Wählen Sie auf der Registerkarte Versionen die Version aus, für die Sie ein Manifest erstellen möchten.
Wählen Sie im Dropdown-Menü Aktionen die Option Manifest erstellen aus.
Fügen Sie die Dateien in das Stammverzeichnis Ihres Quellcode-Repositorys ein.

Hinzufügen einer Variation

Sie können weitere Varianten hinzufügen, bei denen es sich um eine neue Version Ihrer Architektur handelt, die auf den Funktionen der einsatzfähigen Basisarchitektur aufbaut. Wenn Sie mehrere Varianten erstellt in separaten Arbeitsverzeichnissen in Ihrem Quellcode-Repository haben und diese im flavors Array in Ihrer ibm_catalog.json Manifestdatei angegeben haben, müssen Sie jede Variante separat einbinden.

Zu diesem Zeitpunkt haben Sie bereits Ihre erste Variante an Bord. Jetzt können Sie wieder mit dem Hinzufügen einer einsatzfähigen Architektur beginnen, um Ihre nächste Variante einzubinden. Im Folgenden finden Sie einige Tipps für das Onboarding Ihrer nächsten Variante:

Der Quellcode URL des Repo-Release ist für alle Variationen innerhalb dieses Releases gleich und sollte mit der gleichen Versionsnummer importiert werden. Durch den Produktnamen und die Versionsnummer werden die Varianten miteinander verknüpft und erscheinen dann als Optionen auf derselben Katalogkachel.
Auf der Seite Details zur verteilbaren Architektur hinzufügen umfasst Schritt 3 das Hinzufügen von Highlights. Diese werden in der Manifestdatei ibm_catalog.json als Features bezeichnet. Möglicherweise haben Sie diese bereits in das Manifest aufgenommen, so dass Sie sie hier überprüfen können. Wenn nicht, fügen Sie noch ein paar Strähnchen hinzu. Dabei sollte es sich um kurze Fähigkeiten, Prozesse, Kapazitäten oder andere Merkmale dieser spezifischen Architektur handeln. Sie verwenden für alle Variationen die gleiche Markierung "Name". Die Beschreibung ist der Punkt, an dem es Unterschiede geben sollte. Dies ermöglicht es den Benutzern, die Unterschiede zwischen den Architekturen anhand der Textmarkierungen auf der Katalogdetailseite zu bewerten.

Nächste Schritte: Weitergabe und Veröffentlichung

Jetzt, da Ihre verteilbare Architektur zu einem privaten Katalog hinzugefügt wurde und die Details festgelegt sind, können Sie das Produkt für andere Mitglieder Ihrer Organisation freigeben. Hilfe zur Freigabe finden Sie unter Freigabe Ihres Produkts.

Wenn Sie Ihre einsatzfähige Architektur im IBM Cloud Katalog veröffentlichen möchten, können Sie das Partner Center verwenden, um die Genehmigung einzuholen und die Veröffentlichung für alle Benutzer vorzunehmen, damit diese die von Ihnen erstellte Lösung nutzen können. Weitere Informationen finden Sie unter Veröffentlichen Ihrer bereitstellbaren Architektur.