"restart_policy" is wrongly documented at least for kubernetes_deployment resource

[daniel-dona]

Terraform Version, Provider Version and Kubernetes Version

Terraform version: -
Kubernetes provider version: 2.32.0
Kubernetes version: -

Affected Resource(s)

• documentation

Important Factoids

This seems to start in a pretty old ticket kubernetes/kubernetes#24725 as not all restart policies are supported depending on the resource kind. But this is not clear in the documentation, that just list the options but not if they apply to that resource type.

People then are facing a confusing error message like this one:
Unsupported value: "OnFailure": supported values: "Always"

For me doesn't make a lot of sense to have an option that only have one valid value. But I think is more critical to proper document that. Lot's of frustrated people with this...

References

• terraform-provider-kubernetes/docs/resources/deployment.md

  Line 114 in 9d6074c

  - `restart_policy` (String) Restart policy for all containers within the pod. One of Always, OnFailure, Never. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy.

• https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/deployment#restart_policy

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]

Thanks for catching this. A fix is on the way.