docs: promote count usage to prevent module download on stop (#371)

coder · Dec 23, 2024 · 7654140 · 7654140
1 parent bc6490f
commit 7654140
Show file tree

Hide file tree

Showing 31 changed files with 102 additions and 10 deletions.
diff --git a/.sample/README.md b/.sample/README.md
@@ -13,6 +13,7 @@ tags: [helper]
 
 ```tf
 module "MODULE_NAME" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/MODULE_NAME/coder"
   version = "1.0.2"
 }
@@ -28,6 +29,7 @@ Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
 
 ```tf
 module "MODULE_NAME" {
+  count      = data.coder_workspace.me.start_count
   source     = "registry.coder.com/modules/MODULE_NAME/coder"
   version    = "1.0.2"
   agent_id   = coder_agent.example.id
@@ -45,6 +47,7 @@ Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarte
 
 ```tf
 module "MODULE_NAME" {
+  count      = data.coder_workspace.me.start_count
   source     = "registry.coder.com/modules/MODULE_NAME/coder"
   version    = "1.0.2"
   agent_id   = coder_agent.example.id

diff --git a/README.md b/README.md
@@ -17,6 +17,7 @@ e.g.
 
 ```tf
 module "code-server" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/code-server/coder"
   version  = "1.0.2"
   agent_id = coder_agent.main.id

diff --git a/apache-airflow/README.md b/apache-airflow/README.md
@@ -14,6 +14,7 @@ A module that adds Apache Airflow in your Coder template.
 
 ```tf
 module "airflow" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/apache-airflow/coder"
   version  = "1.0.13"
   agent_id = coder_agent.main.id

diff --git a/aws-region/README.md b/aws-region/README.md
@@ -16,6 +16,7 @@ Customize the preselected parameter value:
 
 ```tf
 module "aws-region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/aws-region/coder"
   version = "1.0.12"
   default = "us-east-1"
@@ -36,6 +37,7 @@ Change the display name and icon for a region using the corresponding maps:
 
 ```tf
 module "aws-region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/aws-region/coder"
   version = "1.0.12"
   default = "ap-south-1"
@@ -62,6 +64,7 @@ Hide the Asia Pacific regions Seoul and Osaka:
 
 ```tf
 module "aws-region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/aws-region/coder"
   version = "1.0.12"
   exclude = ["ap-northeast-2", "ap-northeast-3"]

diff --git a/azure-region/README.md b/azure-region/README.md
@@ -13,6 +13,7 @@ This module adds a parameter with all Azure regions, allowing developers to sele
 
 ```tf
 module "azure_region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/azure-region/coder"
   version = "1.0.12"
   default = "eastus"
@@ -33,6 +34,7 @@ Change the display name and icon for a region using the corresponding maps:
 
 ```tf
 module "azure-region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/azure-region/coder"
   version = "1.0.12"
   custom_names = {
@@ -56,6 +58,7 @@ Hide all regions in Australia except australiacentral:
 
 ```tf
 module "azure-region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/azure-region/coder"
   version = "1.0.12"
   exclude = [

diff --git a/code-server/README.md b/code-server/README.md
@@ -13,6 +13,7 @@ Automatically install [code-server](https://github.com/coder/code-server) in a w
 
 ```tf
 module "code-server" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/code-server/coder"
   version  = "1.0.26"
   agent_id = coder_agent.example.id
@@ -27,6 +28,7 @@ module "code-server" {
 
 ```tf
 module "code-server" {
+  count           = data.coder_workspace.me.start_count
   source          = "registry.coder.com/modules/code-server/coder"
   version         = "1.0.26"
   agent_id        = coder_agent.example.id
@@ -40,6 +42,7 @@ Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
 
 ```tf
 module "code-server" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/code-server/coder"
   version  = "1.0.26"
   agent_id = coder_agent.example.id
@@ -57,6 +60,7 @@ Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarte
 
 ```tf
 module "code-server" {
+  count      = data.coder_workspace.me.start_count
   source     = "registry.coder.com/modules/code-server/coder"
   version    = "1.0.26"
   agent_id   = coder_agent.example.id
@@ -73,6 +77,7 @@ Just run code-server in the background, don't fetch it from GitHub:
 
 ```tf
 module "code-server" {
+  count      = data.coder_workspace.me.start_count
   source     = "registry.coder.com/modules/code-server/coder"
   version    = "1.0.26"
   agent_id   = coder_agent.example.id
@@ -88,6 +93,7 @@ Run an existing copy of code-server if found, otherwise download from GitHub:
 
 ```tf
 module "code-server" {
+  count      = data.coder_workspace.me.start_count
   source     = "registry.coder.com/modules/code-server/coder"
   version    = "1.0.26"
   agent_id   = coder_agent.example.id
@@ -100,6 +106,7 @@ Just run code-server in the background, don't fetch it from GitHub:
 
 ```tf
 module "code-server" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/code-server/coder"
   version  = "1.0.26"
   agent_id = coder_agent.example.id

diff --git a/coder-login/README.md b/coder-login/README.md
@@ -13,6 +13,7 @@ Automatically logs the user into Coder when creating their workspace.
 
 ```tf
 module "coder-login" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/coder-login/coder"
   version  = "1.0.15"
   agent_id = coder_agent.example.id

diff --git a/cursor/README.md b/cursor/README.md
@@ -15,6 +15,7 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/cursor-coder)
 
 ```tf
 module "cursor" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/cursor/coder"
   version  = "1.0.19"
   agent_id = coder_agent.example.id
@@ -27,6 +28,7 @@ module "cursor" {
 
 ```tf
 module "cursor" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/cursor/coder"
   version  = "1.0.19"
   agent_id = coder_agent.example.id

diff --git a/dotfiles/README.md b/dotfiles/README.md
@@ -17,6 +17,7 @@ Under the hood, this module uses the [coder dotfiles](https://coder.com/docs/v2/
 
 ```tf
 module "dotfiles" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/dotfiles/coder"
   version  = "1.0.18"
   agent_id = coder_agent.example.id
@@ -29,6 +30,7 @@ module "dotfiles" {
 
 ```tf
 module "dotfiles" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/dotfiles/coder"
   version  = "1.0.18"
   agent_id = coder_agent.example.id
@@ -39,6 +41,7 @@ module "dotfiles" {
 
 ```tf
 module "dotfiles" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/dotfiles/coder"
   version  = "1.0.18"
   agent_id = coder_agent.example.id
@@ -50,12 +53,14 @@ module "dotfiles" {
 
 ```tf
 module "dotfiles" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/dotfiles/coder"
   version  = "1.0.18"
   agent_id = coder_agent.example.id
 }
 
 module "dotfiles-root" {
+  count        = data.coder_workspace.me.start_count
   source       = "registry.coder.com/modules/dotfiles/coder"
   version      = "1.0.18"
   agent_id     = coder_agent.example.id
@@ -70,6 +75,7 @@ You can set a default dotfiles repository for all users by setting the `default_
 
 ```tf
 module "dotfiles" {
+  count                = data.coder_workspace.me.start_count
   source               = "registry.coder.com/modules/dotfiles/coder"
   version              = "1.0.18"
   agent_id             = coder_agent.example.id

diff --git a/exoscale-instance-type/README.md b/exoscale-instance-type/README.md
@@ -16,6 +16,7 @@ Customize the preselected parameter value:
 
 ```tf
 module "exoscale-instance-type" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/exoscale-instance-type/coder"
   version = "1.0.12"
   default = "standard.medium"
@@ -44,6 +45,7 @@ Change the display name a type using the corresponding maps:
 
 ```tf
 module "exoscale-instance-type" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/exoscale-instance-type/coder"
   version = "1.0.12"
   default = "standard.medium"
@@ -78,6 +80,7 @@ Show only gpu1 types
 
 ```tf
 module "exoscale-instance-type" {
+  count         = data.coder_workspace.me.start_count
   source        = "registry.coder.com/modules/exoscale-instance-type/coder"
   version       = "1.0.12"
   default       = "gpu.large"

diff --git a/exoscale-zone/README.md b/exoscale-zone/README.md
@@ -16,6 +16,7 @@ Customize the preselected parameter value:
 
 ```tf
 module "exoscale-zone" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/exoscale-zone/coder"
   version = "1.0.12"
   default = "ch-dk-2"
@@ -43,6 +44,7 @@ Change the display name and icon for a zone using the corresponding maps:
 
 ```tf
 module "exoscale-zone" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/exoscale-zone/coder"
   version = "1.0.12"
   default = "at-vie-1"

diff --git a/filebrowser/README.md b/filebrowser/README.md
@@ -13,6 +13,7 @@ A file browser for your workspace.
 
 ```tf
 module "filebrowser" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/filebrowser/coder"
   version  = "1.0.23"
   agent_id = coder_agent.example.id
@@ -27,6 +28,7 @@ module "filebrowser" {
 
 ```tf
 module "filebrowser" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/filebrowser/coder"
   version  = "1.0.23"
   agent_id = coder_agent.example.id
@@ -38,6 +40,7 @@ module "filebrowser" {
 
 ```tf
 module "filebrowser" {
+  count         = data.coder_workspace.me.start_count
   source        = "registry.coder.com/modules/filebrowser/coder"
   version       = "1.0.23"
   agent_id      = coder_agent.example.id
@@ -49,7 +52,9 @@ module "filebrowser" {
 
 ```tf
 module "filebrowser" {
+  count      = data.coder_workspace.me.start_count
   source     = "registry.coder.com/modules/filebrowser/coder"
+  version    = "1.0.23"
   agent_id   = coder_agent.example.id
   agent_name = "main"
   subdomain  = false

diff --git a/fly-region/README.md b/fly-region/README.md
@@ -15,6 +15,7 @@ We can use the simplest format here, only adding a default selection as the `atl
 
 ```tf
 module "fly-region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/fly-region/coder"
   version = "1.0.2"
   default = "atl"
@@ -31,6 +32,7 @@ The regions argument can be used to display only the desired regions in the Code
 
 ```tf
 module "fly-region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/fly-region/coder"
   version = "1.0.2"
   default = "ams"
@@ -46,6 +48,7 @@ Set custom icons and names with their respective maps.
 
 ```tf
 module "fly-region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/fly-region/coder"
   version = "1.0.2"
   default = "ams"

diff --git a/gcp-region/README.md b/gcp-region/README.md
@@ -13,6 +13,7 @@ This module adds Google Cloud Platform regions to your Coder template.
 
 ```tf
 module "gcp_region" {
+  count   = data.coder_workspace.me.start_count
   source  = "registry.coder.com/modules/gcp-region/coder"
   version = "1.0.12"
   regions = ["us", "europe"]
@@ -33,6 +34,7 @@ Note: setting `gpu_only = true` and using a default region without GPU support,
 
 ```tf
 module "gcp_region" {
+  count    = data.coder_workspace.me.start_count
   source   = "registry.coder.com/modules/gcp-region/coder"
   version  = "1.0.12"
   default  = ["us-west1-a"]
@@ -49,6 +51,7 @@ resource "google_compute_instance" "example" {
 
 ```tf
 module "gcp_region" {
+  count                  = data.coder_workspace.me.start_count
   source                 = "registry.coder.com/modules/gcp-region/coder"
   version                = "1.0.12"
   regions                = ["europe-west"]
@@ -64,6 +67,7 @@ resource "google_compute_instance" "example" {
 
 ```tf
 module "gcp_region" {
+  count                  = data.coder_workspace.me.start_count
   source                 = "registry.coder.com/modules/gcp-region/coder"
   version                = "1.0.12"
   regions                = ["us", "europe"]