[yunikorn-site] branch master updated: [YUNIKORN-1763] Allow setting custom default queue (#302)

[wi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wilfreds 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 de9c2eabf [YUNIKORN-1763] Allow setting custom default queue (#302)
de9c2eabf is described below

commit de9c2eabf96b37af989886319eebc292757bac98
Author: Mit Desai <mi...@gmail.com>
AuthorDate: Wed May 24 13:16:34 2023 +1000

    [YUNIKORN-1763] Allow setting custom default queue (#302)
    
    The default queue can now be set to a custom queue or left empty using a
    configuration setting for the admission controller
    
    Closes: #302
    
    Signed-off-by: Wilfred Spiegelenburg <wi...@apache.org>
---
 docs/user_guide/service_config.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/docs/user_guide/service_config.md b/docs/user_guide/service_config.md
index f4f3a1258..d698b4cd4 100644
--- a/docs/user_guide/service_config.md
+++ b/docs/user_guide/service_config.md
@@ -455,6 +455,7 @@ data:
   admissionController.filtering.labelNamespaces: ""
   admissionController.filtering.noLabelNamespaces: ""
   admissionController.filtering.generateUniqueAppId: "false"
+  admissionController.filtering.defaultQueue: "root.default"
   admissionController.accessControl.bypassAuth: "false"
   admissionController.accessControl.trustControllers: "true"
   admissionController.accessControl.systemUsers: "^system:serviceaccount:kube-system:"
@@ -823,6 +824,34 @@ Example:
 admissionController.filtering.generateUniqueAppId: "true"
 ```
 
+#### admissionController.filtering.defaultQueue
+Controlls what will be the default queue name for the application.
+
+If the application does not define a queue name during app submission, admission controller will add a default queue name to the pod labels. `root.default` queue name will be added to the pod labels if this property is not set.
+
+In case, the default queue name needs to be updated to something other than `root.default`,  `admissionController.filtering.defaultQueue` can be set with the desired queue name.
+
+Example:
+```yaml
+# Change default queue to root.mydefault
+admissionController.filtering.defaultQueue: "root.mydefault"
+```
+
+**_NOTE :_**
+The queue name needs to be a fully qualified queue name.
+
+For certain use-cases, there may be a need to skip adding a default queue name to the pod labels. In such cases, `admissionController.filtering.defaultQueue` can be set to empty string.
+
+Adding default queue name should be avoided when `provided` rule is used in conjunction with other placement rules and `provided` rule is higher in the hierarchy. If default queue label is added whenever there is no queue name specified, all the apps will be placed via `provided` rule and the other rules after that will never be executed.
+
+Default: empty
+
+Example:
+```yaml
+# Skip adding default queue name
+admissionController.filtering.defaultQueue: ""
+```
+
 ### Admission controller ACL settings
 
 #### admissionController.accessControl.bypassAuth