Installieren von Terraform unter Windows mit Azure PowerShell

Mit Terraform können Sie eine Cloudinfrastruktur definieren, eine Vorschau der Cloudinfrastruktur anzeigen und die Cloudinfrastruktur bereitstellen. Terraform ermöglicht das Erstellen von Konfigurationsdateien mit HCL-Syntax. Mit der HCL-Syntax können Sie den Cloudanbieter (beispielsweise Azure) und die Elemente angeben, aus denen sich Ihre Cloudinfrastruktur zusammensetzt. Nach der Erstellung Ihrer Konfigurationsdateien erstellen Sie einen Ausführungsplan, mit dem Sie eine Vorschau Ihrer Infrastrukturänderungen anzeigen können, bevor diese bereitgestellt werden. Nach der Überprüfung der Änderungen wenden Sie den Ausführungsplan an, um die Infrastruktur bereitzustellen. Weitere Informationen zur Verwendung von Terraform in Azure finden Sie im Azure Terraform Developer Center

In diesem Artikel werden die ersten Schritte mit Terraform in Azure unter Verwendung von PowerShell beschrieben.

In diesem Artikel werden folgende Vorgehensweisen behandelt:

  • Installieren der neuesten PowerShell-Version
  • Installieren des neuen PowerShell Az-Moduls
  • Installieren der Azure CLI
  • Installieren von Terraform
  • Informationen zu gängigen Terraform- und Azure-Authentifizierungsszenarien
  • Authentifizieren über ein Microsoft-Konto in Cloud Shell (mithilfe von Bash oder PowerShell)
  • Authentifizieren über ein Microsoft-Konto in Windows (mithilfe von Bash oder PowerShell)
  • Erstellen eines Dienstprinzipals mithilfe der Azure CLI
  • Erstellen eines Dienstprinzipals mit Azure PowerShell
  • Angeben der Anmeldeinformationen für den Dienstprinzipal in Umgebungsvariablen
  • Angeben der Anmeldeinformationen für den Dienstprinzipal in einem Terraform-Anbieterblock

1. Konfigurieren Ihrer Umgebung

  • Azure-Abonnement: Wenn Sie kein Azure-Abonnement besitzen, können Sie ein kostenloses Konto erstellen, bevor Sie beginnen.

2. Installieren von Azure PowerShell

  1. Das aktuelle PowerShell-Modul, das die Interaktion mit Azure-Ressourcen ermöglicht, heißt Azure PowerShell Az-Modul. Wenn Sie das Azure PowerShell Az-Modul verwenden, wird auf allen Plattformen mindestens Version 7 von PowerShell empfohlen. Wenn Sie PowerShell installiert haben, können Sie die Version überprüfen, indem Sie den folgenden Befehl an einer PowerShell-Eingabeaufforderung eingeben:

    $PSVersionTable.PSVersion
    
  2. Installieren Sie PowerShell. Diese Demo wurde mit PowerShell 7.2.1 (x64) auf Windows 10 getestet.

3. Installieren der Azure-Befehlszeilenschnittstelle

Für die Authentifizierung von Terraform bei Azure müssen Sie die Azure CLI installieren. Diese Demo wurde mit Azure CLI Version 2.32.0 getestet.

4. Installieren von Terraform für Windows

  1. Laden Sie Terraform herunter. Dieser Artikel wurde mit Terraform Version 1.1.4 getestet.

  2. Extrahieren Sie die ausführbare Datei aus dem Download in ein Verzeichnis Ihrer Wahl (z. B. c:\terraform).

  3. Aktualisieren Sie den globalen Pfad Ihres Systems auf die ausführbare Datei.

  4. Öffnen Sie ein Terminalfenster.

  5. Überprüfen Sie die Konfiguration des globalen Pfads mit dem Befehl terraform.

    terraform -version
    

5. Authentifizieren von Terraform bei Azure

Terraform- und Azure-Authentifizierungsszenarien

Terraform unterstützt für die Authentifizierung bei Azure nur die Azure-Befehlszeilenschnittstelle (Azure CLI). Die Authentifizierung mit Azure PowerShell wird nicht unterstützt. Obwohl Sie für Ihre Arbeit mit Terraform das Azure PowerShell-Modul verwenden können, müssen Sie sich daher zunächst mithilfe der Azure CLI bei Azure authentifizieren.

In diesem Artikel wird für die unten genannten Szenarien erläutert, wie Sie Terraform bei Azure authentifizieren. Weitere Informationen zu den Optionen für die Authentifizierung von Terraform bei Azure finden Sie unter Authentifizieren mithilfe der Azure CLI.

Authentifizieren bei Azure über ein Microsoft-Konto

Ein Microsoft-Konto ist ein Benutzername (mit einer E-Mail und seinen Anmeldeinformationen verknüpft), der zum Anmelden bei Microsoft-Dienste verwendet wird – z. B. Azure. Ein Microsoft-Konto kann mit einem oder mehreren Azure-Abonnements verknüpft werden, wobei eines davon das Standardabonnement ist.

