Add `immutable` on `PodFailurePolicyRule` in docs

[BBBmau]

This is a Bug Report

Problem:

When applying a PodFailurePolicy on an already made CronJob, it returns a invalid value stating that the PodFailurePolicy is an immutable field. This isn't brought up anywhere when checking the docs.

 Invalid value: batch.PodFailurePolicy{Rules:[]batch.PodFailurePolicyRule(nil)}: field is immutable

Proposed Solution: Update docs so that PodFailurePolicyRule is an immutable field in CronJobs

Page to Update: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podfailurepolicyrule-v1-batch

[pranav-pandey0804]

/sig docs

[pranav-pandey0804]

/language en

[pranav-pandey0804]

Hi @BBBmau Thanks for highlighting this issue regarding the PodFailurePolicy on CronJob. I t's indeed crucial for the documentation to accurately reflect the immutable nature of PodFailurePolicyRule to avoid confusion. I suggest bringing this to the attention of SIG Docs for the documentation update and possibly SIG Apps for any related API considerations. This will ensure clarity and accuracy in the Kubernetes documentation for all users.

[pranav-pandey0804]

/sig apps

[arujjval]

/assign

[a-mccarthy]

hey @arujjval are you still willing to work on this issue?

as noted in this comment, https://github.com/kubernetes/website/pull/44977/files#r1474125105, This page is auto-generated from the upstream source code, any fixes would need to be addressed there. Please refer to the upstream contribution guidelines outlined at: https://kubernetes.io/docs/contribute/generate-ref-docs/contribute-upstream/, https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-api/

/triage accepted /priority longterm-important

[k8s-ci-robot]

@a-mccarthy: The label(s) priority/longterm-important cannot be applied, because the repository doesn't have them.

In response to [this](https://github.com/kubernetes/website/issues/44952#issuecomment-2023773617): >hey @arujjval are you still willing to work on this issue? > >as noted in this comment, https://github.com/kubernetes/website/pull/44977/files#r1474125105, This [page](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/) is auto-generated from the upstream source code, any fixes would need to be addressed there. Please refer to the upstream contribution guidelines outlined at: https://kubernetes.io/docs/contribute/generate-ref-docs/contribute-upstream/, https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-api/ > >/triage accepted >/priority longterm-important Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.

[a-mccarthy]

/priority-longterm-important

[a-mccarthy]

/priority important-longterm

[tengqm]

To be more specific, this issue should be fixed here: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/api/batch/v1/types.go#L331-L342. Please consider close the issue here and raise a PR in the upstream project?