Verwenden von Terraform zum Erstellen eines Azure KI Studio-Hubs

In diesem Artikel verwenden Sie Terraform, um einen Azure KI Studio-Hub, ein Projekt und eine KI-Dienstverbindung zu erstellen. Ein Hub ist ein zentraler Ort für Datenwissenschaftler und Entwickler, um an Machine Learning-Projekten zusammenzuarbeiten. Er bietet einen gemeinsam genutzten Kollaborationsbereich zum Erstellen, Trainieren und Bereitstellen von Machine Learning-Modellen. Der Hub ist in Azure Machine Learning sowie andere Azure-Dienste integriert und ist daher eine umfassende Lösung für Machine Learning-Aufgaben. Der Hub ermöglicht es Ihnen auch, Ihre KI-Bereitstellungen zu verwalten und zu überwachen, um sicherzustellen, dass sie wie erwartet ausgeführt werden.

Mit Terraform können Sie eine Cloudinfrastruktur definieren, eine Vorschau der Cloudinfrastruktur anzeigen und die Cloudinfrastruktur bereitstellen. Terraform ermöglicht das Erstellen von Konfigurationsdateien mit HCL-Syntax. Mit der HCL-Syntax können Sie den Cloudanbieter (beispielsweise Azure) und die Elemente angeben, aus denen sich Ihre Cloudinfrastruktur zusammensetzt. Nach der Erstellung Ihrer Konfigurationsdateien erstellen Sie einen Ausführungsplan, mit dem Sie eine Vorschau Ihrer Infrastrukturänderungen anzeigen können, bevor diese bereitgestellt werden. Nach der Überprüfung der Änderungen wenden Sie den Ausführungsplan an, um die Infrastruktur bereitzustellen.

• Erstellen einer Ressourcengruppe
• Einrichten eines Speicherkontos
• Einrichten eines Schlüsseltresors
• Konfigurieren von KI-Diensten
• Erstellen eines KI Studio-Hubs
• Entwickeln eines KI Studio-Projekts
• Einrichten einer KI-Dienstverbindung

Voraussetzungen

• Erstellen Sie ein Azure-Konto mit einem aktiven Abonnement. Sie können ein Konto kostenlos erstellen.

• Installieren und Konfigurieren von Terraform

Implementieren des Terraform-Codes

Hinweis

Der Beispielcode für diesen Artikel befindet sich im Azure Terraform-GitHub-Repository. Sie können die Protokolldatei anzeigen, die die Testergebnisse von aktuellen und früheren Terraform-Versionen enthält.

Betrachten Sie die weiteren Artikel und Beispielcodes zur Verwendung von Terraform zum Verwalten von Azure-Ressourcen.

1. Erstellen Sie ein Verzeichnis, in dem der Terraform-Beispielcode getestet und ausgeführt werden soll, und legen Sie es als aktuelles Verzeichnis fest.

2. Erstellen Sie eine Datei namens providers.tf, und fügen Sie den folgenden Code ein:

   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. Erstellen Sie eine Datei namens main.tf, und fügen Sie den folgenden Code ein:

   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. Erstellen Sie eine Datei namens variables.tf, und fügen Sie den folgenden Code ein:

   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. Erstellen Sie eine Datei namens outputs.tf, und fügen Sie den folgenden Code ein:

   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
   }
   

Initialisieren von Terraform

Führen Sie zum Initialisieren der Terraform-Bereitstellung terraform init aus. Mit diesem Befehl wird der Azure-Anbieter heruntergeladen, der zum Verwalten Ihrer Azure-Ressourcen erforderlich ist.

terraform init -upgrade

Die wichtigsten Punkte:

• Der Parameter -upgrade aktualisiert die erforderlichen Anbieter-Plug-Ins auf die neueste Version, die den Versionseinschränkungen der Konfiguration entspricht.

Erstellen eines Terraform-Ausführungsplans

Führen Sie terraform plan aus, um einen Ausführungsplan zu erstellen.

terraform plan -out main.tfplan

Die wichtigsten Punkte:

• Durch den Befehl terraform plan wird ein Ausführungsplan erstellt, aber nicht ausgeführt. Stattdessen werden die Aktionen ermittelt, die erforderlich sind, um die in Ihren Konfigurationsdateien angegebene Konfiguration zu erstellen. Mit diesem Muster können Sie überprüfen, ob der Ausführungsplan Ihren Erwartungen entspricht, bevor Sie Änderungen an den eigentlichen Ressourcen vornehmen.
• Der optionale Parameter -out ermöglicht die Angabe einer Ausgabedatei für den Plan. Durch die Verwendung des Parameters -out wird sichergestellt, dass genau der von Ihnen überprüfte Plan angewendet wird.

Anwenden eines Terraform-Ausführungsplans

Führen Sie terraform apply aus, um den Ausführungsplan auf Ihre Cloudinfrastruktur anzuwenden.

terraform apply main.tfplan

Die wichtigsten Punkte:

• Der Beispielbefehl terraform apply setzt voraus, dass Sie zuvor terraform plan -out main.tfplan ausgeführt haben.
• Wenn Sie einen anderen Dateinamen für den Parameter -out angegeben haben, verwenden Sie denselben Dateinamen im Aufruf von terraform apply.
• Wenn Sie den Parameter -out nicht verwendet haben, rufen Sie terraform apply ohne Parameter auf.

Überprüfen der Ergebnisse

Azure-Befehlszeilenschnittstelle

1. Rufen Sie den Namen der Azure-Ressourcengruppe ab.

   resource_group_name=$(terraform output -raw resource_group_name)
   

2. Rufen Sie den Arbeitsbereichsnamen ab.

   workspace_name=$(terraform output -raw workspace_name)
   

3. Führen Sie az ml workspace show aus, um Informationen zum neuen Arbeitsbereich anzuzeigen.

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

Azure PowerShell

1. Rufen Sie den Namen der Azure-Ressourcengruppe ab.

   $resource_group_name=$(terraform output -raw resource_group_name)
   

2. Rufen Sie den Arbeitsbereichsnamen ab.

   $workspace_name=$(terraform output -raw workspace_name)
   

3. Führen Sie Get-AzMLWorkspace aus, um Informationen zum neuen Arbeitsbereich anzuzeigen.

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

Bereinigen von Ressourcen

Wenn Sie die über Terraform erstellten Ressourcen nicht mehr benötigen, führen Sie die folgenden Schritte aus:

1. Führen Sie terraform plan aus, und geben Sie das Flag destroy an.

   terraform plan -destroy -out main.destroy.tfplan
   

   Die wichtigsten Punkte:

   • Durch den Befehl terraform plan wird ein Ausführungsplan erstellt, aber nicht ausgeführt. Stattdessen werden die Aktionen ermittelt, die erforderlich sind, um die in Ihren Konfigurationsdateien angegebene Konfiguration zu erstellen. Mit diesem Muster können Sie überprüfen, ob der Ausführungsplan Ihren Erwartungen entspricht, bevor Sie Änderungen an den eigentlichen Ressourcen vornehmen.
   • Der optionale Parameter -out ermöglicht die Angabe einer Ausgabedatei für den Plan. Durch die Verwendung des Parameters -out wird sichergestellt, dass genau der von Ihnen überprüfte Plan angewendet wird.

2. Führen Sie zum Anwenden des Ausführungsplans den Befehl terraform apply aus.

   terraform apply main.destroy.tfplan
   

Problembehandlung für Terraform in Azure

Behandeln Sie allgemeine Probleme bei der Verwendung von Terraform in Azure.

Nächste Schritte

Weitere Artikel zu Azure KI Studio-Hubs anzeigen