Get started with Azure Batch by using Terraform to create a Batch account, including storage. You need a Batch account to create compute resources (pools of compute nodes) and Batch jobs. You can link an Azure Storage account with your Batch account. This pairing is useful to deploy applications and store input and output data for most real-world workloads.
After completing this quickstart, you'll understand the key concepts of the Batch service and be ready to try Batch with more realistic workloads at larger scale.
Terraform enables the definition, preview, and deployment of cloud infrastructure. Using Terraform, you create configuration files using HCL syntax. The HCL syntax allows you to specify the cloud provider - such as Azure - and the elements that make up your cloud infrastructure. After you create your configuration files, you create an execution plan that allows you to preview your infrastructure changes before they're deployed. Once you verify the changes, you apply the execution plan to deploy the infrastructure.
In this article, you learn how to:
Prerequisites Implement the Terraform codeCreate a directory in which to test and run the sample Terraform code and make it the current directory.
Create a file named providers.tf
and insert the following code:
terraform {
required_version = ">=1.0"
required_providers {
azurerm = {
source = "hashicorp/azurerm"
version = "~>3.0"
}
random = {
source = "hashicorp/random"
version = "~>3.0"
}
}
}
provider "azurerm" {
features {}
}
Create a file named main.tf
and insert the following code:
resource "random_pet" "rg_name" {
prefix = var.resource_group_name_prefix
}
resource "azurerm_resource_group" "rg" {
name = random_pet.rg_name.id
location = var.resource_group_location
}
resource "random_string" "azurerm_storage_account_name" {
length = 13
lower = true
numeric = false
special = false
upper = false
}
resource "random_string" "azurerm_batch_account_name" {
length = 13
lower = true
numeric = false
special = false
upper = false
}
resource "azurerm_storage_account" "storage" {
name = "storage${random_string.azurerm_storage_account_name.result}"
resource_group_name = azurerm_resource_group.rg.name
location = azurerm_resource_group.rg.location
account_tier = element(split("_", var.storage_account_type), 0)
account_replication_type = element(split("_", var.storage_account_type), 1)
}
resource "azurerm_batch_account" "batch" {
name = "batch${random_string.azurerm_batch_account_name.result}"
resource_group_name = azurerm_resource_group.rg.name
location = azurerm_resource_group.rg.location
storage_account_id = azurerm_storage_account.storage.id
storage_account_authentication_mode = "StorageKeys"
}
Create a file named variables.tf
and insert the following code:
variable "resource_group_location" {
type = string
default = "eastus"
description = "Location for all resources."
}
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 "storage_account_type" {
type = string
default = "Standard_LRS"
description = "Azure Storage account type."
validation {
condition = contains(["Premium_LRS", "Premium_ZRS", "Standard_GRS", "Standard_GZRS", "Standard_LRS", "Standard_RAGRS", "Standard_RAGZRS", "Standard_ZRS"], var.storage_account_type)
error_message = "Invalid storage account type. The value should be one of the following: 'Premium_LRS','Premium_ZRS','Standard_GRS','Standard_GZRS','Standard_LRS','Standard_RAGRS','Standard_RAGZRS','Standard_ZRS'."
}
}
Create a file named outputs.tf
and insert the following code:
output "resource_group_name" {
value = azurerm_resource_group.rg.name
}
output "batch_name" {
value = azurerm_batch_account.batch.name
}
output "storage_name" {
value = azurerm_storage_account.storage.name
}
Run terraform init to initialize the Terraform deployment. This command downloads the Azure provider required to manage your Azure resources.
terraform init -upgrade
Key points:
-upgrade
parameter upgrades the necessary provider plugins to the newest version that complies with the configuration's version constraints.Run terraform plan to create an execution plan.
terraform plan -out main.tfplan
Key points:
terraform plan
command creates an execution plan, but doesn't execute it. Instead, it determines what actions are necessary to create the configuration specified in your configuration files. This pattern allows you to verify whether the execution plan matches your expectations before making any changes to actual resources.-out
parameter allows you to specify an output file for the plan. Using the -out
parameter ensures that the plan you reviewed is exactly what is applied.Run terraform apply to apply the execution plan to your cloud infrastructure.
terraform apply main.tfplan
Key points:
terraform apply
command assumes you previously ran terraform plan -out main.tfplan
.-out
parameter, use that same filename in the call to terraform apply
.-out
parameter, call terraform apply
without any parameters.Get the Azure resource group name.
resource_group_name=$(terraform output -raw resource_group_name)
Get the Batch account name.
batch_name=$(terraform output -raw batch_name)
Run az batch account show to display information about the new Batch account.
az batch account show \
--resource-group $resource_group_name \
--name $batch_name
Get the Azure resource group name.
$resource_group_name=$(terraform output -raw resource_group_name)
Get the Batch account name.
$batch_name=$(terraform output -raw batch_name)
Run Get-AzBatchAccount to display information about the new service.
Get-AzBatchAccount -ResourceGroupName $resource_group_name `
-Name $batch_name
When you no longer need the resources created via Terraform, do the following steps:
Run terraform plan and specify the destroy
flag.
terraform plan -destroy -out main.destroy.tfplan
Key points:
terraform plan
command creates an execution plan, but doesn't execute it. Instead, it determines what actions are necessary to create the configuration specified in your configuration files. This pattern allows you to verify whether the execution plan matches your expectations before making any changes to actual resources.-out
parameter allows you to specify an output file for the plan. Using the -out
parameter ensures that the plan you reviewed is exactly what is applied.Run terraform apply to apply the execution plan.
terraform apply main.destroy.tfplan
Troubleshoot common problems when using Terraform on Azure
Next stepsRun your first Batch job with the Azure CLI
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4