Implementierbare Architektur aus einem vorhandenen Angebot erstellen

Sie können ein von IBM®kuratiertes Anpassungspaket nutzen, um eine IBM Cloud® implementierbare ArchitekturCloudautomatisierung für die Bereitstellung eines einheitlichen Architekturmusters, das eine oder mehrere Cloudressourcen kombiniert, die auf einfache Bereitstellung, Skalierbarkeit und Modularität ausgelegt sind.zu erweitern und anzupassen. Jede implementierbare Architektur stellt ein eigenes Anpassungspaket bereit. Mit dem Bundle können Sie die implementierbare Architektur auf Ihrem lokalen Computer bearbeiten, eigene Pipelines zum Testen verwenden und Ihre eigenen Produkte an die Anforderungen Ihres Unternehmens anpassen. Zum Anpassen einer Architektur müssen Sie mit Terraform vertraut sein.

Das Anpassungspaket enthält außerdem ein Verzeichnis automation, das Starterscripts enthält, die Sie bei der Verwaltung des Lebenszyklus Ihrer angepassten implementierbaren Architektur von Onboarding und Validierung bis zur Veröffentlichung in einem privaten Katalog in IBM Cloudunterstützen. Derzeit sind zwei Pipelinemethoden in diesem Verzeichnis enthalten: GitHub-Aktionen oder eine Toolchain aus IBM Cloud.

Die folgende Anleitung bietet einen Überblick über das Anpassungspaket und einige Beispiele für Anpassungen, die Sie durchführen können. Es ist nicht alles inklusive und Sie können alle Änderungen vornehmen, die Sie benötigen. Nachdem Sie die Architektur geändert haben, können Sie sie einem privaten Katalog hinzufügen und die Tools von IBMverwenden, um nach Sicherheitslücken zu suchen, die Sicherheit und Konformität sicherzustellen und die Architektur für Ihr Unternehmen freizugeben. Einen detaillierteren Walkthrough finden Sie unter Implementierbare Architekturen von IBM Cloud zum Erstellen einer implementierbaren Architektur verwenden.

Abhängig von Ihren Änderungen unterstützt IBM Cloud die bereitstellbare Architektur möglicherweise nicht. Die Komponenten der Architektur, die im Bundle bereitgestellt werden, werden von IBM Cloudunterstützt, aber jeder geänderte Code, der zur Erweiterung verwendet wird, wird nicht unterstützt.

Vorbereitende Schritte

  1. Erstellen Sie ein Repository zum Speichern der angepassten bereitstellbaren Architektur, z. B. ein GitHub-Repository. Weitere Informationen finden Sie unter Neues Repository erstellen.
  2. Stellen Sie sicher, dass Sie über einen Editor Ihrer Wahl verfügen, um die implementierbare Architektur zu ändern, z. B. Visual Studio Code. Weitere Informationen finden Sie unter Visual Studio Code.
  3. Stellen Sie sicher, dass Sie über Tools Ihrer Wahl verfügen, um Ihre implementierbare Architektur zu testen und sicherzustellen, dass sie funktioniert. Sie können beispielsweise die Terraform-Laufzeit verwenden, die die Terraform-Befehlszeile bereitstellt.

Implementierbare Architektur suchen

IBM Cloud stellt mehrere implementierbare Architekturen bereit, die Sie unverändert verwenden oder anpassen können. Gehen Sie wie folgt vor, um eine Architektur zu suchen:

  1. Wählen Sie im IBM Cloud-Katalogeine bereitstellbare Architektur aus.
  2. Laden Sie das Anpassungspaket herunter, indem Sie Implementierungsoptionen prüfen > Mit Code arbeiten > Paket herunterladen auswählen.

Implementierbare Architektur anpassen

Wenn Sie das Bundle herunterladen, erhalten Sie eine Reihe von Dateien, die Sie beim Einstieg in die Anpassung unterstützen.

ibm_catalog.json

Die Datei ibm_catalog.json ist eine JSON-Manifestdatei, die zum automatischen Importieren von Versionsinformationen in einen privaten Katalog verwendet wird. Mit einer Katalogmanifestdatei können Sie die manuelle Eingabe von Versionsmetadaten über die Konsole vermeiden. Informationen zum Einrichten einer ibm_catalog.json-Datei und der Werte, die Sie einschließen können, finden Sie unter Katalogmanifest lokal bearbeiten.

main.tf

In der Datei main.tf werden Konfigurationsdaten zu jeder bereitstellbaren Architektur gespeichert, die Sie verwenden möchten. Je nach implementierbarer Architektur können Sie diese Datei verwenden, um bestimmte Regionen, API-Schlüssel und Quellcodepositionen anzugeben. Mit dieser Datei können Sie auch weitere Module hinzufügen und die Terraform-Parameter der Architektur aktualisieren.

Beispiel für main.tf mit Spezifikationen

Das folgende Beispiel zeigt eine sichere Infrastruktur auf VPC für regulierte Branchen mit einer bestimmten Region, us-south:

module "landing-zone" {
  source           = "https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/offering/source//examples/power-sap?archive=tgz&catalogID=7df1e4ca-d54c-4fd0-82ce-3d13247308cd&flavor=power&kind=terraform&name=slz-vpc-with-vsis&version=0.0.22"
  ibmcloud_api_key = var.ibmcloud_api_key
  ssh_public_key   = var.ssh_public_key
  region           = "us-south"
  prefix           = "slz"
}

outputs.tf

