Skip to content

Commit f563e6b

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

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

docs/admin/provisioners.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,10 +148,18 @@ coder templates push on-prem-chicago \
148148
--provisioner-tag datacenter=chicago
149149
```
150150

151+
This can also be done in the UI when building a template:
152+
153+
> ![template tags](../images/admin/provisioner-tags.png)
154+
151155
Alternatively, a template can target a provisioner via
152156
[workspace tags](https://github.com/coder/coder/tree/main/examples/workspace-tags)
153157
inside the Terraform.
154158

159+
> [!NOTE] Workspace tags defined with the `coder_workspace_tags` data source
160+
> template **do not** automatically apply to the template import job! You may
161+
> need to specify the desired tags when importing the template.
162+
155163
A provisioner can run a given build job if one of the below is true:
156164

157165
1. A job with no explicit tags can only be run on a provisioner with no explicit
@@ -170,6 +178,14 @@ However, it will not pick up any build jobs that do not have either of the
170178
`environment` or `datacenter` tags set. It will also not pick up any build jobs
171179
from templates with the tag `scope=user` set.
172180

181+
> [!NOTE] If you only run tagged provisioners, you will need to specify a set of
182+
> tags that matches at least one provisioner for _all_ template import jobs and
183+
> workspace build jobs.
184+
>
185+
> You may wish to run at least one additional provisioner with no additional
186+
> tags so that provisioner jobs with no additional tags defined will be picked
187+
> up instead of potentially remaining in the Pending state indefinitely.
188+
173189
This is illustrated in the below table:
174190

175191
| Provisioner Tags | Job Tags | Can Run Job? |
34.8 KB
Loading

0 commit comments

Comments
 (0)