Skip to content

[WIP] [NO-JIRA] General kueue doc improvements #95120

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 2 commits 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
4 changes: 2 additions & 2 deletions configure/configuring-quotas.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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]

Expand Down
2 changes: 1 addition & 1 deletion modules/configure-rbac-batch-admins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion modules/configure-rbac-batch-users.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion modules/configuring-clusterqueues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion modules/configuring-localqueues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion modules/configuring-resourceflavors.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion modules/create-kueue-cr.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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
//
Expand All @@ -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}.
14 changes: 14 additions & 0 deletions snippets/prereqs-snippet-cluster-admin-yaml.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
// 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

* The {product-title} Operator is installed on your cluster.
* You have cluster administrator permissions.
* You have installed the {oc-first}.
Original file line number Diff line number Diff line change
Expand Up @@ -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 and the `kueue-batch-admin-role` role.
* You have cluster administrator permissions.
* You have access to the {platform} web console.
2 changes: 0 additions & 2 deletions snippets/prereqs-snippet-yaml-user.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}.
2 changes: 1 addition & 1 deletion welcome/about-kueue.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
====
Expand Down