wilfred-s commented on a change in pull request #27:
URL:
https://github.com/apache/incubator-yunikorn-site/pull/27#discussion_r519680850
##########
File path: docs/user_guide/resource_quota_mgmt.md
##########
@@ -121,80 +142,104 @@ partitions:
submitacl: '*'
properties:
application.sort.policy: stateaware
-
```
-Note, the property `application.sort.policy` in this configuration is set to
-`stateaware`. This is a simple app sorting policy applicable for batch jobs,
you
-can find more document [here](sorting_policies.md#StateAwarePolicy).
+This configuration places an application based on the `tag` rule.
+The tag selected is the `namespace` tag which is automatically added by the
k8s shim to all applications that get created.
+The `create` flag is set to true which will trigger the creation of the queue
with the same name as the namespace if it does not exist.
-You can do this during the installation by overwriting the configuration in the
-[helm chart
template](https://github.com/apache/incubator-yunikorn-release/blob/724ec82d0d548598e170cc6d5ca6aaae00f8286c/helm-charts/yunikorn/values.yaml#L71-L81).
+Applications within the automatically created child queues will be sorted
based sorting policy set on the parent queue.
+In this case the property `application.sort.policy` is in this configuration
set to `stateaware`.
+This is a simple app sorting policy applicable for batch jobs, you can find
more document [here](sorting_policies.md#StateAwarePolicy).
-### Set up namespaces
+You can change the configuration using the helm charts during the installation
by overwriting the configuration in the
+[helm chart
template](https://github.com/apache/incubator-yunikorn-release/blob/master/helm-charts/yunikorn/values.yaml#L71-L81).
-Continue to create namespaces like before, do not create namespace quota
anymore.
-Instead, set the following annotation in the namespace object:
+### Namespace quota
+Namespaces in Kubernetes contain the quota information.
+If a quota is set on a namespace Kubernetes will automatically enforce the
quota.
+In the case that YuniKorn is used for quota enforcement no quota must be set
on the namespace.
+To allow specifying a quota on the namespace the following annotations should
be set in the namespace object:
```yaml
yunikorn.apache.org/namespace.max.cpu: "64"
yunikorn.apache.org/namespace.max.memory: "100Gi"
```
+YuniKorn will parse these annotations and set the maximum capacity of the
queue mapped to this namespace.
+The values specified follow the standard Kubernetes formatting and unit
specification.
+Currently, we only support mapping memory and cpu not other resource types.
-YuniKorn will parse the annotation and set the max capacity of the dynamical
queue
-that mapped to this namespace to 64 CPU and 100GB memory.
+The example above will limit the queue mapped to the annotated namespace to 64
CPUs and 100GB memory.
-### Run workloads
+### Run a workload
-Jobs continue to be submitted to namespaces, based on the `Placementrule` used
-in the configuration. YuniKorn will automatically run the job and all its pods
in
-the corresponding queue. For example, if a job is submitted to namespace
`development`,
-then you will see the job is running in `root.development` queue.
+Applications, and the pods that are part of the application, can be submitted
without specific labels.
+YuniKorn will automatically add the required tags.
+The configured placement rule will create the queue, if required, and add the
application to the queue.
+
+For example, if an application is submitted to namespace `development`, then
the application will run in the `root.development` queue.
-## Option 3) Hierarchy queues with dynamical leaves that mapped to namespaces
+## Parent queue mapping
Review comment:
yes correct, changed title slightly adding a diagram as an example too
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
[email protected]
