From eb39d17b48703308a4575bec271cb20abc570a15 Mon Sep 17 00:00:00 2001 From: mesutoezdil Date: Thu, 7 May 2026 22:28:31 +0200 Subject: [PATCH] fix: correct technical errors in configure, ascend, prerequisites, and webui docs - configure.md: fix nvidia.resourceCoreName default value from nvidia.com/cores to nvidia.com/gpucores across docs and all versioned snapshots (v2.5.1, v2.6.0, v2.7.0, v2.8.0) - enable-ascend-sharing.md: fix two typos in notes section: Ascend91B0 -> Ascend910B and huawe.com -> huawei.com across docs and all versioned snapshots (v1.3.0, v2.4.1, v2.5.0, v2.5.1, v2.6.0, v2.7.0, v2.8.0) - prerequisites.md: add missing sudo before systemctl restart docker in all versioned snapshots (v1.3.0, v2.4.1, v2.5.0, v2.5.1, v2.6.0, v2.7.0, v2.8.0) - webui-installation.md: fix namespace inconsistency in troubleshooting and uninstall sections (hami -> kube-system to match install command) Signed-off-by: mesutoezdil --- docs/installation/webui-installation.md | 18 ++++-------------- .../ascend-device/enable-ascend-sharing.md | 4 ++-- docs/userguide/configure.md | 2 +- .../installation/prerequisites.md | 2 +- .../ascend-device/enable-ascend-sharing.md | 2 +- .../installation/prerequisites.md | 2 +- .../ascend-device/enable-ascend-sharing.md | 2 +- .../installation/prerequisites.md | 2 +- .../ascend-device/enable-ascend-sharing.md | 2 +- .../installation/prerequisites.md | 2 +- .../ascend-device/enable-ascend-sharing.md | 4 ++-- .../version-v2.5.1/userguide/configure.md | 2 +- .../installation/prerequisites.md | 2 +- .../ascend-device/enable-ascend-sharing.md | 4 ++-- .../version-v2.6.0/userguide/configure.md | 2 +- .../installation/prerequisites.md | 2 +- .../ascend-device/enable-ascend-sharing.md | 4 ++-- .../version-v2.7.0/userguide/configure.md | 2 +- .../installation/prerequisites.md | 2 +- .../ascend-device/enable-ascend-sharing.md | 4 ++-- .../version-v2.8.0/userguide/configure.md | 2 +- 21 files changed, 29 insertions(+), 39 deletions(-) diff --git a/docs/installation/webui-installation.md b/docs/installation/webui-installation.md index a6b8141e..6bb31b2d 100644 --- a/docs/installation/webui-installation.md +++ b/docs/installation/webui-installation.md @@ -80,26 +80,16 @@ It is important to view the HAMi-WebUI server logs while troubleshooting any iss To check the HAMi-WebUI logs, run the following command: ```bash -kubectl logs --namespace=hami deploy/my-hami-webui -c hami-webui-fe-oss -kubectl logs --namespace=hami deploy/my-hami-webui -c hami-webui-be-oss +kubectl logs --namespace=kube-system deploy/my-hami-webui -c hami-webui-fe-oss +kubectl logs --namespace=kube-system deploy/my-hami-webui -c hami-webui-be-oss ``` For more information about accessing Kubernetes application logs, refer to [Pods](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#interacting-with-running-pods) and [Deployments](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#interacting-with-deployments-and-services). ## Uninstall the HAMi-WebUI deployment -To uninstall the HAMi-WebUI deployment, run the command: - -`helm uninstall ` - -```bash -helm uninstall my-hami-webui -n hami -``` - -This deletes all of the objects from the given namespace hami. - -If you want to delete the namespace `hami`, then run the command: +To uninstall the HAMi-WebUI deployment, run: ```bash -kubectl delete namespace hami +helm uninstall my-hami-webui -n kube-system ``` diff --git a/docs/userguide/ascend-device/enable-ascend-sharing.md b/docs/userguide/ascend-device/enable-ascend-sharing.md index aafcf0ed..4a598d22 100644 --- a/docs/userguide/ascend-device/enable-ascend-sharing.md +++ b/docs/userguide/ascend-device/enable-ascend-sharing.md @@ -104,5 +104,5 @@ spec: 1. Ascend-sharing in init container is not supported. -1. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend91B0=1`. - `huawe.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. +1. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend910B=1`. + `huawei.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. diff --git a/docs/userguide/configure.md b/docs/userguide/configure.md index 08ca757a..74004728 100644 --- a/docs/userguide/configure.md +++ b/docs/userguide/configure.md @@ -37,7 +37,7 @@ You can update these configurations using one of the following methods: | `nvidia.resourceCountName` | String | vGPU number resource name. | `"nvidia.com/gpu"` | | `nvidia.resourceMemoryName` | String | vGPU memory size resource name. | `"nvidia.com/gpumem"` | | `nvidia.resourceMemoryPercentageName` | String | vGPU memory fraction resource name. | `"nvidia.com/gpumem-percentage"` | - | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/cores"` | + | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/gpucores"` | | `nvidia.resourcePriorityName` | String | vGPU job priority name. | `"nvidia.com/priority"` | ## Node Configs: ConfigMap diff --git a/versioned_docs/version-v1.3.0/installation/prerequisites.md b/versioned_docs/version-v1.3.0/installation/prerequisites.md index 13666bb8..2ec554d2 100644 --- a/versioned_docs/version-v1.3.0/installation/prerequisites.md +++ b/versioned_docs/version-v1.3.0/installation/prerequisites.md @@ -48,7 +48,7 @@ When running `Kubernetes` with `Docker`, edit the configuration file, typically And then restart `Docker`: ``` -sudo systemctl daemon-reload && systemctl restart docker +sudo systemctl daemon-reload && sudo systemctl restart docker ``` diff --git a/versioned_docs/version-v1.3.0/userguide/ascend-device/enable-ascend-sharing.md b/versioned_docs/version-v1.3.0/userguide/ascend-device/enable-ascend-sharing.md index ad6dffd3..ba6d9275 100644 --- a/versioned_docs/version-v1.3.0/userguide/ascend-device/enable-ascend-sharing.md +++ b/versioned_docs/version-v1.3.0/userguide/ascend-device/enable-ascend-sharing.md @@ -105,4 +105,4 @@ spec: 1. Ascend-sharing in init container is not supported. -2. `huawei.com/Ascend910B-memory` only work when `huawei.com/Ascend91B0=1`, `huawe.com/Ascend310P-memory` only work when `huawei.com/Ascend310P=1`,etc.. \ No newline at end of file +2. `huawei.com/Ascend910B-memory` only work when `huawei.com/Ascend910B=1`, `huawei.com/Ascend310P-memory` only work when `huawei.com/Ascend310P=1`,etc.. \ No newline at end of file diff --git a/versioned_docs/version-v2.4.1/installation/prerequisites.md b/versioned_docs/version-v2.4.1/installation/prerequisites.md index 13666bb8..2ec554d2 100644 --- a/versioned_docs/version-v2.4.1/installation/prerequisites.md +++ b/versioned_docs/version-v2.4.1/installation/prerequisites.md @@ -48,7 +48,7 @@ When running `Kubernetes` with `Docker`, edit the configuration file, typically And then restart `Docker`: ``` -sudo systemctl daemon-reload && systemctl restart docker +sudo systemctl daemon-reload && sudo systemctl restart docker ``` diff --git a/versioned_docs/version-v2.4.1/userguide/ascend-device/enable-ascend-sharing.md b/versioned_docs/version-v2.4.1/userguide/ascend-device/enable-ascend-sharing.md index ad6dffd3..ba6d9275 100644 --- a/versioned_docs/version-v2.4.1/userguide/ascend-device/enable-ascend-sharing.md +++ b/versioned_docs/version-v2.4.1/userguide/ascend-device/enable-ascend-sharing.md @@ -105,4 +105,4 @@ spec: 1. Ascend-sharing in init container is not supported. -2. `huawei.com/Ascend910B-memory` only work when `huawei.com/Ascend91B0=1`, `huawe.com/Ascend310P-memory` only work when `huawei.com/Ascend310P=1`,etc.. \ No newline at end of file +2. `huawei.com/Ascend910B-memory` only work when `huawei.com/Ascend910B=1`, `huawei.com/Ascend310P-memory` only work when `huawei.com/Ascend310P=1`,etc.. \ No newline at end of file diff --git a/versioned_docs/version-v2.5.0/installation/prerequisites.md b/versioned_docs/version-v2.5.0/installation/prerequisites.md index 13666bb8..2ec554d2 100644 --- a/versioned_docs/version-v2.5.0/installation/prerequisites.md +++ b/versioned_docs/version-v2.5.0/installation/prerequisites.md @@ -48,7 +48,7 @@ When running `Kubernetes` with `Docker`, edit the configuration file, typically And then restart `Docker`: ``` -sudo systemctl daemon-reload && systemctl restart docker +sudo systemctl daemon-reload && sudo systemctl restart docker ``` diff --git a/versioned_docs/version-v2.5.0/userguide/ascend-device/enable-ascend-sharing.md b/versioned_docs/version-v2.5.0/userguide/ascend-device/enable-ascend-sharing.md index ad6dffd3..ba6d9275 100644 --- a/versioned_docs/version-v2.5.0/userguide/ascend-device/enable-ascend-sharing.md +++ b/versioned_docs/version-v2.5.0/userguide/ascend-device/enable-ascend-sharing.md @@ -105,4 +105,4 @@ spec: 1. Ascend-sharing in init container is not supported. -2. `huawei.com/Ascend910B-memory` only work when `huawei.com/Ascend91B0=1`, `huawe.com/Ascend310P-memory` only work when `huawei.com/Ascend310P=1`,etc.. \ No newline at end of file +2. `huawei.com/Ascend910B-memory` only work when `huawei.com/Ascend910B=1`, `huawei.com/Ascend310P-memory` only work when `huawei.com/Ascend310P=1`,etc.. \ No newline at end of file diff --git a/versioned_docs/version-v2.5.1/installation/prerequisites.md b/versioned_docs/version-v2.5.1/installation/prerequisites.md index 13666bb8..2ec554d2 100644 --- a/versioned_docs/version-v2.5.1/installation/prerequisites.md +++ b/versioned_docs/version-v2.5.1/installation/prerequisites.md @@ -48,7 +48,7 @@ When running `Kubernetes` with `Docker`, edit the configuration file, typically And then restart `Docker`: ``` -sudo systemctl daemon-reload && systemctl restart docker +sudo systemctl daemon-reload && sudo systemctl restart docker ``` diff --git a/versioned_docs/version-v2.5.1/userguide/ascend-device/enable-ascend-sharing.md b/versioned_docs/version-v2.5.1/userguide/ascend-device/enable-ascend-sharing.md index c808d1dd..11ba70a8 100644 --- a/versioned_docs/version-v2.5.1/userguide/ascend-device/enable-ascend-sharing.md +++ b/versioned_docs/version-v2.5.1/userguide/ascend-device/enable-ascend-sharing.md @@ -104,5 +104,5 @@ spec: 1. Ascend-sharing in init container is not supported. -2. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend91B0=1`. - `huawe.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. +2. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend910B=1`. + `huawei.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. diff --git a/versioned_docs/version-v2.5.1/userguide/configure.md b/versioned_docs/version-v2.5.1/userguide/configure.md index b177467b..0a685543 100644 --- a/versioned_docs/version-v2.5.1/userguide/configure.md +++ b/versioned_docs/version-v2.5.1/userguide/configure.md @@ -37,7 +37,7 @@ You can update these configurations using one of the following methods: | `nvidia.resourceCountName` | String | vGPU number resource name. | `"nvidia.com/gpu"` | | `nvidia.resourceMemoryName` | String | vGPU memory size resource name. | `"nvidia.com/gpumem"` | | `nvidia.resourceMemoryPercentageName` | String | vGPU memory fraction resource name. | `"nvidia.com/gpumem-percentage"` | - | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/cores"` | + | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/gpucores"` | | `nvidia.resourcePriorityName` | String | vGPU job priority name. | `"nvidia.com/priority"` | ## Chart Configs: arguments diff --git a/versioned_docs/version-v2.6.0/installation/prerequisites.md b/versioned_docs/version-v2.6.0/installation/prerequisites.md index f08ec526..460776be 100644 --- a/versioned_docs/version-v2.6.0/installation/prerequisites.md +++ b/versioned_docs/version-v2.6.0/installation/prerequisites.md @@ -40,7 +40,7 @@ sudo nvidia-ctk runtime configure --runtime=docker And then restart `Docker`: ```bash -sudo systemctl daemon-reload && systemctl restart docker +sudo systemctl daemon-reload && sudo systemctl restart docker ``` diff --git a/versioned_docs/version-v2.6.0/userguide/ascend-device/enable-ascend-sharing.md b/versioned_docs/version-v2.6.0/userguide/ascend-device/enable-ascend-sharing.md index c808d1dd..11ba70a8 100644 --- a/versioned_docs/version-v2.6.0/userguide/ascend-device/enable-ascend-sharing.md +++ b/versioned_docs/version-v2.6.0/userguide/ascend-device/enable-ascend-sharing.md @@ -104,5 +104,5 @@ spec: 1. Ascend-sharing in init container is not supported. -2. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend91B0=1`. - `huawe.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. +2. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend910B=1`. + `huawei.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. diff --git a/versioned_docs/version-v2.6.0/userguide/configure.md b/versioned_docs/version-v2.6.0/userguide/configure.md index b177467b..0a685543 100644 --- a/versioned_docs/version-v2.6.0/userguide/configure.md +++ b/versioned_docs/version-v2.6.0/userguide/configure.md @@ -37,7 +37,7 @@ You can update these configurations using one of the following methods: | `nvidia.resourceCountName` | String | vGPU number resource name. | `"nvidia.com/gpu"` | | `nvidia.resourceMemoryName` | String | vGPU memory size resource name. | `"nvidia.com/gpumem"` | | `nvidia.resourceMemoryPercentageName` | String | vGPU memory fraction resource name. | `"nvidia.com/gpumem-percentage"` | - | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/cores"` | + | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/gpucores"` | | `nvidia.resourcePriorityName` | String | vGPU job priority name. | `"nvidia.com/priority"` | ## Chart Configs: arguments diff --git a/versioned_docs/version-v2.7.0/installation/prerequisites.md b/versioned_docs/version-v2.7.0/installation/prerequisites.md index 41bfa6d4..c4d65d54 100644 --- a/versioned_docs/version-v2.7.0/installation/prerequisites.md +++ b/versioned_docs/version-v2.7.0/installation/prerequisites.md @@ -40,7 +40,7 @@ sudo nvidia-ctk runtime configure --runtime=docker And then restart Docker: ```bash -sudo systemctl daemon-reload && systemctl restart docker +sudo systemctl daemon-reload && sudo systemctl restart docker ``` #### Configure containerd diff --git a/versioned_docs/version-v2.7.0/userguide/ascend-device/enable-ascend-sharing.md b/versioned_docs/version-v2.7.0/userguide/ascend-device/enable-ascend-sharing.md index c808d1dd..11ba70a8 100644 --- a/versioned_docs/version-v2.7.0/userguide/ascend-device/enable-ascend-sharing.md +++ b/versioned_docs/version-v2.7.0/userguide/ascend-device/enable-ascend-sharing.md @@ -104,5 +104,5 @@ spec: 1. Ascend-sharing in init container is not supported. -2. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend91B0=1`. - `huawe.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. +2. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend910B=1`. + `huawei.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. diff --git a/versioned_docs/version-v2.7.0/userguide/configure.md b/versioned_docs/version-v2.7.0/userguide/configure.md index 94f05ead..342e1142 100644 --- a/versioned_docs/version-v2.7.0/userguide/configure.md +++ b/versioned_docs/version-v2.7.0/userguide/configure.md @@ -37,7 +37,7 @@ You can update these configurations using one of the following methods: | `nvidia.resourceCountName` | String | vGPU number resource name. | `"nvidia.com/gpu"` | | `nvidia.resourceMemoryName` | String | vGPU memory size resource name. | `"nvidia.com/gpumem"` | | `nvidia.resourceMemoryPercentageName` | String | vGPU memory fraction resource name. | `"nvidia.com/gpumem-percentage"` | - | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/cores"` | + | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/gpucores"` | | `nvidia.resourcePriorityName` | String | vGPU job priority name. | `"nvidia.com/priority"` | ## Node Configs: ConfigMap diff --git a/versioned_docs/version-v2.8.0/installation/prerequisites.md b/versioned_docs/version-v2.8.0/installation/prerequisites.md index 8a90cbd0..1d295770 100644 --- a/versioned_docs/version-v2.8.0/installation/prerequisites.md +++ b/versioned_docs/version-v2.8.0/installation/prerequisites.md @@ -43,7 +43,7 @@ sudo nvidia-ctk runtime configure --runtime=docker And then restart Docker: ```bash -sudo systemctl daemon-reload && systemctl restart docker +sudo systemctl daemon-reload && sudo systemctl restart docker ``` #### Configure containerd diff --git a/versioned_docs/version-v2.8.0/userguide/ascend-device/enable-ascend-sharing.md b/versioned_docs/version-v2.8.0/userguide/ascend-device/enable-ascend-sharing.md index 21cc9aa1..392b1183 100644 --- a/versioned_docs/version-v2.8.0/userguide/ascend-device/enable-ascend-sharing.md +++ b/versioned_docs/version-v2.8.0/userguide/ascend-device/enable-ascend-sharing.md @@ -104,5 +104,5 @@ spec: 1. Ascend-sharing in init container is not supported. -1. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend91B0=1`. - `huawe.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. +1. `huawei.com/Ascend910B-memory` only works when `huawei.com/Ascend910B=1`. + `huawei.com/Ascend310P-memory` only works when `huawei.com/Ascend310P=1`. diff --git a/versioned_docs/version-v2.8.0/userguide/configure.md b/versioned_docs/version-v2.8.0/userguide/configure.md index 3e49e8cf..7cbcf6e4 100644 --- a/versioned_docs/version-v2.8.0/userguide/configure.md +++ b/versioned_docs/version-v2.8.0/userguide/configure.md @@ -36,7 +36,7 @@ You can update these configurations using one of the following methods: | `nvidia.resourceCountName` | String | vGPU number resource name. | `"nvidia.com/gpu"` | | `nvidia.resourceMemoryName` | String | vGPU memory size resource name. | `"nvidia.com/gpumem"` | | `nvidia.resourceMemoryPercentageName` | String | vGPU memory fraction resource name. | `"nvidia.com/gpumem-percentage"` | - | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/cores"` | + | `nvidia.resourceCoreName` | String | vGPU core resource name. | `"nvidia.com/gpucores"` | | `nvidia.resourcePriorityName` | String | vGPU job priority name. | `"nvidia.com/priority"` | ## Node Configs: ConfigMap