Hinzufügen von anpassbaren Optionen zu Ihrer einsatzfähigen Architektur

Dieses Tutorial zeigt Ihnen einen Weg, wie Sie eine einsatzfähige Architektur mit anpassbaren Optionen erweitern können, um sie an Ihre geschäftlichen Anforderungen anzupassen. In diesem Tutorial erfahren Sie, wie Sie eine neue Version einer vorhandenen einsatzfähigen Architektur in Ihrem privaten Katalog erstellen und andere Architekturen hinzufügen, die von den Benutzern ausgewählt werden können.

Stellen Sie sich vor, Sie sind ein Experte für Cloud-Automatisierungstechnik für das fiktive Unternehmen Example Corp. Sie haben zuvor eine bereitstellbare Architektur angepasst, die heißt Example Corp's infrastructure und fügte es einem privaten Katalog hinzu. Diese maßgeschneiderte, einsatzfähige Architektur ist die Grundlage, auf der die Anwendungen von Example Corp. aufgebaut werden. Nun möchten Sie Ihren Softwareentwicklern einige Datenbankoptionen zur Verfügung stellen, die sie mit Example Corp's infrastructure verwenden können. Nachdem Sie den IBM Cloud Katalog durchsucht haben, entscheiden Sie sich, Ihren Entwicklern die Wahl zwischen zwei einsatzfähigen Architekturen zu lassen, die unterschiedliche Datenbanken erstellen:

Cloud-Automatisierung für Databases for Elasticsearch
Diese einsatzfähige Architektur erstellt eine Instanz von Elasticsearch, einer NoSQL Datenbank, die für die Volltextsuche und die Abfrage großer Datenmengen geeignet ist. Diese Datenbank eignet sich für die Anwendung von Example Corp, da sie flexibel genug ist, um unstrukturierte und halbstrukturierte Daten wie Text, Bilder und Videos zu verarbeiten. Dieses Tutorial wurde auf der Grundlage der Version 1.32 der einsatzfähigen Architektur erstellt, aber Sie können auch eine spätere Version verwenden.
Cloud-Automatisierung für Databases for PostgreSQL
Diese einsatzfähige Architektur erstellt eine Instanz von PostgreSQL, einer SQL-Datenbank für relationale Abfragen und strukturierte Daten. Diese Datenbank ist eine weitere geeignete Wahl für Example Corp, da sie strukturierte Transaktionsdaten verwaltet, um den Benutzern personalisierte App-Erlebnisse zu bieten. Diese Anleitung wurde auf der Grundlage der Version 3.22 erstellt, aber Sie können auch eine neuere Version verwenden.

In diesem Tutorial wird ein fiktives Szenario verwendet, damit Sie verstehen, wie Sie eine komplexere einsatzfähige Architektur erstellen können, indem Sie sie mit anderen Architekturen kombinieren. Passen Sie beim Durcharbeiten des Tutorials jeden Schritt an die Bedürfnisse Ihres Unternehmens an.

Vorbereitende Schritte

  1. Vergewissern Sie sich, dass Sie ein nutzungsabhängiges Konto oder ein Abonnementkonto verwenden; navigieren Sie hierzu in der IBM Cloud-Konsole zu Verwalten > Konto > Kontoeinstellungen.

  2. Stellen Sie sicher, dass Ihnen die folgenden IBM Cloud Identity and Access Management (IAM) Rollen zugewiesen sind:

    • Administrator für alle Kontoverwaltungsdienste und alle IAM-Dienste.
    • Editor für den Dienst Katalogverwaltung.
    • Managerdienst-Zugangsrolle für Schematics.
    • Andere Rollen, die für bestimmte Ressourcen in Ihrer verteilbaren Architektur erforderlich sind. Für die Cloud-Automatisierung für Code Engine ist die Writer-Service-Zugriffsrolle erforderlich, die auf alle Ressourcen für den Code Engine-Service beschränkt ist.

    Weitere Informationen finden Sie unter Zuweisung des Zugriffs auf Kontoverwaltungsdienste und Verwaltung des Zugriffs auf Ressourcen.

  3. Erstellen Sie eine benutzerdefinierte einsatzfähige Architektur namens Example Corp's infrastructure und binden Sie sie in einen privaten Katalog namens Example Corp catalog ein. Diese Architektur ist diejenige, die Sie im Laufe dieses Lehrgangs erweitern werden.

  4. Richten Sie eine Authentifizierungsmethode ein. Sie können einen API-Schlüssel, der in Secrets Manager gespeichert ist, oder ein vertrauenswürdiges Profil verwenden, um eine Bereitstellung in Ihrem Zielkonto zu autorisieren.

    Einsatz eines Proof of Concept zu Testzwecken? Sie können einen API-Schlüssel später erstellen, wenn Sie eine Konfiguration in Ihrem Projekt bearbeiten. Auf diese Weise wird das Projekt für das aktuell ausgewählte Konto freigegeben.

