From c1dd9c5c30db41ed7238d14e02832d7006858cba Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Mon, 23 Jun 2025 13:49:02 -0500 Subject: [PATCH 1/2] [NO-JIRA] General kueue doc improvements --- configure/configuring-quotas.adoc | 4 ++-- modules/configure-rbac-batch-admins.adoc | 2 +- modules/configure-rbac-batch-users.adoc | 2 +- modules/configuring-clusterqueues.adoc | 2 +- modules/configuring-localqueues.adoc | 2 +- modules/configuring-resourceflavors.adoc | 2 +- modules/create-kueue-cr.adoc | 2 +- ...doc => prereqs-snippet-batch-admin-yaml.adoc} | 4 ---- snippets/prereqs-snippet-cluster-admin-yaml.adoc | 16 ++++++++++++++++ ...> prereqs-snippet-console-cluster-admin.adoc} | 2 +- welcome/about-kueue.adoc | 2 +- 11 files changed, 26 insertions(+), 14 deletions(-) rename snippets/{prereqs-snippet-yaml.adoc => prereqs-snippet-batch-admin-yaml.adoc} (75%) create mode 100644 snippets/prereqs-snippet-cluster-admin-yaml.adoc rename snippets/{prereqs-snippet-console.adoc => prereqs-snippet-console-cluster-admin.adoc} (81%) diff --git a/configure/configuring-quotas.adoc b/configure/configuring-quotas.adoc index 3c4e32074824..9c16b15f84c7 100644 --- a/configure/configuring-quotas.adoc +++ b/configure/configuring-quotas.adoc @@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] -As an administrator, you can use {product-title} to configure quotas to optimize resource allocation and system throughput for user workloads. +As an administrator with the `kueue-batch-admin-role` cluster role, you can use {product-title} to configure quotas to optimize resource allocation and system throughput for user workloads. You can configure quotas for compute resources such as CPU, memory, pods, and GPU. You can configure quotas in {product-title} by completing the following steps: @@ -15,7 +15,7 @@ You can configure quotas in {product-title} by completing the following steps: . Configure a resource flavor. . Configure a local queue. -Users can then submit their workloads to the local queue. +After you have completed these steps, users can submit their workloads to the local queue as jobs. include::modules/configuring-clusterqueues.adoc[leveloffset=+1] diff --git a/modules/configure-rbac-batch-admins.adoc b/modules/configure-rbac-batch-admins.adoc index d7de200ee0d9..ee1b9171afd4 100644 --- a/modules/configure-rbac-batch-admins.adoc +++ b/modules/configure-rbac-batch-admins.adoc @@ -10,7 +10,7 @@ You can configure permissions for batch administrators by binding the `kueue-bat .Prerequisites -include::snippets/prereqs-snippet-yaml.adoc[] +include::snippets/prereqs-snippet-cluster-admin-yaml.adoc[] .Procedure diff --git a/modules/configure-rbac-batch-users.adoc b/modules/configure-rbac-batch-users.adoc index 4edf642dfc76..5b4888e3ce31 100644 --- a/modules/configure-rbac-batch-users.adoc +++ b/modules/configure-rbac-batch-users.adoc @@ -10,7 +10,7 @@ You can configure permissions for {product-title} users by binding the `kueue-ba .Prerequisites -include::snippets/prereqs-snippet-yaml.adoc[] +include::snippets/prereqs-snippet-cluster-admin-yaml.adoc[] .Procedure diff --git a/modules/configuring-clusterqueues.adoc b/modules/configuring-clusterqueues.adoc index a164fa3464d1..0bcc05214430 100644 --- a/modules/configuring-clusterqueues.adoc +++ b/modules/configuring-clusterqueues.adoc @@ -16,7 +16,7 @@ The cluster queue is not ready for use until a `ResourceFlavor` object has also .Prerequisites -include::snippets/prereqs-snippet-yaml.adoc[] +include::snippets/prereqs-snippet-batch-admin-yaml.adoc[] .Procedure diff --git a/modules/configuring-localqueues.adoc b/modules/configuring-localqueues.adoc index cfa6305cf3e2..28a27c480b6a 100644 --- a/modules/configuring-localqueues.adoc +++ b/modules/configuring-localqueues.adoc @@ -12,7 +12,7 @@ As an administrator, you can configure a `LocalQueue` object to point to a clust .Prerequisites -include::snippets/prereqs-snippet-yaml.adoc[] +include::snippets/prereqs-snippet-batch-admin-yaml.adoc[] * You have created a `ClusterQueue` object. diff --git a/modules/configuring-resourceflavors.adoc b/modules/configuring-resourceflavors.adoc index 72306115bbff..58694509d3e5 100644 --- a/modules/configuring-resourceflavors.adoc +++ b/modules/configuring-resourceflavors.adoc @@ -14,7 +14,7 @@ You can use a custom `ResourceFlavor` object to represent different resource var .Prerequisites -include::snippets/prereqs-snippet-yaml.adoc[] +include::snippets/prereqs-snippet-batch-admin-yaml.adoc[] .Procedure diff --git a/modules/create-kueue-cr.adoc b/modules/create-kueue-cr.adoc index 2612617f268c..1e673a03bed5 100644 --- a/modules/create-kueue-cr.adoc +++ b/modules/create-kueue-cr.adoc @@ -10,7 +10,7 @@ After you have installed the {kueue-op}, you must create a `Kueue` custom resour .Prerequisites -include::snippets/prereqs-snippet-console.adoc[] +include::snippets/prereqs-snippet-console-cluster-admin.adoc[] .Procedure diff --git a/snippets/prereqs-snippet-yaml.adoc b/snippets/prereqs-snippet-batch-admin-yaml.adoc similarity index 75% rename from snippets/prereqs-snippet-yaml.adoc rename to snippets/prereqs-snippet-batch-admin-yaml.adoc index 1cc37ccd30d6..20787c39ebd3 100644 --- a/snippets/prereqs-snippet-yaml.adoc +++ b/snippets/prereqs-snippet-batch-admin-yaml.adoc @@ -1,8 +1,6 @@ // Text snippet included in the following modules: // -// * modules/configure-rbac-batch-admins.adoc // * modules/configuring-clusterqueues.adoc -// * modules/configure-rbac-batch-users.adoc // * modules/configuring-localqueues.adoc // * modules/configuring-resourceflavors.adoc // @@ -12,8 +10,6 @@ :_mod-docs-content-type: SNIPPET -Ensure that you have completed the following prerequisites: - * The {product-title} Operator is installed on your cluster. * You have cluster administrator permissions and the `kueue-batch-admin-role` role. * You have installed the {oc-first}. diff --git a/snippets/prereqs-snippet-cluster-admin-yaml.adoc b/snippets/prereqs-snippet-cluster-admin-yaml.adoc new file mode 100644 index 000000000000..8fc0996d5645 --- /dev/null +++ b/snippets/prereqs-snippet-cluster-admin-yaml.adoc @@ -0,0 +1,16 @@ +// Text snippet included in the following modules: +// +// * modules/configure-rbac-batch-admins.adoc +// * modules/configure-rbac-batch-users.adoc +// +// Text snippet included in the following assemblies: +// +// * + +:_mod-docs-content-type: SNIPPET + +Ensure that you have completed the following prerequisites: + +* The {product-title} Operator is installed on your cluster. +* You have cluster administrator permissions. +* You have installed the {oc-first}. diff --git a/snippets/prereqs-snippet-console.adoc b/snippets/prereqs-snippet-console-cluster-admin.adoc similarity index 81% rename from snippets/prereqs-snippet-console.adoc rename to snippets/prereqs-snippet-console-cluster-admin.adoc index 2baea93f1959..cc0991a78c08 100644 --- a/snippets/prereqs-snippet-console.adoc +++ b/snippets/prereqs-snippet-console-cluster-admin.adoc @@ -11,5 +11,5 @@ Ensure that you have completed the following prerequisites: * The {product-title} Operator is installed on your cluster. -* You have cluster administrator permissions and the `kueue-batch-admin-role` role. +* You have cluster administrator permissions. * You have access to the {platform} web console. diff --git a/welcome/about-kueue.adoc b/welcome/about-kueue.adoc index 6000135eb8d7..4e0d8d7a8f37 100644 --- a/welcome/about-kueue.adoc +++ b/welcome/about-kueue.adoc @@ -7,7 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] {product-title} is a Kubernetes-native system that manages access to resources for jobs. -{product-title} can determine when a job waits, is admitted to start by creating pods, or should be _preempted_, meaning that active pods for that job are deleted. +{product-title} can determine when a job waits, is admitted to start by creating pods, or should be _preempted_, meaning that active pods for that job are deleted to make room for another job to start. [NOTE] ==== From e9efa405be83243adb79c34419d95ea6d4fa1907 Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Mon, 23 Jun 2025 13:50:16 -0500 Subject: [PATCH 2/2] Remove fluff --- snippets/prereqs-snippet-cluster-admin-yaml.adoc | 2 -- snippets/prereqs-snippet-console-cluster-admin.adoc | 2 -- snippets/prereqs-snippet-yaml-user.adoc | 2 -- 3 files changed, 6 deletions(-) diff --git a/snippets/prereqs-snippet-cluster-admin-yaml.adoc b/snippets/prereqs-snippet-cluster-admin-yaml.adoc index 8fc0996d5645..1ed019957400 100644 --- a/snippets/prereqs-snippet-cluster-admin-yaml.adoc +++ b/snippets/prereqs-snippet-cluster-admin-yaml.adoc @@ -9,8 +9,6 @@ :_mod-docs-content-type: SNIPPET -Ensure that you have completed the following prerequisites: - * The {product-title} Operator is installed on your cluster. * You have cluster administrator permissions. * You have installed the {oc-first}. diff --git a/snippets/prereqs-snippet-console-cluster-admin.adoc b/snippets/prereqs-snippet-console-cluster-admin.adoc index cc0991a78c08..599d919ad679 100644 --- a/snippets/prereqs-snippet-console-cluster-admin.adoc +++ b/snippets/prereqs-snippet-console-cluster-admin.adoc @@ -8,8 +8,6 @@ :_mod-docs-content-type: SNIPPET -Ensure that you have completed the following prerequisites: - * The {product-title} Operator is installed on your cluster. * You have cluster administrator permissions. * You have access to the {platform} web console. diff --git a/snippets/prereqs-snippet-yaml-user.adoc b/snippets/prereqs-snippet-yaml-user.adoc index 8c0bf922e1bb..6e62f95bb562 100644 --- a/snippets/prereqs-snippet-yaml-user.adoc +++ b/snippets/prereqs-snippet-yaml-user.adoc @@ -9,8 +9,6 @@ :_mod-docs-content-type: SNIPPET -Ensure that you have completed the following prerequisites: - * A cluster administrator has installed and configured {product-title} on your {platform} cluster. * A cluster administrator has assigned you the `kueue-batch-user-role` cluster role. * You have installed the {oc-first}.