Freigeben über


Schnellstart: Bereitstellen eines Azure DocumentDB-Clusters mit Terraform

In dieser Schnellstartanleitung stellen Sie einen neuen Azure DocumentDB-Cluster mit Terraform bereit. Diese Schnellstartanleitung enthält schrittweise Anleitungen, mit denen Sie schnell beginnen können. Dieser Cluster enthält alle Ihre MongoDB-Ressourcen: Datenbanken, Sammlungen und Dokumente. Es stellt einen eindeutigen Endpunkt für Tools und Software Development Kits (SDKs) bereit, um eine Verbindung mit Azure DocumentDB herzustellen und Vorgänge auszuführen.

Voraussetzungen

  • Ein Azure-Abonnement

    • Wenn Sie nicht über ein Azure-Abonnement verfügen, erstellen Sie ein kostenloses Konto

Konfigurieren der Umgebung

Richten Sie Ihre Azure CLI-Umgebung ein, um Azure DocumentDB-Ressourcen in Ihrem Abonnement zu verwalten.

  1. Beginnen Sie in einem leeren Verzeichnis.

  2. Melden Sie sich bei Azure CLI an.

    az login
    
  3. Überprüfen Sie Ihr Azure-Zielabonnement.

    az account show
    

    Hinweis

    Wenn Sie nicht mit dem erwarteten Abonnement verbunden sind, verwenden Sie diesen Befehl, um Ihr Abonnement zu ändern:

    az account set --subscription "<subscription-name>"
    

    Weitere Informationen finden Sie unter Verwalten von Azure-Abonnements mit der Azure CLI.

Vorbereiten der Terraform-Konfiguration

Erstellen und konfigurieren Sie eine Terraform-Datei, um die ressourcen zu definieren, die für die Bereitstellung eines Azure DocumentDB-Clusters erforderlich sind.

  1. Erstellen Sie eine neue main.tf Datei in Ihrem Projektverzeichnis.

  2. Fügen Sie diese Konfiguration dem Inhalt der Datei hinzu.

    variable "admin_username" {
      type = string
      description = "Username for default administrator account"
    }
    
    variable "admin_password" {
      type = string
      description = "Password for default administrator account"
      sensitive = true
    }
    
    terraform {
      required_providers {
        azurerm = {
          source = "hashicorp/azurerm"
          version = "~> 4.0"
        }
      }
    }
    
    provider "azurerm" {
      features { }
    }
    
    resource "azurerm_resource_group" "resource_group" {
      name     = "example-resource-group"
      location = "West US"
    }
    
    resource "azurerm_mongo_cluster" "cluster" {
      name                   = "example-mongo-cluster"
      resource_group_name    = azurerm_resource_group.resource_group.name
      location               = azurerm_resource_group.resource_group.location
      administrator_username = var.admin_username
      administrator_password = var.admin_password
      shard_count            = "1"
      compute_tier           = "M10"
      high_availability_mode = "Disabled"
      storage_size_in_gb     = "32"
      version                = "8.0"
    }
    

    Tipp

    Weitere Informationen zu den Optionen, die die azurerm_mongo_clusterRessource verwenden, finden Sie in der azurermDokumentation des Anbieters in Terraform Registry.

Bereitstellen der Konfiguration

Stellen Sie die im vorherigen Schritt erstellte Konfigurationsdatei mithilfe eines Ausführungsplans bereit.

  1. Initialisieren Sie die Terraform-Bereitstellung mit Terraform CLI.

    terraform init --upgrade
    
  2. Erstellen Sie einen Ausführungsplan, und speichern Sie ihn in einer Datei mit dem Namen "main.tfplan". Geben Sie Werte für die Variablen admin_username und admin_password ein, wenn Sie dazu aufgefordert werden.

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform plan --out "main.tfplan"
    

    Hinweis

    Mit diesem Befehl wird die ARM_SUBSCRIPTION_ID Umgebungsvariable vorübergehend festgelegt. Diese Einstellung ist für den azurerm Anbieter ab Version 4.0 erforderlich. Weitere Informationen finden Sie unter "Abonnement-ID" in azurerm.

  3. Wenden Sie den Ausführungsplan an, um Ressourcen in Azure bereitzustellen.

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform apply "main.tfplan"
    
  4. Warten Sie, bis der Bereitstellungsvorgang abgeschlossen ist, bevor Sie fortfahren.

Überprüfen der bereitgestellten Ressourcen

Listen Sie die in Ihrer Ressourcengruppe bereitgestellten Azure DocumentDB-Ressourcen auf.

  1. Verwenden Sie az resource list, um eine Liste von Ressourcen in Ihrer Ressourcengruppe abzurufen.

    az resource list \
        --resource-group "<resource-group-name>" \
        --namespace "Microsoft.DocumentDB" \
        --resource-type "mongoClusters" \
        --query "[].name" \
        --output json
    
  2. Suchen Sie in der Beispielausgabe nach Ressourcen mit einem Typ von Microsoft.DocumentDB/mongoClusters. Hier ist ein Beispiel für den erwarteten Ausgabetyp:

    [
      "msdocs-documentdb-example-cluster"
    ]
    

Bereinigen von Ressourcen

Entfernen Sie alle ressourcen, die in Ihrer Terraform-Konfiguration definiert sind.

  1. Zerstören Sie Ihre Ressourcen, die von Terraform verwaltet werden, mithilfe des destroy Befehls.

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform destroy
    

    Tipp

    Alternativ können Sie az group delete verwenden, um die Ressourcengruppe aus Ihrem Abonnement zu entfernen.

    az group delete \
        --name "<resource-group-name>" \
        --yes \
        --no-wait
    

    Von Bedeutung

    Stellen Sie sicher, dass Sie die Ressourcen nicht mehr benötigen, bevor Sie diesen Befehl ausführen, da sie endgültig gelöscht werden.

  2. Bestätigen Sie alle relevanten Eingabeaufforderungen, um mit dem Löschvorgang fortzufahren.