Erstellen einer Version einer einsatzfähigen Architektur

Da Example Corp's infrastructure bereits in einem privaten Katalog verfügbar ist, müssen Sie es mit einer neuen Version aktualisieren.

  1. Klicken Sie in der Konsole IBM Cloud auf Verwalten > Kataloge > Private Kataloge und öffnen Sie den privaten Katalog Example Corp catalog.
  2. Wählen Sie die Infrastruktur von Example Corp aus der Liste der Produkte aus.
  3. Klicken Sie auf Versionen > Version hinzufügen
  4. Wählen Sie Terraform als Bereitstellungsmethode.
  5. Geben Sie an, ob Ihr Repository öffentlich oder privat ist und geben Sie die Quelle URL an. Für die Zwecke dieses Tutorials können Sie denselben Quellcode URL verwenden, den Sie für die Version 0.0.1 von Example Corp's infrastructure verwendet haben.
  6. Wählen Sie als Variante Deploy Example Corp AI app auf IBM Cloud Code Engine.
  7. Geben Sie 0.0.2 für die Softwareversion ein.
  8. Klicken Sie auf Version hinzufügen

Von hier aus können Sie Details für die hinzugefügte Version konfigurieren.

Erweiterung der Infrastruktur von Example Corp durch Hinzufügen von Datenbankoptionen

Während Sie die Versionsdetails konfigurieren, erweitern Sie Example Corp's infrastructure, indem Sie es mit zwei anderen einsatzfähigen Architekturen kombinieren, die unterschiedliche Datenbanken erstellen. Sie möchten, dass Ihre Nutzer entweder IBM Cloud Databases for Elasticsearch oder IBM Cloud Databases for PostgreSQL wählen. Führen Sie die folgenden Schritte aus:

  1. Klicken Sie in Schritt 3 - Erweitern Sie Ihre Architektur auf Hinzufügen.

  2. Suchen Sie im Produktmenü nach Cloud automation for Databases for Elasticsearch und wählen Sie es aus.

  3. User Semantic Versioning Specification ( SemVer ), um die Versionen der Architektur aufzulisten, die mit der Infrastruktur von Example Corp. funktionieren.

    In der Regel enthalten Patch-Versionen keine grundlegenden Änderungen, sodass Sie einen Bereich von Versionen angeben können SemVer, die mit der Infrastruktur von Example Corp kompatibel sind, zum Beispiel ~1.32. Auf diese Weise kann jeder Benutzer, der Elasticsearch Example Corps mit bereitgestellt hat, sein Projekt aktualisieren, um die neue Version zu verwenden, wenn beispielsweise die 1.32.5 Cloud-Automatisierung für mit einer Patch-Version Databases for Elasticsearch auf aktualisiert wird. Bei größeren Versionsänderungen erstellen Elasticsearch Sie eine neue Version der Infrastruktur von Example Corp, um sicherzustellen, dass die neue Version ordnungsgemäß Elasticsearch mit Ihrer Architektur funktioniert.

  4. Wählen Sie die Standardvariante.

  5. Geben Sie Standard als Standardvariante an, d. h. die Variante, die standardmäßig für die Benutzer ausgewählt wird.

  6. Wählen Sie im Menü Beziehung die Option Optional, da die Architektur für die Bereitstellung von Example Corp's infrastructure nicht erforderlich ist.

  7. (Optional) eine Anzeigebeschreibung, damit die Benutzer verstehen, wie diese Architektur mit Example Corp's infrastructure funktioniert und welche Vorteile sie bietet. Geben Sie beispielsweise Folgendes ein: NoSQL database for full-text searching and querying large datasets.

  8. Klicken Sie auf Hinzufügen.

