Skip to content

docs: document workspace presets feature #16612

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

Merged
merged 11 commits into from
Mar 5, 2025
Merged

docs: document workspace presets feature #16612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f5be2a7
init workspace presets
EdwardAngert Feb 18, 2025
b24deaf
move presets to parameters
EdwardAngert Feb 24, 2025
d73abd0
example of prebuild
EdwardAngert Feb 24, 2025
45d9caf
s/tabs/spaces
EdwardAngert Feb 24, 2025
faee979
rm prebuilt
EdwardAngert Feb 25, 2025
6cedd01
fix extra presets that should be params
EdwardAngert Feb 25, 2025
fa0a54a
copy edit
EdwardAngert Feb 25, 2025
5d5db87
available for new
EdwardAngert Feb 25, 2025
e190310
Merge remote-tracking branch 'origin/main' into 16475-workspace-presets
EdwardAngert Feb 26, 2025
e82afb3
add preset screenshot
EdwardAngert Feb 26, 2025
7bada4b
Merge remote-tracking branch 'origin/main' into 16475-workspace-presets
EdwardAngert Feb 27, 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
56 changes: 56 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 @@ -313,6 +313,62 @@ data "coder_parameter" "project_id" {
}
```

## Workspace presets

Workspace presets allow you to configure commonly used combinations of parameters
into a single option, which makes it easier for developers to pick one that fits
their needs.

![Template with options in the preset dropdown](../../../images/admin/templates/extend-templates/template-preset-dropdown.png)

Use `coder_workspace_preset` to define the preset parameters.
After you save the template file, the presets will be available for all new
workspace deployments.

<details><summary>Expand for an example</summary>

```tf
data "coder_workspace_preset" "goland-gpu" {
name = "GoLand with GPU"
parameters = {
"machine_type" = "n1-standard-1"
"attach_gpu" = "true"
"gcp_region" = "europe-west4-c"
"jetbrains_ide" = "GO"
}
}

data "coder_parameter" "machine_type" {
name = "machine_type"
display_name = "Machine Type"
type = "string"
default = "n1-standard-2"
}

data "coder_parameter" "attach_gpu" {
name = "attach_gpu"
display_name = "Attach GPU?"
type = "bool"
default = "false"
}

data "coder_parameter" "gcp_region" {
name = "gcp_region"
display_name = "Machine Type"
type = "string"
default = "n1-standard-2"
}

data "coder_parameter" "jetbrains_ide" {
name = "jetbrains_ide"
display_name = "Machine Type"
type = "string"
default = "n1-standard-2"
}
```

</details>

## Create Autofill

When the template doesn't specify default values, Coder may still autofill
Expand Down
Binary file added docs/images/admin/templates/extend-templates/template-preset-dropdown.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading