Skip to content
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

[YUNIKORN-2984] Fix typos and add white background to priority tree image for better visibility in dark mode #503

Closed
wants to merge 1 commit into from
Closed
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
Binary file modified docs/assets/priority-tree.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/acls.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The user named `john` whom is a member of the group `dev` will be allowed access

### Escaping and quotation marks
ACLs are currently implemented in the queue configuration which uses a yaml file.
This places some limitations on the how to escape the values.
This places some limitations on how to escape the values.
Incorrectly quoted values will cause a yaml parse error or could lead to the incorrect interpretation of the value.

The following points need to be taken into account:
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/preemption.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ To prevent the occurrence of preemption storms or loops, where subsequent preemp

For a detailed explanation of these preemption laws, please refer to the preemption [design document](design/preemption.md#the-laws-of-preemption).

Next, we will provide a few examples to help you understand the functionality and impact of preemption, allowing you to deploy it effectively in your environment. You can find the necessary files for the examples in the yunikorn-k8shim/deployment/example/preemption directory.
Next, we will provide a few examples to help you understand the functionality and impact of preemption, allowing you to deploy it effectively in your environment. You can find the necessary files for the examples in the yunikorn-k8shim/deployments/examples/preemption directory.

Included in the files is a YuniKorn configuration that defines the queue configuration as follows:

Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/sorting_policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ Config value: `fifo` (default)

Before sorting, the applications are filtered and must have pending resource requests.

After filtering the applications left are sorted based on the application create time stamp only, no other filtering is applied.
Since applications can only be added while the system is locked there can never be two applications with the exact same time stamp.
After filtering the applications left are sorted based on the application create timestamp only, no other filtering is applied.
Since applications can only be added while the system is locked there can never be two applications with the exact same timestamp.

The result is that the oldest application that requests resources gets resources.
Younger applications will be given resources when all the current requests of older applications have been fulfilled.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/usergroup_resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ The admission controller can be configured with the `yunikorn-configs` configmap
| `externalUsers` | "" | Regular expression for the allowed external user list |
| `externalGroups` | "" | Regular expression for the allowed external group list |

If `bypassAuth` is set to true the admission controller will not add the annotation to a pod if the annotation is not present and the deprecated user labell is set. If the annotation is not set and the user label is not set the new annotation will be added. In the case that `bypassAuth` is false, the default, the admission controller will always add the new annotation, regardless of the existence of the deprecated label.
If `bypassAuth` is set to true the admission controller will not add the annotation to a pod if the annotation is not present and the deprecated user label is set. If the annotation is not set and the user label is not set the new annotation will be added. In the case that `bypassAuth` is false, the default, the admission controller will always add the new annotation, regardless of the existence of the deprecated label.

In certain scenarios, users and groups must be provided to Yunikorn upon submission because the user and group management is provided by external systems and the lookup mechanism is not trivial. In these cases, the `externalUsers` and `externalGroups` can be configured which are treated as regular expressions. Matching users and groups are allowed to set the `yunikorn.apache.org/user.info` annotation to any arbitrary value. Since this has implications which affects scheduling inside Yunikorn, these properties must be set carefully.

Expand Down