Make target pod state / phase configurable #2200

arybolovlev · 2023-07-24T10:58:07Z

Description

Replace Pod resource option legacy_lifecycle_states to target_state. It allows to specify the Pod phase(s) that indicate whether it was successfully created. Default to Running. It allows all 5 currently available phases even though some of them may not be an indication of a successfully created pod.

Links:

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase

Acceptance tests

Have you added an acceptance test for the functionality being added?
Have you run the acceptance tests on this branch?
- All tests: hhttps://github.com/hashicorp/terraform-provider-kubernetes/actions/runs/5691661382/job/15427262240
- Pod tests: https://github.com/hashicorp/terraform-provider-kubernetes/actions/runs/5691660004/job/15427258099

Release Note

Release note for CHANGELOG:

`resource/kubernetes_pod`: add a new attribute `target_state` to specify the Pod phase(s) that indicate whether it was successfully created.

`resource/kubernetes_pod_v1`: add a new attribute `target_state` to specify the Pod phase(s) that indicate whether it was successfully created.

References

Enhance: #2141

Community Note

Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
If you are interested in working on this issue or have submitted a pull request, please leave a comment

alexsomesan · 2023-07-24T13:33:00Z

kubernetes/structures_pod.go

+		return t
+	}
+
+	return []string{string(v1.PodRunning)}


Shouldn't this rather be done with a Default: or DefaultFunc: attribute in the schema?
Feels like setting the default here makes it less obvious that there is a default value.

I might have misunderstood it a bit. This case applies when there is an explicit empty value set by the user.
A Default would be needed to cover the case where the attribute isn't configured at all by the user.

This is actually what I have stuck with and ended up with the current solution:

I can't do Default: []string{string(corev1.PodRunning)}. In this case, apply ends up with the error message saying that Default is not valid for lists or sets.

When I do Default: string(corev1.PodRunning), on the Elem level, it doesn't work too. This is what Default documentation says about this Default cannot be used if the Schema is directly an implementation of an Elem field of another Schema, such as trying to set a default value for a TypeList or TypeSet.

DefaultFunc doesn't work too. I tried DefaultFunc: func() (interface{}, error) {return []string{string(corev1.PodRunning)}, nil} on the List level and DefaultFunc: func() (interface{}, error) {return string(corev1.PodRunning), nil} on the Elem level. In both cases, d.Get("target_state") returns an empty slice.

Maybe I miss something.

I don't think you're missing anything. The List and Set types in the SDK have always had problems with defaults.

Let's just keep it the way you did it then, it also covers the case where target_state is set to an empty string or nil.

alexsomesan

LGTM. Thanks for taking another look at this.

vastep · 2023-07-29T21:25:24Z

Is __debug_bin added by mistake?

@JHeilCoveo

<Actions> <action id="60b545e3a7c08156b6118e64d9cdf055bc66d491f519bb73d2490ee2958a6c05"> <h3>Bump Terraform `kubernetes` provider version</h3> <details id="1d9343c012f5434ac9fe8a98135bae3667b399259be16d9b14302ea3bd424a24"> <summary>Update Terraform lock file</summary> <p>"hashicorp/kubernetes" updated from "2.23.0" to "2.23.0" in file ".terraform.lock.hcl"</p> <details> <summary>2.23.0</summary> <pre>Changelog retrieved from:
	https://github.com/hashicorp/terraform-provider-kubernetes/releases/tag/v2.23.0
FEATURES:

