Skip to content

Commit cfc0eff

Browse files
OSDOCS-18093: update our docs to use v1beta2 for kueue objects
1 parent f766a0e commit cfc0eff

9 files changed

Lines changed: 21 additions & 21 deletions

modules/kueue-clusterqueue-configuring-cohorts-reference.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@
66
[id="clusterqueue-configuring-cohorts-reference_{context}"]
77
= Configuring cohorts within a cluster queue spec
88

9-
You can add a cluster queue to a cohort by specifying the name of the cohort in the `.spec.cohort` field of the `ClusterQueue` object, as shown in the following example:
9+
You can add a cluster queue to a cohort by specifying the name of the cohort in the `.spec.cohortName` field of the `ClusterQueue` object, as shown in the following example:
1010

1111
[source,yaml]
1212
----
13-
apiVersion: kueue.x-k8s.io/v1beta1
13+
apiVersion: kueue.x-k8s.io/v1beta2
1414
kind: ClusterQueue
1515
metadata:
1616
name: cluster-queue
1717
spec:
1818
# ...
19-
cohort: example-cohort
19+
cohortName: example-cohort
2020
# ...
2121
----
2222

23-
All cluster queues that have a matching `spec.cohort` are part of the same cohort.
23+
All cluster queues that have a matching `spec.cohortName` are part of the same cohort.
2424

25-
If the `spec.cohort` field is omitted, the cluster queue does not belong to any cohort and cannot access borrowable resources.
25+
If the `spec.cohortName` field is omitted, the cluster queue does not belong to any cohort and cannot access borrowable resources.

modules/kueue-clusterqueue-share-value.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The `weight` value, or share value, defines a comparative advantage for the clus
1515
.Example cluster queue with a fair sharing weight configured
1616
[source,yaml]
1717
----
18-
apiVersion: kueue.x-k8s.io/v1beta1
18+
apiVersion: kueue.x-k8s.io/v1beta2
1919
kind: ClusterQueue
2020
metadata:
2121
name: cluster-queue
@@ -28,7 +28,7 @@ spec:
2828
resources:
2929
- name: cpu
3030
nominalQuota: 9
31-
cohort: example-cohort
31+
cohortName: example-cohort
3232
fairSharing:
3333
weight: 2
3434
----

modules/kueue-configuring-clusterqueues.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ include::snippets/prereqs-snippet-yaml.adoc[]
2525
.Example of a basic `ClusterQueue` object using a single resource flavor
2626
[source,yaml]
2727
----
28-
apiVersion: kueue.x-k8s.io/v1beta1
28+
apiVersion: kueue.x-k8s.io/v1beta2
2929
kind: ClusterQueue
3030
metadata:
3131
name: cluster-queue

modules/kueue-configuring-localqueue-defaults.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ include::snippets/prereqs-snippet-yaml-1.1.adoc[]
2828
.Example of a default `LocalQueue` object
2929
[source,yaml]
3030
----
31-
apiVersion: kueue.x-k8s.io/v1beta1
31+
apiVersion: kueue.x-k8s.io/v1beta2
3232
kind: LocalQueue
3333
metadata:
3434
namespace: team-namespace

modules/kueue-configuring-localqueues.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ include::snippets/prereqs-snippet-yaml.adoc[]
2323
.Example of a basic `LocalQueue` object
2424
[source,yaml]
2525
----
26-
apiVersion: kueue.x-k8s.io/v1beta1
26+
apiVersion: kueue.x-k8s.io/v1beta2
2727
kind: LocalQueue
2828
metadata:
2929
namespace: team-namespace

modules/kueue-configuring-resourceflavors.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ include::snippets/prereqs-snippet-yaml.adoc[]
2323
.Example of an empty `ResourceFlavor` object
2424
[source,yaml]
2525
----
26-
apiVersion: kueue.x-k8s.io/v1beta1
26+
apiVersion: kueue.x-k8s.io/v1beta2
2727
kind: ResourceFlavor
2828
metadata:
2929
name: default-flavor
@@ -32,7 +32,7 @@ metadata:
3232
.Example of a custom `ResourceFlavor` object
3333
[source,yaml]
3434
----
35-
apiVersion: kueue.x-k8s.io/v1beta1
35+
apiVersion: kueue.x-k8s.io/v1beta2
3636
kind: ResourceFlavor
3737
metadata:
3838
name: "x86"

