Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 Update MHC documentation #4228

Merged
merged 1 commit into from
Feb 24, 2021
Merged

📖 Update MHC documentation #4228

merged 1 commit into from
Feb 24, 2021

Conversation

scottslowe
Copy link
Contributor

What this PR does / why we need it:
This PR updates the MachineHealthCheck (MHC) documentation to include support for control plane nodes via KCP and an example of creating an MHC for KCP nodes.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #4138

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 23, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @scottslowe. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added 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. labels Feb 23, 2021
@scottslowe scottslowe changed the title Update MHC documentation 📖 📖 Update MHC documentation Feb 23, 2021
@fabriziopandini
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 23, 2021
CecileRobertMichon
CecileRobertMichon reviewed Feb 23, 2021
View reviewed changes
Copy link
Contributor

@CecileRobertMichon CecileRobertMichon left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 23, 2021
@CecileRobertMichon
Copy link
Contributor

/milestone v0.4.0

should we also backport to 0.3 ?

@k8s-ci-robot k8s-ci-robot added this to the v0.4.0 milestone Feb 23, 2021
fabriziopandini
fabriziopandini reviewed Feb 24, 2021
View reviewed changes
Copy link
Member

@fabriziopandini fabriziopandini left a comment

Choose a reason for hiding this comment

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

/lgtm

As an additional improvement, we can add something about KCP remediation Limitations and Caveats picking from https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20191017-kubeadm-based-control-plane.md#remediation-using-delete-and-recreate but I leave the final call on this to @scottslowe

@scottslowe
Copy link
Contributor Author

@fabriziopandini Maybe just a link to the relevant section, like you posted, instead of actually pulling content from the KCP proposal? Let me see what I can do on that front.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 24, 2021
@fabriziopandini
Copy link
Member

Great!
Please squash commits!

@scottslowe @fabriziopandini
Update MHC documentation
23e0b2d 
Add example of MHC for KCP remediation. Remove text indicating MHC is not supported for control plane nodes and explicitly call out support for remediation of KCP nodes. Add wording regarding the option for provider-supplied remediation solutions. Update the limitation and caveats section with a link to the KCP remediation guidelines for more detail. Fix minor typos and formatting issues. Ensure consistent capitalization for all headings.

Signed-off-by: Scott Lowe <[email protected]>
Co-authored-by: Cecile Robert-Michon <[email protected]>
Co-authored-by: Fabrizio Pandini <[email protected]>
@CecileRobertMichon
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 24, 2021
vincepri
vincepri approved these changes Feb 24, 2021
View reviewed changes
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

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

/approve

Let's backport?

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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

The pull request process is described 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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 24, 2021
@k8s-ci-robot k8s-ci-robot merged commit fc5ee14 into kubernetes-sigs:master Feb 24, 2021
@scottslowe scottslowe deleted the issue-4138 branch February 24, 2021 19:58
@scottslowe scottslowe mentioned this pull request Feb 24, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CecileRobertMichon CecileRobertMichon CecileRobertMichon left review comments

@fabriziopandini fabriziopandini fabriziopandini left review comments

@vincepri vincepri vincepri approved these changes

@randomvariable randomvariable Awaiting requested review from randomvariable

Assignees

@fabriziopandini fabriziopandini

@CecileRobertMichon CecileRobertMichon

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v0.4
Development

Successfully merging this pull request may close these issues.

Document MachineHealthChecks for control planes
5 participants
@scottslowe @k8s-ci-robot @fabriziopandini @CecileRobertMichon @vincepri