Skip to content

Conversation

@acheampongmaa
Copy link

This PR adds documentation under Cluster API Provider Metal³ (CAPM3) to describe
the capi.metal3.io/unhealthy annotation.

Summary of changes

  • Added a new section “Unhealthy Annotation” under capm3/introduction.md.
  • Explained how operators can manually mark a BareMetalHost as unhealthy.
  • Described the automatic annotation applied when remediation timeouts expire.
  • Updated SUMMARY.md to remove a duplicate entry causing mdBook build errors.

Verification

  • Verified locally using mdbook serve, the new section renders correctly and links to the Remediation page.

Issue

Fixes Document unhealthy annotation #403

Notes

This is my first contribution to the Metal³ documentation.
Feedback on placement, tone, or level of detail is very welcome.

@metal3-io-bot metal3-io-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 1, 2025
@metal3-io-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

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

@metal3-io-bot metal3-io-bot added needs-rebase Indicates that a PR cannot be merged because it has merge conflicts with HEAD. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 1, 2025
@metal3-io-bot
Copy link
Contributor

Hi @acheampongmaa. Thanks for your PR.

I'm waiting for a metal3-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@metal3-io-bot metal3-io-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 1, 2025
@acheampongmaa acheampongmaa force-pushed the docs/add-unhealthy-annotation-section branch from 2f8f467 to 5928b37 Compare November 2, 2025 01:22
@metal3-io-bot metal3-io-bot removed the needs-rebase Indicates that a PR cannot be merged because it has merge conflicts with HEAD. label Nov 2, 2025
@acheampongmaa
Copy link
Author

Hello @dtantsur and @smoshiur1237
This is my first contribution to the project.
I’d really appreciate any feedback or suggestions.
Thank you for your time and guidance!

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

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document unhealthy annotation

2 participants