This is an automated email from the ASF dual-hosted git repository.
chia7712 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 602fb55b9b [YUNIKORN-2207] Update user group documentation (#454)
602fb55b9b is described below
commit 602fb55b9b80822521a098dfbf749a32ed922b4b
Author: ryankert <ryan980...@gmail.com>
AuthorDate: Thu Jul 18 22:43:07 2024 +0800
[YUNIKORN-2207] Update user group documentation (#454)
Closes: #454
Signed-off-by: Chia-Ping Tsai <chia7...@gmail.com>
---
docs/user_guide/usergroup_resolution.md | 58 ++++++++++++++++++---------------
1 file changed, 32 insertions(+), 26 deletions(-)
diff --git a/docs/user_guide/usergroup_resolution.md
b/docs/user_guide/usergroup_resolution.md
index 8b6d48334f..b5d8f7165a 100644
--- a/docs/user_guide/usergroup_resolution.md
+++ b/docs/user_guide/usergroup_resolution.md
@@ -30,32 +30,8 @@ In Yunikorn, there are two ways of handling users and
groups. The first is the l
A more reliable and robust mechanism is using the
`yunikorn.apache.org/user.info` annotation, where the user information can be
set externally by an allowed list of users or groups or the admission
controller can attach this automatically to every workload.
-## Legacy user handling
-
-### Using the `yunikorn.apache.org/username` label
-Since, Kubernetes has no pre-defined field or resource for user information
and individual cluster deployments with unique user identification tools can
vary, we have defined a standard way of identifying the user. Yunikorn requires
a Kubernetes
[Label](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)
added. Using the
[recommendation](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/)
provided here, the default label is defined as below:
-
-| Label | Value
|
-|--------------------------------|--------------------------------------------------------------------------------------------------------------|
-| yunikorn.apache.org/username | User name. It can have duplicate
entries but only the first value will be used. The default user is `nobody` |
-
-Example:
-```yaml
-metadata:
- labels:
- yunikorn.apache.org/username: "john"
-```
-:::tip
-In order to make this field uniquiely identifiable to the authorized user, the
suggestion is to add this label as an immutable field by the user
identification tool used by the cluster administrators. The cluster
administrators or users are free to use any method or tool to add this field
and value. This includes adding it manually at the time of submission.
-:::
-
-:::note Assumption
-Assumption:
- Yunikorn assumes that all pods belonging to an application are owned by the
same user. We recommend that the user label is added to every pod of an app.
This is to ensure that there is no discrepency.
-:::
-
-### Group resolution
+## Group resolution
Group membership resolution is pluggables and is defined here. Groups do not
have to be part of provided user and group object. When the object is added to
the cache the groups are automatically resolved based on the resolution that is
configured.
The resolver which is linked to the cache can be set per partition.
@@ -67,7 +43,9 @@ Other resolvers are:
* OS resolver
* test resolver
-## The new, recommended way of handling users
+
+
+## User handling
Since Yunikorn 1.2 a more sophisticated way of user/group resolution is
available.
@@ -110,3 +88,31 @@ The admission controller can be configured with the
`yunikorn-configs` configmap
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.
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 Yuni [...]
+
+
+## Legacy user handling
+
+### Using the `yunikorn.apache.org/username` label
+
+Since, Kubernetes has no pre-defined field or resource for user information
and individual cluster deployments with unique user identification tools can
vary, we have defined a standard way of identifying the user. Yunikorn requires
a Kubernetes
[Label](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)
added. Using the
[recommendation](https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/)
provided here, the default label is defined as below:
+
+| Label | Value
|
+|--------------------------------|--------------------------------------------------------------------------------------------------------------|
+| yunikorn.apache.org/username | User name. It can have duplicate
entries but only the first value will be used. The default user is `nobody` |
+
+Example:
+```yaml
+metadata:
+ labels:
+ yunikorn.apache.org/username: "john"
+```
+:::tip
+In order to make this field uniquiely identifiable to the authorized user, the
suggestion is to add this label as an immutable field by the user
identification tool used by the cluster administrators. The cluster
administrators or users are free to use any method or tool to add this field
and value. This includes adding it manually at the time of submission.
+:::
+
+:::note Assumption
+Assumption:
+ Yunikorn assumes that all pods belonging to an application are owned by the
same user. We recommend that the user label is added to every pod of an app.
This is to ensure that there is no discrepency.
+:::
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@yunikorn.apache.org
For additional commands, e-mail: issues-h...@yunikorn.apache.org
