You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@yunikorn.apache.org by "yzhangal (via GitHub)" <gi...@apache.org> on 2023/06/28 00:02:38 UTC

[GitHub] [yunikorn-site] yzhangal opened a new pull request, #321: [YUNIKORN-1831] Incorrect key name used for user info in pod annotati…

yzhangal opened a new pull request, #321:
URL: https://github.com/apache/yunikorn-site/pull/321

   …on in user guide example
   
   ### What is this PR for?
   This PR is to fix the documentation about setting user info in annotation.
   
   There are two issues:
   1. The "username" word should be "user" which is implemented in code
   2. There need to be quote around the keys "user", "groups"
   
   ### What type of PR is it?
   * [ ] - Bug Fix
   * [x ] - Improvement
   * [ ] - Feature
   * [x] - Documentation
   * [ ] - Hot Fix
   * [ ] - Refactoring
   
   ### Todos
   * [ ] - Task
   
   ### What is the Jira issue?
   * https://issues.apache.org/jira/browse/YUNIKORN-1831
   
   ### How should this be tested?
   Tested in locally built doc and content was tested in real cluster
   
   ### Screenshots (if appropriate)
   
   ### Questions:
   * [ ] - The licenses files need update.
   * [ ] - There is breaking changes for older versions.
   * [ ] - It needs documentation.
   


-- 
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: reviews-unsubscribe@yunikorn.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [yunikorn-site] craigcondit closed pull request #321: [YUNIKORN-1831] Incorrect key name used for user info in pod annotati…

Posted by "craigcondit (via GitHub)" <gi...@apache.org>.
craigcondit closed pull request #321: [YUNIKORN-1831] Incorrect key name used for user info in pod annotati…
URL: https://github.com/apache/yunikorn-site/pull/321


-- 
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: reviews-unsubscribe@yunikorn.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [yunikorn-site] craigcondit commented on a diff in pull request #321: [YUNIKORN-1831] Incorrect key name used for user info in pod annotati…

Posted by "craigcondit (via GitHub)" <gi...@apache.org>.
craigcondit commented on code in PR #321:
URL: https://github.com/apache/yunikorn-site/pull/321#discussion_r1248042036


##########
docs/user_guide/usergroup_resolution.md:
##########
@@ -86,14 +86,16 @@ metadata:
   annotations:
     yunikorn.apache.org/user.info: "
     {
-      username: \"yunikorn\",
-      groups: [
+      \"user\": \"yunikorn\",
+      \"groups\": [
         \"developers\",
         \"devops\"
       ]
     }"
 ```
 
+(NOTE: for historical reason, "username" is used in label "yunikorn.apache.org/username", whereas, "user" is used in the annotation here)

Review Comment:
   I think we should leave the note out as it's completely obsolete. It's likely to cause more confusion than not. The old label still exists but has completely different meaning and semantics. 



-- 
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: reviews-unsubscribe@yunikorn.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [yunikorn-site] yzhangal commented on a diff in pull request #321: [YUNIKORN-1831] Incorrect key name used for user info in pod annotati…

Posted by "yzhangal (via GitHub)" <gi...@apache.org>.
yzhangal commented on code in PR #321:
URL: https://github.com/apache/yunikorn-site/pull/321#discussion_r1248092711


##########
docs/user_guide/usergroup_resolution.md:
##########
@@ -86,14 +86,16 @@ metadata:
   annotations:
     yunikorn.apache.org/user.info: "
     {
-      username: \"yunikorn\",
-      groups: [
+      \"user\": \"yunikorn\",
+      \"groups\": [
         \"developers\",
         \"devops\"
       ]
     }"
 ```
 
+(NOTE: for historical reason, "username" is used in label "yunikorn.apache.org/username", whereas, "user" is used in the annotation here)

Review Comment:
   Thanks Craig, submitted new rev to remove the NOTE statement.



-- 
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: reviews-unsubscribe@yunikorn.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org