docs(get-started): simplify quick start and online installation guides - #712
Conversation
Signed-off-by: Srijan <singhsrijangkp@gmail.com>
hami-robot
Bot
added
kind/documentation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: singhsrijan46 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughChangesHelm quick-start documentation
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/get-started/deploy-with-helm.md`:
- Around line 51-53: Update the manifest introduction in
docs/get-started/deploy-with-helm.md:51-53 and
versioned_docs/version-v2.9.0/get-started/deploy-with-helm.md:51-53 to tell
users to save it as “gpu-pod.yaml”; add the equivalent Chinese instruction in
i18n/zh/docusaurus-plugin-content-docs/current/get-started/deploy-with-helm.md:51-53
and
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md:51-53.
In `@docs/installation/online-installation.md`:
- Around line 35-43: Add the GPU-node labeling prerequisite before the helm
install hami step, instructing users to label applicable nodes with gpu=on or
clearly link to the existing prerequisite. Apply the same update to
docs/installation/online-installation.md lines 35-43,
i18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.md
lines 36-44,
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md
lines 36-44, and
versioned_docs/version-v2.9.0/installation/online-installation.md lines 35-43.
In `@versioned_docs/version-v2.9.0/installation/online-installation.md`:
- Around line 21-23: Pin every Helm install command in the v2.9.0 archived
documentation to chart version 2.9.0 by adding the --version 2.9.0 option:
update versioned_docs/version-v2.9.0/installation/online-installation.md
(21-23),
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md
(22-24), versioned_docs/version-v2.9.0/get-started/deploy-with-helm.md (35-39),
and
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md
(35-39).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 39546764-7bdb-4316-9973-a258774857ec
📒 Files selected for processing (8)
docs/get-started/deploy-with-helm.mddocs/installation/online-installation.mdi18n/zh/docusaurus-plugin-content-docs/current/get-started/deploy-with-helm.mdi18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.mdversioned_docs/version-v2.9.0/get-started/deploy-with-helm.mdversioned_docs/version-v2.9.0/installation/online-installation.md
| Create a Pod requesting 1 vGPU with 10240 MiB of GPU memory limit: | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Tell users to save the manifest as gpu-pod.yaml.
The page shows an inline manifest, but the next command applies gpu-pod.yaml. A user who follows the steps literally does not create that file.
docs/get-started/deploy-with-helm.md#L51-L53: add “Save the following manifest asgpu-pod.yaml:”.i18n/zh/docusaurus-plugin-content-docs/current/get-started/deploy-with-helm.md#L51-L53: add “将以下清单保存为gpu-pod.yaml：”.i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md#L51-L53: add the same Chinese instruction.versioned_docs/version-v2.9.0/get-started/deploy-with-helm.md#L51-L53: add the same English instruction.
📍 Affects 4 files
docs/get-started/deploy-with-helm.md#L51-L53(this comment)i18n/zh/docusaurus-plugin-content-docs/current/get-started/deploy-with-helm.md#L51-L53i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md#L51-L53versioned_docs/version-v2.9.0/get-started/deploy-with-helm.md#L51-L53
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/get-started/deploy-with-helm.md` around lines 51 - 53, Update the
manifest introduction in docs/get-started/deploy-with-helm.md:51-53 and
versioned_docs/version-v2.9.0/get-started/deploy-with-helm.md:51-53 to tell
users to save it as “gpu-pod.yaml”; add the equivalent Chinese instruction in
i18n/zh/docusaurus-plugin-content-docs/current/get-started/deploy-with-helm.md:51-53
and
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md:51-53.
| ## 3. Verify Installation {#verify-installation} | ||
|
|
||
| You can verify your installation using the following command: | ||
| Verify that the HAMi components (`hami-device-plugin` and `hami-scheduler`) are running correctly: | ||
|
|
||
| ```bash | ||
| kubectl get pods -n kube-system | ||
| kubectl get pods -n kube-system | grep hami | ||
| ``` | ||
|
|
||
| If both hami-device-plugin and hami-scheduler pods are in the Running state, your installation is successful. | ||
| If both `hami-device-plugin` and `hami-scheduler` pods are in the `Running` state, your installation is successful. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
files=(
"docs/installation/online-installation.md"
"i18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.md"
"i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md"
"versioned_docs/version-v2.9.0/installation/online-installation.md"
)
for file in "${files[@]}"; do
rg -n 'gpu=on|label nodes|标记节点' "$file" || {
echo "Missing GPU-node labeling instructions: $file"
exit 1
}
doneRepository: Project-HAMi/website
Length of output: 239
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== target files =="
for f in \
docs/installation/online-installation.md \
i18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.md \
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md \
versioned_docs/version-v2.9.0/installation/online-installation.md
do
echo "--- $f"
wc -l "$f"
sed -n '1,120p' "$f"
done
echo "== search for selector/label references in docs =="
rg -n "gpu=on|matchLabels|nodeSelector|label nodes|节点标签|GPU 节点|device-plugin|hami-device-plugin" docs i18n versioned_docs -S || trueRepository: Project-HAMi/website
Length of output: 50377
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== target lines =="
for f in \
docs/installation/online-installation.md \
i18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.md \
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md \
versioned_docs/version-v2.9.0/installation/online-installation.md
do
echo "--- $f"
wc -l "$f"
sed -n '1,90p' "$f"
done
echo "== prerequisites labeling sections =="
for f in \
docs/installation/prerequisites.md \
docs/installation/offline-installation.md \
i18n/zh/docusaurus-plugin-content-docs/current/installation/prerequisites.md \
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/prerequisites.md \
versioned_docs/version-v2.9.0/installation/prerequisites.md
do
echo "--- $f"
if [ -f "$f" ]; then
rg -n "gpu=on|label nodes|标记节点|Prepare|准备" "$f" -C 3 || true
fi
done
echo "== hami-device-plugin manifest snippets in docs = "
rg -n "app\.kubernetes\.io/component: hami-device-plugin|nodeSelector:|gpu: on|gpu=\"on\"|gpu:=on" docs/versioned_docs i18n/zh/docusaurus-plugin-content-docs -S --glob '*.md' --max-count 50 || trueRepository: Project-HAMi/website
Length of output: 9119
Add the GPU-node labeling prerequisite to the online installation pages.
hami-device-plugin depends on GPU nodes having the gpu=on label for HAMi scheduling. Add this step before helm install hami, or link clearly to the existing prerequisite, on all four pages:
docs/installation/online-installation.mdi18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.mdversioned_docs/version-v2.9.0/installation/online-installation.md
📍 Affects 4 files
docs/installation/online-installation.md#L35-L43(this comment)i18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.md#L36-L44i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md#L36-L44versioned_docs/version-v2.9.0/installation/online-installation.md#L35-L43
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/installation/online-installation.md` around lines 35 - 43, Add the
GPU-node labeling prerequisite before the helm install hami step, instructing
users to label applicable nodes with gpu=on or clearly link to the existing
prerequisite. Apply the same update to docs/installation/online-installation.md
lines 35-43,
i18n/zh/docusaurus-plugin-content-docs/current/installation/online-installation.md
lines 36-44,
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md
lines 36-44, and
versioned_docs/version-v2.9.0/installation/online-installation.md lines 35-43.
Source: MCP tools
| ```bash | ||
| kubectl version | ||
| helm install hami hami-charts/hami -n kube-system | ||
| ``` |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== repo files =="
git ls-files | rg 'versioned_docs/version-v2\.9\.0|docusaurus-plugin-content-docs/version-v2\.9\.0' | sed -n '1,120p'
echo "== relevant files context =="
for f in \
versioned_docs/version-v2.9.0/installation/online-installation.md \
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md \
versioned_docs/version-v2.9.0/get-started/deploy-with-helm.md \
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md
do
if [ -f "$f" ]; then
echo "--- $f"
wc -l "$f"
sed -n '1,80p' "$f" | nl -ba
else
echo "MISSING $f"
fi
done
echo "== search for pinned helm install commands in v2.9 docs =="
rg -n "helm (repo add|update|install)|PROJECT_HAMI_CHART|chart|version 2\.9|v2\.9" versioned_docs/version-v2.9.0 i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0 -g '*.md'Repository: Project-HAMi/website
Length of output: 11989
🌐 Web query:
project-hami tutorials labs online-install helm install hami-charts/hami --version 2.9.0
💡 Result:
HAMi (Heterogeneous AI Computing Virtualization Middleware) is a CNCF-incubating open-source project designed to provide GPU virtualization and heterogeneous accelerator scheduling for Kubernetes [1][2][3]. It enables device sharing, resource isolation, and device-aware scheduling across various hardware, including NVIDIA GPUs, NPUs, and other AI accelerators [4][5]. To perform an online installation of HAMi using Helm, follow these steps [6][7]: 1. Add the HAMi repository to your Helm configuration: helm repo add hami-charts https://project-hami.github.io/HAMi/ helm repo update 2. Install the desired version using Helm [8]: helm install hami hami-charts/hami --version 2.9.0 -n hami-system --create-namespace Note: While the general command uses the hami-system namespace [8], earlier documentation or tutorials may suggest the kube-system namespace [6][7]. Verify your specific cluster requirements. You can also customize the deployment by setting parameters like the Kubernetes scheduler image tag to match your cluster version [6]. For hands-on learning, the project provides official tutorials and labs available at the official project website. These include: - Lab 1: Online Installation of HAMi, which covers building a GPU-enabled Kubernetes cluster and installing HAMi [9][10]. - Lab 2: Local Fake GPU Setup, which allows you to learn the HAMi control plane without needing physical GPU hardware [11]. For more information, visit the official documentation at project-hami.io [1][2].
Citations:
- 1: https://project-hami.io/
- 2: https://project-hami.io/docs
- 3: https://www.cncf.io/projects/hami/
- 4: https://github.com/Project-HAMi/HAMi?tab=readme-ov-file
- 5: https://github.com/project-hami/hami
- 6: https://project-hami.io/docs/installation/online-installation
- 7: https://project-hami.io/docs/get-started/deploy-with-helm
- 8: https://github.com/Project-HAMi/website/blob/master/blog/hami-v2-9-0-release/index.md
- 9: https://project-hami.io/tutorials/labs/online-install
- 10: https://project-hami.io/tutorials
- 11: https://project-hami.io/tutorials/labs/local-fake-gpu
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== relevant file contents =="
for f in \
versioned_docs/version-v2.9.0/installation/online-installation.md \
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md \
versioned_docs/version-v2.9.0/get-started/deploy-with-helm.md \
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md
do
if [ -f "$f" ]; then
echo "--- $f"
head -n 80 "$f"
else
echo "MISSING $f"
fi
done
echo "== broader v2.9 docs pin usage =="
rg -n "helm .*hami-charts/hami" versioned_docs/version-v2.9.0 i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0 -g '*.md' || true
rg -n "2\.9\.0|--version" versioned_docs/version-v2.9.0 i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0 -g '*.md' | rg "helm|2\.9\.0" || trueRepository: Project-HAMi/website
Length of output: 15414
🌐 Web query:
HAMi v2.9.0 release tutorial online install helm command hami-charts/hami helm install
💡 Result:
To install HAMi v2.9.0, follow the standard online installation procedure via Helm [1]. Ensure your environment meets the prerequisites, which include Kubernetes v1.23+, Helm v3+, NVIDIA drivers (v440+), and proper configuration of the NVIDIA container toolkit [2][3]. Installation Steps: 1. Label your GPU nodes so they can be managed by the HAMi scheduler [4][3]: kubectl label nodes gpu=on 2. Add and update the HAMi Helm repository [1][3]: helm repo add hami-charts https://project-hami.github.io/HAMi/ helm repo update 3. Install HAMi [1][3]: It is recommended to specify the Kubernetes scheduler image tag to match your cluster's Kubernetes server version [1]. Replace vX.Y.Z with your actual version: helm install hami hami-charts/hami --set scheduler.kubeScheduler.imageTag=vX.Y.Z -n kube-system 4. Verify the installation [1][3]: Check that the hami-device-plugin and hami-scheduler pods are in the Running state: kubectl get pods -n kube-system For upgrading an existing installation to v2.9.0, use the following command [5]: helm upgrade hami hami-charts/hami -n kube-system For comprehensive documentation and configuration options (such as Volcano or Ascend device support), refer to the official HAMi documentation at https://project-hami.io/docs/ [5][1].
Citations:
- 1: https://project-hami.io/docs/installation/online-installation
- 2: https://project-hami.io/docs/installation/prerequisites
- 3: https://github.com/Project-HAMi/HAMi?tab=readme-ov-file
- 4: https://project-hami.io/docs/get-started/deploy-with-helm
- 5: https://project-hami.io/blog/hami-v2-9-0-release
🌐 Web query:
"website/blob/master/blog/hami-v2-9-0-release/index.md" "helm install" "2.9.0"
💡 Result:
To install HAMi version 2.9.0 using Helm, follow these steps to add the official repository and deploy the chart [1][2]. 1. Add the HAMi Helm repository to your local environment: helm repo add hami-charts https://project-hami.github.io/HAMi/ helm repo update 2. Install the HAMi 2.9.0 chart. You can deploy it into a specific namespace, such as hami-system or kube-system [1][2][3][4]: helm install hami hami-charts/hami -n hami-system --create-namespace If you are upgrading an existing deployment to version 2.9.0, use the upgrade command [1][2]: helm upgrade hami hami-charts/hami -n hami-system Ensure that your environment meets the necessary prerequisites, such as having Kubernetes v1.16+, Helm v3+, and the required NVIDIA drivers or other device runtimes if applicable [3]. Detailed installation and configuration documentation can be found on the official HAMi website [1][3].
Citations:
- 1: https://project-hami.io/blog/hami-v2-9-0-release
- 2: https://github.com/Project-HAMi/website/blob/master/blog/hami-v2-9-0-release/index.md
- 3: https://project-hami.io/docs/get-started/deploy-with-helm
- 4: https://deepwiki.com/Project-HAMi/HAMi/3.2-helm-installation
Pin the Helm chart in the pinned v2.9.0 install commands.
Use helm install hami hami-charts/hami --version 2.9.0 -n kube-system in the versioned v2.9.0 install steps so later chart releases cannot change these archived instructions.
versioned_docs/version-v2.9.0/installation/online-installation.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.mdversioned_docs/version-v2.9.0/get-started/deploy-with-helm.mdi18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md
📍 Affects 4 files
versioned_docs/version-v2.9.0/installation/online-installation.md#L21-L23(this comment)i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md#L22-L24versioned_docs/version-v2.9.0/get-started/deploy-with-helm.md#L35-L39i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md#L35-L39
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@versioned_docs/version-v2.9.0/installation/online-installation.md` around
lines 21 - 23, Pin every Helm install command in the v2.9.0 archived
documentation to chart version 2.9.0 by adding the --version 2.9.0 option:
update versioned_docs/version-v2.9.0/installation/online-installation.md
(21-23),
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/installation/online-installation.md
(22-24), versioned_docs/version-v2.9.0/get-started/deploy-with-helm.md (35-39),
and
i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/get-started/deploy-with-helm.md
(35-39).
Source: MCP tools
1 participant
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Simplified the quick start guide and cleaned up old installation commands.
Changes made:
Updated
deploy-with-helm.mdto be a clear, single-page quick start.Added NVIDIA Container Toolkit to prerequisites and removed extra setup steps from the quick start.
Removed
kubectl versionstep and old--set scheduler.kubeScheduler.image.tag=v1.29.0command fromonline-installation.md.Updated Chinese translation files and synced changes to
version-v2.9.0.Which issue(s) this PR fixes:
Fixes #689
Checklist:
npm run lintandnpm run format:checkpassnpm run buildsucceeds for bothenandzhgit commit -s)Summary by CodeRabbit