Inlining Links
_ Improve phrasing
Remove redundant parts
Remove trailing spaces
@@ -40,8 +40,8 @@ With this enhancement we propose a better, future-proof mechanism, that aligns u
This proposal is a backport of parts of the upstream machine healthcheck proposal [0], which
also is already implemented [1].
-- [0] https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20191030-machine-health-checking.md
-- [1] https://github.com/kubernetes-sigs/cluster-api/pull/3606
+- [0] [upstream machine healthcheck proposal](https://github.com/kubernetes-sigs/cluster-api/blob/master/docs/proposals/20191030-machine-health-checking.md)
+- [1] [upstream machine healthcheck implementation](https://github.com/kubernetes-sigs/cluster-api/pull/3606)
## Motivation
@@ -63,7 +63,7 @@ TBD
## Proposal
-We propose modifying the MachineHealthCheck CRD to support a externalRemediationTemplate, an ObjectReference to
+We propose modifying the MachineHealthCheck CRD to add a new field, `externalRemediationTemplate`, an ObjectReference to
a provider-specific remediation template CR.
### User Stories
@@ -77,11 +77,7 @@ from transient errors faster and begin application recovery sooner.
As an admin of a hardware based cluster, I would like unhealthy nodes to be power-cycled, so that I can detect
non-transient issues faster.
-
-#### Story 3
-
-As an admin of a hardware based cluster, I would like the system to keep attempting to power-cycle unhealthy nodes,
-so that they are automatically added back to the cluster when I fix the underlying problem.
+If automatic power-cycles don't resolve the issue it helps the admin to rule out transient issues like software bugs, etc.
### Implementation Details/Notes/Constraints
@@ -95,12 +91,6 @@ External Remediation Controller (ERC) watching for that CR.
No further action (deletion or applying conditions) will be taken by the MachineHealthCheck controller until the
Node becomes healthy. After that, it will locate and delete the instantiated MachineRemediation CR.
-When a Machine enters an unhealthy state, the MHC will:
-* Look up the referenced template
-* Instantiate the template (for simplicity, we will refer to this as a External Machine Remediation CR, or EMR)
-* Force the name and namespace to match the unhealthy Machine
-* Save the new object in etcd
-
We use the same name and namespace for the External Machine Remediation CR to ensure uniqueness and lessen the
possibility for multiple parallel remediations of the same Machine.
@@ -250,11 +240,3 @@ no known drawbacks
## Alternatives
- Keep the existing annotation based mechanism.
\ No newline at end of file
-
-## Infrastructure Needed [optional]
-
-Use this section if you need things from the project. Examples include a new
-subproject, repos requested, github details, and/or testing infrastructure.
-
-Listing these here allows the community to get the process for these resources
-started right away.