modules/kueue-monitoring-pending-workloads-on-demand.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ The following procedure tells you how to install and test workload monitoring.
2626
----
2727
cat <<EOF| oc create -f -
2828
---
29-
apiVersion: kueue.x-k8s.io/v1beta1
29+
apiVersion: kueue.x-k8s.io/v1beta2
3030
kind: ResourceFlavor
3131
metadata:
3232
name: "default-flavor"
3333
---
34-
apiVersion: kueue.x-k8s.io/v1beta1
34+
apiVersion: kueue.x-k8s.io/v1beta2
3535
kind: ClusterQueue
3636
metadata:
3737
name: "cluster-queue"
@@ -47,7 +47,7 @@ spec:
4747
- name: "memory"
4848
nominalQuota: 36Gi
4949
---
50-
apiVersion: kueue.x-k8s.io/v1beta1
50+
apiVersion: kueue.x-k8s.io/v1beta2
5151
kind: LocalQueue
5252
metadata:
5353
namespace: "default"

modules/kueue-viewing-pending-workloads-clusterqueue.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ To view all pending workloads at the cluster level, administrators can use the `
1515
+
1616
[source,terminal]
1717
----
18-
$ oc get --raw "/apis/visibility.kueue.x-k8s.io/v1beta1/clusterqueues/cluster-queue/pendingworkloads"
18+
$ oc get --raw "/apis/visibility.kueue.x-k8s.io/v1beta2/clusterqueues/cluster-queue/pendingworkloads"
1919
----
2020
+
2121
.Example output
2222
[source,yaml]
2323
----
2424
{
2525
"kind": "PendingWorkloadsSummary",
26-
"apiVersion": "visibility.kueue.x-k8s.io/v1beta1",
26+
"apiVersion": "visibility.kueue.x-k8s.io/v1beta2",
2727
"metadata": {
2828
"creationTimestamp": null
2929
},
@@ -99,5 +99,5 @@ You can pass the following optional query parameters:
9999
+
100100
[source,terminal]
101101
----
102-
$ oc get --raw "/apis/visibility.kueue.x-k8s.io/v1beta1/clusterqueues/cluster-queue/pendingworkloads?limit=1&offset=0"
102+
$ oc get --raw "/apis/visibility.kueue.x-k8s.io/v1beta2/clusterqueues/cluster-queue/pendingworkloads?limit=1&offset=0"
103103
----

modules/kueue-viewing-pending-workloads-localqueue.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ To view the pending workloads submitted by a specific tenant within their namesp
1515
+
1616
[source,terminal]
1717
----
18-
$ oc get --raw /apis/visibility.kueue.x-k8s.io/v1beta1/namespaces/default/localqueues/user-queue/pendingworkloads
18+
$ oc get --raw /apis/visibility.kueue.x-k8s.io/v1beta2/namespaces/default/localqueues/user-queue/pendingworkloads
1919
----
2020
+
2121
.Example output
2222
[source,yaml]
2323
----
2424
{
2525
"kind": "PendingWorkloadsSummary",
26-
"apiVersion": "visibility.kueue.x-k8s.io/v1beta1",
26+
"apiVersion": "visibility.kueue.x-k8s.io/v1beta2",
2727
"metadata": {
2828
"creationTimestamp": null
2929
},
@@ -99,5 +99,5 @@ You can pass the following optional query parameters:
9999
+
100100
[source,terminal]
101101
----
102-
$ oc get --raw "/apis/visibility.kueue.x-k8s.io/v1beta1/namespaces/default/localqueues/user-queue/pendingworkloads?limit=1&offset=0"
102+
$ oc get --raw "/apis/visibility.kueue.x-k8s.io/v1beta2/namespaces/default/localqueues/user-queue/pendingworkloads?limit=1&offset=0"
103103
----

0 commit comments

Comments
 (0)