Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/admin/templates/extending-templates/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

For users to connect to a workspace, the template must include a [`coder_agent`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent).
The associated agent will facilitate [workspace connections](../../../user-guides/workspace-access/index.md) via SSH, port forwarding, and IDEs.
The agent may also display real-time [workspace metadata](./agent-metadata.md) like resource usage.

Check notice on line 14 in docs/admin/templates/extending-templates/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'might, can' instead of 'may'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.

```tf
resource "coder_agent" "dev" {
Expand All @@ -32,13 +32,13 @@

![A healthy workspace agent](../../../images/templates/healthy-workspace-agent.png)

Multiple agents may be used in a single template or even a single resource.

Check notice on line 35 in docs/admin/templates/extending-templates/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'might, can' instead of 'may'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.
Each agent may have its own apps, startup script, and metadata.

Check notice on line 36 in docs/admin/templates/extending-templates/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'might, can' instead of 'may'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.
This can be used to associate multiple containers or VMs with a workspace.

## Resource persistence

The resources you define in a template may be _ephemeral_ or _persistent_.

Check notice on line 41 in docs/admin/templates/extending-templates/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'might, can' instead of 'may'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.
Persistent resources stay provisioned when workspaces are stopped, where as ephemeral resources are destroyed and recreated on restart.
All resources are destroyed when a workspace is deleted.

Expand All @@ -47,7 +47,7 @@
Template resources follow the [behavior of Terraform resources](https://developer.hashicorp.com/terraform/language/resources/behavior#how-terraform-applies-a-configuration) and can be further configured  using the [lifecycle argument](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle).

A common configuration is a template whose only persistent resource is the home directory.
This allows the developer to retain their work while ensuring the rest of their environment is consistently up-to-date on each workspace restart.

Check notice on line 50 in docs/admin/templates/extending-templates/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'making sure' instead of 'ensuring'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.

When a workspace is deleted, the control plane essentially runs a [terraform destroy](https://www.terraform.io/cli/commands/destroy) to remove all resources associated with the workspace.

Expand Down Expand Up @@ -128,7 +128,7 @@
The dashboard shows the app as disabled, except for `http` and `https` links, which open with the placeholder left in place.
Links without the placeholder open as written.
Dev container apps never receive a session token.
Refer to [Customizing dev containers](../../workspaces/devcontainers/customizing-dev-containers.md) for details.
Refer to [Customizing dev containers](../../../user-guides/devcontainers/customizing-dev-containers.md) for details.

## Environment variables

Expand Down Expand Up @@ -178,7 +178,7 @@
- **Lifecycle control**:
Run on start (`run_on_start`), stop (`run_on_stop`), or cron schedule (`cron`)
- **Login blocking**:
Use `start_blocks_login = true` to ensure critical setup completes before user access

Check notice on line 181 in docs/admin/templates/extending-templates/index.md

View workflow job for this annotation

GitHub Actions / lint-docs

Coder.AmbiguousWords

Use 'make sure' instead of 'ensure'; the word has more than one meaning. Refer to word-choice.md#choose-words-that-have-one-meaning.
- **Timeouts**:
Configure `timeout` for long-running scripts
- **Custom icons**:
Expand Down
Loading