Terraform gebruiken om een Azure AI Studio-hub te maken

In dit artikel gebruikt u Terraform om een Azure AI Studio-hub, een project- en AI-servicesverbinding te maken. Een hub is een centrale plek voor gegevenswetenschappers en ontwikkelaars om samen te werken aan machine learning-projecten. Het biedt een gedeelde, gezamenlijke ruimte voor het bouwen, trainen en implementeren van machine learning-modellen. De hub is geïntegreerd met Azure Machine Learning en andere Azure-services, waardoor het een uitgebreide oplossing is voor machine learning-taken. Met de hub kunt u ook uw AI-implementaties beheren en bewaken, zodat ze naar behoren presteren.

Terraform maakt de definitie, preview en implementatie van de cloudinfrastructuur mogelijk. Met Behulp van Terraform maakt u configuratiebestanden met behulp van de HCL-syntaxis. Met de HCL-syntaxis kunt u de cloudprovider opgeven, zoals Azure, en de elementen waaruit uw cloudinfrastructuur bestaat. Nadat u uw configuratiebestanden hebt gemaakt, maakt u een uitvoeringsplan waarmee u een voorbeeld van uw infrastructuurwijzigingen kunt bekijken voordat ze worden geïmplementeerd. Zodra u de wijzigingen hebt gecontroleerd, past u het uitvoeringsplan toe om de infrastructuur te implementeren.

• Een brongroep maken
• Een opslagaccount instellen
• Een sleutelkluis tot stand brengen
• AI-services configureren
• Een AI Studio-hub bouwen
• Een AI Studio-project ontwikkelen
• Een VERBINDING met AI-services tot stand brengen

Vereisten

• Maak een Azure-account met een actief abonnement. U kunt gratis een account maken.

• Terraform installeren en configureren

De Terraform-code implementeren

Notitie

De voorbeeldcode voor dit artikel bevindt zich in de Azure Terraform GitHub-opslagplaats. U kunt het logboekbestand met de testresultaten van de huidige en vorige versies van Terraform bekijken.

Zie meer artikelen en voorbeeldcode waarin wordt getoond hoe u Terraform gebruikt om Azure-resources te beheren

1. Maak een map waarin u de Terraform-voorbeeldcode wilt testen en uitvoeren en deze de huidige map wilt maken.

2. Maak een bestand met de naam providers.tf en voeg de volgende code in.

   terraform {
     required_version = ">= 1.0"
   
     required_providers { 
       azurerm = {
         source  = "hashicorp/azurerm"
         version = "~>3.0"
       }
       azapi = {
         source  = "azure/azapi"
       }
       random = {
         source  = "hashicorp/random"
         version = "~>3.0"
       }
     }
   }
   
   provider "azurerm" {
     features {
       key_vault {
         recover_soft_deleted_key_vaults    = false
         purge_soft_delete_on_destroy       = false
         purge_soft_deleted_keys_on_destroy = false
       }
       resource_group {
         prevent_deletion_if_contains_resources = false
       }
     }
   }
   
   provider "azapi" {
   }
   

