diff --git a/docs/data-sources/workspace_preset.md b/docs/data-sources/workspace_preset.md
index 14e235f9..cd4908c2 100644
--- a/docs/data-sources/workspace_preset.md
+++ b/docs/data-sources/workspace_preset.md
@@ -51,3 +51,14 @@ data "coder_workspace_preset" "example" {
Required:
- `instances` (Number) The number of workspaces to keep in reserve for this preset.
+
+Optional:
+
+- `expiration_policy` (Block Set, Max: 1) Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date. (see [below for nested schema](#nestedblock--prebuilds--expiration_policy))
+
+
+### Nested Schema for `prebuilds.expiration_policy`
+
+Required:
+
+- `ttl` (Number) Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.
diff --git a/integration/integration_test.go b/integration/integration_test.go
index a5019635..36612904 100644
--- a/integration/integration_test.go
+++ b/integration/integration_test.go
@@ -90,11 +90,12 @@ func TestIntegration(t *testing.T) {
// TODO (sasswart): the cli doesn't support presets yet.
// once it does, the value for workspace_parameter.value
// will be the preset value.
- "workspace_parameter.value": `param value`,
- "workspace_parameter.icon": `param icon`,
- "workspace_preset.name": `preset`,
- "workspace_preset.parameters.param": `preset param value`,
- "workspace_preset.prebuilds.instances": `1`,
+ "workspace_parameter.value": `param value`,
+ "workspace_parameter.icon": `param icon`,
+ "workspace_preset.name": `preset`,
+ "workspace_preset.parameters.param": `preset param value`,
+ "workspace_preset.prebuilds.instances": `1`,
+ "workspace_preset.prebuilds.expiration_policy.ttl": `86400`,
},
},
{
diff --git a/integration/test-data-source/main.tf b/integration/test-data-source/main.tf
index f18fa347..50274fff 100644
--- a/integration/test-data-source/main.tf
+++ b/integration/test-data-source/main.tf
@@ -27,6 +27,9 @@ data "coder_workspace_preset" "preset" {
prebuilds {
instances = 1
+ expiration_policy {
+ ttl = 86400
+ }
}
}
@@ -52,6 +55,7 @@ locals {
"workspace_preset.name" : data.coder_workspace_preset.preset.name,
"workspace_preset.parameters.param" : data.coder_workspace_preset.preset.parameters.param,
"workspace_preset.prebuilds.instances" : tostring(one(data.coder_workspace_preset.preset.prebuilds).instances),
+ "workspace_preset.prebuilds.expiration_policy.ttl" : tostring(one(one(data.coder_workspace_preset.preset.prebuilds).expiration_policy).ttl),
}
}
diff --git a/provider/workspace_preset.go b/provider/workspace_preset.go
index 78466c10..e9c697c7 100644
--- a/provider/workspace_preset.go
+++ b/provider/workspace_preset.go
@@ -22,6 +22,16 @@ type WorkspacePreset struct {
type WorkspacePrebuild struct {
Instances int `mapstructure:"instances"`
+ // There should always be only one expiration_policy block, but Terraform's type system
+ // still parses them as a slice, so we need to handle it as such. We could use
+ // an anonymous type and rd.Get to avoid a slice here, but that would not be possible
+ // for utilities that parse our terraform output using this type. To remain compatible
+ // with those cases, we use a slice here.
+ ExpirationPolicy []ExpirationPolicy `mapstructure:"expiration_policy"`
+}
+
+type ExpirationPolicy struct {
+ TTL int `mapstructure:"ttl"`
}
func workspacePresetDataSource() *schema.Resource {
@@ -81,6 +91,24 @@ func workspacePresetDataSource() *schema.Resource {
ForceNew: true,
ValidateFunc: validation.IntAtLeast(0),
},
+ "expiration_policy": {
+ Type: schema.TypeSet,
+ Description: "Configuration block that defines TTL (time-to-live) behavior for prebuilds. Use this to automatically invalidate and delete prebuilds after a certain period, ensuring they stay up-to-date.",
+ Optional: true,
+ MaxItems: 1,
+ Elem: &schema.Resource{
+ Schema: map[string]*schema.Schema{
+ "ttl": {
+ Type: schema.TypeInt,
+ Description: "Time in seconds after which an unclaimed prebuild is considered expired and eligible for cleanup.",
+ Required: true,
+ ForceNew: true,
+ // Ensure TTL is between 0 and 31536000 seconds (1 year) to prevent stale prebuilds
+ ValidateFunc: validation.IntBetween(0, 31536000),
+ },
+ },
+ },
+ },
},
},
},
diff --git a/provider/workspace_preset_test.go b/provider/workspace_preset_test.go
index aa1ca0ce..d9f7da46 100644
--- a/provider/workspace_preset_test.go
+++ b/provider/workspace_preset_test.go
@@ -144,6 +144,83 @@ func TestWorkspacePreset(t *testing.T) {
return nil
},
},
+ {
+ Name: "Prebuilds is set with a expiration_policy field without its required fields",
+ Config: `
+ data "coder_workspace_preset" "preset_1" {
+ name = "preset_1"
+ parameters = {
+ "region" = "us-east1-a"
+ }
+ prebuilds {
+ instances = 1
+ expiration_policy {}
+ }
+ }`,
+ ExpectError: regexp.MustCompile("The argument \"ttl\" is required, but no definition was found."),
+ },
+ {
+ Name: "Prebuilds is set with a expiration_policy field with its required fields",
+ Config: `
+ data "coder_workspace_preset" "preset_1" {
+ name = "preset_1"
+ parameters = {
+ "region" = "us-east1-a"
+ }
+ prebuilds {
+ instances = 1
+ expiration_policy {
+ ttl = 86400
+ }
+ }
+ }`,
+ ExpectError: nil,
+ Check: func(state *terraform.State) error {
+ require.Len(t, state.Modules, 1)
+ require.Len(t, state.Modules[0].Resources, 1)
+ resource := state.Modules[0].Resources["data.coder_workspace_preset.preset_1"]
+ require.NotNil(t, resource)
+ attrs := resource.Primary.Attributes
+ require.Equal(t, attrs["name"], "preset_1")
+ require.Equal(t, attrs["prebuilds.0.expiration_policy.0.ttl"], "86400")
+ return nil
+ },
+ },
+ {
+ Name: "Prebuilds block with expiration_policy.ttl set to 2 years (exceeds 1 year limit)",
+ Config: `
+ data "coder_workspace_preset" "preset_1" {
+ name = "preset_1"
+ parameters = {
+ "region" = "us-east1-a"
+ }
+ prebuilds {
+ instances = 1
+ expiration_policy {
+ ttl = 63072000
+ }
+ }
+ }`,
+ ExpectError: regexp.MustCompile(`expected prebuilds.0.expiration_policy.0.ttl to be in the range \(0 - 31536000\), got 63072000`),
+ },
+ {
+ Name: "Prebuilds is set with a expiration_policy field with its required fields and an unexpected argument",
+ Config: `
+ data "coder_workspace_preset" "preset_1" {
+ name = "preset_1"
+ parameters = {
+ "region" = "us-east1-a"
+ }
+ prebuilds {
+ instances = 1
+ expiration_policy {
+ ttl = 86400
+ invalid_argument = "test"
+ }
+ }
+ }`,
+ ExpectError: regexp.MustCompile("An argument named \"invalid_argument\" is not expected here."),
+ },
}
for _, testcase := range testcases {
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy