Udostępnij przez


Szybki start: wdrażanie klastra usługi Azure DocumentDB przy użyciu narzędzia Terraform

W tym przewodniku szybkiego startu wdrożysz nowy klaster Azure DocumentDB przy użyciu narzędzia Terraform. Ten przewodnik Szybki start zawiera instrukcje krok po kroku ułatwiające szybkie rozpoczęcie pracy. Ten klaster zawiera wszystkie zasoby bazy danych MongoDB, kolekcje i dokumenty. Zapewnia on unikatowy punkt końcowy dla narzędzi i zestawów SDK (Software Development Kit) w celu nawiązywania połączenia z usługą Azure DocumentDB i wykonywania operacji.

Wymagania wstępne

  • Subskrypcja platformy Azure

Konfigurowanie środowiska

Skonfiguruj środowisko interfejsu wiersza polecenia platformy Azure, aby zarządzać zasobami usługi Azure DocumentDB w ramach subskrypcji.

  1. Rozpocznij w pustym katalogu.

  2. Zaloguj się do Azure CLI.

    az login
    
  3. Sprawdź docelową subskrypcję platformy Azure.

    az account show
    

    Uwaga / Notatka

    Jeśli nie masz połączenia z oczekiwaną subskrypcją, użyj tego polecenia, aby zmienić subskrypcję:

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

    Aby uzyskać więcej informacji, zobacz Zarządzanie subskrypcjami platformy Azure za pomocą interfejsu wiersza polecenia platformy Azure.

Przygotowywanie konfiguracji narzędzia Terraform

Utwórz i skonfiguruj plik Programu Terraform w celu zdefiniowania zasobów wymaganych do wdrożenia klastra usługi Azure DocumentDB.

  1. Utwórz nowy plik main.tf w katalogu projektu.

  2. Dodaj tę konfigurację do zawartości pliku.

    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"
    }
    

    Wskazówka

    Aby uzyskać więcej informacji na temat opcji przy użyciu azurerm_mongo_cluster zasobu, zobacz azurerm dokumentację dostawcy w usłudze Terraform Registry.

Wdrażanie konfiguracji

Wdróż plik konfiguracji utworzony w poprzednim kroku przy użyciu planu wykonania.

  1. Zainicjuj wdrożenie narzędzia Terraform przy użyciu interfejsu wiersza polecenia programu Terraform.

    terraform init --upgrade
    
  2. Utwórz plan wykonania i zapisz go w pliku o nazwie main.tfplan. Podaj wartości, gdy zostaniesz poproszony o zmienne admin_username i admin_password.

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

    Uwaga / Notatka

    To polecenie tymczasowo ustawia zmienną ARM_SUBSCRIPTION_ID środowiskową. To ustawienie jest wymagane dla dostawcy azurerm począwszy od wersji 4.0. Aby uzyskać więcej informacji, zobacz identyfikator subskrypcji w programie azurerm.

  3. Zastosuj plan wykonywania, aby wdrożyć zasoby na platformie Azure.

    ARM_SUBSCRIPTION_ID=$(az account show --query id --output tsv) terraform apply "main.tfplan"
    
  4. Przed przejściem poczekaj na zakończenie operacji wdrażania.

Przeglądanie wdrożonych zasobów

Wyświetl listę zasobów usługi Azure DocumentDB wdrożonych w grupie zasobów.

  1. Użyj polecenia az resource list , aby uzyskać listę zasobów w grupie zasobów.

    az resource list \
        --resource-group "<resource-group-name>" \
        --namespace "Microsoft.DocumentDB" \
        --resource-type "mongoClusters" \
        --query "[].name" \
        --output json
    
  2. W przykładowych danych wyjściowych poszukaj zasobów, które mają typ Microsoft.DocumentDB/mongoClusters. Oto przykład typu danych wyjściowych, których można oczekiwać:

    [
      "msdocs-documentdb-example-cluster"
    ]
    

Uprzątnij zasoby

Usuń wszystkie zasoby zdefiniowane w konfiguracji narzędzia Terraform.

  1. Zniszcz zasoby zarządzane przez narzędzie Terraform przy użyciu destroy polecenia .

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

    Wskazówka

    Alternatywnie użyj polecenia az group delete , aby usunąć grupę zasobów z subskrypcji:

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

    Ważne

    Przed uruchomieniem tego polecenia upewnij się, że zasoby nie są już potrzebne, ponieważ trwale je usuwa.

  2. Potwierdź wszelkie odpowiednie komunikaty, aby kontynuować usuwanie.