Merge pull request #67 from archlitchi/update_documents

update documents about dynamic-mig feature

Author: archlitchi

README.md

@@ -77,9 +77,9 @@ We will be editing the docker daemon config file which is usually present at `/e
 > *if `runtimes` is not already present, head to the install page of [nvidia-docker](https://github.com/NVIDIA/nvidia-docker)*
 
 
-### Configure scheduler
+### Configuration
 
-update the scheduler configuration:
+You need to enable vgpu in volcano-scheduler configMap:
 
 ```shell script
 kubectl edit cm -n volcano-system volcano-scheduler-configmap
@@ -111,7 +111,17 @@ data:
       - name: binpack
 ```
 
-Customize your installation by adjusting the [configs](doc/config.md)
+### Sharing Mode
+
+Volcano-vgpu supports two types of device-sharing: `HAMi-core` and `dynamia-mig`, A node can either using `HAMi-core`, or `Dynamic-mig`. Heterogeneous is supported(a part of node using HAMi-core, the other using Dynamic-mig)
+
+A brief introduction about these two modes:
+
+HAMi-core is a user-layer resource isolator provided by HAMi community, works on all types of GPU.
+
+Dynamic-mig is a hardware resource isolator, works on Ampere arch or later GPU. 
+
+You can set the sharing mode and customize your installation by adjusting the [configs](doc/config.md)
 
 
 ### Enabling GPU Support in Kubernetes
@@ -130,28 +140,7 @@ Check the node status, it is ok if `volcano.sh/vgpu-number` is included in the a
 ```shell script
 $ kubectl get node {node name} -oyaml
 ...
-status:
-  addresses:
-  - address: 172.17.0.3
-    type: InternalIP
-  - address: volcano-control-plane
-    type: Hostname
-  allocatable:
-    cpu: "4"
-    ephemeral-storage: 123722704Ki
-    hugepages-1Gi: "0"
-    hugepages-2Mi: "0"
-    memory: 8174332Ki
-    pods: "110"
-    volcano.sh/vgpu-memory: "89424"
-    volcano.sh/vgpu-number: "10"    # vGPU resource
   capacity:
-    cpu: "4"
-    ephemeral-storage: 123722704Ki
-    hugepages-1Gi: "0"
-    hugepages-2Mi: "0"
-    memory: 8174332Ki
-    pods: "110"
     volcano.sh/vgpu-memory: "89424"
     volcano.sh/vgpu-number: "10"   # vGPU resource
 ```
@@ -166,6 +155,8 @@ apiVersion: v1
 kind: Pod
 metadata:
   name: gpu-pod1
+  annotations:
+    volcano.sh/vgpu-mode: "hami-core" # (Optional, 'hami-core' or 'mig')
 spec:
   schedulerName: volcano
   containers:
@@ -188,6 +179,7 @@ You can validate device memory using nvidia-smi inside container:
 > **WARNING:** *if you don't request GPUs when using the device plugin with NVIDIA images all
 > the GPUs on the machine will be exposed inside your container.
 > The number of vgpu used by a container can not exceed the number of gpus on that node.*
+> You can specify the mode of this task by assigning `volcano.sh/vgpu-mode` annotations, If not, both modes are possible.
 
 ### Monitor
 

examples/vgpu-case01.yml

@@ -6,7 +6,7 @@ spec:
   restartPolicy: OnFailure
   schedulerName: volcano
   containers:
-  - image: ubuntu:20.04
+  - image: ubuntu:24.04
     name: pod1-ctr
     command: ["sleep"]
     args: ["100000"]

examples/vgpu-case02.yml

@@ -6,12 +6,11 @@ spec:
   restartPolicy: OnFailure
   schedulerName: volcano
   containers:
-  - image: nvidia/cuda:11.2.2-base-ubi8
+  - image: ubuntu:24.04
     name: pod1-ctr
     command: ["sleep"]
     args: ["100000"]
     resources:
       limits:
         volcano.sh/vgpu-number: 1 #request 1 GPU
-        volcano.sh/vgpu-cores: 50 #each GPU request 50% of compute core resources
         volcano.sh/vgpu-memory: 10240 #each GPU request 10G device memory

examples/vgpu-deployment.yaml

@@ -15,9 +15,9 @@ spec:
       schedulerName: volcano
       containers:
       - name: resnet101-container
-        image: ubuntu:18.04
+        image: ubuntu:24.04
         command: ["sleep","infinity"]
         resources:
          limits:
             volcano.sh/vgpu-number: 1 # requesting 2 vGPUs
-            volcano.sh/vgpu-memory: 16384
+            volcano.sh/vgpu-memory: 16384