Поделиться через


Начало работы: Развертывание первого обновляемого ресурса в Azure с помощью провайдера AzAPI Terraform

Статья протестирована со следующими версиями Terraform и провайдера Terraform:

Terraform включает определение, предварительную версию и развертывание облачной инфраструктуры. С помощью Terraform вы создаете файлы конфигурации с помощью синтаксиса HCL. Синтаксис HCL позволяет указать поставщика облачных служб, таких как Azure, и элементы, составляющие облачную инфраструктуру. После создания файлов конфигурации вы создадите план выполнения , который позволяет предварительно просмотреть изменения инфраструктуры перед развертыванием. После того как вы проверите изменения, примените план выполнения для развертывания инфраструктуры.

В этой статье вы узнаете, как использовать поставщик AzAPI Terraform для управления новой функцией службы Azure, которая в настоящее время не поддерживается поставщиком AzureRM. Элемент azapi_update_resource будет использоваться для управления набором правил сети Azure EventHub.

  • Определение и настройка поставщиков AzureRM и AzAPI
  • Создание случайного имени для пространства имен Центров событий
  • Использование поставщика AzureRM для создания группы ресурсов Azure и необходимых сетевых ресурсов и ресурсов Центров событий
  • Используйте поставщика AzAPI для добавления сетевого набора правил azurerm_eventhub_namespace к ресурсам.

Замечание

Пример кода в этой статье находится в репозитории Azure Terraform GitHub.

Предпосылки

Реализуйте код Terraform

  1. Создайте каталог для тестирования примера кода Terraform и сделайте его текущим каталогом.

  2. Создайте файл с именем providers.tf и вставьте следующий код:

    terraform {
      required_providers {
        azapi = {
          source  = "azure/azapi"
          version = "=0.1.0"
        }
    
        azurerm = {
          source  = "hashicorp/azurerm"
          version = "=3.0.2"
        }
    
        random = {
          source  = "hashicorp/random"
          version = "=3.1.2"
        }
      }
    }
    
    provider "azapi" {
    }
    
    provider "azurerm" {
      features {}
    }
    
    provider "random" {
    }
    
  3. Создайте файл с именем main.tf и вставьте следующий код:

    resource "azurerm_resource_group" "qs101" {
      name     = "rg-qs101-eh-rules"
      location = "westus2"
    }
    
    resource "azurerm_virtual_network" "qs101" {
      name                = "myvnet"
      location            = azurerm_resource_group.qs101.location
      resource_group_name = azurerm_resource_group.qs101.name
      address_space       = ["172.17.0.0/16"]
      dns_servers         = ["10.0.0.4", "10.0.0.5"]
    }
    
    resource "azurerm_subnet" "qs101" {
      name                 = "default"
      resource_group_name  = azurerm_resource_group.qs101.name
      virtual_network_name = azurerm_virtual_network.qs101.name
      address_prefixes     = ["172.17.0.0/24"]
    
      service_endpoints = ["Microsoft.EventHub"]
    }
    
    resource "random_pet" "qs101_namespace" {
      length    = 3
      separator = ""
    }
    
    resource "azurerm_eventhub_namespace" "qs101" {
      name                = random_pet.qs101_namespace.id
      location            = azurerm_resource_group.qs101.location
      resource_group_name = azurerm_resource_group.qs101.name
      sku                 = "Standard"
      capacity            = 2
    }
    
  4. Создайте файл с именем main-generic.tf и вставьте следующий код:

    # AzAPI update resource is used to enable Network Rule sets on Event Hub namespace
    resource "azapi_update_resource" "qs101" {
      type      = "Microsoft.EventHub/namespaces/networkRuleSets@2021-11-01"
      name      = "default"
      parent_id = azurerm_eventhub_namespace.qs101.id
    
      body = jsonencode({
        properties = {
          defaultAction       = "Deny"
          publicNetworkAccess = "Enabled"
          virtualNetworkRules = [
            {
              ignoreMissingVnetServiceEndpoint = false
              subnet = {
                # API bug, returned id replaced `resourceGroups` with `resourcegroups`
                id = replace(azurerm_subnet.qs101.id, "resourceGroups", "resourcegroups")
              }
            }
          ]
          ipRules = [
            {
              action = "Allow"
              ipMask = "1.1.1.1"
            }
          ]
        }
      })
    }
    

Инициализируйте Terraform

Запустите terraform init , чтобы инициализировать развертывание Terraform. Эта команда загружает поставщика Azure, необходимого для управления вашими ресурсами в Azure.

terraform init -upgrade

Ключевые моменты:

  • Параметр -upgrade обновляет необходимые плагины провайдера до самой последней версии, которая соответствует ограничениям версии конфигурации.

Создайте план запуска Terraform

Запустите terraform plan, чтобы создать план выполнения.

terraform plan -out main.tfplan

Ключевые моменты:

  • Команда terraform plan создает план выполнения, но не выполняет его. Вместо этого он определяет, какие действия необходимы для создания конфигурации, указанной в ваших конфигурационных файлах. Данный шаблон позволяет вам убедиться, что план выполнения соответствует вашим ожиданиям, прежде чем вносить какие-либо изменения в реальные ресурсы.
  • Необязательный параметр -out позволяет указать выходной файл для плана. Использование параметра -out обеспечивает, что план, который вы просмотрели, будет применен точно в таком виде.

Применение плана выполнения Terraform

Выполните terraform apply, чтобы применить план выполнения к облачной инфраструктуре.

terraform apply main.tfplan

Ключевые моменты:

  • Пример команды terraform apply предполагает, что вы ранее выполнили команду terraform plan -out main.tfplan.
  • Если вы указали другое имя файла для параметра -out, используйте то же имя файла при вызове terraform apply.
  • Если вы не использовали параметр -out, вызовите terraform apply без параметров.

Проверка результатов

Запустите az eventhubs namespace network-rule-set show, чтобы отобразить сетевые правила пространства имен Event Hubs.

az eventhubs namespace network-rule show --resource-group <resource_group_name> --namespace-name <namespace_name>

Ключевые моменты:

  • Имя группы ресурсов и имя пространства имен Центров событий отображаются в terraform apply выходных данных.

Очистите ресурсы

Если вам больше не нужны ресурсы, созданные через Terraform, выполните следующие действия:

  1. Запустите команду terraform plan и укажите флаг destroy.

    terraform plan -destroy -out main.destroy.tfplan
    

    Ключевые моменты:

    • Команда terraform plan создает план выполнения, но не выполняет его. Вместо этого он определяет, какие действия необходимы для создания конфигурации, указанной в ваших конфигурационных файлах. Данный шаблон позволяет вам убедиться, что план выполнения соответствует вашим ожиданиям, прежде чем вносить какие-либо изменения в реальные ресурсы.
    • Необязательный параметр -out позволяет указать выходной файл для плана. Использование параметра -out обеспечивает, что план, который вы просмотрели, будет применен точно в таком виде.
  2. Чтобы применить план выполнения, запустите terraform apply.

    terraform apply main.destroy.tfplan
    

Устранение неполадок с Terraform в Azure

Устранение распространенных проблем при использовании Terraform в Azure

Дальнейшие шаги