Skip to content

Commit b00226d

Browse files
committed
kueue cr docs
1 parent f3b350f commit b00226d

File tree

4 files changed

+54
-7
lines changed

4 files changed

+54
-7
lines changed

install/install-kueue.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ You can install {product-title} by using the {kueue-op} in OperatorHub.
1414
* You have installed and configured the link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/security_and_compliance/cert-manager-operator-for-red-hat-openshift#installing-the-cert-manager-operator-for-red-hat-openshift[{cert-manager-operator}] on your cluster.
1515

1616
include::modules/install-kueue-operator.adoc[leveloffset=+1]
17+
include::modules/create-kueue-cr.adoc[leveloffset=+1]
1718

1819
[id="next-steps_{context}"]
1920
== Next steps
2021

21-
* Complete the procedures in the xref:../configure/configuring-quotas.adoc#configuring-quotas[Configuring quotas] documentation.
2222
* Complete the procedures in xref:../authentication/rbac-permissions.adoc#configure-rbac-batch-admins_rbac-permissions[Configuring permissions for batch administrators] and xref:../authentication/rbac-permissions.adoc#configure-rbac-batch-users_rbac-permissions[Configuring permissions for users].
23+
* Complete the procedures in the xref:../configure/configuring-quotas.adoc#configuring-quotas[Configuring quotas] documentation.

modules/configuring-clusterqueues.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ kind: ClusterQueue
3030
metadata:
3131
name: example-queue
3232
spec:
33-
namespaceSelector: {} <1>
33+
namespaceSelector: {} # <1>
3434
resourceGroups:
35-
- coveredResources: ["cpu", "memory", "pods", "foo.com/gpu"] <2>
35+
- coveredResources: ["cpu", "memory", "pods", "foo.com/gpu"] # <2>
3636
flavors:
37-
- name: "default-flavor" <3>
38-
resources: <4>
37+
- name: "default-flavor" # <3>
38+
resources: # <4>
3939
- name: "cpu"
4040
nominalQuota: 9
4141
- name: "memory"

modules/configuring-localqueues.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ include::snippets/prereqs-snippet.adoc[]
2626
apiVersion: kueue.x-k8s.io/v1beta1
2727
kind: LocalQueue
2828
metadata:
29-
namespace: team-a
30-
name: team-a-queue
29+
namespace: default
30+
name: example
3131
spec:
3232
clusterQueue: cluster-queue
3333
----

modules/create-kueue-cr.adoc

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * install/install-kueue.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="create-kueue-cr_{context}"]
7+
= Creating a Kueue custom resource
8+
9+
After you have installed the {kueue-op}, you must create a `Kueue` custom resource (CR) to configure your installation.
10+
11+
.Prerequisites
12+
13+
include::snippets/prereqs-snippet.adoc[]
14+
15+
.Procedure
16+
17+
. In the {platform} web console, click *Operators* -> *Installed Operators*.
18+
. In the *Provided APIs* table column, click *Kueue*. This takes you to the *Kueue* tab of the *Operator details* page.
19+
. Click *Create Kueue*. This takes you to the *Create Kueue* YAML view.
20+
. Enter the details for your `Kueue` CR.
21+
+
22+
.Example `Kueue` CR
23+
[source,yaml]
24+
----
25+
apiVersion: operator.openshift.io/v1alpha1
26+
kind: Kueue
27+
metadata:
28+
labels:
29+
app.kubernetes.io/name: kueue-operator
30+
app.kubernetes.io/managed-by: kustomize
31+
name: cluster
32+
namespace: openshift-kueue-operator
33+
spec:
34+
managementState: Managed
35+
config:
36+
integrations:
37+
frameworks:
38+
- BatchJob
39+
- Pod
40+
- Deployment
41+
- StatefulSet
42+
----
43+
. Click *Create*.
44+
45+
.Verification
46+
// verification steps?

0 commit comments

Comments
 (0)