Mengonfigurasi host sesi Azure Virtual Desktop menggunakan Terraform

Artikel ini memperlihatkan kepada Anda cara membangun Host Sesi dan menyebarkannya ke Kumpulan Host AVD dengan Terraform. Artikel ini mengasumsikan Anda telah menyebarkan Infrastruktur Azure Virtual Desktop.

Artikel diuji dengan versi penyedia Terraform dan Terraform berikut:

• Terraform v1.1.7
• Penyedia AzureRM v.2.99.0

Pelajari selengkapnya tentang menggunakan Terraform di Azure

Dalam artikel ini, Anda akan mempelajari cara:

• Menggunakan Terraform untuk membuat NIC untuk setiap host sesi
• Menggunakan Terraform untuk membuat VM untuk host sesi
• Menggabungkan VM ke domain
• Mendaftarkan VM dengan Azure Virtual Desktop
• Menggunakan file variabel

1. Mengonfigurasi lingkungan Anda

• Langganan Azure: Jika Anda tidak memiliki langganan Azure, buat akun gratis sebelum memulai.

• Konfigurasi Terraform: Jika Anda belum melakukannya, konfigurasikan Terraform menggunakan salah satu opsi berikut:

  • Mengonfigurasi Terraform in Azure Cloud Shell dengan Bash
  • Mengonfigurasi Terraform in Azure Cloud Shell dengan PowerShell
  • Konfigurasikan Terraform dalam Windows dengan Bash
  • Konfigurasikan Terraform dalam Windows dengan PowerShell

2. Terapkan kode Terraform

1. Buat direktori untuk menguji dan menjalankan kode sampel Terraform dan menjadikannya direktori saat ini.

2. Buat file bernama providers.tf dan masukkan kode berikut.

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

   Poin utama:

   • Gunakan count untuk menunjukkan berapa banyak sumber daya yang akan dibuat
   • Mereferensikan sumber daya yang dibuat ketika infrastruktur dibangun - seperti azurerm_subnet.subnet.id dan azurerm_virtual_desktop_host_pool.hostpool.name. Jika Anda mengubah nama sumber daya ini dari bagian tersebut, Anda juga perlu memperbarui referensi di sini.