Nachdem Sie nun die Cloud-Automatisierung für Databases for Elasticsearch hinzugefügt haben, wiederholen Sie die Schritte erneut, aber diesmal suchen Sie nach Cloud automation for Databases for PostgreSQL. Für die optionale Anzeigebeschreibung geben Sie ein SQL database for relational queries and structured data.

Die Datenbanken untereinander austauschbar machen

Da Sie nun beide Datenbanken als optional zu Example Corp's infrastructure hinzugefügt haben, können Sie festlegen, dass sie miteinander ausgetauscht werden können. Ihre Benutzer können auswählen, welche Datenbankoption sie mit Example Corp's infrastructure verwenden möchten. Führen Sie die folgenden Schritte aus:

  1. Aktivieren Sie in Schritt 3 - Erweitern Sie Ihre Architektur das Kontrollkästchen für die Cloud-Automatisierung für Databases for Elasticsearch.
  2. Aktivieren Sie das Kontrollkästchen für die Cloud-Automatisierung für Databases for PostgreSQL.
  3. Klicken Sie auf Gruppe als austauschbar.
  4. Geben Sie Databases als Gruppennamen ein und klicken Sie auf Hinzufügen.
  5. Klicken Sie auf Weiter.

Definieren Sie Variablen für Ihre Benutzer

Nachdem Sie nun einige Datenbankoptionen zu Ihrer Architektur hinzugefügt haben, müssen Sie Variablen für Ihre Benutzer definieren. Auf diese Weise werden die Eingänge in den Architekturen miteinander verbunden, was es Ihren Benutzern erleichtert, Example Corp's infrastructure für die Bereitstellung zu konfigurieren.

  1. Klicken Sie in Schritt 4 - Konfigurieren Sie die Einsatzdetails auf Variablen definieren.

    Das Fenster „Variablen definieren“ wird mit der für Sie Databases for Elasticsearch ausgewählten Cloud-Automatisierung angezeigt, sodass Sie auf die Ein- und Ausgänge dieser Architektur zugreifen können. Von hier aus können Sie entweder Verweise hinzufügen oder Eingaben auf Example Corp's infrastructure verschieben, damit die Benutzer sie konfigurieren können.

  2. Als Example Corp's infrastructure gegründet wurde, war die Region auf die USA beschränkt. Um sicherzustellen, dass die Cloud-Automatisierung für Databases for Elasticsearch dieselbe Region wie Example Corp's infrastructure verwendet, fügen Sie einen Verweis hinzu, um sie miteinander zu verbinden, indem Sie die folgenden Schritte ausführen:

    1. Wählen Sie im Fenster Erforderliche Eingänge für die Cloud-Automatisierung für Databases for Elasticsearch das Symbol Referenzieren einer Variablen für den Eingang region.
    2. Wählen Sie dann Region im Menü Variablenname.
    3. Klicken Sie auf Hinzufügen. Wenn ein Benutzer die Eingabe region in Example Corp's infrastructure konfiguriert, verwendet die Cloud-Automatisierung für Databases for Elasticsearch diesen Wert, den der Benutzer als Eingabe angibt.
  3. Da Example Corp's infrastructure auch einen Eingang prefix enthält, führen Sie die gleichen Schritte für den Eingang prefix in der Cloud-Automatisierung für Databases for Elasticsearch durch:

    1. Wählen Sie das Symbol Variablenreferenz für den Eingang prefix.
    2. Wählen Sie dann im Menü Variablenname die Option Präfix.
    3. Klicken Sie auf Hinzufügen.
  4. Da Example Corp's infrastructure einen Eingang für die existing_resource_group_name enthält, können Sie dieselbe Ressourcengruppe für die Cloud-Automatisierung für Databases for Elasticsearch verwenden:

    1. Wählen Sie das Symbol Variablenreferenz für den Eingang resource_group_name.
    2. Wählen Sie dann existing_resource_group_name im Menü Variablenname.
    3. Klicken Sie auf Hinzufügen.
  5. Setzen Sie den Standardwert für use_existing_resource_group auf true, um anzugeben, dass Ihre Benutzer eine bestehende Ressourcengruppe für Ihre Architektur benötigen.

  6. Um die Einrichtung zu vereinfachen und die Kosten für eine Entwicklungsumgebung zu senken, entfernen Sie die Anforderung der Schlüsselverschlüsselung, indem Sie die folgenden Schritte ausführen:

    1. Setzen Sie den Standardwert für existing_kms_instance_crn auf __NULL__.
    2. Klicken Sie auf Optionale Eingaben.
    3. Setzen Sie den Standardwert für use_ibm_owned_encryption_key auf true.
    4. Setzen Sie den Standardwert für plan auf enterprise.
    5. Setzen Sie den Standardwert für member_cpu_count auf 2.
    6. Setzen Sie den Standardwert für member_host_flavor auf multitenant.

