update docs

Project-HAMi · Jun 24, 2024 · 8d6af35 · 8d6af35
1 parent 5d370fc
commit 8d6af35
Show file tree

Hide file tree

Showing 231 changed files with 13 additions and 2,423 deletions.
diff --git a/.bashrc b/.bashrc
diff --git a/.profile b/.profile
diff --git a/README.md b/README.md
@@ -1,21 +1,17 @@
-# DCU vGPU device plugin for HAMi
+# Mock device plugin for HAMi
 
 ## Introduction
-This is a [Kubernetes][k8s] [device plugin][dp] implementation that enables the registration of hygon DCU in a container cluster for compute workload.  With the approrpriate hardware and this plugin deployed in your Kubernetes cluster, you will be able to run jobs that require AMD DCU. It supports DCU-virtualzation by using hy-virtual provided by dtk
+This is a [Kubernetes][k8s] [device plugin][dp] implementation that enables the registration of virtual-devices which would normally be ignored by scheduler (i.e gpu-memory, gpu-cores, etc..)on each node. After deployment, these resources will be available on node.status.allocatable and node.status.capacity
 
 
-## Prerequisites
-* dtk >= 24.04
-* hy=smi == v1.6.0
-
 
 ## Limitations
 * This plugin targets Kubernetes v1.18+.
 
 ## Deployment
 ```
-$ kubectl apply -f k8s-dcu-rbac.yaml
-$ kubectl apply -f k8s-dcu-plugin.yaml
+$ kubectl apply -f k8s-mock-rbac.yaml
+$ kubectl apply -f k8s-mock-plugin.yaml
 ```
 
 ## Build
@@ -26,40 +22,15 @@ docker build .
 ## Examples
 
 ```
-apiVersion: v1
-kind: Pod
-metadata:
-  name: alexnet-tf-gpu-pod-mem
-  labels:
-    purpose: demo-tf-amdgpu
-spec:
-  containers:
-    - name: alexnet-tf-gpu-container
-      image: ubuntu:20.04
-      workingDir: /root
-      command: ["sleep","infinity"]
-      resources:
-        limits:
-          hygon.com/dcunum: 1 # requesting a GPU
-          hygon.com/dcumem: 2000 # each dcu require 2000 MiB device memory
-          hygon.com/dcucores: 15 # each dcu use 60% of total compute cores
-```
-
-## Validation
-
-Inside container, use hy-virtual to validate
-
-```
-source /opt/hygondriver/env.sh
-hy-virtual -show-device-info
-```
-
-There will be output like these:
-```
-Device 0:
-	Actual Device: 0
-	Compute units: 9
-	Global memory: 2097152000 bytes
+Allocatable:
+  ...
+  memory:                             769189866507
+  nvidia.com/gpu:                     20
+  nvidia.com/gpucores:                200
+  nvidia.com/gpumem:                  65536
+  nvidia.com/gpumem-percentage:       200
+  pods:                               110
+  ...
 ```
 
 ## Maintainer

diff --git a/example/README.md b/example/README.md
diff --git a/example/default_use.yaml b/example/default_use.yaml
diff --git a/example/exlusive_use.yaml b/example/exlusive_use.yaml
diff --git a/example/pod/alexnet-cpu.yaml b/example/pod/alexnet-cpu.yaml
diff --git a/example/pod/alexnet-gpu.yaml b/example/pod/alexnet-gpu.yaml
diff --git a/example/pod/k8s-plugin.tar b/example/pod/k8s-plugin.tar
diff --git a/helm/amd-gpu/.helmignore b/helm/amd-gpu/.helmignore
diff --git a/helm/amd-gpu/Chart.yaml b/helm/amd-gpu/Chart.yaml
diff --git a/helm/amd-gpu/README.md b/helm/amd-gpu/README.md
diff --git a/helm/amd-gpu/templates/NOTES.txt b/helm/amd-gpu/templates/NOTES.txt