3. Buat file bernama main.tf dan masukkan kode berikut:

   locals {
     registration_token = azurerm_virtual_desktop_host_pool_registration_info.registrationinfo.token
   }
   
   resource "random_string" "AVD_local_password" {
     count            = var.rdsh_count
     length           = 16
     special          = true
     min_special      = 2
     override_special = "*!@#?"
   }
   
   resource "azurerm_resource_group" "rg" {
     name     = var.rg
     location = var.resource_group_location
   }
   
   resource "azurerm_network_interface" "avd_vm_nic" {
     count               = var.rdsh_count
     name                = "${var.prefix}-${count.index + 1}-nic"
     resource_group_name = azurerm_resource_group.rg.name
     location            = azurerm_resource_group.rg.location
   
     ip_configuration {
       name                          = "nic${count.index + 1}_config"
       subnet_id                     = azurerm_subnet.subnet.id
       private_ip_address_allocation = "dynamic"
     }
   
     depends_on = [
       azurerm_resource_group.rg
     ]
   }
   
   resource "azurerm_windows_virtual_machine" "avd_vm" {
     count                 = var.rdsh_count
     name                  = "${var.prefix}-${count.index + 1}"
     resource_group_name   = azurerm_resource_group.rg.name
     location              = azurerm_resource_group.rg.location
     size                  = var.vm_size
     network_interface_ids = ["${azurerm_network_interface.avd_vm_nic.*.id[count.index]}"]
     provision_vm_agent    = true
     admin_username        = var.local_admin_username
     admin_password        = var.local_admin_password
   
     os_disk {
       name                 = "${lower(var.prefix)}-${count.index + 1}"
       caching              = "ReadWrite"
       storage_account_type = "Standard_LRS"
     }
   
     source_image_reference {
       publisher = "MicrosoftWindowsDesktop"
       offer     = "Windows-10"
       sku       = "20h2-evd"
       version   = "latest"
     }
   
     depends_on = [
       azurerm_resource_group.rg,
       azurerm_network_interface.avd_vm_nic
     ]
   }
   
   resource "azurerm_virtual_machine_extension" "domain_join" {
     count                      = var.rdsh_count
     name                       = "${var.prefix}-${count.index + 1}-domainJoin"
     virtual_machine_id         = azurerm_windows_virtual_machine.avd_vm.*.id[count.index]
     publisher                  = "Microsoft.Compute"
     type                       = "JsonADDomainExtension"
     type_handler_version       = "1.3"
     auto_upgrade_minor_version = true
   
     settings = <<SETTINGS
       {
         "Name": "${var.domain_name}",
         "OUPath": "${var.ou_path}",
         "User": "${var.domain_user_upn}@${var.domain_name}",
         "Restart": "true",
         "Options": "3"
       }
   SETTINGS
   
     protected_settings = <<PROTECTED_SETTINGS
       {
         "Password": "${var.domain_password}"
       }
   PROTECTED_SETTINGS
   
     lifecycle {
       ignore_changes = [settings, protected_settings]
     }
   
     depends_on = [
       azurerm_virtual_network_peering.peer1,
       azurerm_virtual_network_peering.peer2
     ]
   }
   
   resource "azurerm_virtual_machine_extension" "vmext_dsc" {
     count                      = var.rdsh_count
     name                       = "${var.prefix}${count.index + 1}-avd_dsc"
     virtual_machine_id         = azurerm_windows_virtual_machine.avd_vm.*.id[count.index]
     publisher                  = "Microsoft.Powershell"
     type                       = "DSC"
     type_handler_version       = "2.73"
     auto_upgrade_minor_version = true
   
     settings = <<-SETTINGS
       {
         "modulesUrl": "https://wvdportalstorageblob.blob.core.windows.net/galleryartifacts/Configuration_09-08-2022.zip",
         "configurationFunction": "Configuration.ps1\\AddSessionHost",
         "properties": {
           "HostPoolName":"${azurerm_virtual_desktop_host_pool.hostpool.name}"
         }
       }
   SETTINGS
   
     protected_settings = <<PROTECTED_SETTINGS
     {
       "properties": {
         "registrationInfoToken": "${local.registration_token}"
       }
     }
   PROTECTED_SETTINGS
   
     depends_on = [
       azurerm_virtual_machine_extension.domain_join,
       azurerm_virtual_desktop_host_pool.hostpool
     ]
   }
   

4. Buat file bernama variables.tf dan masukkan kode berikut:

variable "resource_group_location" {
  default     = "eastus"
  description = "Location of the resource group."
}

variable "rg" {
  type        = string
  default     = "rg-avd-compute"
  description = "Name of the Resource group in which to deploy session host"
}

variable "rdsh_count" {
  description = "Number of AVD machines to deploy"
  default     = 2
}

variable "prefix" {
  type        = string
  default     = "avdtf"
  description = "Prefix of the name of the AVD machine(s)"
}

variable "domain_name" {
  type        = string
  default     = "infra.local"
  description = "Name of the domain to join"
}

variable "domain_user_upn" {
  type        = string
  default     = "domainjoineruser" # do not include domain name as this is appended
  description = "Username for domain join (do not include domain name as this is appended)"
}

variable "domain_password" {
  type        = string
  default     = "ChangeMe123!"
  description = "Password of the user to authenticate with the domain"
  sensitive   = true
}

variable "vm_size" {
  description = "Size of the machine to deploy"
  default     = "Standard_DS2_v2"
}

variable "ou_path" {
  default = ""
}

variable "local_admin_username" {
  type        = string
  default     = "localadm"
  description = "local admin username"
}

variable "local_admin_password" {
  type        = string
  default     = "ChangeMe123!"
  description = "local admin password"
  sensitive   = true
}

1. Buat file bernama output.tf dan masukkan kode berikut:

output "location" {
  description = "The Azure region"
  value       = azurerm_resource_group.rg.location
}

output "session_host_count" {
  description = "The number of VMs created"
  value       = var.rdsh_count
}

output "dnsservers" {
  description = "Custom DNS configuration"
  value       = azurerm_virtual_network.vnet.dns_servers
}

output "vnetrange" {
  description = "Address range for deployment vnet"
  value       = azurerm_virtual_network.vnet.address_space
}