Die folgenden Schritte zeigen, wie Sie sich interaktiv mit einem Microsoft-Konto bei Azure anmelden, die zugeordneten Azure-Abonnements des Kontos (einschließlich der Standardeinstellung) auflisten und das aktuelle Abonnement festlegen.

  1. Öffnen Sie eine Befehlszeile, die Zugriff auf die Azure CLI hat.

  2. Führen Sie az-Anmeldung ohne Parameter aus, und folgen Sie den Anweisungen, um sich bei Azure anzumelden.

    az login
    

    Die wichtigsten Punkte:

    • Zeigt bei erfolgreicher Anmeldung eine Liste der Azure-Abonnements an, az login die dem angemeldeten Microsoft-Konto zugeordnet sind, einschließlich des Standardabonnements.
  3. Führen Sie zum Überprüfen des aktuellen Azure-Abonnements az account show aus.

    az account show
    
  4. Führen Sie zum Anzeigen aller Azure-Abonnementnamen und -IDs für ein bestimmtes Microsoft-Konto az account list aus.

    az account list --query "[?user.name=='<microsoft_account_email>'].{Name:name, ID:id, Default:isDefault}" --output Table
    

    Die wichtigsten Punkte:

    • Ersetzen Sie den Platzhalter <microsoft_account_email> durch die E-Mail-Adresse des Microsoft-Kontos, dessen Azure-Abonnements Sie auflisten möchten.
    • Mit einem Live Konto ( z. B. hotmail oder Outlook - müssen Sie möglicherweise die vollqualifizierte E-Mail-Adresse angeben. Wenn Ihre E-Mail-Adresse admin@hotmail.com lautet, würden Sie den Platzhalter in diesem Fall z. B. durch live.com#admin@hotmail.com ersetzen.
  5. Führen Sie az account set aus, um ein bestimmtes Azure-Abonnement zu verwenden.

    az account set --subscription "<subscription_id_or_subscription_name>"
    

    Die wichtigsten Punkte:

    • Ersetzen Sie den Platzhalter <subscription_id_or_subscription_name> durch die ID oder den Namen des gewünschten Abonnements.
    • Die Ergebnisse des Wechsels zum angegebenen Azure-Abonnement werden durch den Aufruf von az account set nicht angezeigt. Sie können sich jedoch mithilfe von az account show vergewissern, dass sich das aktuelle Azure-Abonnement geändert hat.
    • Wenn Sie den Befehl az account list im vorherigen Schritt ausführen, sehen Sie, dass das Azure-Standardabonnement in das Abonnement geändert wurde, das Sie mit az account set angegeben haben.

Erstellen eines Dienstprinzipals

Automatisierte Tools wie Terraform, die Azure-Dienste bereitstellen oder verwenden, sollten stets über eingeschränkte Berechtigungen verfügen. Azure bietet Dienstprinzipale, damit Anwendungen nicht als Benutzer mit uneingeschränkten Berechtigungen angemeldet werden müssen.

Das häufigste Muster besteht darin, sich interaktiv bei Azure anzumelden, einen Dienstprinzipal zu erstellen, den Dienstprinzipal zu testen und dann diesen Dienstprinzipal für die zukünftige Authentifizierung zu verwenden (entweder interaktiv oder aus Ihren Skripts).

  1. Melden Sie sich bei Azure an, um einen Dienstprinzipal zu erstellen. Führen Sie dazu die Schritte zum Authentifizieren bei Azure über ein Microsoft-Konto aus, und kehren Sie dann hierher zurück.

  2. Wenn Sie einen Dienstprinzipal über Git Bash erstellen, legen Sie die Umgebungsvariable MSYS_NO_PATHCONV fest. (Dieser Schritt ist nicht erforderlich, wenn Sie Cloud Shell verwenden.)

    export MSYS_NO_PATHCONV=1    
    

    Die wichtigsten Punkte:

    • Sie können die Umgebungsvariable MSYS_NO_PATHCONV global (für alle Terminalsitzungen) oder lokal (nur für die aktuelle Sitzung) festlegen. Da das Erstellen eines Dienstprinzipals nicht häufig ausgeführt wird, legt das Beispiel den Wert für die aktuelle Sitzung fest. Um diese Umgebungsvariable global festzulegen, fügen Sie die Einstellung der ~/.bashrc-Datei hinzu.
  3. Führen Sie zum Erstellen eines Dienstprinzipals az ad sp create-for-rbac aus.

    az ad sp create-for-rbac --name <service_principal_name> --role Contributor --scopes /subscriptions/<subscription_id>
    

    Die wichtigsten Punkte:

    • Sie können <service-principal-name> durch einen benutzerdefinierten Namen für Ihre Umgebung ersetzen oder den Parameter ganz weglassen. Wenn Sie den Parameter weglassen, wird der Dienstprinzipalname basierend auf dem aktuellen Datum und der aktuellen Uhrzeit generiert.
    • Nach dem erfolgreichen Abschluss werden von az ad sp create-for-rbac verschiedene Werte angezeigt. Die Werte appId, password und tenant werden im nächsten Schritt verwendet.
    • Dieses Kennwort kann nicht erneut abgerufen werden. Es empfiehlt sich daher, das Kennwort an einem sicheren Ort zu speichern. Sollten Sie Ihr Kennwort vergessen, können Sie die Anmeldeinformationen für den Dienstprinzipal zurücksetzen.
    • In diesem Artikel wird ein Dienstprinzipal mit der Rolle Mitwirkender verwendet. Weitere Informationen zu Role-Based Access Control(RBAC)-Rollen finden Sie unter RBAC: Integrierte Rollen.
    • Die Ausgabe der Erstellung des Dienstprinzipals enthält vertrauliche Anmeldeinformationen. Schließen Sie diese Anmeldeinformationen nicht in Ihren Code ein, und checken Sie sie nicht in Ihre Quellcodeverwaltung ein.
    • Weitere Informationen zu Optionen beim Erstellen eines Dienstprinzipals mit der Azure CLI finden Sie im Artikel Erstellen eines Azure-Dienstprinzipals mit der Azure CLI.

Angeben der Anmeldeinformationen für den Dienstprinzipal in Umgebungsvariablen

Nachdem Sie einen Dienstprinzipal erstellt haben, können Sie seine Anmeldeinformationen über Umgebungsvariablen für Terraform angeben.

  1. Bearbeiten Sie die ~/.bashrc-Datei, indem Sie die folgenden Umgebungsvariablen hinzufügen.

    export ARM_SUBSCRIPTION_ID="<azure_subscription_id>"
    export ARM_TENANT_ID="<azure_subscription_tenant_id>"
    export ARM_CLIENT_ID="<service_principal_appid>"
    export ARM_CLIENT_SECRET="<service_principal_password>"
    
  2. Führen Sie source ~/.bashrc (oder die abgekürzte Entsprechung . ~/.bashrc) aus, um das Skript ~/.bashrc auszuführen. Sie können Cloud Shell auch beenden und erneut öffnen, damit das Skript automatisch ausgeführt wird.

    . ~/.bashrc
    
  3. Nachdem Sie die Umgebungsvariablen festgelegt haben, können Sie deren Werte wie folgt überprüfen:

    printenv | grep ^ARM*
    

Die wichtigsten Punkte:

  • Verwenden Sie wie bei jeder Umgebungsvariablen die folgende Syntax, um innerhalb eines Terraform-Skripts auf einen Azure-Abonnementwert zuzugreifen: ${env.<environment_variable>}. Beispiel: Wenn Sie auf den Wert ARM_SUBSCRIPTION_ID zugreifen möchten, geben Sie ${env.ARM_SUBSCRIPTION_ID} an.
  • Beim Erstellen und Anwenden von Terraform-Ausführungsplänen werden Änderungen an dem Azure-Abonnement vorgenommen, das dem Dienstprinzipal zugeordnet ist. Dies kann manchmal verwirrend sein, wenn Sie bei einem Azure-Abonnement angemeldet sind und die Umgebungsvariablen auf ein zweites Azure-Abonnement verweisen. Betrachten Sie zur Veranschaulichung das folgende Beispiel. Angenommen, Sie verfügen über zwei Azure-Abonnements: SubA und SubB. Wenn das aktuelle Azure-Abonnement SubA ist (über az account show ermittelt), während die Umgebungsvariablen auf SubB verweisen, gelten alle von Terraform vorgenommenen Änderungen für SubB. Daher müssen Sie sich beim Abonnement SubB anmelden, um Azure CLI- oder Azure PowerShell-Befehle auszuführen und Ihre Änderungen anzuzeigen.

Angeben von Anmeldeinformationen für den Dienstprinzipal in einem Terraform-Anbieterblock

Der Azure-Anbieterblock definiert die Syntax, mit der Sie die Authentifizierungsinformationen Ihres Azure-Abonnements angeben können.

terraform {
  required_providers {
    azurerm = {
      source = "hashicorp/azurerm"
      version = "~>2.0"
    }
  }
}

provider "azurerm" {
  features {}

  subscription_id   = "<azure_subscription_id>"
  tenant_id         = "<azure_subscription_tenant_id>"
  client_id         = "<service_principal_appid>"
  client_secret     = "<service_principal_password>"
}

# Your code goes here

Achtung

Die Möglichkeit, Anmeldeinformationen für Ihr Azure-Abonnement in einer Terraform-Konfigurationsdatei anzugeben, kann besonders beim Testen praktisch sein. Es ist jedoch nicht ratsam, Anmeldeinformationen in einer Klartextdatei zu speichern, die von nicht vertrauenswürdigen Personen angezeigt werden kann.

Problembehandlung für Terraform in Azure

Behandeln allgemeiner Probleme bei der Verwendung von Terraform in Azure

Nächste Schritte