Die Datei outputs.tf enthält verfügbare Ausgabewerte, die Sie in Ihre implementierbare Architektur einschließen können. Die Werte sind auf Kommentar gesetzt, aber Sie können die Werte einschließen, indem Sie das Symbol # aus dem Wert entfernen. Sie können auch weitere Ausgabevariablen zur Datei hinzufügen. Führen Sie die folgenden Schritte aus, um bestimmte Werte einzuschließen.

  1. Öffnen Sie die Datei outputs.tf.
  2. Entfernen Sie die # aus allen Ausgabewerten, die Sie einschließen möchten.

Beispiel outputs.tf

Das folgende Beispiel enthält den Wert vsi_names und schließt den Wert transit_gateway_name aus:

output "vsi_names" {
  value       = var.vsi_names
  description = "A list of the vsis names provisioned within the VPCs"
}

#output "transit_gateway_name" {
#  value       = var.transit_gateway_name
#  description = "The name of the transit gateway"
#}

provider.tf

Die Datei provider.tf enthält erforderliche Informationen zu dem Provider, dem API-Schlüssel und der Region, die Benutzer verwenden müssen.

Diese Informationen werden aus der Datei variables.tf extrahiert. Wenn Sie Änderungen vornehmen müssen, aktualisieren Sie die Datei variables.tf.

Beispiel einer provider.tf-Datei

Im folgenden Beispiel wird IBM als Provider aufgelistet:

provider "ibm" {
  ibmcloud_api_key = var.ibmcloud_api_key
  region           = var.region
}

README.md

Die Readme-Datei enthält Hintergrund-und Nutzungsinformationen zur implementierbaren Architektur. Sie können die Readme-Datei anpassen, damit Mitglieder Ihres Unternehmens die implementierbare Architektur verwenden können.

variables.tf

Die Datei variables.tf enthält die erforderlichen Variablen für die implementierbare Architektur. Sie können alle zusätzlichen Variablen hinzufügen, die Sie benötigen.

version.tf

In der Datei version.tf werden Informationen zur Terraform-Version und zur Providerversion gespeichert, die für die Ausführung der bereitstellbaren Architektur erforderlich sind. Wenn Sie die implementierbare Architektur unverändert ausführen, sind keine Aktualisierungen erforderlich. Ihre Konfiguration erfordert möglicherweise, dass Sie diese Datei aktualisieren. Wenn Sie eine bestimmte Terraform-oder Providerversion angeben müssen, gehen Sie wie folgt vor:

  1. Öffnen Sie die Datei versions.tf.
  2. Aktualisieren Sie required_version auf die Terrafrom-Version, die Benutzer verwenden müssen.
  3. Aktualisieren Sie version auf die Providerversion, die Benutzer verwenden müssen.

Testen der implementierbaren Architektur

Bevor Sie Ihre implementierbare Architektur in einen privaten Katalog integrieren, testen Sie Ihre Anpassung und stellen Sie sicher, dass die Architektur wie beabsichtigt ausgeführt wird. Führen Sie die folgenden Schritte aus, um Ihre Architektur mit der Terraform-Befehlszeile zu testen:

  1. Initialisieren Sie nach der Anpassung der Architektur die Terraform-CLI. Weitere Informationen finden Sie unter Arbeitsverzeichnisse initialisieren.

    terraform init

  2. Stellen Sie die Ressourcen 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

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

      terraform apply

Release erstellen

Wenn Ihre Tests erfolgreich waren, können Sie Ihre Architektur in einen privaten Katalog integrieren, indem Sie sicherstellen, dass sich Ihre Dateien im Repository befinden, und ein Release erstellen. Weitere Informationen finden Sie unter Release erstellen.

Automatisierung für die gemeinsame Nutzung in einem privaten Katalog nutzen

Das Anpassungspaket enthält ein Verzeichnis automation, das einige Optionen für Starter-Pipelines enthält. Diese Pipelines können verwendet werden, um den Lebenszyklus Ihrer angepassten Produkte zu automatisieren, die Sie mithilfe eines privaten Katalogs in IBM Cloudgemeinsam nutzen. Dies umfasst die Verwaltung des Onboardings, der Validierung und der gemeinsamen Nutzung der implementierbaren Architekturversion in einem privaten Katalog. Für jede Pipelineoption sind README-Dateien enthalten, die Details zur Nutzung bereitstellen. Weitere Informationen zu jedem Element finden Sie unter GitHub-Aktionen und Toolchain erstellen.

Konsole für das Onboarding in einen privaten Katalog verwenden

Wenn Sie die Konsole für das Onboarding Ihrer implementierbaren Architektur verwenden möchten, finden Sie im Abschnitt Einbinden Ihrer angepassten implementierbaren Architektur in einen privaten Katalog eine schrittweise Anleitung.

Nächste Schritte

Die Scripts, die im Anpassungspaket bereitgestellt werden, unterstützen Sie bei der Automatisierung des Onboarding-Prozesses in einem privaten Katalog für die gemeinsame Nutzung Ihres Produkts mit anderen Benutzern. Wenn Sie jedoch die Konsole oder die CLI für das Onboarding Ihrer implementierbaren Architektur verwenden möchten, finden Sie im Abschnitt Angepasste implementierbare Architektur in einen privaten Katalog integrieren eine schrittweise Anleitung. Wenn Sie private Kataloge verwenden, müssen Mitglieder Ihres Unternehmens genehmigte Architekturen verwenden, die sie mithilfe von Projekten implementieren können.