* `resource/kubernetes_cron_job_v1`: add a new volume type `ephemeral` to `spec.job_template.spec.template.spec.volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]
* `resource/kubernetes_cron_job`: add a new volume type `ephemeral` to `spec.job_template.spec.template.spec.volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]
* `resource/kubernetes_daemon_set_v1`: add a new volume type `ephemeral` to `spec.template.spec.volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]
* `resource/kubernetes_daemonset`: add a new volume type `ephemeral` to `spec.template.spec..volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]
* `resource/kubernetes_deployment_v1`: add a new volume type `ephemeral` to `spec.template.spec.volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]
* `resource/kubernetes_deployment`: add a new volume type `ephemeral` to `spec.template.spec.volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]
* `resource/kubernetes_job_v1`: add a new volume type `ephemeral` to `spec.template.spec.volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]
* `resource/kubernetes_job`: add a new volume type `ephemeral` to `spec.template.spec.volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]
* `resource/kubernetes_pod_v1`: add a new volume type `ephemeral` to `spec.volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]
* `resource/kubernetes_pod`: add a new volume type `ephemeral` to `spec.volume` to support generic ephemeral volumes. [[GH-2199](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2199)]

ENHANCEMENTS:

* `resource/kubernetes_endpoint_slice_v1`: make attribute `endpoint.condition` optional. If you had previously included an empty block `condition {}` in your configuration, we request you to remove it. Doing so will prevent receiving continuous _"update in-place"_ messages while performing the plan and apply operations. [[GH-2208](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2208)]
* `resource/kubernetes_pod_v1`: add a new attribute `target_state` to specify the Pod phase(s) that indicate whether it was successfully created. [[GH-2200](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2200)]
* `resource/kubernetes_pod`: add a new attribute `target_state` to specify the Pod phase(s) that indicate whether it was successfully created. [[GH-2200](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2200)]

BUG FIXES:

* `resource/kubernetes_manifest`: update flow in `wait` block to fix timeout bug within tf apply where the resource is created and appears in Kubernetes but does not appear in TF state file after deadline. The fix would ensure that the resource has been created in the state file while also tainting the resource requiring the user to make the necessary changes in order for their to not be another timeout error. [[GH-2163](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2163)]

DOCS:

* Fix external broken links in the documentation. [[GH-2221](https://github.com/hashicorp/terraform-provider-kubernetes/issues/2221)]

## Community Contributors 🙌

- @JHeilCoveo made their contribution in hashicorp/terraform-provider-kubernetes#2183 @baumandm made their contribution in hashicorp/terraform-provider-kubernetes#1026 @vastep made their contribution in hashicorp/terraform-provider-kubernetes#2193 @rafed made their contribution in hashicorp/terraform-provider-kubernetes#2214, https://github.com/hashicorp/terraform-provider-kubernetes/pull/2225


</pre> </details> </details> </action> </Actions> --- <table> <tr> <td width="77"> <img src="https://www.updatecli.io/images/updatecli.png" alt="Updatecli logo" width="50" height="50"> </td> <td> <p> Created automatically by <a href="https://www.updatecli.io/">Updatecli</a> </p> <details><summary>Options:</summary> <br /> <p>Most of Updatecli configuration is done via <a href="https://www.updatecli.io/docs/prologue/quick-start/">its manifest(s)</a>.</p> <ul> <li>If you close this pull request, Updatecli will automatically reopen it, the next time it runs.</li> <li>If you close this pull request and delete the base branch, Updatecli will automatically recreate it, erasing all previous commits made.</li> </ul> <p> Feel free to report any issues at <a href="https://github.com/updatecli/updatecli/issues">github.com/updatecli/updatecli</a>.<br /> If you find this tool useful, do not hesitate to star <a href="https://github.com/updatecli/updatecli/stargazers">our GitHub repository</a> as a sign of appreciation, and/or to tell us directly on our <a href="https://matrix.to/#/#Updatecli_community:gitter.im">chat</a>! </p> </details> </td> </tr> </table> Co-authored-by: Jenkins Infra Bot (updatecli) <[email protected]>

arybolovlev added 2 commits July 21, 2023 16:00

Replace pod attribute legacy_lifecycle_states with target_state

cbe653f

Update description

9452d5c

github-actions bot added documentation size/S labels Jul 24, 2023

alexsomesan reviewed Jul 24, 2023

View reviewed changes

Add Pending and Unknown phases and test

4c897f1

github-actions bot added size/M and removed size/S labels Jul 27, 2023

arybolovlev added 2 commits July 27, 2023 09:48

Add change log

7ab0639

Merge branch 'main' into fix-pod-state

592a8c4

arybolovlev marked this pull request as ready for review July 27, 2023 07:49

arybolovlev requested a review from a team as a code owner July 27, 2023 07:49

arybolovlev requested a review from alexsomesan July 27, 2023 07:49

arybolovlev added 2 commits July 27, 2023 10:50

Merge branch 'main' into fix-pod-state

5f2c0d7

Merge branch 'main' into fix-pod-state

24fccae

alexsomesan approved these changes Jul 28, 2023

View reviewed changes

arybolovlev merged commit e0afbe9 into main Jul 28, 2023

arybolovlev deleted the fix-pod-state branch July 28, 2023 13:09

github-actions bot locked as resolved and limited conversation to collaborators Jul 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make target pod state / phase configurable #2200

Make target pod state / phase configurable #2200

arybolovlev commented Jul 24, 2023 •

edited

Loading

alexsomesan Jul 24, 2023

alexsomesan Jul 24, 2023

arybolovlev Jul 25, 2023

alexsomesan Jul 26, 2023

alexsomesan left a comment

vastep commented Jul 29, 2023 •

edited

Loading

Make target pod state / phase configurable #2200

Make target pod state / phase configurable #2200

Conversation

arybolovlev commented Jul 24, 2023 • edited Loading

Description

Acceptance tests

Release Note

References

Community Note

alexsomesan Jul 24, 2023

Choose a reason for hiding this comment

alexsomesan Jul 24, 2023

Choose a reason for hiding this comment

arybolovlev Jul 25, 2023

Choose a reason for hiding this comment

alexsomesan Jul 26, 2023

Choose a reason for hiding this comment

alexsomesan left a comment

Choose a reason for hiding this comment

vastep commented Jul 29, 2023 • edited Loading

arybolovlev commented Jul 24, 2023 •

edited

Loading

vastep commented Jul 29, 2023 •

edited

Loading