Skip to content

Document MachinePool Health - #137

Open
friegger wants to merge 3 commits into
mainfrom
enh/ironcore-1472-add-machine-pool-health-docs
Open

Document MachinePool Health#137
friegger wants to merge 3 commits into
mainfrom
enh/ironcore-1472-add-machine-pool-health-docs

Conversation

@friegger

@friegger friegger commented Jul 28, 2026

Copy link
Copy Markdown

MachinePool health monitoring documented based on the implementation of IEP-15.

This adds a new Pools and Lifecycle section, which can also accommodate MachinePool eviction and other lifecycle related topics in the future.

Contributes to #ironcore-dev/ironcore#1472

Summary by CodeRabbit

  • Documentation
    • Added a new “Pools and Lifecycle” subsection in the Architecture sidebar, including a MachinePool Health page.
    • Documented how MachinePool health is determined and updated via heartbeat/lease renewal and Ready status transitions, including timing/configuration defaults.
    • Added a Scheduling warning clarifying that the scheduler does not consider pool Ready health; pools with Ready=False or Ready=Unknown can still receive assignments.

MachinePool Health documented based on the implementation
of IEP-15.

This adds a new Pools and Lifecycle section, which can
also accomodate MachinePool eviction and other lifecycle
related topics in the future.

Signed-off-by: Felix Riegger <felix.riegger@sap.com>
@friegger
friegger requested a review from a team as a code owner July 28, 2026 14:56
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@friegger, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 56 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a280a5af-8c09-48a4-88ee-3dac2fe5c2e3

📥 Commits

Reviewing files that changed from the base of the PR and between 89de403 and 0d76afc.

📒 Files selected for processing (1)
  • docs/iaas/architecture/machine-pool-health.md
📝 Walkthrough

Walkthrough

Adds architecture documentation for MachinePool health reporting, including Lease heartbeats, Ready condition semantics, lifecycle grace-period handling, configuration defaults, and current scheduler behavior. Adds the page to the IaaS architecture sidebar and scheduling documentation.

Changes

MachinePool health documentation

Layer / File(s) Summary
Health signals and readiness semantics
docs/iaas/architecture/machine-pool-health.md
Documents Lease heartbeats, IRI probe outcomes, and Ready condition updates from machinepoollet.
Lifecycle detection and scheduling behavior
docs/iaas/architecture/machine-pool-health.md, docs/iaas/architecture/scheduling.md, docs/.vitepress/config.mts
Documents grace-period handling, timing configuration, scheduler behavior, and sidebar navigation for the new page.

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

Possibly related issues

  • ironcore-dev/ironcore#1472 — Covers the MachinePool health heartbeat and status-condition implementation described by this documentation.

Possibly related PRs

Suggested labels: enhancement, size/L

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description mentions the new docs and future scope, but it does not follow the required template headings or include a proper Fixes # section. Rewrite it using the template: add # Proposed Changes bullets and a Fixes # line, and keep the future-scope note if needed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: adding documentation for MachinePool health.
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 enh/ironcore-1472-add-machine-pool-health-docs

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 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/iaas/architecture/machine-pool-health.md`:
- Around line 11-15: Clarify in the architecture page that the MachinePool
reconciler is the sole writer of MachinePool.status, including the Ready
condition. Revise the lifecycle controller description to say it triggers status
reprocessing when the machinepoollet stops reporting, rather than marking Ready
directly; do not describe both components as status writers.
🪄 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: 0d01afa8-2f4f-48f0-9d29-24b59daded9e

📥 Commits

Reviewing files that changed from the base of the PR and between 4467d8e and b8432ce.

📒 Files selected for processing (3)
  • docs/.vitepress/config.mts
  • docs/iaas/architecture/machine-pool-health.md
  • docs/iaas/architecture/scheduling.md

Comment thread docs/iaas/architecture/machine-pool-health.md
friegger added 2 commits July 28, 2026 20:48
Signed-off-by: Felix Riegger <felix.riegger@sap.com>
Signed-off-by: Felix Riegger <felix.riegger@sap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant