Vorschau einer Bereitstellung ansehen

Auf dieser Seite wird beschrieben, wie Sie mit Infrastructure Manager eine Vorschau der Bereitstellung von Ressourcen anzeigen, die in einer Terraform-Konfiguration definiert sind.

In einer Vorschau werden die Aktionen beschrieben, die zur Ausführung einer bestimmten Terraform-Konfiguration erforderlich sind. Bevor Sie eine neue Bereitstellung erstellen oder eine vorhandene aktualisieren, können Sie sich eine Vorschau der Bereitstellung ansehen, um die geplanten Bereitstellungsressourcen zu überprüfen.

In einer Vorschau wird der Befehl Terraform plan ausgeführt. Auf dieser Seite wird davon ausgegangen, dass Sie mit Terraform vertraut sind. Weitere Informationen finden Sie unter Terraform und Infrastructure Manager.

Damit eine Vorschau erstellt werden kann, muss die Terraform-Konfiguration mit einer der unterstützten Terraform-Versionen kompatibel sein.

Hinweise

  1. Aktivieren Sie Infra Manager.
  2. Sie benötigen die IAM-Berechtigungen roles/config.admin, um Vorschauen zu erstellen.
  3. Sie benötigen ein Dienstkonto mit den erforderlichen Berechtigungen. Weitere Informationen finden Sie unter Dienstkonto konfigurieren.
  4. Wählen Sie die Terraform-Konfiguration aus, für die Sie eine Vorschau anzeigen möchten. Prüfen Sie, ob diese Terraform-Konfiguration die Einschränkungen erfüllt, insbesondere, dass sie keine sensiblen Daten enthält.
  5. Wenn Sie die Terraform-Konfiguration in einem Speicher-Bucket speichern möchten, müssen Sie sie in einen Cloud Storage-Bucket hochladen. Weitere Informationen finden Sie unter Konfiguration in einen Speicher-Bucket hochladen.

    Mit einem Storage-Bucket können Sie den Zugriff auf die Konfiguration steuern. Sie können auch eine Terraform-Konfiguration bereitstellen, die in einem Git-Repository oder auf Ihrem lokalen Computer gespeichert ist.

Vorschau einer neuen Bereitstellung ansehen

Die Terraform-Konfiguration, die Sie in der Vorschau ansehen, kann sich in einem Speicher-Bucket oder in einem Git-Repository befinden.

Vorschau mit einer Terraform-Konfiguration ansehen, die in einem Cloud Storage-Bucket gespeichert ist

  1. Die Terraform-Konfiguration muss in einen Cloud Storage-Bucket hochgeladen werden. Weitere Informationen finden Sie unter Konfiguration in einen Speicher-Bucket hochladen.

    Mit einem Storage-Bucket können Sie den Zugriff auf die Konfiguration steuern. Sie können auch eine Terraform-Konfiguration bereitstellen, die in einem Git-Repository oder auf Ihrem lokalen Computer gespeichert ist.

  2. So rufen Sie eine Vorschau des Updates auf:

    gcloud infra-manager previews create projects/PROJECT_ID/locations/LOCATION/previews/PREVIEW_ID \
        --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \
        --gcs-source gs://BUCKET_NAME/OBJECT_NAME \
        --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \
        --tf-version-constraint=TERRAFORM_VERSION \
        --annotation="ANNOTATION_KEY=ANNOTATION_VALUE"
    

    Ersetzen Sie:

    • PROJECT_ID ist die Projekt-ID, unter der Infrastructure Manager ausgeführt wird.
    • LOCATION ist der Ort, an dem Infra Manager ausgeführt wird. Eine Liste der gültigen Standorte finden Sie unter Infrastructure Manager-Standorte.
    • PREVIEW_ID ist die von Ihnen angegebene Vorschau-ID. Weitere Informationen zu Einschränkungen für die Vorschau-ID finden Sie unter Vorschauname.
    • SERVICE_ACCOUNT ist der Name des Dienstkontos, mit dem Sie Infra Manager aufrufen.
    • SERVICE_ACCOUNT_PROJECT_ID ist die Projekt-ID des Dienstkontos. In der Regel ist dies dasselbe Projekt, in dem Infra Manager ausgeführt wird.
    • BUCKET_NAME ist der Name des Storage-Buckets, in dem die Konfiguration gespeichert ist.
    • OBJECT_NAME ist der Objektname der Konfigurationsdatei. Dieses Objekt kann ein Verzeichnis oder eine ZIP-Datei sein, aber keine Terraform-Datei. Wenn Sie die Objektversionsverwaltung verwenden, können Sie auch die Generierungsnummer des Objekts angeben. Weitere Informationen finden Sie unter Versionierte Objekte verwenden.

      Wenn der Speicher-Bucket der Stammpfad der Terraform-Konfiguration ist, ist OBJECT_NAME optional.

    • INPUT_1_NAME=VALUE und INPUT_2_NAME=VALUE: beliebige Eingabewerte in der Terraform-Konfiguration, einschließlich derjenigen, die nicht standardmäßig definiert sind. Sie können beispielsweise das Projekt, in dem Sie die Ressourcen bereitstellen, als project_id=my-project angeben.

      Wenn alle Eingabewerte in der Konfiguration standardmäßig definiert sind, ist dieses Flag optional.

    • Optional: TERRAFORM_VERSION: Die Version von Terraform, die Infra Manager zum Erstellen der Bereitstellung verwenden soll. Eine Liste der unterstützten Versionen finden Sie unter Unterstützte Terraform-Version. Wenn Sie dieses optionale Flag entfernen, wird die neueste unterstützte Version von Terraform verwendet.

    • Optional: ANNOTATION_KEY und ANNOTATION_VALUE sind Schlüssel/Wert-Paare im freien Format, die an Ihre Infra Manager-Bereitstellungen angehängt werden können. Weitere Informationen zur Verwendung und zu den Einschränkungen von Anmerkungen und Labels finden Sie unter Anmerkungen und Labels.

    Felder aus der Bereitstellung wie die Terraform-Konfiguration, Variablen und das Dienstkonto werden automatisch in die Vorschau eingefügt, es sei denn, Sie geben im Befehl „preview“ neue Werte an.

