Kueue Alpha API

Generated API reference documentation for kueue.x-k8s.io/v1alpha1.

Resource Types

Topology

`Topology`

Appears in:

Topology is the Schema for the topology API

Field	Description
`apiVersion` string	`kueue.x-k8s.io/v1alpha1`
`kind` string	`Topology`
`spec` [Required] `TopologySpec`	No description provided.

`Cohort`

Appears in:

Cohort defines the Cohorts API.

Hierarchical Cohorts (any Cohort which has a parent) are compatible with Fair Sharing as of v0.11. Using these features together in V0.9 and V0.10 is unsupported, and results in undefined behavior.

Field	Description
`spec` [Required] `CohortSpec`	No description provided.
`status` [Required] `CohortStatus`	No description provided.

`CohortSpec`

Appears in:

Cohort

CohortSpec defines the desired state of Cohort

Field Description

Field	Description
`parent` [Required] `CohortReference`	Parent references the name of the Cohort's parent, if any. It satisfies one of three cases: Unset. This Cohort is the root of its Cohort tree. References a non-existent Cohort. We use default Cohort (no borrowing/lending limits). References an existent Cohort. If a cycle is created, we disable all members of the Cohort, including ClusterQueues, until the cycle is removed. We prevent further admission while the cycle exists.
`resourceGroups` [Required] `[]ResourceGroup`	ResourceGroups describes groupings of Resources and Flavors. Each ResourceGroup defines a list of Resources and a list of Flavors which provide quotas for these Resources. Each Resource and each Flavor may only form part of one ResourceGroup. There may be up to 16 ResourceGroups within a Cohort. BorrowingLimit limits how much members of this Cohort subtree can borrow from the parent subtree. LendingLimit limits how much members of this Cohort subtree can lend to the parent subtree. Borrowing and Lending limits must only be set when the Cohort has a parent. Otherwise, the Cohort create/update will be rejected by the webhook.
`fairSharing` `FairSharing`	fairSharing defines the properties of the Cohort when participating in FairSharing. The values are only relevant if FairSharing is enabled in the Kueue configuration.

parent [Required]
CohortReference

Parent references the name of the Cohort's parent, if any. It satisfies one of three cases:

Unset. This Cohort is the root of its Cohort tree.
References a non-existent Cohort. We use default Cohort (no borrowing/lending limits).
References an existent Cohort.

If a cycle is created, we disable all members of the Cohort, including ClusterQueues, until the cycle is removed. We prevent further admission while the cycle exists.

resourceGroups [Required]
[]ResourceGroup

ResourceGroups describes groupings of Resources and Flavors. Each ResourceGroup defines a list of Resources and a list of Flavors which provide quotas for these Resources. Each Resource and each Flavor may only form part of one ResourceGroup. There may be up to 16 ResourceGroups within a Cohort.

BorrowingLimit limits how much members of this Cohort subtree can borrow from the parent subtree.

LendingLimit limits how much members of this Cohort subtree can lend to the parent subtree.

Borrowing and Lending limits must only be set when the Cohort has a parent. Otherwise, the Cohort create/update will be rejected by the webhook.

fairSharing
FairSharing

fairSharing defines the properties of the Cohort when participating in FairSharing. The values are only relevant if FairSharing is enabled in the Kueue configuration.

`CohortStatus`

Appears in:

Cohort

CohortStatus defines the observed state of Cohort.

Field	Description
`fairSharing` `FairSharingStatus`	fairSharing contains the current state for this Cohort when participating in Fair Sharing. The is recorded only when Fair Sharing is enabled in the Kueue configuration.

`TopologyLevel`

Appears in:

TopologySpec

TopologyLevel defines the desired state of TopologyLevel

Field Description

Field	Description
`nodeLabel` [Required] `string`	nodeLabel indicates the name of the node label for a specific topology level. Examples: cloud.provider.com/topology-block cloud.provider.com/topology-rack

nodeLabel [Required]
string

nodeLabel indicates the name of the node label for a specific topology level.

Examples:

cloud.provider.com/topology-block
cloud.provider.com/topology-rack

`TopologySpec`

Appears in:

Topology

TopologySpec defines the desired state of Topology

Field	Description
`levels` [Required] `[]TopologyLevel`	levels define the levels of topology.

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified March 24, 2025: Add FairsharingStatus API documentation to Cohort and ClusterQueue (#4764) (2a3cb527)