feat(workspace): add auto destroy attribute to resource and data source #1354

notchairmk · 2024-05-09T19:07:19Z

Description

This change adds auto_destroy_at to Workspace resource and data source schemas. The Workspaces API accepts three possible types of values for auto_destroy_at:

a set value
- e.g. a payload with the shape { "data": { "attributes": { "name": "some-workspace", "auto-destroy-at": "2006-01-02T15:04:05Z" }}}
an ignored value
- e.g. a payload with the shape { "data": { "attributes": { "name": "some-workspace" }}}
and an unset value
- e.g. a payload with the shape { "data": { "attributes": { "name": "some-workspace", "auto-destroy-at": null }}}

Remember to:

Update the Change Log
Update the Documentation

Testing plan

(these follow the integration tests added as part of these changes)

create a workspace with auto_destroy_at unset

resource "tfe_workspace" "foobar" {
  name            = "workspace-test-0"
  organization    = "hashicorp"
}

confirm no diffs for future plans

update the workspace with a set auto_destroy_at

resource "tfe_workspace" "foobar" {
  name            = "workspace-test-0"
  organization    = "hashicorp"
  auto_destroy_at = "2024-05-31T14:04:00Z"
}

confirm that auto_destroy_at is set in state and that no further diff occurs with future plans
repeat above steps but creating workspace with auto_destroy_at then removing in the update

External links

Include any links here that might be helpful for people reviewing your PR. If there are none, feel free to delete this section.

Output from acceptance tests

Please run applicable acceptance tests locally and include the output here. See testing.md to learn how to run acceptance tests.

If you are an external contributor, your contribution(s) will first be reviewed before running them against the project's CI pipeline.

Tested against local TFE, but these auto_destroy_at changes are out in production TFC.

➜  ~/h/terraform-provider-tfe git:(notchairmk/workspace-auto-destroy) TFE_HOSTNAME=<host> TFE_TOKEN=<token> TESTARGS="-run TestAccTFEWorkspace.*AutoDestroyAt" make testacc
TF_ACC=1 TF_LOG_SDK_PROTO=OFF go test $(go list ./... |grep -v 'vendor') -v -run TestAccTFEWorkspace.*AutoDestroyAt -timeout 15m
?   	github.com/hashicorp/terraform-provider-tfe	[no test files]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-tfe/internal/client	(cached) [no tests to run]
testing: warning: no tests to run
PASS
ok  	github.com/hashicorp/terraform-provider-tfe/internal/logging	(cached) [no tests to run]
?   	github.com/hashicorp/terraform-provider-tfe/internal/provider/validators	[no test files]
?   	github.com/hashicorp/terraform-provider-tfe/version	[no test files]
=== RUN   TestAccTFEWorkspaceDataSource_readAutoDestroyAt
--- PASS: TestAccTFEWorkspaceDataSource_readAutoDestroyAt (10.10s)
=== RUN   TestAccTFEWorkspace_createWithAutoDestroyAt
--- PASS: TestAccTFEWorkspace_createWithAutoDestroyAt (5.61s)
=== RUN   TestAccTFEWorkspace_updateWithAutoDestroyAt
--- PASS: TestAccTFEWorkspace_updateWithAutoDestroyAt (11.59s)
PASS
ok  	github.com/hashicorp/terraform-provider-tfe/internal/provider	27.816s

internal/provider/provider_custom_diffs.go

emailnitram

Is it worth documenting that once the destroy plan is run the auto_destroy_at attribute will be deleted there will be a plan diff (drift)?

emailnitram

tested locally and working as expected

brandonc

Just a few thought-provoking questions. I'm still trying to wrap my head around the IaC use case for this

brandonc · 2024-05-17T16:55:17Z

website/docs/r/workspace.html.markdown

@@ -68,6 +68,10 @@ The following arguments are supported:
 * `assessments_enabled` - (Optional) Whether to regularly run health assessments such as drift detection on the workspace. Defaults to `false`.
 * `auto_apply` - (Optional) Whether to automatically apply changes when a Terraform plan is successful. Defaults to `false`.
 * `auto_apply_run_trigger` - (Optional) Whether to automatically apply changes for runs that were created by run triggers from another workspace. Defaults to `false`.
+* `auto_destroy_at` - (Optional) A future date/time string at which point all resources in a workspace will be scheduled for deletion. Must be a string in RFC3339 format (e.g. "2100-01-01T00:00:00Z").
+
+~> **NOTE:** `auto_destroy_at` is not intended for workspaces containing production resources. Additionally, the field is partially managed by HCP Terraform so usage with any long-lived workspaces may cause a perpetual diff.


If the platform is going to change this value, I think it should be marked as computed in the schema to avoid 'perpetual diff' though I think it may still happen if the config is different. When does HCP Terraform change this value? After the auto destroy comes to pass?

Marking it as computed would at least allow users to manage the workspace with the tfe provider but the auto-destroy-at configuration could be managed in the UI without causing drift in the next plan.

"perpetual diff" is sloppy phrasing on my part, because the HCP Terraform API will respect the value set by the provider. but there will be contention because both pieces are effectively managing the workspace. I agree with your other comment that this doesn't make as much sense in an IaC context, however we have discussed this with enterprise teams and they have expressed a desire to control this specifically through the provider.

yeah, HCP Terraform will unset auto_destroy_at after a destroy run occurs.

I did initially have this as a computed attribute but allowing the user to set "meaningful null" values added significantly more complexity (specifically where the user has set the value but then removes auto_destroy_at from the TF config). what's in this PR ended up feeling like the provider SDK's preferred path for allowing for meaningful null values.

