Skip to content

docs: illustrate how to use HAMi on Red Hat OpenShift - #861

Draft
spencercjh wants to merge 5 commits into
Project-HAMi:masterfrom
spencercjh:docs/openshift
Draft

spencercjh wants to merge 5 commits into
Project-HAMi:masterfrom
spencercjh:docs/openshift

Conversation

@spencercjh

@spencercjh spencercjh commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

Add doc to explain how to run HAMi on Red Hat OpenShift.

What this PR does / why we need it:

There is a big difference between normal Kubernetes and Red Hat OpenShift when using HAMi. We have already finished the adaptation work on Project-HAMi/HAMi#2208. Here is the installation docs for users.

Which issue(s) this PR fixes:

Part of #795.

Checklist:

  • npm run lint and npm run format:check pass
  • npm run build succeeds for both en and zh
  • Chinese translation updated if English docs changed (or noted why not)
  • Commits are signed off (git commit -s)

AI assistance: Codex assisted with drafting, editing, and validating the documentation.

Summary by CodeRabbit

  • Documentation
    • Added English and Chinese installation guides for deploying HAMi on Red Hat OpenShift.
    • Documented prerequisites, GPU Operator configuration, Helm installation, verification steps, shared-vGPU testing, troubleshooting, and cleanup.
    • Added the OpenShift installation guide to the Installation documentation navigation.

@netlify

netlify Bot commented Sep 14, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 20448de
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6aa907d769e3f500080d046d
😎 Deploy Preview https://deploy-preview-861--project-hami.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

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

@hami-robot
hami-robot Bot requested review from wawa0210 and windsonsea September 14, 2026 08:25
@hami-robot

hami-robot Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: spencercjh
Once this PR has been reviewed and has the lgtm label, please assign archlitchi 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

@coderabbitai

coderabbitai Bot commented Sep 14, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: d164e743-d18c-43b2-952b-a970b6d1b199

📥 Commits

Reviewing files that changed from the base of the PR and between fdc8ca0 and 56c8c32.

📒 Files selected for processing (3)
  • docs/installation/openshift-installation.md
  • i18n/zh/docusaurus-plugin-content-docs/current/installation/openshift-installation.md
  • sidebars.js

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Adds English and Chinese OpenShift installation guides for HAMi. The guides cover prerequisites, GPU Operator preparation, Helm deployment, verification, shared-vGPU testing, troubleshooting, and cleanup. The English guide is added to the installation sidebar.

Changes

OpenShift installation guide

Layer / File(s) Summary
OpenShift prerequisites and preparation
docs/installation/openshift-installation.md, i18n/zh/docusaurus-plugin-content-docs/current/installation/openshift-installation.md, sidebars.js
Documents required OpenShift components and permissions, cluster inspection commands, GPU Operator device-plugin removal, and installation navigation.
HAMi configuration and deployment
docs/installation/openshift-installation.md, i18n/zh/docusaurus-plugin-content-docs/current/installation/openshift-installation.md
Documents Helm repository setup, OpenShift-specific values, HAMi installation, and readiness checks.
Smoke test and troubleshooting
docs/installation/openshift-installation.md, i18n/zh/docusaurus-plugin-content-docs/current/installation/openshift-installation.md
Documents a restricted-SCC shared-vGPU test, expected results, troubleshooting cases, and cleanup commands.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related PRs

  • Project-HAMi/website#765: Documents the same OpenShift installation area and changes the same guide, translation, and sidebar locations.

Suggested labels: kind/documentation

Suggested reviewers: mesutoezdil

Merge Risk: ⚪ Minimal · up to 56c8c

The OpenShift guide’s default CDI configuration remains consistent with the documented runtime requirements, with no actionable merge-blocking risk identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change and its focus on using HAMi with Red Hat OpenShift.
✨ Finishing Touches 💡 2
⚔️ Resolve merge conflicts 💡
  • Resolve merge conflict in branch docs/openshift
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@spencercjh
spencercjh marked this pull request as draft September 14, 2026 08:25
@coderabbitai coderabbitai Bot added the kind/documentation Improvements or additions to documentation label Sep 14, 2026
@spencercjh
spencercjh force-pushed the docs/openshift branch 7 times, most recently from 420c38e to 5f6343c Compare September 14, 2026 09:13
@spencercjh

spencercjh commented Sep 14, 2026

Copy link
Copy Markdown
Contributor Author

This PR MUST NOT be merged BEFORE #840 is done.

@spencercjh
spencercjh marked this pull request as ready for review September 14, 2026 09:37
@hami-robot
hami-robot Bot requested a review from rootsongjc September 14, 2026 09:37
@spencercjh

Copy link
Copy Markdown
Contributor Author

/assign rootsongjc

@spencercjh

Copy link
Copy Markdown
Contributor Author

/assign @mesutoezdil

@spencercjh

Copy link
Copy Markdown
Contributor Author

@codex review

Comment thread docs/installation/openshift-installation.md
Comment thread docs/installation/openshift-installation.md Outdated
Comment thread sidebars.js
Comment thread docs/installation/openshift-installation.md
Signed-off-by: Spencer Cai <jiahao.cai@dynamia.ai>
Signed-off-by: Spencer Cai <jiahao.cai@dynamia.ai>
Signed-off-by: Spencer Cai <jiahao.cai@dynamia.ai>
Signed-off-by: Spencer Cai <jiahao.cai@dynamia.ai>
Signed-off-by: Spencer Cai <jiahao.cai@dynamia.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants