- Notifications
You must be signed in to change notification settings - Fork1.1k
chore(docs): update numbered lists to be consistent#20350
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
60 changes: 30 additions & 30 deletionsdocs/admin/templates/extending-templates/prebuilt-workspaces.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -377,27 +377,27 @@ This keeps other provisioners available to handle user-initiated jobs. | ||
| #### Setup | ||
| 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. | ||
| 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)). | ||
| Daemons in this pool will only execute jobs that include all of the tags specified in their provisioner key. | ||
| See [External provisioners](../../provisioners/index.md) for environment-specific deployment examples. | ||
| 1. Update the template to conditionally add the prebuild tag for prebuild jobs. | ||
| ```hcl | ||
| data "coder_workspace_tags" "prebuilds" { | ||
| count = data.coder_workspace_owner.me.name == "prebuilds" ? 1 : 0 | ||
| tags = { | ||
| "is_prebuild" = "true" | ||
| } | ||
| } | ||
| ``` | ||
| Prebuild workspaces are a special type of workspace owned by the system user `prebuild`. | ||
matifali marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| The value `data.coder_workspace_owner.me.name` returns the name of the workspace owner, for prebuild workspaces, this value is `"prebuild"`. | ||
| 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. | ||
| @@ -411,19 +411,19 @@ Because the condition evaluates based on the workspace owner, provisioning or de | ||
| 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. | ||
| Follow these steps: | ||
| 1. Publish the new template version. | ||
| 1. 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. | ||
| 1. 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`. | ||
| 1. 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. | ||
| ### Monitoring and observability | ||
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.