diff --git a/docs/user-guide/how_to_use_nodegroup_plugin.md b/docs/user-guide/how_to_use_nodegroup_plugin.md new file mode 100644 index 00000000000..3a27e1a30b0 --- /dev/null +++ b/docs/user-guide/how_to_use_nodegroup_plugin.md @@ -0,0 +1,225 @@ +# Nodegroup Plugin User Guide + +## Introduction + +**Nodegroup plugin** is designed to isolate resources by assigning labels to nodes and set node label affinty on Queue. + +## Usage + +### assign label to node +Assign label to node, label key is `volcano.sh/nodegroup-name`. +```shell script +kubectl label nodes volcano.sh/nodegroup-name= +``` + +### configure queue +Create queue and bind nodegroup to it. + + ```yaml + apiVersion: scheduling.volcano.sh/v1beta1 + kind: Queue + metadata: + name: default + spec: + reclaimable: true + weight: 1 + affinity: # added field + nodeGroupAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + - + preferredDuringSchedulingIgnoredDuringExecution: + - + nodeGroupAntiAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + - + preferredDuringSchedulingIgnoredDuringExecution: + - + ``` +### submit a vcjob + +submit vcjob job-1 to default queue. + +```shell script +$ cat <