we will need to make this computed, but the drift we'd be trying to work around is actually intended behavior that will be more explicit once we factor in logic around the duration attribute (update forthcoming here hashicorp/go-tfe#902). changes for the duration attribute will be compatible with the behavior in this PR.

Is it the intention that a tfe_workspace without a auto_destroy_at config should unset any drifted autodestroy setting?

Usually this kind of drift correction is good but in the case of auto_destroy, it seems like terraform wouldn't be the best source of that config.

Methodology:

create workspace using basic config with no auto destroy

set up auto destroy in the UI

terraform apply

Outcome:
terraform plans to unset the auto destroy setting

Is it the intention that a tfe_workspace without a auto_destroy_at config should unset any drifted autodestroy setting?

By default, yes. Talked this through with @jondavidjohn and the way we're leaning (Jon correct me if I'm wrong) is how it's currently implemented because it allows the most flexibility for users.

@brandonc your argument makes sense: there are cases where the user may want to ignore changes to this specific field. If that's the case we can recommend that they use an ignore_changes here. My argument is that as a user, there are cases where I would explicitly want to be alerted if somebody set auto destroy on my workspace – in this case I always want to show the diff.

If we specifically ignore the diff within the provider there's no way to override that behavior as a user, but there is more flexibility if we default to showing a diff.

brandonc · 2024-05-17T17:15:09Z

website/docs/r/workspace.html.markdown

@@ -68,6 +68,10 @@ The following arguments are supported:
 * `assessments_enabled` - (Optional) Whether to regularly run health assessments such as drift detection on the workspace. Defaults to `false`.
 * `auto_apply` - (Optional) Whether to automatically apply changes when a Terraform plan is successful. Defaults to `false`.
 * `auto_apply_run_trigger` - (Optional) Whether to automatically apply changes for runs that were created by run triggers from another workspace. Defaults to `false`.
+* `auto_destroy_at` - (Optional) A future date/time string at which point all resources in a workspace will be scheduled for deletion. Must be a string in RFC3339 format (e.g. "2100-01-01T00:00:00Z").


I'm trying to imagine how a static date could be useful in the context of config. Likely this data would come from a variable, but aside from that it will be inevitable that they will define a relative time that will end up changing with every plan.

timeadd(timestamp(), "1h")

notchairmk self-assigned this May 9, 2024

notchairmk requested a review from a team as a code owner May 9, 2024 19:07

notchairmk requested a review from a team May 9, 2024 19:07

notchairmk commented May 9, 2024

View reviewed changes

internal/provider/provider_custom_diffs.go Outdated Show resolved Hide resolved

notchairmk force-pushed the notchairmk/workspace-auto-destroy branch 3 times, most recently from bee7df9 to 17f66fa Compare May 9, 2024 23:51

feat(workspace): add auto destroy attribute to resource and data source

615ea2e

notchairmk force-pushed the notchairmk/workspace-auto-destroy branch from c87fc41 to 615ea2e Compare May 10, 2024 15:27

notchairmk and others added 3 commits May 14, 2024 07:48

standardize auto destroy error messages

2df7f06

Merge branch 'main' into notchairmk/workspace-auto-destroy

29057dd

fix changelog

6c627ac

emailnitram reviewed May 16, 2024

View reviewed changes

emailnitram approved these changes May 16, 2024

View reviewed changes

add docs note for auto_destroy_at attribute

eefc06b

brandonc reviewed May 17, 2024

View reviewed changes

notchairmk added 2 commits May 21, 2024 06:56

update docs

fe9e102

call out ignore_changes for workspace auto destroy docs

b3efa21

brandonc approved these changes May 22, 2024

View reviewed changes

notchairmk merged commit 5219dbf into main May 22, 2024
6 checks passed

notchairmk deleted the notchairmk/workspace-auto-destroy branch May 22, 2024 18:30

thrashr888 mentioned this pull request May 28, 2024

tfe_workspace resource does not support auto-destroy features #1157

Closed

notchairmk mentioned this pull request Jun 13, 2024

feat(workspace): add auto destroy activity duration #1377

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(workspace): add auto destroy attribute to resource and data source #1354

feat(workspace): add auto destroy attribute to resource and data source #1354

notchairmk commented May 9, 2024 •

edited

Loading

emailnitram left a comment

emailnitram left a comment

brandonc left a comment

brandonc May 17, 2024

brandonc May 17, 2024

notchairmk May 20, 2024

notchairmk May 21, 2024

brandonc May 21, 2024

notchairmk May 22, 2024

brandonc May 17, 2024

feat(workspace): add auto destroy attribute to resource and data source #1354

feat(workspace): add auto destroy attribute to resource and data source #1354

Conversation

notchairmk commented May 9, 2024 • edited Loading

Description

Testing plan

External links

Output from acceptance tests

emailnitram left a comment

Choose a reason for hiding this comment

emailnitram left a comment

Choose a reason for hiding this comment

brandonc left a comment

Choose a reason for hiding this comment

brandonc May 17, 2024

Choose a reason for hiding this comment

brandonc May 17, 2024

Choose a reason for hiding this comment

notchairmk May 20, 2024

Choose a reason for hiding this comment

notchairmk May 21, 2024

Choose a reason for hiding this comment

brandonc May 21, 2024

Choose a reason for hiding this comment

notchairmk May 22, 2024

Choose a reason for hiding this comment

brandonc May 17, 2024

Choose a reason for hiding this comment

notchairmk commented May 9, 2024 •

edited

Loading