diff --git a/azure-region/README.md b/azure-region/README.md index afeaa37..af63a31 100644 --- a/azure-region/README.md +++ b/azure-region/README.md @@ -13,4 +13,36 @@ A parameter with all Azure regions. This allows developers to select the region ## Examples -TODO \ No newline at end of file +### Default region + +```hcl +module "azure_region" { + source = "https://registry.coder.com/modules/azure-region" + default = "eastus" +} + +provider "azure" { + region = module.azure_region.value + ... +} +``` + +### Customize existing regions + +Change the display name for a region: + +```hcl +module "azure-region" { + source = "https://registry.coder.com/modules/azure-region" + custom_names = { + "eastus": "Eastern United States!" + } + custom_icons = { + "eastus": "/icons/smiley.svg" + } +} + +provider "aws" { + region = module.aws_region.value +} +``` diff --git a/azure-region/main.tf b/azure-region/main.tf index ce1a174..4cd3b2b 100644 --- a/azure-region/main.tf +++ b/azure-region/main.tf @@ -51,7 +51,7 @@ variable "exclude" { } locals { - regions = { + all_regions = { "eastus" = { name = "US (Virginia)" icon = "/emojis/1f1fa-1f1f8.png" @@ -166,7 +166,7 @@ data "coder_parameter" "region" { default = var.default mutable = var.mutable dynamic "option" { - for_each = { for k, v in local.regions : k => v if !(contains(var.exclude, k)) } + for_each = { for k, v in local.all_regions : k => v if !(contains(var.exclude, k)) } content { name = try(var.custom_names[option.key], option.value.name) icon = try(var.custom_icons[option.key], option.value.icon)