Nachdem Sie die Variablen für die Cloud-Automatisierung für Databases for Elasticsearch definiert haben, müssen Sie nun die Variablen für die andere Datenbankoption definieren, die Sie einbezogen haben: Cloud-Automatisierung für Databases for PostgreSQL. Führen Sie die folgenden Schritte aus:

  1. Wechseln Sie im Fenster Variablen definieren über das Architekturmenü von Cloud-Automatisierung für Databases for Elasticsearch zu Cloud-Automatisierung für Databases for PostgreSQL.
  2. Klicken Sie auf Erforderliche Eingaben und entfernen Sie die Anforderung der Schlüsselverschlüsselung, indem Sie den Standardwert für existing_kms_instance_crn auf __NULL__ setzen.
  3. Die drei anderen erforderlichen Eingänge in dieser Architektur können alle auf Eingänge verweisen, die bereits in Example Corp's infrastructure vorhanden sind. Führen Sie die folgenden Schritte aus, um Referenzen zu diesen Eingängen hinzuzufügen:
    1. Wählen Sie das Symbol Verweis auf eine Variable Verweis auf eine Variable für resource_group_name und wählen Sie dann existing_resource_group_name aus dem Menü Variablenname. Klicken Sie auf Hinzufügen, und die Eingabe resource_group_name in der Cloud-Automatisierung für Databases for PostgreSQL verweist auf den Wert existing_resource_group_name aus der Infrastruktur von Example Corp, den Ihr Benutzer bereitstellt.
    2. Wählen Sie das Symbol Verweis auf eine Variable Verweis auf eine Variable für prefix und wählen Sie Präfix aus dem Menü Variablenname und klicken Sie auf Hinzufügen.
    3. Wählen Sie das Symbol Verweis auf eine Variable Verweis auf eine Variable für region und wählen Sie Region aus dem Menü Variablenname und klicken Sie auf Hinzufügen.
  4. Klicken Sie auf Optionale Eingaben.
  5. Setzen Sie den Standardwert für use_existing_resource_group auf true, um anzugeben, dass Ihre Benutzer eine bestehende Ressourcengruppe für Ihre Architektur benötigen.
  6. Setzen Sie den Standardwert für use_ibm_owned_encryption_key auf true.
  7. Klicken Sie auf Speichern.

Mitteilung von Änderungen an Ihre Nutzer

Die neueste Version von Example Corp's infrastructure enthält keine grundlegenden Änderungen, aber neue Funktionen, die Ihre Benutzer kennen sollten. Informieren Sie Ihre Benutzer über die neuen Datenbankoptionen, die sie mit Example Corp's infrastructure nutzen können, indem Sie einen Änderungshinweis hinzufügen. Führen Sie die folgenden Schritte aus:

  1. Klicken Sie in Schritt 6 - Änderungsmitteilungen hinzufügen auf Neues Merkmal hinzufügen.
  2. Geben Sie in das Feld Titel Database options added to Example Corp's infrastructure ein.
  3. Für die Beschreibung geben Sie ein Version 0.0.2 includes two optional databases that you can choose to add. You can either use Cloud automation for Databases for Elasticsearch, or Cloud automation for Databases for PostgreSQL.
  4. Klicken Sie auf Speichern.

Wählen Sie im Menü Aktionen die Option Manifest generieren, um die letzten Änderungen herunterzuladen. Am besten laden Sie die Dateien herunter und fügen sie zu Ihrem Quellcode-Repository hinzu, damit Ihre Änderungen in die nächste Version übernommen werden können.

