diff --git a/.images/aws-custom.png b/.images/aws-custom.png new file mode 100644 index 0000000..e43f616 Binary files /dev/null and b/.images/aws-custom.png differ diff --git a/.images/aws-exclude.png b/.images/aws-exclude.png new file mode 100644 index 0000000..d4c60f2 Binary files /dev/null and b/.images/aws-exclude.png differ diff --git a/.images/azure-custom.png b/.images/azure-custom.png new file mode 100644 index 0000000..47be4fe Binary files /dev/null and b/.images/azure-custom.png differ diff --git a/.images/azure-default.png b/.images/azure-default.png new file mode 100644 index 0000000..963ce09 Binary files /dev/null and b/.images/azure-default.png differ diff --git a/.images/azure-exclude.png b/.images/azure-exclude.png new file mode 100644 index 0000000..8a4cd01 Binary files /dev/null and b/.images/azure-exclude.png differ diff --git a/.images/filebrowser.png b/.images/filebrowser.png new file mode 100644 index 0000000..8a8bbf3 Binary files /dev/null and b/.images/filebrowser.png differ diff --git a/.images/vscode-desktop.png b/.images/vscode-desktop.png new file mode 100644 index 0000000..e3e40a4 Binary files /dev/null and b/.images/vscode-desktop.png differ diff --git a/aws-region/README.md b/aws-region/README.md index f23b11f..02a731a 100644 --- a/aws-region/README.md +++ b/aws-region/README.md @@ -29,18 +29,19 @@ provider "aws" { ## Examples -### Customize Regions +### Customize regions -Change the display name and icon for a region: +Change the display name and icon for a region using the corresponding maps: ```hcl module "aws-region" { source = "https://registry.coder.com/modules/aws-region" + default = "ap-south-1" custom_names = { - "fra": "Awesome Germany!" + "ap-south-1": "Awesome Mumbai!" } custom_icons = { - "fra": "/icons/smiley.svg" + "ap-south-1": "/emojis/1f33a.png" } } @@ -49,17 +50,28 @@ provider "aws" { } ``` -### Exclude Regions +![AWS Custom](../.images/aws-custom.png) -Hide the `fra` region: +### Exclude regions + +Hide the Asia Pacific regions Seoul and Osaka: ```hcl module "aws-region" { source = "https://registry.coder.com/modules/aws-region" - exclude = [ "fra" ] + exclude = [ "ap-northeast-2", "ap-northeast-3" ] } provider "aws" { region = module.aws_region.value } ``` + +![AWS Exclude](../.images/aws-exclude.png) + +## Related templates + +For a complete AWS EC2 template, see the following examples in the [Coder Registry](https://registry.coder.com/). + +- [AWS EC2 (Linux)](https://registry.coder.com/templates/aws-linux) +- [AWS EC2 (Windows)](https://registry.coder.com/templates/aws-windows) diff --git a/azure-region/README.md b/azure-region/README.md index 235f58e..a6a0b7c 100644 --- a/azure-region/README.md +++ b/azure-region/README.md @@ -22,20 +22,22 @@ resource "azurem_resource_group" "example" { } ``` +![Azure Region Default](../.images/azure-default.png) + ## Examples ### Customize existing regions -Change the display name for a region: +Change the display name and icon for a region using the corresponding maps: ```hcl module "azure-region" { source = "https://registry.coder.com/modules/azure-region" custom_names = { - "eastus": "Eastern United States!" + "australia": "Go Australia!" } custom_icons = { - "eastus": "/icons/smiley.svg" + "australia": "/icons/smiley.svg" } } @@ -44,17 +46,33 @@ resource "azurerm_resource_group" "example" { } ``` +![Azure Region Custom](../.images/azure-custom.png) + ### Exclude Regions -Hide the `westus2` region: +Hide all regions in Australia except australiacentral: ```hcl module "azure-region" { source = "https://registry.coder.com/modules/azure-region" - exclude = [ "westus2" ] + exclude = [ + "australia", + "australiacentral2", + "australiaeast", + "australiasoutheast" + ] } resource "azurerm_resource_group" "example" { location = module.azure_region.value } ``` + +![Azure Exclude](../.images/azure-exclude.png) + +## Related templates + +For a complete Azure template, see the following examples in the [Coder Registry](https://registry.coder.com/). + +- [Azure VM (Linux)](https://registry.coder.com/templates/azure-linux) +- [Azure VM (Windows)](https://registry.coder.com/templates/azure-windows) diff --git a/azure-region/main.tf b/azure-region/main.tf index 1e38091..744fb88 100644 --- a/azure-region/main.tf +++ b/azure-region/main.tf @@ -310,6 +310,7 @@ data "coder_parameter" "region" { description = var.description default = var.default mutable = var.mutable + icon = "/icon/azure.png" dynamic "option" { for_each = { for k, v in local.all_regions : k => v if !(contains(var.exclude, k)) } content { diff --git a/filebrowser/README.md b/filebrowser/README.md index bd1ba07..9a08398 100644 --- a/filebrowser/README.md +++ b/filebrowser/README.md @@ -18,6 +18,8 @@ module "filebrowser" { } ``` +![Filebrowsing Example](../.images/filebrowser.png) + ## Examples ### Serve a specific directory diff --git a/vscode-desktop/README.md b/vscode-desktop/README.md index 2651aed..ff34f0d 100644 --- a/vscode-desktop/README.md +++ b/vscode-desktop/README.md @@ -19,3 +19,5 @@ module "vscode" { agent_id = coder_agent.example.id } ``` + +![VSCode Desktop Button](../.images/vscode-desktop.png)