Nachdem Sie eine Vorschau erstellt haben, können Sie die Ergebnisse exportieren und ansehen, um den Plan für die Bereitstellung zu überprüfen.

Vorschau mit einer Terraform-Konfiguration erstellen, die in einem Git-Repository gespeichert ist

Wenn Sie eine Bereitstellung aktualisieren, ändern sich einige der vorhandenen Ressourcen möglicherweise nicht. In der Vorschau eines Updates sehen Sie, welche Ressourcen bereitgestellt oder gelöscht werden sollen und welche nicht geändert werden sollen.

So aktualisieren Sie eine in einem Git-Repository gespeicherte Bereitstellung:

  1. Wenn Sie ein privates Git-Repository verwenden, müssen Sie über Cloud Build eine Verbindung zu Ihrem GitHub-Host und Ihrem GitHub-Repository herstellen, um Infra Manager Zugriff auf Ihr Repository zu gewähren.

  2. So rufen Sie eine Vorschau der Bereitstellung auf:

    gcloud infra-manager previews create projects/PROJECT_ID/locations/LOCATION/previews/PREVIEW_ID \
        --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \
        --git-source-repo="GIT_REPO" \
        --git-source-directory="DIRECTORY" \
        --git-source-ref="REF" \
        --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \
        --tf-version-constraint=TERRAFORM_VERSION \
        --annotation="ANNOTATION_KEY=ANNOTATION_VALUE"
    

Ersetzen Sie:

  • PROJECT_ID ist die Projekt-ID, unter der Infrastructure Manager ausgeführt wird.
  • LOCATION ist der Ort, an dem Infra Manager ausgeführt wird. Eine Liste der gültigen Standorte finden Sie unter Infrastructure Manager-Standorte.
  • PREVIEW_ID ist die von Ihnen angegebene Vorschau-ID. Weitere Informationen zu Einschränkungen für die Vorschau-ID finden Sie unter Vorschauname.
  • SERVICE_ACCOUNT ist der Name des Dienstkontos, mit dem Sie Infra Manager aufrufen.
  • SERVICE_ACCOUNT_PROJECT_ID ist die Projekt-ID des Dienstkontos. In der Regel ist dies dasselbe Projekt, in dem Infra Manager ausgeführt wird.
  • GIT_REPO: das Git-Repository.
  • DIRECTORY: das Verzeichnis mit der Terraform-Konfiguration.
  • REF: die Git-Referenz der Konfiguration. Die Referenz ist optional. Wenn Sie keine Referenz angeben, wird der standardmäßig konfigurierte Branch des Git-Repositorys verwendet.
  • INPUT_1_NAME=VALUE und INPUT_2_NAME=VALUE: beliebige Eingabewerte in der Terraform-Konfiguration, einschließlich derjenigen, die nicht standardmäßig definiert sind. Sie können beispielsweise das Projekt, in dem Sie die Ressourcen bereitstellen, als project_id=my-project angeben.

    Wenn alle Eingabewerte in der Konfiguration standardmäßig definiert sind, ist dieses Flag optional.

  • Optional: TERRAFORM_VERSION: Die Version von Terraform, die Infra Manager zum Erstellen der Bereitstellung verwenden soll. Eine Liste der unterstützten Versionen finden Sie unter Unterstützte Terraform-Version. Wenn Sie dieses optionale Flag entfernen, wird die neueste unterstützte Version von Terraform verwendet.

  • Optional: ANNOTATION_KEY und ANNOTATION_VALUE sind Schlüssel/Wert-Paare im freien Format, die an Ihre Infra Manager-Bereitstellungen angehängt werden können. Weitere Informationen zur Verwendung und zu den Einschränkungen von Anmerkungen und Labels finden Sie unter Anmerkungen und Labels.

Felder aus der Bereitstellung wie die Terraform-Konfiguration, Variablen und das Dienstkonto werden automatisch in die Vorschau eingefügt, es sei denn, Sie geben im Befehl „preview“ neue Werte an.

Nachdem Sie eine Vorschau erstellt haben, können Sie die Ergebnisse exportieren und ansehen, um den Plan für die Bereitstellung zu überprüfen.

Nachdem Sie sich eine Vorschau der Bereitstellung angesehen haben, können Sie die Bereitstellung erstellen, um die Ressourcen bereitzustellen. Weitere Informationen finden Sie unter Ressourcen bereitstellen.

Nächste Schritte