Skip to content

docs: add quick start guide to verify HAMi in Kubernetes#154

Open
mesutoezdil wants to merge 6 commits intoProject-HAMi:masterfrom
mesutoezdil:docs/verify-hami-quickstart
Open

docs: add quick start guide to verify HAMi in Kubernetes#154
mesutoezdil wants to merge 6 commits intoProject-HAMi:masterfrom
mesutoezdil:docs/verify-hami-quickstart

Conversation

@mesutoezdil
Copy link
Copy Markdown

@mesutoezdil mesutoezdil commented Mar 31, 2026

This PR adds a practical quick start guide to verify HAMi in a real Kubernetes environment.

Key improvements:

  • Adds a strict pre-flight GPU validation step
  • Ensures users verify GPU functionality before installing HAMi
  • Uses copy-paste friendly commands (cat <<EOF)
  • Includes clear expected outcomes for each step
  • Reduces confusion between successful deployment and actual runtime behavior

The goal is to help users quickly confirm that HAMi works correctly, not just that it is installed.

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 31, 2026 •
edited
Loading

✅ Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 3c49909
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/69d6c34020ada2000854fae9
😎 Deploy Preview https://deploy-preview-154--project-hami.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@hami-robot hami-robot bot requested review from archlitchi and wawa0210 March 31, 2026 20:29
@hami-robot
Copy link
Copy Markdown
Contributor

hami-robot bot commented Mar 31, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mesutoezdil
Once this PR has been reviewed and has the lgtm label, please assign windsonsea for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@hami-robot
Copy link
Copy Markdown
Contributor

hami-robot bot commented Mar 31, 2026

Welcome @mesutoezdil! It looks like this is your first PR to Project-HAMi/website 🎉

@hami-robot hami-robot bot added the size/L label Mar 31, 2026
@mesutoezdil mesutoezdil force-pushed the docs/verify-hami-quickstart branch from 8530ec5 to 76552b6 Compare March 31, 2026 20:30
@mesutoezdil
Copy link
Copy Markdown
Author

mesutoezdil commented Mar 31, 2026 •
edited
Loading

Happy to adjust or simplify if needed @rootsongjc, @archlitchi!

@rootsongjc
Copy link
Copy Markdown
Contributor

rootsongjc commented Apr 1, 2026

@mesutoezdil How about covert it into a blog? Because it is so solid and long to be a quick start doc. And I think if there is a diagrm it will be better.

@mesutoezdil mesutoezdil force-pushed the docs/verify-hami-quickstart branch from 1a2f2d9 to 76552b6 Compare April 2, 2026 07:06
@archlitchi
Copy link
Copy Markdown
Member

archlitchi commented Apr 8, 2026

please sign-off your commit to pass the DCO check

@mesutoezdil-adfinis
docs: add quick start guide to verify HAMi in Kubernetes
85c681c 
Signed-off-by: Mesut Oezdil <mesut.oezdil@adfinis.com>
@mesutoezdil-adfinis
docs: add verify-hami to v2.8.0 docs
2874376 
Signed-off-by: Mesut Oezdil <mesut.oezdil@adfinis.com>
@mesutoezdil-adfinis
docs: add verify-hami to versioned sidebar
e91026d 
Signed-off-by: Mesut Oezdil <mesut.oezdil@adfinis.com>
@mesutoezdil-adfinis
fix: remove id to match sidebar path
1cd5e4c 
Signed-off-by: Mesut Oezdil <mesut.oezdil@adfinis.com>
@mesutoezdil-adfinis
docs: improve title to better reflect validation scope
d34c6b4 
Signed-off-by: Mesut Oezdil <mesut.oezdil@adfinis.com>
@mesutoezdil-adfinis
docs: clarify scope and fix wording
3c49909 
Signed-off-by: Mesut Oezdil <mesut.oezdil@adfinis.com>
@mesutoezdil mesutoezdil force-pushed the docs/verify-hami-quickstart branch 2 times, most recently from afd2d60 to 3c49909 Compare April 8, 2026 21:06
@mesutoezdil
Copy link
Copy Markdown
Author

mesutoezdil commented Apr 8, 2026

please sign-off your commit to pass the DCO check

Added DCO sign-off to all commits and cleaned ip history @archlitchi

rootsongjc
rootsongjc reviewed Apr 9, 2026
View reviewed changes
versioned_docs/version-v2.8.0/get-started/verify-hami.md

## Scope and Assumptions

This guide assumes that HAMi is already installed (for example, via the "Deploy HAMi using Helm" guide in the Get Started section).
Copy link
Copy Markdown
Contributor

@rootsongjc rootsongjc Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can insert the link for deploy-with-helm.

versioned_docs/version-v2.8.0/get-started/verify-hami.md
HAMi requires the `nvidia-container-toolkit` to be installed and set as the default low-level runtime on all your GPU nodes.

### 1. Install nvidia-container-toolkit (Debian/Ubuntu example)
```
Copy link
Copy Markdown
Contributor

@rootsongjc rootsongjc Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```bash

Copy link
Copy Markdown
Contributor

@rootsongjc rootsongjc Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other code blocks should also be prefixed with the language title.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rootsongjc rootsongjc rootsongjc left review comments

@archlitchi archlitchi Awaiting requested review from archlitchi

@wawa0210 wawa0210 Awaiting requested review from wawa0210

Assignees

No one assigned

Labels

dco-signoff: yes size/L

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@mesutoezdil @rootsongjc @archlitchi @mesutoezdil-adfinis