Skip to content

Commit 481104e

Browse files
committed
fixup! chore(docs): add notes regarding provisioner tags and untagged jobs
1 parent f563e6b commit 481104e

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

docs/admin/provisioners.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,9 @@ This can also be done in the UI when building a template:
154154
155155
Alternatively, a template can target a provisioner via
156156
[workspace tags](https://github.com/coder/coder/tree/main/examples/workspace-tags)
157-
inside the Terraform.
157+
inside the Terraform. See the
158+
[workspace tags documentation](../admin/templates/extending-templates/workspace-tags.md)
159+
for more information.
158160

159161
> [!NOTE] Workspace tags defined with the `coder_workspace_tags` data source
160162
> template **do not** automatically apply to the template import job! You may

docs/admin/templates/extending-templates/workspace-tags.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ specified:
1717
```tf
1818
data "coder_workspace_tags" "custom_workspace_tags" {
1919
tags = {
20+
"az" = var.az
2021
"zone" = "developers"
2122
"runtime" = data.coder_parameter.runtime_selector.value
2223
"project_id" = "PROJECT_${data.coder_parameter.project_name.value}"
@@ -50,6 +51,9 @@ added that can handle its combination of tags.
5051
Before releasing the template version with configurable workspace tags, ensure
5152
that every tag set is associated with at least one healthy provisioner.
5253

54+
> [!NOTE] It may be useful to run at least one provisioner with no additional
55+
> tag restrictions that is able to take on any job.
56+
5357
### Parameters types
5458

5559
Provisioners require job tags to be defined in plain string format. When a
@@ -66,6 +70,14 @@ the workspace owner to change a provisioner group (due to different tags). In
6670
most cases, `coder_parameter`s backing `coder_workspace_tags` should be marked
6771
as immutable and set only once, during workspace creation.
6872

73+
**We recommend only using the following as inputs for `coder_workspace_tags`:**
74+
75+
- Static values (e.g. `"developers"`),
76+
- Template variables (e.g. `var.az`),
77+
- Coder parameters (e.g. `data.coder_parameter.runtime_selector.value`).
78+
79+
Passing template tags in from other data sources may have undesired effects!
80+
6981
### HCL syntax
7082

7183
When importing the template version with `coder_workspace_tags`, the Coder

0 commit comments

Comments
 (0)