Skip to content

[WIP] OSDOCS-13804: Kueue installation docs #93433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: kueue-docs
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -125,3 +125,4 @@
:mce-short: multicluster engine Operator
//Kueue
:platform: Red Hat OpenShift Container Platform
:kueue-op: Red Hat Build of Kueue Operator
10 changes: 9 additions & 1 deletion _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions install/_attributes
1 change: 1 addition & 0 deletions install/images
23 changes: 23 additions & 0 deletions install/install-kueue.adoc
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions install/modules
1 change: 1 addition & 0 deletions install/snippets
8 changes: 4 additions & 4 deletions modules/configuring-clusterqueues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions modules/configuring-localqueues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
----
Expand Down
46 changes: 46 additions & 0 deletions modules/create-kueue-cr.adoc
Original file line number Diff line number Diff line change
@@ -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?
24 changes: 24 additions & 0 deletions modules/install-kueue-operator.adoc
Original file line number Diff line number Diff line change
@@ -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*.