3. Maak een bestand met de naam main.tf en voeg de volgende code in.

   resource "random_pet" "rg_name" { 
     prefix = var.resource_group_name_prefix
   }
   
   // RESOURCE GROUP
   resource "azurerm_resource_group" "rg" {
     location = var.resource_group_location
     name     = random_pet.rg_name.id
   }
   
   data "azurerm_client_config" "current" {
   }
   
   // STORAGE ACCOUNT
   resource "azurerm_storage_account" "default" {
     name                            = "${var.prefix}storage${random_string.suffix.result}"
     location                        = azurerm_resource_group.rg.location
     resource_group_name             = azurerm_resource_group.rg.name
     account_tier                    = "Standard"
     account_replication_type        = "GRS"
     allow_nested_items_to_be_public = false
   }
   
   // KEY VAULT
   resource "azurerm_key_vault" "default" {
     name                     = "${var.prefix}keyvault${random_string.suffix.result}"
     location                 = azurerm_resource_group.rg.location
     resource_group_name      = azurerm_resource_group.rg.name
     tenant_id                = data.azurerm_client_config.current.tenant_id
     sku_name                 = "standard"
     purge_protection_enabled = false
   }
   
   // AzAPI AIServices
   resource "azapi_resource" "AIServicesResource"{
     type = "Microsoft.CognitiveServices/accounts@2023-10-01-preview"
     name = "AIServicesResource${random_string.suffix.result}"
     location = azurerm_resource_group.rg.location
     parent_id = azurerm_resource_group.rg.id
   
     identity {
       type = "SystemAssigned"
     }
   
     body = jsonencode({
       name = "AIServicesResource${random_string.suffix.result}"
       properties = {
         //restore = true
         customSubDomainName = "${random_string.suffix.result}domain"
           apiProperties = {
               statisticsEnabled = false
           }
       }
       kind = "AIServices"
       sku = {
           name = var.sku
       }
       })
   
     response_export_values = ["*"]
   }
   
   // Azure AI Hub
   resource "azapi_resource" "hub" {
     type = "Microsoft.MachineLearningServices/workspaces@2024-04-01-preview"
     name = "${random_pet.rg_name.id}-aih"
     location = azurerm_resource_group.rg.location
     parent_id = azurerm_resource_group.rg.id
   
     identity {
       type = "SystemAssigned"
     }
   
     body = jsonencode({
       properties = {
         description = "This is my Azure AI hub"
         friendlyName = "My Hub"
         storageAccount = azurerm_storage_account.default.id
         keyVault = azurerm_key_vault.default.id
   
         /* Optional: To enable these field, the corresponding dependent resources need to be uncommented.
         applicationInsight = azurerm_application_insights.default.id
         containerRegistry = azurerm_container_registry.default.id
         */
   
         /*Optional: To enable Customer Managed Keys, the corresponding 
         encryption = {
           status = var.encryption_status
           keyVaultProperties = {
               keyVaultArmId = azurerm_key_vault.default.id
               keyIdentifier = var.cmk_keyvault_key_uri
           }
         }
         */
         
       }
       kind = "hub"
     })
   }
   
   // Azure AI Project
   resource "azapi_resource" "project" {
     type = "Microsoft.MachineLearningServices/workspaces@2024-04-01-preview"
     name = "my-ai-project${random_string.suffix.result}"
     location = azurerm_resource_group.rg.location
     parent_id = azurerm_resource_group.rg.id
   
     identity {
       type = "SystemAssigned"
     }
   
     body = jsonencode({
       properties = {
         description = "This is my Azure AI PROJECT"
         friendlyName = "My Project"
         hubResourceId = azapi_resource.hub.id
       }
       kind = "project"
     })
   }
   
   // AzAPI AI Services Connection
   resource "azapi_resource" "AIServicesConnection" {
     type = "Microsoft.MachineLearningServices/workspaces/connections@2024-04-01-preview"
     name = "Default_AIServices${random_string.suffix.result}"
     parent_id = azapi_resource.hub.id
   
     body = jsonencode({
         properties = {
           category = "AIServices",
           target = jsondecode(azapi_resource.AIServicesResource.output).properties.endpoint,
           authType = "AAD",
           isSharedToAll = true,
           metadata = {
             ApiType = "Azure",
             ResourceId = azapi_resource.AIServicesResource.id
           }
         }
       })
     response_export_values = ["*"]
   }
   
   /* The following resources are OPTIONAL.
   // APPLICATION INSIGHTS
   resource "azurerm_application_insights" "default" {
     name                = "${var.prefix}appinsights${random_string.suffix.result}"
     location            = azurerm_resource_group.rg.location
     resource_group_name = azurerm_resource_group.rg.name
     application_type    = "web"
   }
   
   // CONTAINER REGISTRY
   resource "azurerm_container_registry" "default" {
     name                     = "${var.prefix}contreg${random_string.suffix.result}"
     resource_group_name      = azurerm_resource_group.rg.name
     location                 = azurerm_resource_group.rg.location
     sku                      = "premium"
     admin_enabled            = true
   }
   */
   

4. Maak een bestand met de naam variables.tf en voeg de volgende code in.

   variable "resource_group_location" {
     type        = string
     default     = "eastus"
     description = "Location of the resource group."
   }
   
   variable "resource_group_name_prefix" {
     type        = string
     default     = "rg"
     description = "Prefix of the resource group name that's combined with a random ID so name is unique in your Azure subscription."
   }
   
   variable "prefix" {
       type = string
       description="This variable is used to name the hub, project, and dependent resources."
       default = "ai"
   }
   
   variable "sku" {
       type        = string
       description = "The sku name of the Azure Analysis Services server to create. Choose from: B1, B2, D1, S0, S1, S2, S3, S4, S8, S9. Some skus are region specific. See https://docs.microsoft.com/en-us/azure/analysis-services/analysis-services-overview#availability-by-region"
       default     = "S0"
   }
   
   resource "random_string" "suffix" {  
     length           = 4  
     special          = false  
     upper            = false  
   } 
   
   /*Optional: For Customer Managed Keys, uncomment this part AND the corresponding section in main.tf
   variable "cmk_keyvault_key_uri" {
       description = "Key vault uri to access the encryption key."
   }
   
   variable "encryption_status" {
       description = "Indicates whether or not the encryption is enabled for the workspace."
       default = "Enabled"
   }
   */
   

