diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 1408a33c4567..d7dbbefb9ab7 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -125,3 +125,4 @@ :mce-short: multicluster engine Operator //Kueue :platform: Red Hat OpenShift Container Platform +:kueue-op: Red Hat Build of Kueue Operator diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 310b015c97ea..ed987816f270 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -32,7 +32,15 @@ Topics: - Name: About Red Hat build of Kueue File: about-kueue --- -Name: Authentication and authorization +Name: Install +Dir: install +Distros: openshift-kueue +Topics: +- Name: Installing Red Hat build of Kueue + File: install-kueue +# Add disconnected docs once eng has details +--- +Name: Authentication Dir: authentication Distros: openshift-kueue Topics: diff --git a/install/_attributes b/install/_attributes new file mode 120000 index 000000000000..f27fd275ea6b --- /dev/null +++ b/install/_attributes @@ -0,0 +1 @@ +../_attributes/ \ No newline at end of file diff --git a/install/images b/install/images new file mode 120000 index 000000000000..e4c5bd02a10a --- /dev/null +++ b/install/images @@ -0,0 +1 @@ +../images/ \ No newline at end of file diff --git a/install/install-kueue.adoc b/install/install-kueue.adoc new file mode 100644 index 000000000000..c4cf19c7e219 --- /dev/null +++ b/install/install-kueue.adoc @@ -0,0 +1,23 @@ +:_mod-docs-content-type: ASSEMBLY +include::_attributes/common-attributes.adoc[] +[id="install-kueue"] += Installing {product-title} +:context: install-kueue + +toc::[] + +You can install {product-title} by using the {kueue-op} in OperatorHub. + +[id="prerequisites_{context}"] +== Prerequisites + +* 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. + +include::modules/install-kueue-operator.adoc[leveloffset=+1] +include::modules/create-kueue-cr.adoc[leveloffset=+1] + +[id="next-steps_{context}"] +== Next steps + +* 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]. +* Complete the procedures in the xref:../configure/configuring-quotas.adoc#configuring-quotas[Configuring quotas] documentation. diff --git a/install/modules b/install/modules new file mode 120000 index 000000000000..43aab75b53c9 --- /dev/null +++ b/install/modules @@ -0,0 +1 @@ +../modules/ \ No newline at end of file diff --git a/install/snippets b/install/snippets new file mode 120000 index 000000000000..9d58b92e5058 --- /dev/null +++ b/install/snippets @@ -0,0 +1 @@ +../snippets/ \ No newline at end of file diff --git a/modules/configuring-clusterqueues.adoc b/modules/configuring-clusterqueues.adoc index 707bbeec3765..57e3bf13114e 100644 --- a/modules/configuring-clusterqueues.adoc +++ b/modules/configuring-clusterqueues.adoc @@ -30,12 +30,12 @@ kind: ClusterQueue metadata: name: example-queue spec: - namespaceSelector: {} <1> + namespaceSelector: {} # <1> resourceGroups: - - coveredResources: ["cpu", "memory", "pods", "foo.com/gpu"] <2> + - coveredResources: ["cpu", "memory", "pods", "foo.com/gpu"] # <2> flavors: - - name: "default-flavor" <3> - resources: <4> + - name: "default-flavor" # <3> + resources: # <4> - name: "cpu" nominalQuota: 9 - name: "memory" diff --git a/modules/configuring-localqueues.adoc b/modules/configuring-localqueues.adoc index 6e0df3831c1e..d45ff4302edd 100644 --- a/modules/configuring-localqueues.adoc +++ b/modules/configuring-localqueues.adoc @@ -26,8 +26,8 @@ include::snippets/prereqs-snippet.adoc[] apiVersion: kueue.x-k8s.io/v1beta1 kind: LocalQueue metadata: - namespace: team-a - name: team-a-queue + namespace: default + name: example spec: clusterQueue: cluster-queue ---- diff --git a/modules/create-kueue-cr.adoc b/modules/create-kueue-cr.adoc new file mode 100644 index 000000000000..ffcc5c1589fc --- /dev/null +++ b/modules/create-kueue-cr.adoc @@ -0,0 +1,46 @@ +// Module included in the following assemblies: +// +// * install/install-kueue.adoc + +:_mod-docs-content-type: PROCEDURE +[id="create-kueue-cr_{context}"] += Creating a Kueue custom resource + +After you have installed the {kueue-op}, you must create a `Kueue` custom resource (CR) to configure your installation. + +.Prerequisites + +include::snippets/prereqs-snippet.adoc[] + +.Procedure + +. In the {platform} web console, click *Operators* -> *Installed Operators*. +. In the *Provided APIs* table column, click *Kueue*. This takes you to the *Kueue* tab of the *Operator details* page. +. Click *Create Kueue*. This takes you to the *Create Kueue* YAML view. +. Enter the details for your `Kueue` CR. ++ +.Example `Kueue` CR +[source,yaml] +---- +apiVersion: operator.openshift.io/v1alpha1 +kind: Kueue +metadata: + labels: + app.kubernetes.io/name: kueue-operator + app.kubernetes.io/managed-by: kustomize + name: cluster + namespace: openshift-kueue-operator +spec: + managementState: Managed + config: + integrations: + frameworks: + - BatchJob + - Pod + - Deployment + - StatefulSet +---- +. Click *Create*. + +.Verification +// verification steps? diff --git a/modules/install-kueue-operator.adoc b/modules/install-kueue-operator.adoc new file mode 100644 index 000000000000..5096f56bfd21 --- /dev/null +++ b/modules/install-kueue-operator.adoc @@ -0,0 +1,24 @@ +// Module included in the following assemblies: +// +// * /install/install-kueue.adoc + +:_mod-docs-content-type: PROCEDURE +[id="install-kueue-operator_{context}"] += Installing the {kueue-op} + +You can install the {kueue-op} on an {platform} cluster by using the OperatorHub in the web console. + +.Prerequisites + +* You have administrator permissions on an {platform} cluster. +* You have access to the {platform} web console. +* You have installed and configured the {cert-manager-operator} for your cluster. + +.Procedure + +. In the {platform} web console, click *Operators* -> *OperatorHub*. +. Choose *{kueue-op}* from the list of available Operators, and click *Install*. + +.Verification + +* Go to *Operators* -> *Installed Operators* and confirm that the *{kueue-op}* is listed with *Status* as *Succeeded*.