-
Notifications
You must be signed in to change notification settings - Fork 887
feat: Windows on Azure example template #7469
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
129f036
WIP Azure template for windows machine
spikecurtis c49584b
WIP windows uses data disk
spikecurtis 101d796
Data drive working
spikecurtis 4182835
Add az cli commands to start & stop
spikecurtis 70364bc
Remove commented line
spikecurtis 9043f04
Prettierify
spikecurtis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
<FirstLogonCommands> | ||
<SynchronousCommand> | ||
<CommandLine>cmd /c "copy C:\AzureData\CustomData.bin C:\AzureData\Initialize.ps1"</CommandLine> | ||
<Description>Copy Initialize.ps1 to file from CustomData</Description> | ||
<Order>3</Order> | ||
</SynchronousCommand> | ||
<SynchronousCommand> | ||
<CommandLine>powershell.exe -sta -ExecutionPolicy Unrestricted -Command "C:\AzureData\Initialize.ps1 *> C:\AzureData\Initialize.log"</CommandLine> | ||
<Description>Execute Initialize.ps1 script</Description> | ||
<Order>4</Order> | ||
</SynchronousCommand> | ||
</FirstLogonCommands> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# This script gets run once when the VM is first created. | ||
|
||
# Initialize the data disk & home directory. | ||
$disk = Get-Disk -Number 2 | ||
if ($disk.PartitionStyle -Eq 'RAW') | ||
{ | ||
"Initializing data disk" | ||
$disk | Initialize-Disk | ||
} else { | ||
"data disk already initialized" | ||
} | ||
|
||
$partitions = Get-Partition -DiskNumber $disk.Number | Where-Object Type -Ne 'Reserved' | ||
if ($partitions.Count -Eq 0) { | ||
"Creating partition on data disk" | ||
$partition = New-Partition -DiskNumber $disk.Number -UseMaximumSize | ||
} else { | ||
$partition = $partitions[0] | ||
$s = "data disk already has partition of size {0:n1} GiB" -f ($partition.Size / 1073741824) | ||
Write-Output $s | ||
} | ||
|
||
$volume = Get-Volume -Partition $partition | ||
if ($volume.FileSystemType -Eq 'Unknown') | ||
{ | ||
"Formatting data disk" | ||
Format-Volume -InputObject $volume -FileSystem NTFS -Confirm:$false | ||
} else { | ||
"data disk is already formatted" | ||
} | ||
|
||
# Mount the partition | ||
Add-PartitionAccessPath -InputObject $partition -AccessPath "F:" | ||
|
||
# Enable RDP | ||
Set-ItemProperty -Path 'HKLM:\System\CurrentControlSet\Control\Terminal Server' -name "fDenyTSConnections" -value 0 | ||
# Enable RDP through Windows Firewall | ||
Enable-NetFirewallRule -DisplayGroup "Remote Desktop" | ||
# Disable Network Level Authentication (NLA) | ||
# Clients will connect via Coder's tunnel | ||
(Get-WmiObject -class "Win32_TSGeneralSetting" -Namespace root\cimv2\terminalservices -ComputerName $env:COMPUTERNAME -Filter "TerminalName='RDP-tcp'").SetUserAuthenticationRequired(0) | ||
|
||
# Install Chocolatey package manager | ||
Set-ExecutionPolicy Bypass -Scope Process -Force | ||
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072 | ||
iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1')) | ||
# Reload path so sessions include "choco" and "refreshenv" | ||
$env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User") | ||
|
||
# Install Git and reload path | ||
choco install -y git | ||
$env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User") | ||
|
||
# Set protocol to TLS1.2 for agent download | ||
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 | ||
|
||
# Set Coder Agent to run immediately, and on each restart | ||
$init_script = @' | ||
${init_script} | ||
'@ | ||
Out-File -FilePath "C:\AzureData\CoderAgent.ps1" -InputObject $init_script | ||
$task = @{ | ||
TaskName = 'CoderAgent' | ||
Action = (New-ScheduledTaskAction -Execute 'powershell.exe' -Argument '-sta -ExecutionPolicy Unrestricted -Command "C:\AzureData\CoderAgent.ps1 *>> C:\AzureData\CoderAgent.log"') | ||
Trigger = (New-ScheduledTaskTrigger -AtStartup), (New-ScheduledTaskTrigger -Once -At (Get-Date).AddSeconds(15)) | ||
Settings = (New-ScheduledTaskSettingsSet -DontStopOnIdleEnd -ExecutionTimeLimit ([TimeSpan]::FromDays(3650)) -Compatibility Win8) | ||
Principal = (New-ScheduledTaskPrincipal -UserId 'vm\coder' -RunLevel Highest -LogonType S4U) | ||
} | ||
Register-ScheduledTask @task -Force | ||
|
||
# Additional Chocolatey package installs (optional, uncomment to enable) | ||
# choco feature enable -n=allowGlobalConfirmation | ||
# choco install visualstudio2022community --package-parameters "--add=Microsoft.VisualStudio.Workload.ManagedDesktop;includeRecommended --passive --locale en-US" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
name: Develop in Windows on Azure | ||
description: Get started with Windows development on Microsoft Azure. | ||
tags: [cloud, azure, windows] | ||
icon: /icon/azure.png | ||
--- | ||
|
||
# azure-windows | ||
|
||
To get started, run `coder templates init`. When prompted, select this template. | ||
Follow the on-screen instructions to proceed. | ||
|
||
## Authentication | ||
|
||
This template assumes that coderd is run in an environment that is authenticated | ||
with Azure. For example, run `az login` then `az account set --subscription=<id>` | ||
to import credentials on the system and user running coderd. For other ways to | ||
authenticate [consult the Terraform docs](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs#authenticating-to-azure). | ||
|
||
## Dependencies | ||
|
||
This template depends on the Azure CLI tool (`az`) to start and stop the Windows VM. Ensure this | ||
tool is installed and available in the path on the machine that runs coderd. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,231 @@ | ||
terraform { | ||
required_providers { | ||
coder = { | ||
source = "coder/coder" | ||
version = "0.7.0" | ||
} | ||
azurerm = { | ||
source = "hashicorp/azurerm" | ||
version = "=3.52.0" | ||
} | ||
} | ||
} | ||
|
||
provider "azurerm" { | ||
features {} | ||
} | ||
|
||
provider "coder" { | ||
} | ||
|
||
data "coder_workspace" "me" {} | ||
|
||
data "coder_parameter" "location" { | ||
description = "What location should your workspace live in?" | ||
display_name = "Location" | ||
name = "location" | ||
default = "eastus" | ||
mutable = false | ||
option { | ||
value = "eastus" | ||
name = "East US" | ||
} | ||
option { | ||
value = "centralus" | ||
name = "Central US" | ||
} | ||
option { | ||
value = "southcentralus" | ||
name = "South Central US" | ||
} | ||
option { | ||
value = "westus2" | ||
name = "West US 2" | ||
} | ||
} | ||
|
||
data "coder_parameter" "data_disk_size" { | ||
description = "Size of your data (F:) drive in GB" | ||
display_name = "Data disk size" | ||
name = "data_disk_size" | ||
default = 20 | ||
mutable = "false" | ||
type = "number" | ||
validation { | ||
min = 5 | ||
max = 5000 | ||
} | ||
} | ||
|
||
resource "coder_agent" "main" { | ||
arch = "amd64" | ||
auth = "azure-instance-identity" | ||
os = "windows" | ||
login_before_ready = false | ||
} | ||
|
||
resource "random_password" "admin_password" { | ||
length = 16 | ||
special = true | ||
# https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-complexity-requirements#reference | ||
# we remove characters that require special handling in XML, as this is how we pass it to the VM | ||
# namely: <>&'" | ||
override_special = "~!@#$%^*_-+=`|\\(){}[]:;,.?/" | ||
} | ||
|
||
locals { | ||
prefix = "coder-win" | ||
admin_username = "coder" | ||
} | ||
|
||
resource "azurerm_resource_group" "main" { | ||
name = "${local.prefix}-${data.coder_workspace.me.id}" | ||
location = data.coder_parameter.location.value | ||
tags = { | ||
Coder_Provisioned = "true" | ||
} | ||
} | ||
|
||
// Uncomment here and in the azurerm_network_interface resource to obtain a public IP | ||
#resource "azurerm_public_ip" "main" { | ||
# name = "publicip" | ||
# resource_group_name = azurerm_resource_group.main.name | ||
# location = azurerm_resource_group.main.location | ||
# allocation_method = "Static" | ||
# tags = { | ||
# Coder_Provisioned = "true" | ||
# } | ||
#} | ||
resource "azurerm_virtual_network" "main" { | ||
name = "network" | ||
address_space = ["10.0.0.0/24"] | ||
location = azurerm_resource_group.main.location | ||
resource_group_name = azurerm_resource_group.main.name | ||
tags = { | ||
Coder_Provisioned = "true" | ||
} | ||
} | ||
resource "azurerm_subnet" "internal" { | ||
name = "internal" | ||
resource_group_name = azurerm_resource_group.main.name | ||
virtual_network_name = azurerm_virtual_network.main.name | ||
address_prefixes = ["10.0.0.0/29"] | ||
} | ||
resource "azurerm_network_interface" "main" { | ||
name = "nic" | ||
resource_group_name = azurerm_resource_group.main.name | ||
location = azurerm_resource_group.main.location | ||
ip_configuration { | ||
name = "internal" | ||
subnet_id = azurerm_subnet.internal.id | ||
private_ip_address_allocation = "Dynamic" | ||
// Uncomment for public IP address as well as azurerm_public_ip resource above | ||
# public_ip_address_id = azurerm_public_ip.main.id | ||
} | ||
tags = { | ||
Coder_Provisioned = "true" | ||
} | ||
} | ||
# Create storage account for boot diagnostics | ||
resource "azurerm_storage_account" "my_storage_account" { | ||
name = "diag${random_id.storage_id.hex}" | ||
location = azurerm_resource_group.main.location | ||
resource_group_name = azurerm_resource_group.main.name | ||
account_tier = "Standard" | ||
account_replication_type = "LRS" | ||
} | ||
# Generate random text for a unique storage account name | ||
resource "random_id" "storage_id" { | ||
keepers = { | ||
# Generate a new ID only when a new resource group is defined | ||
resource_group = azurerm_resource_group.main.name | ||
} | ||
byte_length = 8 | ||
} | ||
|
||
resource "azurerm_managed_disk" "data" { | ||
name = "data_disk" | ||
location = azurerm_resource_group.main.location | ||
resource_group_name = azurerm_resource_group.main.name | ||
storage_account_type = "Standard_LRS" | ||
create_option = "Empty" | ||
disk_size_gb = data.coder_parameter.data_disk_size.value | ||
} | ||
|
||
# Create virtual machine | ||
resource "azurerm_windows_virtual_machine" "main" { | ||
name = "vm" | ||
admin_username = local.admin_username | ||
admin_password = random_password.admin_password.result | ||
location = azurerm_resource_group.main.location | ||
resource_group_name = azurerm_resource_group.main.name | ||
network_interface_ids = [azurerm_network_interface.main.id] | ||
size = "Standard_DS1_v2" | ||
custom_data = base64encode( | ||
templatefile("${path.module}/Initialize.ps1.tftpl", { init_script = coder_agent.main.init_script }) | ||
) | ||
os_disk { | ||
name = "myOsDisk" | ||
caching = "ReadWrite" | ||
storage_account_type = "Premium_LRS" | ||
} | ||
source_image_reference { | ||
publisher = "MicrosoftWindowsServer" | ||
offer = "WindowsServer" | ||
sku = "2022-datacenter-azure-edition" | ||
version = "latest" | ||
} | ||
additional_unattend_content { | ||
content = "<AutoLogon><Password><Value>${random_password.admin_password.result}</Value></Password><Enabled>true</Enabled><LogonCount>1</LogonCount><Username>${local.admin_username}</Username></AutoLogon>" | ||
setting = "AutoLogon" | ||
} | ||
additional_unattend_content { | ||
content = file("${path.module}/FirstLogonCommands.xml") | ||
setting = "FirstLogonCommands" | ||
} | ||
boot_diagnostics { | ||
storage_account_uri = azurerm_storage_account.my_storage_account.primary_blob_endpoint | ||
} | ||
tags = { | ||
Coder_Provisioned = "true" | ||
} | ||
} | ||
|
||
resource "coder_metadata" "rdp_login" { | ||
resource_id = azurerm_windows_virtual_machine.main.id | ||
item { | ||
key = "Username" | ||
value = local.admin_username | ||
} | ||
item { | ||
key = "Password" | ||
value = random_password.admin_password.result | ||
sensitive = true | ||
} | ||
} | ||
|
||
resource "azurerm_virtual_machine_data_disk_attachment" "main_data" { | ||
managed_disk_id = azurerm_managed_disk.data.id | ||
virtual_machine_id = azurerm_windows_virtual_machine.main.id | ||
lun = "10" | ||
caching = "ReadWrite" | ||
} | ||
|
||
# Stop the VM | ||
resource "null_resource" "stop_vm" { | ||
count = data.coder_workspace.me.transition == "stop" ? 1 : 0 | ||
depends_on = [azurerm_windows_virtual_machine.main] | ||
provisioner "local-exec" { | ||
# Use deallocate so the VM is not charged | ||
command = "az vm deallocate --ids ${azurerm_windows_virtual_machine.main.id}" | ||
} | ||
} | ||
|
||
# Start the VM | ||
resource "null_resource" "start" { | ||
count = data.coder_workspace.me.transition == "start" ? 1 : 0 | ||
depends_on = [azurerm_windows_virtual_machine.main] | ||
provisioner "local-exec" { | ||
command = "az vm start --ids ${azurerm_windows_virtual_machine.main.id}" | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does line 61 start the agent once? Line 65 is also intended to do this (it runs the agent after the task is registered 15 seconds later)
I feel like we should only have one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 61 writes the script to a file, line 69 registers the task that runs the script.
Line 65 is just defining the trigger(s) for the task, which are then used as args for Line 69.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, understood :)