mirror of
https://github.com/coder/coder.git
synced 2026-09-21 20:51:01 +08:00
docs: document workspace presets feature (#16612)
closes #16475 relates to #16304 - [x] reword opening sentence to clarify where this is done - I think this is set because it's under parameters now - [x] list of configurable settings - same as above - [x] (optional) screenshot [preview](https://coder.com/docs/@16475-workspace-presets/admin/templates/extending-templates/parameters#workspace-presets) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
co-authored by
EdwardAngert
parent
9251e0d642
commit
0913594bfc
@@ -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.
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
Reference in New Issue
Block a user