Validieren Sie die Architekturen, indem Sie sie in einem Projekt einsetzen

Jetzt ist die Version 0.0.2 von Example Corp's infrastructure als Entwurf in Ihrem privaten Katalog verfügbar. Jeder Benutzer mit Zugriff auf Ihren privaten Katalog kann ihn einsetzen. Um sicherzustellen, dass die Datenbankoptionen mit Example Corp's infrastructure funktionieren, setzen Sie es zweimal in Ihrem Projekt ein. Für einen Einsatz ist Elasticsearch einzubeziehen. Und für den anderen Einsatz: PostgreSQL. Indem Sie die Architektur zweimal einsetzen, können Sie überprüfen, ob beide Datenbankoptionen wie vorgesehen mit Example Corp's infrastructure funktionieren.

Bevor Sie Example Corp's infrastructure für Ihr Unternehmen freigeben können, müssen Sie die Version validieren, wenn Sie sie in Ihren privaten Katalog aufnehmen. Derzeit werden bei der Validierung der Version im Katalog keine Architekturen validiert, die Sie mit Ihrer eigenen gestapelt haben. Wenn Sie die Architekturen aus einem Projekt bereitstellen, während sich Example Corp's infrastructure im Entwurfsstatus im privaten Katalog befindet, können Sie sicherstellen, dass die enthaltenen Architekturen mit Example Corp's infrastructure ordnungsgemäß funktionieren.

Bereitstellung der Infrastruktur von Example Corp mit Elasticsearch

  1. Rufen Sie den Katalog IBM Cloud auf und öffnen Sie den privaten Katalog Example Corp catalog.

  2. Wählen Sie die Infrastruktur von Example Corp aus, um die Katalogliste zu öffnen.

  3. Stellen Sie sicher, dass als Version 0.0.2 ausgewählt ist.

  4. Klicken Sie auf „ Projekt erstellen “, benennen Sie das neue Projekt Testing Example Corp infrastructure und klicken Sie auf „ Erstellen “.

  5. Klicken Sie auf das Symbol „Projekteinstellungen“ Projekteinstellungen, ändern Sie den Namen der Konfiguration in Example Corp infrastructure with Elasticsearch und klicken Sie auf „ Speichern “.

  6. Klicken Sie im Abschnitt „Übersicht über die bereitstellbare Architektur“ auf „Anpassen“, stellen Sie sicher, dass „ Cloud-Automatisierung für “ ausgewählt Databases for Elasticsearch ist, und klicken Sie auf „ Speichern “.

  7. Klicken Sie auf Konfigurieren und Bereitstellen.

  8. Konfigurieren Sie die Architektur, indem Sie die folgenden Schritte ausführen:

    1. Überprüfen Sie im Abschnitt Details die Informationen und klicken Sie auf Weiter.
    2. Geben Sie im Abschnitt Sicherheit eine Authentifizierungsmethode an, die für Ihr Zielkonto eingesetzt werden soll, und klicken Sie auf Weiter. Verwenden Sie ein vertrauenswürdiges Profil oder einen API-Schlüssel.
    3. Geben Sie im Abschnitt Eingaben den Wert test-south für die Eingabevariable prefix ein.
    4. Wählen Sie Standard für die Eingangsvariable existing_resource_group_name.
    5. Wählen Sie us-south für die Eingangsvariable region.
    6. Klicken Sie auf Speichern, um die Konfiguration von Example Corp's infrastructure zu speichern.
  9. Klicken Sie auf Validieren. Das angezeigte Modal enthält weitere Details zu Ihrer laufenden Validierung.

    Wenn die Validierung fehlschlägt, können Sie die Fehlerursache beheben. Alternativ kann ein Administrator des Projektdienstes IBM Cloud die Ergebnisse über den Dienst Schematics überprüfen, den Fehler beheben und die Konfiguration zur Bereitstellung trotzdem freigeben. Stellen Sie jedoch sicher, dass die Pipeline aufgrund des Code Risk Analyzer-Scans fehlgeschlagen ist und nicht aufgrund eines Validierungs- oder Planfehlers. Es wird nicht empfohlen, einen Fehler zu überschreiben, der aufgrund eines Validierungs- oder Planungsfehlers markiert wurde, da die Konfiguration nicht erfolgreich bereitgestellt werden kann. Weitere Informationen zu Sicherheit und Compliance in Projekten finden Sie unter Kontinuierliche Compliance als Unternehmen erreichen.

  10. Nach Abschluss der Validierung genehmigen Sie die Änderungen und stellen sie bereit:

    1. Wählen Sie im Projekt Testing Example Corp infrastructure die Registerkarte Konfigurationen.
    2. Klicken Sie auf Example Corp infrastructure with Elasticsearch > Details anzeigen, um die letzte Validierung anzuzeigen und die Änderungen zu genehmigen.
    3. Fügen Sie einen Kommentar mit weiteren Einzelheiten zur Genehmigung hinzu und klicken Sie auf Genehmigen.
  11. Klicken Sie auf Bereitstellen und warten Sie, bis die Bereitstellung abgeschlossen ist.

    Wenn die Bereitstellung erfolgreich war, wissen Sie, dass wie vorgesehen Example Corp's infrastructureElasticsearch mit funktioniert.

  12. Heben Sie schließlich die Bereitstellung der Ressourcen auf, die die Architekturen erstellt haben. Klicken Sie auf der Registerkarte Konfigurationen im Projekt auf das Symbol Optionen Optionen für Example Corp infrastructure with Elasticsearch > Rückgängig machen.

