diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..ed9462b7 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "markdownlint.config": { + "MD028": false, + "MD025": { + "front_matter_title": "" + } + } +} \ No newline at end of file diff --git a/quickstart/101-azure-virtual-desktop/README.md b/quickstart/101-azure-virtual-desktop/README.md new file mode 100644 index 00000000..9098f388 --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/README.md @@ -0,0 +1,138 @@ +## Terraform for Azure Virtual Desktop + +The purpose of this repository is to demonstrate using Terraform to deploy a simple Azure Virtual Desktop environment. For Classic Azure Virtual Desktop click [here](https://github.com/Azure/RDS-Templates/tree/master/wvd-sh/terraform-azurerm-windowsvirtualdesktop). + +## Requirements and limitations +* Ensure that you meet the [requirements for Azure Virtual Desktop](https://docs.microsoft.com/en-us/azure/virtual-desktop/overview#requirements) +* Terraform must be installed and configured as outlined [here](https://docs.microsoft.com/en-us/azure/developer/terraform/get-started-cloud-shell) +* Active Directory already in place in this example, we are using AD in it’s own VNet. +* Users in AAD that will be given access to AVD +* This demo does not support Azure ADDS only deployment +* Destroy could produce errors deleting subnet due to resources associated. Manually delete resources within the subnet before running destroy + +## Components + +* Azure Virtual Desktop Environment +* Networking Infrastructure +* Session Hosts +* Profile Storage +* Role Based Access Control + +## Features + +This directory contains the various components for building out Azure Virtual Desktop. +* `main.tf` + deploys a new workspace, hostpool, application group with associations +* `networking.tf` + deploys a new vnet, subnet, nsg and peering to AD vnet +* `host.tf` + deploys new session host from the marketplace build and join to domain +* `afstorage.tf` + deploys Azure Files storage for profiles and creates file share with RBAC permissions for the users group ([NTFS permissions will need to be configured](https://docs.microsoft.com/en-us/azure/virtual-desktop/create-file-share)) +* `rbac.tf` + deploys rbac assignment for the users group +* `variables.tf` + Input variables +* `defaults.tfvars` + declares the actual input values (keep security in mind if you are putting confidential data) +* `provider.tf` + Azure RM and Azure AD provider configuation +* `outputs.tf` + defines the outputs that will be displayed on deployment +* `netappstorage.tf` + as an alternate to Azure Files storage this deploys NetApp Files storage for profiles in a dedicated subnet (access needs to be granted to the ANF service) [Set up Azure NetApp Files](https://docs.microsoft.com/en-us/azure/azure-netapp-files/azure-netapp-files-quickstart-set-up-account-create-volumes?tabs=azure-portal) + +## Varialble Inputs + +| Name | Description | Default | +|:---|:---|:---| +| `rg_name` | Name of the Resource Group in which to deploy these resources | `AVD-TF` | +| `deploy_location` | Region in which to deploy these resources | - | +| `hostpool` | Name of the Azure Virtual Desktop host pool | `AVD-TF-HP` | +| `ad_vnet` | Name of domain controller VNet | - | +| `dns_servers` | Custom DNS configuration | - | +| `vnet_range` | Address range for deployment VNet | - | +| `subnet_range` | Address range for session host subnet | - | +| `avd_users` | The resource group for AD VM | `[]` | +| `aad_group_name` | Azure Active Directory Group for AVD users | - | +| `rdsh_count` | Number of AVD machines to deploy | 2 | +| `prefix` | Prefix of the name of the AVD machine(s) | - | +| `domain_name` | Name of the domain to join | - | +| `domain_user_upn` | Username for domain join (do not include domain name as this is appended | - | +| `domain_password` | Password of the user to authenticate with the domain | - | +| `vm_size` | Size of the machine to deploy | `Standard_DS2_v2` | +| `ou_path` | The ou path for AD | `""` | +| `local_admin_username` | The local admin username for the VM | - | +| `local_admin_password` | The local admin password for the VM | - | +| `netapp_acct_name` | The NetApp account name | `AVD_NetApp` | +| `netapp_pool_name` | The NetApp pool name | `AVD_NetApp_pool` | +| `netapp_volume_name` | The NetApp volume name | `AVD_NetApp_volume` | +| `netapp_smb_name` | The NetApp smb name | `AVDNetApp` | +| `netapp_volume_path` | The NetApp volume path | `AVDNetAppVolume` | +| `netapp_subnet_name` | The NetApp subnet name | `NetAppSubnet` | +| `netapp_address` | The Address range for NetApp Subnet | - | + +## Deploy +If you’ve not previously setup terraform, check out this article to get it installed [Quickstart - Configure Terraform using Azure Cloud Shell](https://docs.microsoft.com/en-us/azure/developer/terraform/get-started-cloud-shell) + +You can review our sample configuration video here + +Once Terraform is setup and you have created your Terraform templates, the first step is to initialize Terraform. This step ensures that Terraform has all the prerequisites to build your template in Azure. + +``` +terraform init +``` + +The next step is to have Terraform review and validate the template. An execution plan is generated and stored in the file specified by the -out parameter. + +We also need to pass our variable definitions file during the plan. We can either load it automatically by renaming env.tfvars as terraform.tfvars OR env.auto.tfvars, in which case we will use the following to create the execution plan: + +```bash +terraform plan -out terraform_azure.tfplan +``` + +When you're ready to build the infrastructure in Azure, apply the execution plan: + +```bash +terraform apply terraform_azure.tfplan +``` + +## Final Configuration + +You’ll notice we didn’t actually configure the session hosts to use our profile storage at any point. There is an assumption that we are using GPO to manage FSLogix across our host pools as documented here: [Use FSLogix Group Policy Template Files - FSLogix](https://docs.microsoft.com/en-us/fslogix/use-group-policy-templates-ht). + +At a minimum you’ll need to configure the registry keys to enable FSLogix and configure the VHD Location to the NetApp Share URI: [Profile Container registry configuration settings - FSLogix](https://docs.microsoft.com/en-us/fslogix/profile-container-configuration-reference#enabled) + +## Troubleshooting Terraform deployment +
+Click to expand +Terraform deployment can fail in two main categories: + +Issues with Terraform code +1. [Issues with Desired State Configuration (DSC)](#issues-with-desired-state-configuration-dsc) +2. [Issues with Terraform code](#issues-with-desired-state-configuration-dsc) + +While it is rare to have issues with the Terraform code it is still possible, however most often errors are due to bad input in variables.tf. + +* If there are errors in the Terraform code, please file a GitHub issue. +* If there are warning in the Terraform code feel free to ignore or address for your own instance of that code. +* Using Terraform error messages it's a good starting point towards identifying issues with input variables + +### Issues with Desired State Configuration (DSC) + +To troubleshoot this type of issue, navigate to the Azure portal and if needed reset the password on the VM that failed DSC. Once you are able to log in to the VM review the log files in the following two folders: +
+ +## Additional References +
+Click to expand + +- [Terraform Download](https://www.terraform.io/downloads.html) +- [Visual Code Download](https://code.visualstudio.com/Download) +- [Powershell VS Code Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell) +- [HashiCorp Terraform VS Code Extension](https://marketplace.visualstudio.com/items?itemName=HashiCorp.terraform) +- [Azure Terraform VS Code Extension Name](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureterraform) +- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-windows?tabs=azure-cli) +- [Configure the Azure Terraform Visual Studio Code extension](https://docs.microsoft.com/en-us/azure/developer/terraform/configure-vs-code-extension-for-terraform) +- [Setup video](https://youtu.be/YmbmpGdhI6w) +
\ No newline at end of file diff --git a/quickstart/101-azure-virtual-desktop/afstorage.tf b/quickstart/101-azure-virtual-desktop/afstorage.tf new file mode 100644 index 00000000..d674a34e --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/afstorage.tf @@ -0,0 +1,43 @@ +## Create a Resource Group for Storage +resource "azurerm_resource_group" "rg_storage" { + location = "east us" + name = "af-storage-rg" +} + +# generate a random string (consisting of four characters) +# https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string +resource "random_string" "random" { + length = 4 + upper = false + special = false +} + +## Azure Storage Accounts requires a globally unique names +## https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview +## Create a File Storage Account +resource "azurerm_storage_account" "storage" { + name = "stor${random_string.random.id}" + resource_group_name = azurerm_resource_group.rg_storage.name + location = azurerm_resource_group.rg_storage.location + account_tier = "Premium" + account_replication_type = "LRS" + account_kind = "FileStorage" +} + +resource "azurerm_storage_share" "FSShare" { + name = "fslogix" + storage_account_name = azurerm_storage_account.storage.name + depends_on = [azurerm_storage_account.storage] +} + +## Azure built-in roles +## https://docs.microsoft.com/en-us/azure/role-based-access-control/built-in-roles +data "azurerm_role_definition" "storage_role" { + name = "Storage File Data SMB Share Contributor" +} + +resource "azurerm_role_assignment" "af_role" { + scope = azurerm_storage_account.storage.id + role_definition_id = data.azurerm_role_definition.storage_role.id + principal_id = azuread_group.aad_group.id +} diff --git a/quickstart/101-azure-virtual-desktop/defaults.tfvars b/quickstart/101-azure-virtual-desktop/defaults.tfvars new file mode 100644 index 00000000..228003aa --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/defaults.tfvars @@ -0,0 +1,20 @@ +# 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" +] diff --git a/quickstart/101-azure-virtual-desktop/host.tf b/quickstart/101-azure-virtual-desktop/host.tf new file mode 100644 index 00000000..aa3285ff --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/host.tf @@ -0,0 +1,126 @@ +locals { + registration_token = azurerm_virtual_desktop_host_pool.hostpool.registration_info[0].token +} + +resource "random_string" "AVD_local_password" { + count = var.rdsh_count + length = 16 + special = true + min_special = 2 + override_special = "*!@#?" +} + +resource "azurerm_network_interface" "avd_vm_nic" { + count = var.rdsh_count + name = "${var.prefix}-${count.index + 1}-nic" + resource_group_name = var.rg_name + location = var.deploy_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 = var.rg_name + location = var.deploy_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 = <.com", + "user2@.com" +] diff --git a/quickstart/101-azure-virtual-desktop/options/netapp/netappstorage.tf b/quickstart/101-azure-virtual-desktop/options/netapp/netappstorage.tf new file mode 100644 index 00000000..4bd63341 --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/options/netapp/netappstorage.tf @@ -0,0 +1,67 @@ +resource "azurerm_subnet" "netapp_subnet" { + name = var.netapp_subnet_name + resource_group_name = var.rg_name + virtual_network_name = azurerm_virtual_network.vnet.name + address_prefixes = var.netapp_address + + delegation { + name = "NetAppdelegation" + + service_delegation { + name = "Microsoft.Netapp/volumes" + } + } +} + +resource "azurerm_netapp_account" "netapp_acct" { + name = var.netapp_acct_name + resource_group_name = var.rg_name + location = var.deploy_location + + active_directory { + username = var.domain_user_upn + password = var.domain_password + smb_server_name = var.netapp_smb_name + dns_servers = var.dns_servers + domain = var.domain_name + organizational_unit = var.ou_path + } + + depends_on = [ + azurerm_resource_group.rg + ] +} + +resource "azurerm_netapp_pool" "netapp_pool" { + name = var.netapp_pool_name + location = var.deploy_location + resource_group_name = var.rg_name + account_name = var.netapp_acct_name + service_level = "Standard" + size_in_tb = 4 + + depends_on = [ + azurerm_resource_group.rg, azurerm_netapp_account.netapp_acct + ] +} + +resource "azurerm_netapp_volume" "NetApp_Vol" { + lifecycle { + prevent_destroy = true + } + + name = var.netapp_volume_name + location = var.deploy_location + resource_group_name = var.rg_name + account_name = var.netapp_acct_name + pool_name = var.netapp_pool_name + volume_path = var.netapp_volume_path + service_level = "Standard" + subnet_id = azurerm_subnet.netapp_subnet.id + protocols = ["CIFS"] + storage_quota_in_gb = 100 + + depends_on = [ + azurerm_netapp_pool.netapp_pool + ] +} diff --git a/quickstart/101-azure-virtual-desktop/options/netapp/variables.tf b/quickstart/101-azure-virtual-desktop/options/netapp/variables.tf new file mode 100644 index 00000000..f9bc290e --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/options/netapp/variables.tf @@ -0,0 +1,122 @@ +variable "rg_name" { + type = string + default = "AVD-TF" + description = "Name of the Resource group in which to deploy these resources" +} + +variable "deploy_location" { + type = string + description = "The Azure Region in which all resources in this example should be created." +} + +variable "workspace" { + description = "Name of the Azure Virtual Desktop workspace" + default = "AVD TF Workspace" +} + +variable "hostpool" { + description = "Name of the Azure Virtual Desktop host pool" + default = "AVD-TF-HP" +} + +variable "ad_vnet" { + type = string + description = "Name of domain controller vnet" +} + +variable "dns_servers" { + description = "Custom DNS configuration" +} + +variable "vnet_range" { + description = "Address range for deployment VNet" +} +variable "subnet_range" { + description = "Address range for session host subnet" +} + +variable "ad_rg" { + type = string + description = "The resource group for AD VM" +} + +variable "avd_users" { + description = "AVD users" + default = [] +} + +variable "aad_group_name" { + description = "Azure Active Directory Group for AVD users" +} + +variable "rdsh_count" { + description = "Number of AVD machines to deploy" + default = 2 +} + +variable "prefix" { + description = "Prefix of the name of the AVD machine(s)" +} + +variable "domain_name" { + type = string + description = "Name of the domain to join" +} + +variable "domain_user_upn" { + type = string + description = "Username for domain join (do not include domain name as this is appended)" +} + +variable "domain_password" { + type = string + description = "Password of the user to authenticate with the domain" +} + +variable "vm_size" { + description = "Size of the machine to deploy" + default = "Standard_DS2_v2" +} + +variable "ou_path" { + default = "" +} + +variable "local_admin_username" { + type = string + description = "local admin username" +} + +variable "local_admin_password" { + description = "local admin password" +} + +# optional section - only use if deploying ANF + +variable "netapp_acct_name" { + default = "AVD_NetApp" +} + +variable "netapp_pool_name" { + default = "AVD_NetApp_pool" +} + +variable "netapp_volume_name" { + default = "AVD_NetApp_volume" +} + +variable "netapp_smb_name" { + default = "AVDNetApp" +} + +variable "netapp_volume_path" { + default = "AVDNetAppVolume" +} + +variable "netapp_subnet_name" { + default = "NetAppSubnet" +} + +variable "netapp_address" { + description = "Address range for NetApp Subnet" +} diff --git a/quickstart/101-azure-virtual-desktop/outputs.tf b/quickstart/101-azure-virtual-desktop/outputs.tf new file mode 100644 index 00000000..ec1f9624 --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/outputs.tf @@ -0,0 +1,39 @@ +output "resource_group_name" { + description = "Name of the Resource group created" + value = azurerm_resource_group.rg.name +} + +output "location" { + description = "The Azure region" + value = azurerm_resource_group.rg.location +} + +output "storage_account_share" { + description = "Name of the Azure File Share created for FSLogix" + value = azurerm_storage_share.FSShare.name +} + +output "rdshcount" { + 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 + +} +output "avdusers" { + description = "AVD users" + value = azuread_group.aad_group.members +} + +output "aadgroupname" { + description = "Azure Active Directory Group for AVD users" + value = azuread_group.aad_group.display_name +} diff --git a/quickstart/101-azure-virtual-desktop/provider.tf b/quickstart/101-azure-virtual-desktop/provider.tf new file mode 100644 index 00000000..185ac1fa --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/provider.tf @@ -0,0 +1,15 @@ +terraform { + required_providers { + azurerm = { + source = "hashicorp/azurerm" + version = "~>2.0" + } + azuread = { + source = "hashicorp/azuread" + } + } +} + +provider "azurerm" { + features {} +} diff --git a/quickstart/101-azure-virtual-desktop/rbac.tf b/quickstart/101-azure-virtual-desktop/rbac.tf new file mode 100644 index 00000000..7da8669d --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/rbac.tf @@ -0,0 +1,25 @@ +data "azuread_user" "aad_user" { + for_each = toset(var.avd_users) + user_principal_name = format("%s", each.key) +} + +data "azurerm_role_definition" "role" { # access an existing built-in role + name = "Desktop Virtualization User" +} + +resource "azuread_group" "aad_group" { + display_name = var.aad_group_name + security_enabled = true +} + +resource "azuread_group_member" "aad_group_member" { + for_each = data.azuread_user.aad_user + group_object_id = azuread_group.aad_group.id + member_object_id = each.value["id"] +} + +resource "azurerm_role_assignment" "role" { + scope = azurerm_virtual_desktop_application_group.dag.id + role_definition_id = data.azurerm_role_definition.role.id + principal_id = azuread_group.aad_group.id +} diff --git a/quickstart/101-azure-virtual-desktop/sig.tf b/quickstart/101-azure-virtual-desktop/sig.tf new file mode 100644 index 00000000..9ec2d2f3 --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/sig.tf @@ -0,0 +1,35 @@ +resource "azurerm_resource_group" "sigrg" { + location = var.deploy_location + name = "${var.prefix}-rg" +} + +# Creates Shared Image Gallery +# https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/shared_image_gallery +resource "azurerm_shared_image_gallery" "sig" { + name = "AVDTFsig" + resource_group_name = azurerm_resource_group.rg.name + location = azurerm_resource_group.rg.location + description = "Shared images" + + tags = { + Environment = "Demo" + Tech = "Terraform" + } +} + +#Creates image definition +# https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/shared_image +resource "azurerm_shared_image" "example" { + name = "avd-image" + gallery_name = azurerm_shared_image_gallery.sig.name + resource_group_name = azurerm_resource_group.rg.name + location = azurerm_resource_group.rg.location + os_type = "Windows" + + identifier { + publisher = "MicrosoftWindowsDesktop" + offer = "office-365" + sku = "20h2-evd-o365pp" + } +} + diff --git a/quickstart/101-azure-virtual-desktop/variables.tf b/quickstart/101-azure-virtual-desktop/variables.tf new file mode 100644 index 00000000..69a769cb --- /dev/null +++ b/quickstart/101-azure-virtual-desktop/variables.tf @@ -0,0 +1,101 @@ +variable "rg_name" { + type = string + default = "AVD-TF" + description = "Name of the Resource group in which to deploy these resources" +} + +variable "deploy_location" { + type = string + description = "The Azure Region in which all resources in this example should be created." +} + +variable "workspace" { + type = string + description = "Name of the Azure Virtual Desktop workspace" + default = "AVD TF Workspace" +} + +variable "hostpool" { + type = string + description = "Name of the Azure Virtual Desktop host pool" + default = "AVD-TF-HP" +} + +variable "ad_vnet" { + type = string + description = "Name of domain controller vnet" +} + +variable "dns_servers" { + type = list(string) + description = "Custom DNS configuration" +} + +variable "vnet_range" { + type = list(string) + description = "Address range for deployment VNet" +} +variable "subnet_range" { + type = list(string) + description = "Address range for session host subnet" +} + +variable "ad_rg" { + type = string + description = "The resource group for AD VM" +} + +variable "avd_users" { + description = "AVD users" + default = [] +} + +variable "aad_group_name" { + type = string + description = "Azure Active Directory Group for AVD users" +} + +variable "rdsh_count" { + description = "Number of AVD machines to deploy" + default = 2 +} + +variable "prefix" { + type = string + description = "Prefix of the name of the AVD machine(s)" +} + +variable "domain_name" { + type = string + description = "Name of the domain to join" +} + +variable "domain_user_upn" { + type = string + description = "Username for domain join (do not include domain name as this is appended)" +} + +variable "domain_password" { + type = string + 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 + description = "local admin username" +} + +variable "local_admin_password" { + description = "local admin password" + sensitive = true +}