[incubator-yunikorn-site] branch master updated: [YUNIKORN-808] document child template (#73)

[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/incubator-yunikorn-site.git


The following commit(s) were added to refs/heads/master by this push:
     new 4997fe9  [YUNIKORN-808] document child template (#73)
4997fe9 is described below

commit 4997fe9cd19c44a1a8149cf20475681ce46670d3
Author: Chia-Ping Tsai <ch...@gmail.com>
AuthorDate: Wed Sep 8 11:39:58 2021 +1000

    [YUNIKORN-808] document child template (#73)
    
    Child template for parent queue documentation
    
    Fixes: #73
---
 docs/user_guide/queue_config.md | 49 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/docs/user_guide/queue_config.md b/docs/user_guide/queue_config.md
index a3a931f..26dd0f7 100644
--- a/docs/user_guide/queue_config.md
+++ b/docs/user_guide/queue_config.md
@@ -302,3 +302,52 @@ resources:
     <resource name 2>: <0..maxint>
 ```
 Resources that are not specified in the list are not limited, for max resources, or guaranteed in the case of guaranteed resources. 
+
+### Child Template
+
+The parent queue can provide a template to define the behaviour of dynamic leaf queues below it. A parent queue having no child template inherits the child template
+from its parent if that parent has one defined. A child template can be defined at any level in the queue hierarchy on a queue that is of the type parent.
+
+The supported configuration in template are shown below.
+1. application sort policy
+2. max resources
+3. guaranteed resources
+4. max applications
+
+As an example:
+```yaml
+ partitions:
+   - name: default
+     placementrules:
+       - name: provided
+         create: true
+     queues:
+       - name: root
+         submitacl: '*'
+         childtemplate:
+           maxapplications: 10
+           properties:
+             application.sort.policy: stateaware
+           resources:
+             guaranteed:
+               vcore: 1000
+               memory: 1000
+             max:
+               vcore: 20000
+               memory: 600000
+         queues:
+           - name: parent
+             parent: true
+             childtemplate:
+               resources:
+                 max:
+                   vcore: 21000
+                   memory: 610000
+           - name: notemplate
+             parent: true
+```
+In this case, `root.parent.sales` will directly use the child template of parent queue `root.parent`. By contrast,
+`root.notemplate.sales` will use the child template set on the queue `root` since its parent queue `root.notemplate` inherits the child template from the queue `root`.
+
+[DEPRECATED] Please migrate to template if your cluster is relying on old behavior that dynamic leaf queue can inherit
+`application.sort.policy` from parent (introduced by [YUNIKORN-195](https://issues.apache.org/jira/browse/YUNIKORN-195)). The old behavior will get removed in the future release.