diff --git a/code-server/README.md b/code-server/README.md index 54916a9..8d450eb 100644 --- a/code-server/README.md +++ b/code-server/README.md @@ -27,9 +27,9 @@ module "code-server" { ```hcl module "code-server" { - source = "registry.coder.com/modules/code-server/coder" + source = "registry.coder.com/modules/code-server/coder" version = "1.0.1" - agent_id = coder_agent.example.id + agent_id = coder_agent.example.id install_version = "4.8.3" } ``` diff --git a/coder-login/README.md b/coder-login/README.md index bbbe22b..b6b72d8 100644 --- a/coder-login/README.md +++ b/coder-login/README.md @@ -13,7 +13,7 @@ Automatically logs the user into Coder when creating their workspace. ```hcl module "coder-login" { - source = "registry.coder.com/modules/coder-login/coder" + source = "registry.coder.com/modules/coder-login/coder" version = "1.0.1" agent_id = coder_agent.example.id } diff --git a/exoscale-instance-type/README.md b/exoscale-instance-type/README.md index 3702617..11dc07f 100644 --- a/exoscale-instance-type/README.md +++ b/exoscale-instance-type/README.md @@ -22,13 +22,13 @@ module "exoscale-instance-type" { } resource "exoscale_compute_instance" "instance" { - type = module.exoscale-instance-type.value + type = module.exoscale-instance-type.value ... } resource "coder_metadata" "workspace_info" { item { - key = "instance type" + key = "instance type" value = module.exoscale-instance-type.name } } @@ -56,13 +56,13 @@ module "exoscale-instance-type" { } resource "exoscale_compute_instance" "instance" { - type = module.exoscale-instance-type.value + type = module.exoscale-instance-type.value ... } resource "coder_metadata" "workspace_info" { item { - key = "instance type" + key = "instance type" value = module.exoscale-instance-type.name } } @@ -76,11 +76,11 @@ Show only gpu1 types ```hcl module "exoscale-instance-type" { - source = "registry.coder.com/modules/exoscale-instance-type/coder" + source = "registry.coder.com/modules/exoscale-instance-type/coder" version = "1.0.1" - default = "gpu.large" + default = "gpu.large" type_category = ["gpu"] - exclude = [ + exclude = [ "gpu2.small", "gpu2.medium", "gpu2.large", @@ -93,13 +93,13 @@ module "exoscale-instance-type" { } resource "exoscale_compute_instance" "instance" { - type = module.exoscale-instance-type.value + type = module.exoscale-instance-type.value ... } resource "coder_metadata" "workspace_info" { item { - key = "instance type" + key = "instance type" value = module.exoscale-instance-type.name } } diff --git a/exoscale-zone/README.md b/exoscale-zone/README.md index b5cd45d..94c1533 100644 --- a/exoscale-zone/README.md +++ b/exoscale-zone/README.md @@ -28,7 +28,7 @@ data "exoscale_compute_template" "my_template" { } resource "exoscale_compute_instance" "instance" { - zone = module.exoscale-zone.value + zone = module.exoscale-zone.value .... } ``` @@ -60,7 +60,7 @@ data "exoscale_compute_template" "my_template" { } resource "exoscale_compute_instance" "instance" { - zone = module.exoscale-zone.value + zone = module.exoscale-zone.value .... } ``` @@ -84,7 +84,7 @@ data "exoscale_compute_template" "my_template" { } resource "exoscale_compute_instance" "instance" { - zone = module.exoscale-zone.value + zone = module.exoscale-zone.value .... } ``` diff --git a/gcp-region/README.md b/gcp-region/README.md index a1abd0e..997f013 100644 --- a/gcp-region/README.md +++ b/gcp-region/README.md @@ -13,7 +13,7 @@ This module adds Google Cloud Platform regions to your Coder template. ```hcl module "gcp_region" { - source = "registry.coder.com/modules/gcp-region/coder" + source = "registry.coder.com/modules/gcp-region/coder" version = "1.0.1" regions = ["us", "europe"] } @@ -33,10 +33,10 @@ Note: setting `gpu_only = true` and using a default region without GPU support, ```hcl module "gcp_region" { - source = "registry.coder.com/modules/gcp-region/coder" + source = "registry.coder.com/modules/gcp-region/coder" version = "1.0.1" - default = ["us-west1-a"] - regions = ["us-west1"] + default = ["us-west1-a"] + regions = ["us-west1"] gpu_only = false } @@ -49,9 +49,9 @@ resource "google_compute_instance" "example" { ```hcl module "gcp_region" { - source = "registry.coder.com/modules/gcp-region/coder" + source = "registry.coder.com/modules/gcp-region/coder" version = "1.0.1" - regions = ["europe-west"] + regions = ["europe-west"] single_zone_per_region = false } @@ -64,10 +64,10 @@ resource "google_compute_instance" "example" { ```hcl module "gcp_region" { - source = "registry.coder.com/modules/gcp-region/coder" + source = "registry.coder.com/modules/gcp-region/coder" version = "1.0.1" - regions = ["us", "europe"] - gpu_only = true + regions = ["us", "europe"] + gpu_only = true single_zone_per_region = true } diff --git a/git-clone/README.md b/git-clone/README.md index 716a225..ca8c450 100644 --- a/git-clone/README.md +++ b/git-clone/README.md @@ -13,10 +13,10 @@ This module allows you to automatically clone a repository by URL and skip if it ```hcl module "git-clone" { - source = "registry.coder.com/modules/git-clone/coder" + source = "registry.coder.com/modules/git-clone/coder" version = "1.0.1" agent_id = coder_agent.example.id - url = "https://github.com/coder/coder" + url = "https://github.com/coder/coder" } ``` @@ -34,10 +34,10 @@ data "coder_git_auth" "github" { ```hcl module "git-clone" { - source = "registry.coder.com/modules/git-clone/coder" + source = "registry.coder.com/modules/git-clone/coder" version = "1.0.1" agent_id = coder_agent.example.id - url = "https://github.com/coder/coder" - path = "~/projects/coder/coder" + url = "https://github.com/coder/coder" + path = "~/projects/coder/coder" } ``` diff --git a/jetbrains-gateway/README.md b/jetbrains-gateway/README.md index 667ed55..0311aae 100644 --- a/jetbrains-gateway/README.md +++ b/jetbrains-gateway/README.md @@ -13,12 +13,12 @@ This module adds a JetBrains Gateway Button to open any workspace with a single ```hcl module "jetbrains_gateway" { - source = "registry.coder.com/modules/jetbrains-gateway/coder" + source = "registry.coder.com/modules/jetbrains-gateway/coder" version = "1.0.1" - agent_id = coder_agent.example.id - folder = "/home/coder/example" + agent_id = coder_agent.example.id + folder = "/home/coder/example" jetbrains_ides = ["GO", "WS", "IU", "PY", "PS", "CL", "RM"] - default = "PY" + default = "PY" } ``` @@ -30,12 +30,12 @@ module "jetbrains_gateway" { ```hcl module "jetbrains_gateway" { - source = "registry.coder.com/modules/jetbrains-gateway/coder" + source = "registry.coder.com/modules/jetbrains-gateway/coder" version = "1.0.1" - agent_id = coder_agent.example.id - folder = "/home/coder/example" - jetbrains_ides = ["GO", "WS"] - default = "GO" + agent_id = coder_agent.example.id + folder = "/home/coder/example" + jetbrains_ides = ["GO", "WS"] + default = "GO" } ``` diff --git a/jfrog-token/README.md b/jfrog-token/README.md index 3158ed2..25312d7 100644 --- a/jfrog-token/README.md +++ b/jfrog-token/README.md @@ -31,7 +31,7 @@ Get a JFrog access token from your Artifactory instance. The token must be an [a ```hcl variable "artifactory_access_token" { - type = string + type = string sensitive = true } ``` diff --git a/vault-github/README.md b/vault-github/README.md index bde9638..6f399c8 100644 --- a/vault-github/README.md +++ b/vault-github/README.md @@ -13,9 +13,9 @@ This module lets you authenticate with [Hashicorp Vault](https://www.vaultprojec ```hcl module "vault" { - source = "registry.coder.com/modules/vault-github/coder" + source = "registry.coder.com/modules/vault-github/coder" version = "1.0.1" - agent_id = coder_agent.example.id + agent_id = coder_agent.example.id vault_addr = "https://vault.example.com" } ``` @@ -23,7 +23,7 @@ module "vault" { Then you can use the Vault CLI in your workspaces to fetch secrets from Vault: ```shell -vault kv get -mount=secret my-secret +vault kv get -mount = secret my-secret ``` or using the Vault API: @@ -44,10 +44,10 @@ To configure the Vault module, you must set up a Vault GitHub auth method. See t ```hcl module "vault" { - source = "registry.coder.com/modules/vault-github/coder" + source = "registry.coder.com/modules/vault-github/coder" version = "1.0.1" - agent_id = coder_agent.example.id - vault_addr = "https://vault.example.com" + agent_id = coder_agent.example.id + vault_addr = "https://vault.example.com" coder_github_auth_id = "my-github-auth-id" } ``` @@ -56,11 +56,11 @@ module "vault" { ```hcl module "vault" { - source = "registry.coder.com/modules/vault-github/coder" + source = "registry.coder.com/modules/vault-github/coder" version = "1.0.1" - agent_id = coder_agent.example.id - vault_addr = "https://vault.example.com" - coder_github_auth_id = "my-github-auth-id" + agent_id = coder_agent.example.id + vault_addr = "https://vault.example.com" + coder_github_auth_id = "my-github-auth-id" vault_github_auth_path = "my-github-auth-path" } ``` @@ -69,10 +69,10 @@ module "vault" { ```hcl module "vault" { - source = "registry.coder.com/modules/vault-github/coder" + source = "registry.coder.com/modules/vault-github/coder" version = "1.0.1" - agent_id = coder_agent.example.id - vault_addr = "https://vault.example.com" + agent_id = coder_agent.example.id + vault_addr = "https://vault.example.com" vault_cli_version = "1.15.0" } ``` diff --git a/vscode-web/README.md b/vscode-web/README.md index 63a37c8..71969fd 100644 --- a/vscode-web/README.md +++ b/vscode-web/README.md @@ -13,9 +13,9 @@ Automatically install [Visual Studio Code Server](https://code.visualstudio.com/ ```hcl module "vscode-web" { - source = "registry.coder.com/modules/vscode-web/coder" + source = "registry.coder.com/modules/vscode-web/coder" version = "1.0.1" - agent_id = coder_agent.example.id + agent_id = coder_agent.example.id accept_license = true } ``` @@ -28,11 +28,11 @@ module "vscode-web" { ```hcl module "vscode-web" { - source = "registry.coder.com/modules/vscode-web/coder" + source = "registry.coder.com/modules/vscode-web/coder" version = "1.0.1" - agent_id = coder_agent.example.id - install_dir = "/home/coder/.vscode-web" - folder = "/home/coder" - accept_license = true + agent_id = coder_agent.example.id + install_dir = "/home/coder/.vscode-web" + folder = "/home/coder" + accept_license = true } ```