Correct Keyword name for DisruptionsAllowed in PDB.

[nikhilmaheshwari24]

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR proposes a naming convention improvement for PodDisruptionBudget (PDB) configuration in Kubernetes. The key change is related to the disruptions allowed field in the PDB configuration. The proposed change is to use disruptionsAllowed as the keyword for representing the number of disruptions currently allowed in a PDB.

The reason for this change is to align the key naming in the PDB configuration with typical JSON/YAML key naming practices and improve clarity and maintainability. When key names are consistent with their meaning, it becomes easier for humans and automated systems to understand and work with the data. The disruptionsAllowed keyword clearly conveys its meaning and purpose, reducing potential confusion and errors in managing resources like PodDisruptionBudgets in a Kubernetes cluster.

Overall, this PR aims to enhance the naming convention within PDB configurations to provide more transparent and user-friendly documentation for Kubernetes users and operators.

Which issue(s) this PR fixes:

Fixes #121585

Special notes for your reviewer:

NONE

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

NONE

[k8s-ci-robot]

Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-ci-robot]

Please note that we're already in Test Freeze for the release-1.29 branch. This means every merged PR will be automatically fast-forwarded via the periodic ci-fast-forward job to the release branch of the upcoming v1.29.0 release.

Fast forwards are scheduled to happen every 6 hours, whereas the most recent run was: Wed Nov 22 15:56:03 UTC 2023.

[k8s-ci-robot]

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-ci-robot]

Hi @nikhilmaheshwari24. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: nikhilmaheshwari24
Once this PR has been reviewed and has the lgtm label, please assign seans3 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• pkg/printers/OWNERS
• staging/src/k8s.io/kubectl/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[seans3]

/ok-to-test

[mpuckett159]

Just to clarify this is just to have the helper text follow the same wording as the existing keyword correct? Since the type is disruptionsAllowed the helper text should be Disruptions allowed instead of Allowed disruptions?

[nikhilmaheshwari24]

Absolutely @mpuckett159 , this PR aims to align the naming convention within the PodDisruptionBudget (PDB) configuration, specifically focusing on the helper text to follow the same wording as the existing keyword. The current type in the configuration is Allowed disruptions, and the proposed change in the helper text is to update it to Disruptions allowed, maintaining consistency with the actual type.

This adjustment enhances the clarity and readability of the documentation by ensuring that the helper text precisely mirrors the actual field type. By doing so, it enables users, operators, and automated systems to better understand and interact with the PDB configuration in Kubernetes.

The intention is solely to provide consistency between the naming convention used in the PDB configuration and the corresponding helper text, enhancing the overall usability and maintainability of Kubernetes resources.

[mpuckett159]

Cool just making sure I was understanding the change completely. Seems like a good idea to me. Thank you for the PR.

/lgtm

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 30935ac8001bcf360961d24be9f40a71eaf49649

[k8s-ci-robot]

New changes are detected. LGTM label has been removed.

[k8s-ci-robot]

Adding label do-not-merge/contains-merge-commits because PR contains merge commits, which are not allowed in this repository.
Use git rebase to reapply your commits on top of the target branch. Detailed instructions for doing so can be found here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[k8s-ci-robot]

@nikhilmaheshwari24: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-kubernetes-e2e-gce	8a4d98a	link	true	/test pull-kubernetes-e2e-gce

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale