Skip to content

Commit

Permalink
[YUNIKORN-2994] Fix typos and make some minor improvement in User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael committed Dec 6, 2024
1 parent f8d13d6 commit 1fe9954
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
Binary file modified docs/assets/queue-resource-quotas.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/user_guide/gang_scheduling.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ spec:

When this job is submitted to Kubernetes, 2 pods will be created using the same template, and they all belong to one taskGroup:
*“task-group-example”*. YuniKorn will create 2 placeholder pods, each uses the resources specified in the taskGroup definition.
When all 2 placeholders are allocated, the scheduler will bind the the real 2 sleep pods using the spot reserved by the placeholders.
When all 2 placeholders are allocated, the scheduler will bind the real 2 sleep pods using the spot reserved by the placeholders.

You can add more than one taskGroups if necessary, each taskGroup is identified by the taskGroup name,
it is required to map each real pod with a pre-defined taskGroup by setting the taskGroup name. Note,
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/labels_and_annotations_in_yunikorn.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Label values should comply with [Kubernetes Syntax and character set](https://ku
| `yunikorn.apache.org/namespace.quota` | Set the maximum capacity of the queue mapped to this namespace. Further details can be found in the [ Resource Quota Management](resource_quota_management#namespace-quota) documentation. |
| [DEPRECATED]<br/>`yunikorn.apache.org/namespace.max.cpu` | Replaced with `yunikorn.apache.org/namespace.quota` since version 1.2.0 |
| [DEPRECATED]<br/>`yunikorn.apache.org/namespace.max.memory` | Replaced with `yunikorn.apache.org/namespace.quota` since version 1.2.0 |
| `yunikorn.apache.org/namespace.enableYuniKorn` | Controls which namespaces will have pods forwarded to Yunikorn for scheduling. Further details can be found in the [Service Configuration #admission-controller-filtering-settings](service_config#admission-controller-filtering-settings)documentation. |
| `yunikorn.apache.org/namespace.enableYuniKorn` | Controls which namespaces will have pods forwarded to Yunikorn for scheduling. Further details can be found in the [Service Configuration #admission-controller-filtering-settings](service_config#admission-controller-filtering-settings) documentation. |
| `yunikorn.apache.org/namespace.generateAppId` | Controls which namespaces will have pods labeled with an `yunikorn.apache.org/app-id`. Further details can be found in the [Service Configuration #admission-controller-filtering-settings](service_config#admission-controller-filtering-settings) documentation. |

For more details surrounding gang-scheduling labels and annotations, please refer to the documentation on [gang scheduling](user_guide/gang_scheduling.md).
4 changes: 2 additions & 2 deletions docs/user_guide/resource_quota_mgmt.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ On Kubernetes a pod must fit into the namespace quota when the pod is submitted.
If the pod does not fit in the namespace quota the pod is rejected.
The client must implement a retry-mechanism and re-submit the pod if it needs the pod to be scheduled.

Contrary to quotas in Kubernetes YuniKorn does not enforce quotas on submission but only on actively consumed resources.
Contrary to quotas in Kubernetes, YuniKorn does not enforce quotas on submission but only on actively consumed resources.
To explain the difference: when using YuniKorn for quota enforcement a new pod submitted to Kubernetes is always accepted.
Yunikorn will queue the pod without counting the queued pod's resources towards the consumed quota.
When YuniKorn tries to schedule the pod it checks at scheduling time if the pod fits in the quota configured for the queue the pod is assigned to.
Expand Down Expand Up @@ -232,7 +232,7 @@ yunikorn.apache.org/namespace.quota: "{\"cpu\": \"64\", \"memory\": \"100G\", \"
```
YuniKorn will parse these annotations and set the maximum capacity of the queue mapped to this namespace.
The values specified follow the standard Kubernetes formatting and unit specification.
Annotation value must be a single json compliant string. Ensure double quotes iare escaped properly to not cause any problems.
Annotation value must be a single json compliant string. Ensure double quotes are escaped properly to not cause any problems.

The example above will limit the queue mapped to the annotated namespace to 64 CPUs, 100GB memory and 1 `nvidia.com/gpu`.

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/use_case.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ See the documentation on [Partition and Queue Configuration #Resources](queue_co

YuniKorn supports priority scheduling, where priorities can be assigned to each task and also to each queue.

This section demonstrates how to configure priority in a queue. If you want to configure the priority of each task, you can learn more about it from document Pod Priority and Preemption on Kubernete .
This section demonstrates how to configure priority in a queue. If you want to configure the priority of each task, you can learn more about it from document [Pod Priority and Preemption](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/) on Kubernetes.

### Explanation of Configuration

Expand Down

0 comments on commit 1fe9954

Please sign in to comment.