shishantbiswas/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): improve prebuild provsioners section (#20321)

Browse Source 
## Description

Follow-up from: https://github.com/coder/coder/pull/20305 to include a
note about `coder_workspace_tags` being cumulative and a new step to
validate the status of the prebuild provisioners.
Fix steps formatting.
This commit is contained in:
Susana Ferreira
2025-10-16 11:22:48 +01:00
committed by GitHub
parent 0faee8e913
commit 104aa19014
2 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin/templates/extending-templates/prebuilt-workspaces.md
+6 -2
View File
@@ -379,6 +379,7 @@ This keeps other provisioners available to handle user-initiated jobs.
1) Create a provisioner key with a prebuild tag (e.g., `is_prebuild=true`).
Provisioner keys are org-scoped and their tags are inferred automatically by provisioner daemons that use the key.
**Note:** `coder_workspace_tags` are cumulative, so if your template already defines provisioner tags, you will need to create the provisioner key with the same tags plus the `is_prebuild=true` tag so that prebuild jobs correctly match the dedicated prebuild pool.
See [Scoped Key](../../provisioners/index.md#scoped-key-recommended) for instructions on how to create a provisioner key.
2) Deploy a separate provisioner pool using that key (for example, via the [Helm coder-provisioner chart](https://github.com/coder/coder/pkgs/container/chart%2Fcoder-provisioner)).
@@ -412,12 +413,15 @@ Follow these steps:
1) Publish the new template version.
2) Wait for the prebuilds reconciliation loop to run.
2) Validate the status of the prebuild provisioners.
Check the Provisioners page in the Coder dashboard or run the [`coder provisioner list`](../../../reference/cli/provisioner_list.md) CLI command to ensure all prebuild provisioners are up to date and the tags are properly set.
3) Wait for the prebuilds reconciliation loop to run.
The loop frequency is controlled by the configuration value [`CODER_WORKSPACE_PREBUILDS_RECONCILIATION_INTERVAL`](../../../reference/cli/server.md#--workspace-prebuilds-reconciliation-interval).
When the loop runs, it will provision prebuilds for the new template version and deprovision prebuilds for the previous version.
Both provisioning and deprovisioning jobs for prebuilds should display the tag `is_prebuild=true`.
3) Create a new workspace from a preset.
4) Create a new workspace from a preset.
Whether the preset uses a prebuild pool or not, the resulting job should not include the `is_prebuild=true` tag.
This confirms that only prebuild-related jobs are routed to the dedicated prebuild provisioner pool.
docs/admin/templates/extending-templates/workspace-tags.md
+3
View File
@@ -74,6 +74,9 @@ that every tag set is associated with at least one healthy provisioner.
> [!NOTE]
> It may be useful to run at least one provisioner with no additional
> tag restrictions that is able to take on any job.
>
> `coder_workspace_tags` are cumulative.
> Jobs will only match provisioners that have all tags defined in both your template configuration and `coder_workspace_tags`.
### Parameters types