pbacsko commented on code in PR #464:
URL: https://github.com/apache/yunikorn-site/pull/464#discussion_r1742283857
##########
docs/user_guide/labels_and_annotations_in_yunikorn.md:
##########
@@ -25,19 +25,21 @@ under the License.
YuniKorn utilizes several Kubernetes labels and annotations to support various
features:
### Labels in YuniKorn
-| Name | Description
|
-|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `applicationId` | Associates this pod with an application.
|
-| `queue` | Selects the YuniKorn queue this
application should be scheduled in. 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. |
+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. |
Review Comment:
nit grammar/spelling: "if the queue doesn't comply, annotations could be
used as described below"
##########
docs/user_guide/labels_and_annotations_in_yunikorn.md:
##########
@@ -25,19 +25,21 @@ under the License.
YuniKorn utilizes several Kubernetes labels and annotations to support various
features:
### Labels in YuniKorn
-| Name | Description
|
-|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `applicationId` | Associates this pod with an application.
|
-| `queue` | Selects the YuniKorn queue this
application should be scheduled in. 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. |
+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.
|
Review Comment:
nit grammar: "...if the label `applicationId` and annotation
`yunikorn.apache.org/app-id` are unset".
##########
docs/user_guide/queue_config.md:
##########
@@ -143,7 +143,13 @@ The name of a queue must be unique at the level that the
queue is defined.
Since the queue structure is fully hierarchical queues at different points in
the hierarchy may have the same name.
As an example: the queue structure `root.testqueue` and
`root.parent.testqueue` is a valid structure.
A queue cannot contain a dot "." character as that character is used to
separate the queues in the hierarchy.
-If the name is not unique for the queue in the configuration or contains a dot
a parsing error is generated and the configuration is rejected.
+
+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 (-).
Review Comment:
nit: "could" -> "can"
##########
docs/user_guide/placement_rules.md:
##########
@@ -72,6 +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).
Review Comment:
nit: "The queue name"
##########
docs/user_guide/labels_and_annotations_in_yunikorn.md:
##########
@@ -25,19 +25,21 @@ under the License.
YuniKorn utilizes several Kubernetes labels and annotations to support various
features:
### Labels in YuniKorn
-| Name | Description
|
-|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `applicationId` | Associates this pod with an application.
|
-| `queue` | Selects the YuniKorn queue this
application should be scheduled in. 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. |
+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. |
Review Comment:
Shouldn't we use the `<br>` tag here as well, just like below?
##########
docs/user_guide/queue_config.md:
##########
@@ -143,7 +143,13 @@ The name of a queue must be unique at the level that the
queue is defined.
Since the queue structure is fully hierarchical queues at different points in
the hierarchy may have the same name.
As an example: the queue structure `root.testqueue` and
`root.parent.testqueue` is a valid structure.
A queue cannot contain a dot "." character as that character is used to
separate the queues in the hierarchy.
-If the name is not unique for the queue in the configuration or contains a dot
a parsing error is generated and the configuration is rejected.
+
+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 (-).
+
+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.
Review Comment:
nit: "...or does not follow the above rules, a parsing error is generated..."
##########
docs/user_guide/queue_config.md:
##########
@@ -265,7 +271,19 @@ The star "*" is the wildcard character and matches all
users or groups.
Duplicate entries in the lists are ignored and do not cause a parsing error.
Specifying a star beside other list elements is not allowed.
When a wildcard group is configured, a limit must be configured with at least
one named group.
-Parsing will reject the configuration with limits that do not follow this rule.
+
+Valid User name:
+
+* must start with lower case or upper case alphabet,
+* followed by alphanumeric character ([a-z0-9A-Z]), underscores (_), colons
(:), hashes (#), slashes (/), at signs (@), dots (.), and dashes (-).
+* could end with dollar ($).
Review Comment:
nit: "could" -> "can"
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
