You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by cc...@apache.org on 2023/05/23 18:40:30 UTC
[yunikorn-site] branch master updated: [YUNIKORN-1654] Document dynamic namespace processing functionality (#296)
This is an automated email from the ASF dual-hosted git repository.
ccondit pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new 42123ecd2 [YUNIKORN-1654] Document dynamic namespace processing functionality (#296)
42123ecd2 is described below
commit 42123ecd265cc45657731f79b5f10fa8479b542c
Author: wusamzong <t3...@gmail.com>
AuthorDate: Tue May 23 13:40:13 2023 -0500
[YUNIKORN-1654] Document dynamic namespace processing functionality (#296)
Closes: #296
Signed-off-by: Craig Condit <cc...@apache.org>
---
docs/user_guide/labels_and_annotations_in_yunikorn.md | 2 ++
docs/user_guide/service_config.md | 11 ++++++++++-
2 files changed, 12 insertions(+), 1 deletion(-)
diff --git a/docs/user_guide/labels_and_annotations_in_yunikorn.md b/docs/user_guide/labels_and_annotations_in_yunikorn.md
index f5da6fc7a..d85cda899 100644
--- a/docs/user_guide/labels_and_annotations_in_yunikorn.md
+++ b/docs/user_guide/labels_and_annotations_in_yunikorn.md
@@ -49,5 +49,7 @@ All annotations are under the namespace `yunikorn.apache.org`. For example `yuni
| `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] `namespace.max.cpu` | Replaced with ``namespace.quota`` since version 1.2.0 |
| [DEPRECATED] `namespace.max.memory` | Replaced with `namespace.quota` since version 1.2.0 |
+| `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. |
+| `namespace.generateAppId` | Controls which namespaces will have pods labeled with an `applicationId`. 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).
diff --git a/docs/user_guide/service_config.md b/docs/user_guide/service_config.md
index 47ea9af78..f4f3a1258 100644
--- a/docs/user_guide/service_config.md
+++ b/docs/user_guide/service_config.md
@@ -753,6 +753,10 @@ Example:
# Don't schedule pods in kube-system or fluentd-* namespaces
admissionController.filtering.bypassNamespaces: "^kube-system$,^fluentd-"
```
+
+> **_NOTE :_**
+> To simplify management, you can directly set the `yunikorn.apache.org/namespace.enableYunikorn` annotation on the namespace itself, regardless of whether it is specified in a regular expression. This annotation enables you to determine if the namespace should be managed by Yunikorn.
+
#### admissionController.filtering.labelNamespaces
Controls which namespaces will have pods labeled with an `applicationId`. By default,
all pods which are scheduled by YuniKorn will have an `applicationId` label applied.
@@ -801,8 +805,12 @@ Example:
# Skip queueing in the noqueue namespace
admissionController.filtering.labelNamespaces: "^noqueue$"
```
+
+> **_NOTE :_**
+> To simplify management, you can directly set the `yunikorn.apache.org/namespace.generateAppId` annotation on the namespace itself, regardless of whether it is specified in a regular expression. This annotation enables you to determine if the namespace should be labeled by Yunikorn.
+
#### admissionController.filtering.generateUniqueAppId
-YuniKorn generates `applicationId` for all the apps that do not have an `applicationId` to start with. This property controlls if a *unique* `applicationId` should be generated for each such application or all the apps in a namespace should be bundled under a single `applicationId`.
+YuniKorn generates `applicationId` for all the apps that do not have an `applicationId` to start with. This property controls if a *unique* `applicationId` should be generated for each such application or all the apps in a namespace should be bundled under a single `applicationId`.
This setting is turned off by default and only one `applicationId` will be generated per namespace.
@@ -814,6 +822,7 @@ Example:
```yaml
admissionController.filtering.generateUniqueAppId: "true"
```
+
### Admission controller ACL settings
#### admissionController.accessControl.bypassAuth