You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/admin/templates/extending-templates/prebuilt-workspaces.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -377,27 +377,27 @@ This keeps other provisioners available to handle user-initiated jobs.
377
377
378
378
#### Setup
379
379
380
-
1) Create a provisioner key with a prebuild tag (e.g., `is_prebuild=true`).
381
-
Provisioner keys are org-scoped and their tags are inferred automatically by provisioner daemons that use the key.
382
-
**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.
383
-
See [Scoped Key](../../provisioners/index.md#scoped-key-recommended) for instructions on how to create a provisioner key.
384
-
385
-
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)).
386
-
Daemons in this pool will only execute jobs that include all of the tags specified in their provisioner key.
387
-
See [External provisioners](../../provisioners/index.md) for environment-specific deployment examples.
388
-
389
-
3) Update the template to conditionally add the prebuild tag for prebuild jobs.
1. Create a provisioner key with a prebuild tag (e.g., `is_prebuild=true`).
381
+
Provisioner keys are org-scoped and their tags are inferred automatically by provisioner daemons that use the key.
382
+
**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.
383
+
See [Scoped Key](../../provisioners/index.md#scoped-key-recommended) for instructions on how to create a provisioner key.
384
+
385
+
1. 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)).
386
+
Daemons in this pool will only execute jobs that include all of the tags specified in their provisioner key.
387
+
See [External provisioners](../../provisioners/index.md) for environment-specific deployment examples.
388
+
389
+
1. Update the template to conditionally add the prebuild tag for prebuild jobs.
Prebuild workspaces are a special type of workspace owned by the system user `prebuilds`.
400
+
Prebuild workspaces are a special type of workspace owned by the system user `prebuild`.
401
401
The value `data.coder_workspace_owner.me.name` returns the name of the workspace owner, for prebuild workspaces, this value is `"prebuild"`.
402
402
Because the condition evaluates based on the workspace owner, provisioning or deprovisioning prebuilds automatically applies the prebuild tag, whereas regular jobs (like workspace creation or template import) do not.
403
403
@@ -411,19 +411,19 @@ Because the condition evaluates based on the workspace owner, provisioning or de
411
411
To confirm that prebuild jobs are correctly routed to the new provisioner pool, use the Provisioner Jobs dashboard or the [`coder provisioner jobs list`](../../../reference/cli/provisioner_jobs_list.md) CLI command to inspect job metadata and tags.
412
412
Follow these steps:
413
413
414
-
1) Publish the new template version.
414
+
1. Publish the new template version.
415
415
416
-
2) Validate the status of the prebuild provisioners.
417
-
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.
416
+
1. Validate the status of the prebuild provisioners.
417
+
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.
418
418
419
-
3) Wait for the prebuilds reconciliation loop to run.
420
-
The loop frequency is controlled by the configuration value [`CODER_WORKSPACE_PREBUILDS_RECONCILIATION_INTERVAL`](../../../reference/cli/server.md#--workspace-prebuilds-reconciliation-interval).
421
-
When the loop runs, it will provision prebuilds for the new template version and deprovision prebuilds for the previous version.
422
-
Both provisioning and deprovisioning jobs for prebuilds should display the tag `is_prebuild=true`.
419
+
1. Wait for the prebuilds reconciliation loop to run.
420
+
The loop frequency is controlled by the configuration value [`CODER_WORKSPACE_PREBUILDS_RECONCILIATION_INTERVAL`](../../../reference/cli/server.md#--workspace-prebuilds-reconciliation-interval).
421
+
When the loop runs, it will provision prebuilds for the new template version and deprovision prebuilds for the previous version.
422
+
Both provisioning and deprovisioning jobs for prebuilds should display the tag `is_prebuild=true`.
423
423
424
-
4) Create a new workspace from a preset.
425
-
Whether the preset uses a prebuild pool or not, the resulting job should not include the `is_prebuild=true` tag.
426
-
This confirms that only prebuild-related jobs are routed to the dedicated prebuild provisioner pool.
424
+
1. Create a new workspace from a preset.
425
+
Whether the preset uses a prebuild pool or not, the resulting job should not include the `is_prebuild=true` tag.
426
+
This confirms that only prebuild-related jobs are routed to the dedicated prebuild provisioner pool.
0 commit comments