Update document for release 1.1.0

[archlitchi]

1. We enable monitor by default
2. Update the kai-scheduler installation command

Summary by CodeRabbit

• Documentation
  • Added prerequisites for KAI-Scheduler version 0.17.0 or later.
  • Updated Helm installation instructions and chart versions.
  • Included monitor enablement, node selector, and runtime class configuration details.
  • Clarified that VRAM metrics are enabled as part of the standard setup.

[cursor]

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

[hami-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: archlitchi

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [archlitchi]

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

[coderabbitai]

📝 Walkthrough

Walkthrough

The README now requires KAI-Scheduler 0.17.0, uses OCI Helm installation, pins the isolator chart to 1.1.0-chart, enables monitoring, documents runtime settings, and simplifies VRAM metrics instructions.

Changes

Installation documentation

Layer / File(s)	Summary
Helm installation requirements and configuration README.md	Adds the KAI-Scheduler prerequisite. Updates the Helm source and versions. Enables the monitor and ServiceMonitor. Documents node selection and NVIDIA runtime settings.
VRAM metrics instructions README.md	Removes the optional label and separate monitor enablement instructions from the VRAM metrics section.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• Project-HAMi/KAI-resource-isolator#8: Both update README KAI-Scheduler Helm installation configuration.
• Project-HAMi/KAI-resource-isolator#20: Both update README VRAM metrics and monitor documentation.

Suggested reviewers: dttung2905

Poem

A rabbit checks the chart with care,
OCI commands now nestle there.
Monitors wake, metrics shine,
Versions match in neat design.
Hop through setup, smooth and bright!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the documentation updates for release 1.1.0.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch update_document

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

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 `@README.md`:
- Line 7: Correct the README heading spelling by changing “Prequisities” to
“Prerequisites,” leaving the surrounding content unchanged.
- Around line 32-33: Update the README configuration guidance around
monitor.serviceMonitor.enabled to document that automatic scraping requires the
Prometheus Operator monitoring.coreos.com/v1 ServiceMonitor CRD, and state that
the setting has no effect when that CRD is unavailable.
- Line 34: Update the README Helm install example around the `--version
1.1.0-chart` reference to use a version that exists in the checked-out chart or
omit the version for source-only installs; keep release workflow version-bumping
details out of user-facing installation documentation.

🪄 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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8189a210-d6a3-476d-841e-bfbd806926e6

📥 Commits

Reviewing files that changed from the base of the PR and between b705858 and 9626970.

📒 Files selected for processing (1)

• README.md

[coderabbitai]

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Correct the heading spelling.

Change Prequisities to Prerequisites.

🧰 Tools

🪛 LanguageTool

[grammar] ~7-~7: Ensure spelling is correct
Context: ... see the Design section. ## Prequisities - KAI-scheduler Version: ≥ 0.17.0 ## Qu...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 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 `@README.md` at line 7, Correct the README heading spelling by changing
“Prequisities” to “Prerequisites,” leaving the surrounding content unchanged.

Source: Linters/SAST tools

[coderabbitai]

🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Document the ServiceMonitor dependency.

The chart creates ServiceMonitor only when monitoring.coreos.com/v1 is available. Without the Prometheus Operator CRD, Helm succeeds but automatic scraping is not configured.

Add this prerequisite or state that monitor.serviceMonitor.enabled=true is effective only when the CRD exists.

🤖 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 `@README.md` around lines 32 - 33, Update the README configuration guidance
around monitor.serviceMonitor.enabled to document that automatic scraping
requires the Prometheus Operator monitoring.coreos.com/v1 ServiceMonitor CRD,
and state that the setting has no effect when that CRD is unavailable.