Kueue Alpha API

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

Resource Types

`MultiKueueCluster`

Appears in:

MultiKueueCluster is the Schema for the multikueue API

Field	Description
`apiVersion` string	`kueue.x-k8s.io/v1alpha1`
`kind` string	`MultiKueueCluster`
`spec` [Required] `MultiKueueClusterSpec`	No description provided.
`status` [Required] `MultiKueueClusterStatus`	No description provided.

`MultiKueueConfig`

Appears in:

MultiKueueConfig is the Schema for the multikueue API

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

`Cohort`

Appears in:

Cohort is the Schema for the cohorts API

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] `string`	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.

parent [Required]
string

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.

`CohortStatus`

Appears in:

Cohort

CohortStatus defines the observed state of Cohort

Field	Description
`conditions` [Required] `[]k8s.io/apimachinery/pkg/apis/meta/v1.Condition`	No description provided.

`KubeConfig`

Appears in:

MultiKueueClusterSpec

Field Description

Field	Description
`location` [Required] `string`	Location of the KubeConfig. If LocationType is Secret then Location is the name of the secret inside the namespace in which the kueue controller manager is running. The config should be stored in the "kubeconfig" key.
`locationType` [Required] `LocationType`	Type of the KubeConfig location.

location [Required]
string

Location of the KubeConfig.

If LocationType is Secret then Location is the name of the secret inside the namespace in which the kueue controller manager is running. The config should be stored in the "kubeconfig" key.

locationType [Required]
LocationType

Type of the KubeConfig location.