Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
@Nuckal777
Nuckal777 committed Oct 2, 2024
1 parent 364632d commit 2ab7220
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This is done best on `MachineDeployments` resources for consistency reasons.
As soon as a machine is marked as enabled for runtime-extension-maintenance-controller it is annotated with `pre-drain.delete.hook.machine.cluster.x-k8s.io/maintenance-controller: runtime-extensions-maintenance-controller` to stop the cleanup logic of Cluster API on machine deletion.
Instead the corresponding `Node` object in the workload cluster is marked with the `runtime-extension-maintenance-controller.cloud.sap/machine-deleted: "true"` label.
This label should be used to trigger the maintenance-controller in the workload cluster.
The `runtime-extension-maintenance-controller.cloud.sap/approve-deletion: "true"` label shoud be used by the maintenance-controller to notify the runtime-extension, that the node is ready to be removed.
The `runtime-extension-maintenance-controller.cloud.sap/approve-deletion: "true"` label should be used by the maintenance-controller to notify the runtime-extension, that the node is ready to be removed.
After attaching the approve-deletion label the pre-drain hook will be removed, which allows machine deletion to continue.

![Workflow](docs/flow.drawio.png)
Expand All @@ -27,10 +27,11 @@ After attaching the approve-deletion label the pre-drain hook will be removed, w
Sometimes a machine needs a longer maintenance outside of the cluster-api machine lifecycle.
To initiate such a longer maintenance a `Machine` object can be labelled with `runtime-extension-maintenance-controller.cloud.sap/maintenance: requested`.
That will deliver the `runtime-extension-maintenance-controller.cloud.sap/machine-maintenance: "true"` label on the respective node, which the maintenance-controller can act upon.
The `runtime-extension-maintenance-controller.cloud.sap/approve-deletion: "true"` label shoud be used by the maintenance-controller to notify the runtime-extension, that the node is ready to be maintained.
The `runtime-extension-maintenance-controller.cloud.sap/approve-maintenance: "true"` label should be used by the maintenance-controller to notify the runtime-extension, that the node is ready to be maintained.
This sets the label on the `Machine` object to `runtime-extension-maintenance-controller.cloud.sap/maintenance: approved`.

A different controller needs to start the actual maintenance procedure once the a maintenance on a machine is approved as that procedure depends on the infrastructure provider backing the machine.
A different controller needs to start the actual maintenance procedure once the a maintenance on a machine is approved.
Such a procedure depends on the infrastructure provider backing the machine.
The maintenance can be stopped by removing the `runtime-extension-maintenance-controller.cloud.sap/maintenance` label.

#### Metal3
Expand Down

0 comments on commit 2ab7220

Please sign in to comment.