Bereitstellung der Infrastruktur von Example Corp mit PostgreSQL

Führen Sie dieselben Schritte durch, um zu überprüfen, ob Example Corp's infrastructure mit PostgreSQL funktioniert:

  1. Klicken Sie auf der Registerkarte Konfigurationen im Projekt Testing Example Corp infrastructure auf Erstellen und öffnen Sie den privaten Katalog Example Corp catalog.

  2. Wählen Sie die Infrastruktur von Example Corp aus, um die Katalogliste zu öffnen.

  3. Stellen Sie sicher, dass als Version 0.0.2 ausgewählt ist.

  4. Vergewissern Sie sich, dass die Infrastruktur von Testing Example Corp als Projekt ausgewählt ist.

  5. Klicken Sie auf das Symbol „Projekteinstellungen“ Projekteinstellungen, ändern Sie den Namen der Konfiguration in Example Corp infrastructure with PostgreSQL und klicken Sie auf „ Speichern “.

  6. Klicken Sie im Abschnitt „Übersicht über die bereitstellbare Architektur“ auf „Anpassen“, stellen Sie sicher, dass „ Cloud-Automatisierung für “ ausgewählt Databases for PostgreSQL ist, und klicken Sie auf „ Speichern “.

  7. Klicken Sie auf Konfigurieren und Bereitstellen.

  8. Konfigurieren Sie die Architektur. Dann validieren, genehmigen und implementieren Sie es, um zu überprüfen, ob Example Corp's infrastructure wie vorgesehen mit PostgreSQL funktioniert.

    Wählen Sie bei der Konfiguration der Architektur us-east für die Eingabevariable region aus, um zu bestätigen, dass die Architektur sowohl in der Region US-Süd als auch in der Region US-Ost eingesetzt werden kann. Geben Sie test-east als Präfix ein, um die Region anzugeben, in der die Ressourcen bereitgestellt werden.

  9. Heben Sie die Bereitstellung der Konfigurationen aus Ihrem Projekt auf, um die Bereitstellung von Ressourcen aufzuheben.

Nächste Schritte

Setzen Sie das Onboarding der neuesten Version von Example Corp's infrastructure fort. Wenn Sie fertig sind, steht den Benutzern eine neue Version der einsatzfähigen Architektur zur Verfügung. Wenn sie die neue Version zu einem Projekt hinzufügen, können sie es anpassen, indem sie Cloud-Automatisierung für Databases for Elasticsearch oder Cloud-Automatisierung für Databases for PostgreSQL einbeziehen.

Wenn ein Benutzer bereits die frühere Version von Example Corp's infrastructure eingesetzt hat, wird er in seinem Projekt mit dem Widget "needs attention" aufgefordert, die Architektur auf die neueste Version zu aktualisieren.