Skip to content

Document MachinePool Health - #137

Merged
afritzler merged 4 commits into
mainfrom
enh/ironcore-1472-add-machine-pool-health-docs
Jul 31, 2026
Merged

Document MachinePool Health#137
afritzler merged 4 commits into
mainfrom
enh/ironcore-1472-add-machine-pool-health-docs

Conversation

@friegger

@friegger friegger commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

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 MachinePool Health page under a new “Pools and Lifecycle” architecture section.
    • Documented MachinePool health reporting, heartbeat behavior, Ready status transitions, and timing configuration.
    • Clarified that pool health does not currently affect scheduling; pools marked Ready=False or Ready=Unknown may 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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8fb88a88-bcd4-4ea4-be4d-7fb92806bea2

📥 Commits

Reviewing files that changed from the base of the PR and between 89de403 and 74a9996.

📒 Files selected for processing (1)
  • docs/iaas/architecture/machine-pool-health.md
🚧 Files skipped from review as they are similar to previous changes (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, configuration, and scheduling documentation
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 implementation documented by this change.

Suggested labels: enhancement, size/L

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the primary change: documenting MachinePool health.
Description check ✅ Passed The description explains the documentation changes and issue contribution, but it does not use the repository template headings.
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>
Comment on lines +21 to +24
::: info
Health reporting is currently only implemented for `MachinePool`. The `VolumePool` and `BucketPool` types
are not covered by this mechanism.
:::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do we need this info in the machine pool section?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

No, I was thinking, someone might come up with that question, but I can also remove it.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed.

Comment thread docs/iaas/architecture/scheduling.md
Signed-off-by: Felix Riegger <felix.riegger@sap.com>
@friegger
friegger requested a review from afritzler July 31, 2026 13:58
@afritzler
afritzler merged commit 02fcc1b into main Jul 31, 2026
6 checks passed
@afritzler
afritzler deleted the enh/ironcore-1472-add-machine-pool-health-docs branch July 31, 2026 14:22
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.

2 participants