Skip to content

Commit

Permalink
Addressed review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@manirajv06
manirajv06 committed Sep 4, 2024
1 parent 71a515b commit 17d83a5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
10 changes: 5 additions & 5 deletions docs/user_guide/labels_and_annotations_in_yunikorn.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ YuniKorn utilizes several Kubernetes labels and annotations to support various f
### Labels in YuniKorn
Label values should comply with [Kubernetes Syntax and character set](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set).

| Name | Description |
|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `applicationId` | Associates this pod with an application. |
| `queue` | Selects the YuniKorn queue this application should be scheduled in. Queue name should comply with [Kubernetes Syntax and character set](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) and also with [Partition and Queue Configuration](queue_config#queues). If Queue name doesn't comply, Annotations could be used as described below. This may be ignored if a placement policy is in effect. |
| `spark-app-selector` | Alternative method of specifying `applicationId` used by Spark Operator if the label `applicationId` and annotation `yunikorn.apache.org/app-id` unset. |
| Name | Description |
|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `applicationId` | Associates this pod with an application. |
| `queue` | Selects the YuniKorn queue this application should be scheduled in.<br/>Queue name should comply with [Kubernetes Syntax and character set](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) and also with [Partition and Queue Configuration](queue_config#queues).<br/>If the queue doesn't comply, annotations could be used as described below. This may be ignored if a placement policy is in effect. |
| `spark-app-selector` | Alternative method of specifying `applicationId` used by Spark Operator if the label `applicationId` and annotation `yunikorn.apache.org/app-id` are unset. |

### Annotations in YuniKorn
All annotations are under the namespace `yunikorn.apache.org`. For example `yunikorn.apache.org/app-id`.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/placement_rules.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ This means that we allow user name and or tag values to contain dots without the
For queues in the configuration that as an example must map to username with a dot you must specify them as follows:
A user rule with the user `user.name` will generate the queue name `root.user_dot_name` as output.
If that "user queue" must be added to the configuration the `user_dot_name` name should be used.
Queue name should comply with rules described in [Partition and Queue Configuration](queue_config#queues).
The queue name should comply with rules described in [Partition and Queue Configuration](queue_config#queues).

### Create parameter
The create parameter is a boolean flag that defines if a queue that is generated by the rule may be created if it does not exist.
Expand Down
10 changes: 5 additions & 5 deletions docs/user_guide/queue_config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,9 +147,9 @@ A queue cannot contain a dot "." character as that character is used to separate
Valid Queue name:

* must be 64 characters or less,
* could contain alphanumeric character ([a-z0-9A-Z]), underscores (_), colons (:), hashes (#), slashes (/), at signs (@), and dashes (-).
* can contain alphanumeric character ([a-z0-9A-Z]), underscores (_), colons (:), hashes (#), slashes (/), at signs (@), and dashes (-).

If the name is not unique for the queue in the configuration or contains a dot or do not follow the above rules a parsing error is generated and the configuration is rejected.
If the name is not unique for the queue in the configuration or contains a dot or does not follow the above rules, a parsing error is generated and the configuration is rejected.

Queues in the structure will automatically get a type assigned.
The type of the queue is based on the fact that the queue has children or sub queues.
Expand Down Expand Up @@ -274,13 +274,13 @@ When a wildcard group is configured, a limit must be configured with at least on

Valid User name:

* must start with lower case or upper case alphabet,
* must start with a letter (uppercase or lowercase) or an underscore (_),
* followed by alphanumeric character ([a-z0-9A-Z]), underscores (_), colons (:), hashes (#), slashes (/), at signs (@), dots (.), and dashes (-).
* could end with dollar ($).
* can end with dollar ($).

Valid Group name:

* must start with lower case or upper case alphabet
* must start with a letter (uppercase or lowercase) or an underscore (_),
* followed by alphanumeric character ([a-z0-9A-Z]), underscores (_), colons (:), dots (.), and dashes (-).

Parsing will reject the configuration with limits that do not follow the above rules.
Expand Down

0 comments on commit 17d83a5

Please sign in to comment.