5. Maak een bestand met de naam outputs.tf en voeg de volgende code in.

   output "resource_group_name" {
     value = azurerm_resource_group.rg.id
   }
   
   output "workspace_name" {
       value = azapi_resource.project.id
   }
   
   output "endpoint" {
     value = jsondecode(azapi_resource.AIServicesResource.output).properties.endpoint
   }
   

Terraform initialiseren

Voer terraform init uit om de Terraform-implementatie te initialiseren. Met deze opdracht wordt de Azure-provider gedownload die is vereist voor het beheren van uw Azure-resources.

terraform init -upgrade

Belangrijkste punten:

• Met -upgrade de parameter worden de benodigde providerinvoegtoepassingen bijgewerkt naar de nieuwste versie die voldoet aan de versiebeperkingen van de configuratie.

Een Terraform-uitvoeringsplan maken

Voer terraform-plan uit om een uitvoeringsplan te maken.

terraform plan -out main.tfplan

Belangrijkste punten:

• De terraform plan opdracht maakt een uitvoeringsplan, maar voert het niet uit. In plaats daarvan wordt bepaald welke acties nodig zijn om de configuratie te maken die is opgegeven in uw configuratiebestanden. Met dit patroon kunt u controleren of het uitvoeringsplan aan uw verwachtingen voldoet voordat u wijzigingen aanbrengt in de werkelijke resources.
• Met de optionele -out parameter kunt u een uitvoerbestand voor het plan opgeven. Door de -out parameter te gebruiken, zorgt u ervoor dat het plan dat u hebt gecontroleerd precies wordt toegepast.

Een Terraform-uitvoeringsplan toepassen

Terraform uitvoeren is van toepassing om het uitvoeringsplan toe te passen op uw cloudinfrastructuur.

terraform apply main.tfplan

Belangrijkste punten:

• Bij de voorbeeldopdracht terraform apply wordt ervan uitgegaan dat u eerder hebt uitgevoerd terraform plan -out main.tfplan.
• Als u een andere bestandsnaam voor de -out parameter hebt opgegeven, gebruikt u diezelfde bestandsnaam in de aanroep naar terraform apply.
• Als u de parameter niet hebt gebruikt, roept terraform apply u deze -out aan zonder parameters.

De resultaten controleren

Azure-CLI

1. Haal de naam van de Azure-resourcegroep op.

   resource_group_name=$(terraform output -raw resource_group_name)
   

2. Haal de naam van de werkruimte op.

   workspace_name=$(terraform output -raw workspace_name)
   

3. Voer az ml workspace show uit om informatie over de nieuwe werkruimte weer te geven.

   az ml workspace show --resource-group $resource_group_name \
                        --name $workspace_name
   

Azure PowerShell

1. Haal de naam van de Azure-resourcegroep op.

   $resource_group_name=$(terraform output -raw resource_group_name)
   

2. Haal de naam van de werkruimte op.

   $workspace_name=$(terraform output -raw workspace_name)
   

3. Voer Get-AzMLWorkspace uit om informatie over de nieuwe werkruimte weer te geven.

   Get-AzMLWorkspace -ResourceGroupName $resource_group_name `
                     -Name $workspace_name
   

Resources opschonen

Voer de volgende stappen uit wanneer u de resources die zijn gemaakt via Terraform niet meer nodig hebt:

1. Voer terraform-plan uit en geef de destroy vlag op.

   terraform plan -destroy -out main.destroy.tfplan
   

   Belangrijkste punten:

   • De terraform plan opdracht maakt een uitvoeringsplan, maar voert het niet uit. In plaats daarvan wordt bepaald welke acties nodig zijn om de configuratie te maken die is opgegeven in uw configuratiebestanden. Met dit patroon kunt u controleren of het uitvoeringsplan aan uw verwachtingen voldoet voordat u wijzigingen aanbrengt in de werkelijke resources.
   • Met de optionele -out parameter kunt u een uitvoerbestand voor het plan opgeven. Door de -out parameter te gebruiken, zorgt u ervoor dat het plan dat u hebt gecontroleerd precies wordt toegepast.

2. Terraform uitvoeren is van toepassing om het uitvoeringsplan toe te passen.

   terraform apply main.destroy.tfplan
   

Problemen met Terraform in Azure oplossen

Veelvoorkomende problemen bij het gebruik van Terraform in Azure oplossen.

Volgende stappen

Zie meer artikelen over Azure AI Studio Hub