Merge pull request #60 from peachest/feat/runtime-class

feat: add ascend RuntimeClass manifest

Author: hami-robot[bot]

README.md

@@ -32,17 +32,22 @@ docker buildx build -t $IMAGE_NAME .
 
 ### Label the Node with `ascend=on`
 
-
-```
+```bash
 kubectl label node {ascend-node} ascend=on
-``` 
+```
 
 ### Deploy ConfigMap
 
-```
+```bash
 kubectl apply -f ascend-device-configmap.yaml
 ```
 
+### Deply RuntimeClass
+
+```bash
+kubectl apply -f ascend-runtimeclass.yaml
+```
+
 ### Deploy `ascend-device-plugin`
 
 ```bash
@@ -51,6 +56,14 @@ kubectl apply -f ascend-device-plugin.yaml
 
 If scheduling Ascend devices in HAMi, simply set `devices.ascend.enabled` to true when deploying HAMi, and the ConfigMap and `ascend-device-plugin` will be automatically deployed. refer https://github.com/Project-HAMi/HAMi/blob/master/charts/hami/README.md#huawei-ascend
 
+If you require HAMi to automatically add the `runtimeClassName` configuration to Pods requesting Ascend resources (this is disabled by default), you should set `devices.ascend.runtimeClassName` value to **a non-empty string** in HAMi’s `values.yaml` file, ensuring it matches the name of the `RuntimeClass` resource. For example:
+
+```yaml
+devices:
+  ascend:
+    runtimeClassName: ascend
+```
+
 ## Usage
 
 To exclusively use an entire card or request multiple cards, you only need to set the corresponding resourceName. If multiple tasks need to share the same NPU, you need to set the corresponding resource request to 1 and configure the appropriate ResourceMemoryName.

README_cn.md

@@ -32,16 +32,22 @@ docker buildx build -t $IMAGE_NAME .
 
 ### 给 Node 打 ascend 标签
 
-```
+```bash
 kubectl label node {ascend-node} ascend=on
 ```
 
 ### 部署 ConfigMap
 
-```
+```bash
 kubectl apply -f ascend-device-configmap.yaml
 ```
 
+### 部署 RuntimeClass
+
+```bash
+kubectl apply -f ascend-runtimeclass.yaml
+```
+
 ### 部署 `ascend-device-plugin`
 
 ```bash
@@ -50,6 +56,14 @@ kubectl apply -f ascend-device-plugin.yaml
 
 如果要在HAMi中使用升腾NPU, 在部署HAMi时设置 `devices.ascend.enabled` 为 true 会自动部署 ConfigMap 和 `ascend-device-plugin`。 参考 <https://github.com/Project-HAMi/HAMi/blob/master/charts/hami/README.md#huawei-ascend>
 
+如果需要 HAMi 为申请 ascend 资源的 Pod 自动添加 runtimeClassName 配置（默认关闭），则应该在 HAMi 的 values.yaml 文件中配置 `deivces.ascend.runtimeClassName` 为**一个非空字符串**，并且与 RuntimeClass 资源名称保持一致。 例如：
+
+```yaml
+devices:
+  ascend:
+    runtimeClassName: ascend
+```
+
 ## 使用
 
 如果要独占整卡或者申请多张卡只需要设置对应的 resourceName 即可。如果多个任务要共享同一张卡，需要将 resourceName 设置为1，并且设置对应的 ResourceMemoryName。

ascend-runtimeclass.yaml

@@ -0,0 +1,6 @@
+apiVersion: node.k8s.io/v1
+handler: ascend
+kind: RuntimeClass
+metadata:
+  name: ascend
+handler: ascend