Skip to content

LimitPodHardAntiAffinityTopology docs reference never-implemented requiredDuringSchedulingRequiredDuringExecution field #55284

@zhiland

Description

@zhiland

Problem:

The LimitPodHardAntiAffinityTopology documentation states:

This admission controller denies any pod that defines AntiAffinity topology key other than kubernetes.io/hostname in requiredDuringSchedulingRequiredDuringExecution.

This is misleading because requiredDuringSchedulingRequiredDuringExecution was never implemented in the Kubernetes API.

The actual admission controller source code checks both requiredDuringSchedulingRequiredDuringExecution and requiredDuringSchedulingIgnoredDuringExecution, but only the latter exists in the API and affects real workloads.

Proposed Solution:

Update the description to mention both fields, matching the source code:

This admission controller denies any pod that defines AntiAffinity topology key other than kubernetes.io/hostname in requiredDuringSchedulingRequiredDuringExecution and requiredDuringSchedulingIgnoredDuringExecution.

Or, since requiredDuringSchedulingRequiredDuringExecution was never implemented, consider only referencing requiredDuringSchedulingIgnoredDuringExecution.

Page to Update:
https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#limitpodhardantiaffinitytopology

Additional Information:

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/bugCategorizes issue or PR as related to a bug.needs-triageIndicates an issue or PR lacks a `triage/foo` label and requires one.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions