Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit71097ea

Browse files
committed
feat: implement default preset
Partially addressescoder/coder#18110Signed-off-by: Danny Kopping <dannykopping@gmail.com>
1 parenteee4ed5 commit71097ea

File tree

5 files changed

+87
-1
lines changed

5 files changed

+87
-1
lines changed

‎docs/data-sources/workspace_preset.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ data "coder_workspace_preset" "example" {
2727
(data.coder_parameter.ami.name) = "ami-xxxxxxxx"
2828
}
2929
}
30+
31+
# Example of a default preset that will be pre-selected for users
32+
data "coder_workspace_preset" "standard" {
33+
name = "Standard"
34+
default = true
35+
parameters = {
36+
(data.coder_parameter.instance_type.name) = "t3.medium"
37+
(data.coder_parameter.region.name) = "us-west-2"
38+
}
39+
}
3040
```
3141

3242
<!-- schema generated by tfplugindocs-->
@@ -38,6 +48,7 @@ data "coder_workspace_preset" "example" {
3848

3949
###Optional
4050

51+
-`default` (Boolean) Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.
4152
-`parameters` (Map of String) Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.
4253
-`prebuilds` (Block Set, Max: 1) Configuration for prebuilt workspaces associated with this preset. Coder will maintain a pool of standby workspaces based on this configuration. When a user creates a workspace using this preset, they are assigned a prebuilt workspace instead of waiting for a new one to build. See prebuilt workspace documentation[here](https://coder.com/docs/admin/templates/extending-templates/prebuilt-workspaces.md) (see[below for nested schema](#nestedblock--prebuilds))
4354

‎examples/data-sources/coder_workspace_preset/data-source.tf

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,13 @@ data "coder_workspace_preset" "example" {
1212
(data.coder_parameter.ami.name)="ami-xxxxxxxx"
1313
}
1414
}
15+
16+
# Example of a default preset that will be pre-selected for users
17+
data"coder_workspace_preset""standard" {
18+
name="Standard"
19+
default=true
20+
parameters={
21+
(data.coder_parameter.instance_type.name)="t3.medium"
22+
(data.coder_parameter.region.name)="us-west-2"
23+
}
24+
}

‎integration/test-data-source/main.tf

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ data "coder_parameter" "param" {
2020
icon="param icon"
2121
}
2222
data"coder_workspace_preset""preset" {
23-
name="preset"
23+
name="preset"
24+
default=true
2425
parameters={
2526
(data.coder_parameter.param.name)="preset param value"
2627
}
@@ -53,6 +54,7 @@ locals {
5354
"workspace_parameter.value": data.coder_parameter.param.value,
5455
"workspace_parameter.icon": data.coder_parameter.param.icon,
5556
"workspace_preset.name": data.coder_workspace_preset.preset.name,
57+
"workspace_preset.default":tostring(data.coder_workspace_preset.preset.default),
5658
"workspace_preset.parameters.param": data.coder_workspace_preset.preset.parameters.param,
5759
"workspace_preset.prebuilds.instances":tostring(one(data.coder_workspace_preset.preset.prebuilds).instances),
5860
"workspace_preset.prebuilds.expiration_policy.ttl":tostring(one(one(data.coder_workspace_preset.preset.prebuilds).expiration_policy).ttl),

‎provider/workspace_preset.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212

1313
typeWorkspacePresetstruct {
1414
Namestring`mapstructure:"name"`
15+
Defaultbool`mapstructure:"default"`
1516
Parametersmap[string]string`mapstructure:"parameters"`
1617
// There should always be only one prebuild block, but Terraform's type system
1718
// still parses them as a slice, so we need to handle it as such. We could use
@@ -68,6 +69,12 @@ func workspacePresetDataSource() *schema.Resource {
6869
Required:true,
6970
ValidateFunc:validation.StringIsNotEmpty,
7071
},
72+
"default": {
73+
Type:schema.TypeBool,
74+
Description:"Whether this preset should be selected by default when creating a workspace. Only one preset per template can be marked as default.",
75+
Optional:true,
76+
Default:false,
77+
},
7178
"parameters": {
7279
Type:schema.TypeMap,
7380
Description:"Workspace parameters that will be set by the workspace preset. For simple templates that only need prebuilds, you may define a preset with zero parameters. Because workspace parameters may change between Coder template versions, preset parameters are allowed to define values for parameters that do not exist in the current template version.",

‎provider/workspace_preset_test.go

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,62 @@ func TestWorkspacePreset(t *testing.T) {
265265
}`,
266266
ExpectError:regexp.MustCompile("An argument named\"invalid_argument\" is not expected here."),
267267
},
268+
{
269+
Name:"Default field set to true",
270+
Config:`
271+
data "coder_workspace_preset" "preset_1" {
272+
name = "preset_1"
273+
default = true
274+
parameters = {
275+
"region" = "us-east1-a"
276+
}
277+
}`,
278+
Check:func(state*terraform.State)error {
279+
require.Len(t,state.Modules,1)
280+
require.Len(t,state.Modules[0].Resources,1)
281+
resource:=state.Modules[0].Resources["data.coder_workspace_preset.preset_1"]
282+
require.NotNil(t,resource)
283+
require.Equal(t,resource.Primary.Attributes["default"],"true")
284+
returnnil
285+
},
286+
},
287+
{
288+
Name:"Default field set to false",
289+
Config:`
290+
data "coder_workspace_preset" "preset_1" {
291+
name = "preset_1"
292+
default = false
293+
parameters = {
294+
"region" = "us-east1-a"
295+
}
296+
}`,
297+
Check:func(state*terraform.State)error {
298+
require.Len(t,state.Modules,1)
299+
require.Len(t,state.Modules[0].Resources,1)
300+
resource:=state.Modules[0].Resources["data.coder_workspace_preset.preset_1"]
301+
require.NotNil(t,resource)
302+
require.Equal(t,resource.Primary.Attributes["default"],"false")
303+
returnnil
304+
},
305+
},
306+
{
307+
Name:"Default field not provided (defaults to false)",
308+
Config:`
309+
data "coder_workspace_preset" "preset_1" {
310+
name = "preset_1"
311+
parameters = {
312+
"region" = "us-east1-a"
313+
}
314+
}`,
315+
Check:func(state*terraform.State)error {
316+
require.Len(t,state.Modules,1)
317+
require.Len(t,state.Modules[0].Resources,1)
318+
resource:=state.Modules[0].Resources["data.coder_workspace_preset.preset_1"]
319+
require.NotNil(t,resource)
320+
require.Equal(t,resource.Primary.Attributes["default"],"false")
321+
returnnil
322+
},
323+
},
268324
}
269325

270326
for_,testcase:=rangetestcases {

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp