Skip to content

docs: add section about prebuilt workspaces to parameters doc #17205

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

docs: add section about prebuilt workspaces to parameters doc #17205

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a27a59a
add prebuilt to parameters
EdwardAngert Apr 1, 2025
9a3499e
Merge branch 'main' into prebuilds
EdwardAngert Apr 10, 2025
191680b
add qs to parameters doc
EdwardAngert Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/admin/templates/extending-templates/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,29 @@ data "coder_parameter" "jetbrains_ide" {

</details>

## Prebuilt workspaces

Prebuilt workspaces expand on presets and allow you to provision a ready-to-deploy workspace with a defined set of parameters.

You can use prebuilt workspaces to ensure that workspaces can be deployed within one minute.
Use the `prebuilds` parameter to define how many instances of the template should be stored as a prebuilt workspace.

When a developer selects the associated template, the workspace will be assigned to that developer and the server will build a new prebuilt workspace.

For example:

```hcl
...(more example here)
prebuilds {
instances = 1
}
```

- How to update user-specific data/resources after its assigned?
- Can existing templates be updated?
- Schedule workspaces?
- Do pre-builds in the pool go stale?

## Create Autofill

When the template doesn't specify default values, Coder may still autofill
Expand Down
Loading