1. Buat file bernama terraform.tfvars dan masukkan kode berikut:

   # Customized the sample values below for your environment and either rename to terraform.tfvars or env.auto.tfvars
   
   deploy_location      = "west europe"
   rg_name              = "avd-resources-rg"
   prefix               = "avdtf"
   local_admin_username = "localadm"
   local_admin_password = "ChangeMe123$"
   vnet_range           = ["10.1.0.0/16"]
   subnet_range         = ["10.1.0.0/24"]
   dns_servers          = ["10.0.1.4", "168.63.129.16"]
   aad_group_name       = "AVDUsers"
   domain_name          = "infra.local"
   domain_user_upn      = "admin"     # do not include domain name as this is appended
   domain_password      = "ChangeMe123!"
   ad_vnet              = "infra-network"
   ad_rg                = "infra-rg"
   avd_users = [
     "avduser01@infra.local",
     "avduser01@infra.local"
   ]
   

3. Inisialisasi Terraform

Jalankan terraform init untuk menginisialisasi penyebaran Terraform. Perintah ini mengunduh penyedia Azure yang diperlukan untuk mengelola sumber daya Azure Anda.

terraform init -upgrade

Poin utama:

• Parameter -upgrade meningkatkan plugin penyedia yang diperlukan ke versi terbaru yang sesuai dengan batasan versi konfigurasi.

4. Buat rencana eksekusi Terraform

Jalankan terraform plan untuk membuat rencana eksekusi.

terraform plan -out main.tfplan

Poin utama:

• Perintah terraform plan membuat rencana eksekusi, tetapi tidak menjalankannya. Perintah ini justru menentukan tindakan yang diperlukan untuk membuat konfigurasi yang ditentukan dalam file konfigurasi Anda. Pola ini memungkinkan Anda memastikan apakah rencana eksekusi telah sesuai dengan ekspektasi Anda sebelum membuat perubahan pada sumber daya aktual.
• Parameter -out opsional memungkinkan Anda menentukan file output untuk rencana. Menggunakan parameter -out memastikan bahwa rencana yang Anda tinjau benar-benar sesuai dengan yang diterapkan.

5. Terapkan rencana eksekusi Terraform

Jalankan terraform apply untuk menerapkan rencana eksekusi ke infrastruktur cloud Anda.

terraform apply main.tfplan

Poin utama:

• Contoh terraform apply perintah mengasumsikan Anda sebelumnya menjalankan terraform plan -out main.tfplan.
• Jika Anda menentukan nama file yang berbeda untuk parameter -out, gunakan nama file yang sama dalam panggilan ke terraform apply.
• Jika Anda tidak menggunakan parameter -out, panggil terraform apply tanpa parameter apa pun.

6. Verifikasi hasilnya

1. Pada portal Azure, Pilih Azure Virtual Desktop.
2. Pilih Kumpulan host lalu Nama sumber daya yang dibuat kumpulan.
3. Pilih Host sesi lalu verifikasi host sesi tercantum.

7. Membersihkan sumber daya

Ketika Anda tidak lagi membutuhkan sumber daya yang dibuat melalui Terraform, lakukan langkah-langkah berikut:

1. Jalankan terraform plan dan tentukan bendera destroy.

   terraform plan -destroy -out main.destroy.tfplan
   

   Poin utama:

   • Perintah terraform plan membuat rencana eksekusi, tetapi tidak menjalankannya. Perintah ini justru menentukan tindakan yang diperlukan untuk membuat konfigurasi yang ditentukan dalam file konfigurasi Anda. Pola ini memungkinkan Anda memastikan apakah rencana eksekusi telah sesuai dengan ekspektasi Anda sebelum membuat perubahan pada sumber daya aktual.
   • Parameter -out opsional memungkinkan Anda menentukan file output untuk rencana. Menggunakan parameter -out memastikan bahwa rencana yang Anda tinjau benar-benar sesuai dengan yang diterapkan.

2. Jalankan terraform apply untuk menerapkan rencana eksekusi.

   terraform apply main.destroy.tfplan
   

Memecahkan masalah Terraform pada Azure

Memecahkan masalah umum saat menggunakan Terraform di Azure

Langkah berikutnya

Pelajari selengkapnya tentang menggunakan Terraform di Azure