Skip to content

Update documentation regarding node deletion changes#1067

Open
gagan16k wants to merge 3 commits intogardener:masterfrom
gagan16k:doc_changes
Open

Update documentation regarding node deletion changes#1067
gagan16k wants to merge 3 commits intogardener:masterfrom
gagan16k:doc_changes

Conversation

@gagan16k
Copy link
Member

@gagan16k gagan16k commented Feb 5, 2026

What this PR does / why we need it:
This PR updates documentation to account for changes made by #1055 , regarding the node.machine.sapcloud.io/trigger-deletion-by-mcm annotation.

  • Updated docs/faq.md to clarify that deleting a node now immediately triggers the deletion and replacement of the corresponding machine, and that the trigger-deletion-by-mcm annotation is no longer supported on node objects but is still supported on machine and machineDeployment objects for CA-MCM integration.
  • Updated comment for TriggerDeletionByMCM in pkg/util/provider/machineutils/utils.go

Release note:

NONE

@gagan16k gagan16k requested a review from a team as a code owner February 5, 2026 11:54
@gardener-prow gardener-prow bot added do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. labels Feb 5, 2026
@gardener-prow
Copy link

gardener-prow bot commented Feb 5, 2026

[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 gagan16k for approval. For more information see the Code Review Process.

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

Details 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

@gardener-prow gardener-prow bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 5, 2026
docs/faq.md Outdated
@@ -155,16 +155,14 @@ It can be unpaused again by removing the `Paused` field from the machine-deploym

### How to delete machine object immedietly if I don't have access to it?
Copy link
Member

Choose a reason for hiding this comment

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

I know this line was not added by you, nor is it in scope of this PR, but could you please correct the spelling error in "immediately"?

docs/faq.md Outdated
On the other hand if the user deletes the node object immedietly then replacement will start only after `MachineHealthTimeout`.

This annotation can also be used if the user wants to expedite the [replacement of unhealthy nodes](#how-does-rate-limiting-replacement-of-machine-work-in-mcm-how-is-it-related-to-meltdown-protection)
If the user deletes the node object, the corresponding machine object is marked for deletion immediately, triggering a replacement. The replacement machine is created to maintain the `desired replicas` specified for the machineDeployment/machineSet.
Copy link
Member

Choose a reason for hiding this comment

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

imo, the answer here answers the question "what happens if I delete a node object" rather than what it's supposed to answer. I've given a suggestion but please feel free to improvise or change the direction

Suggested change
If the user deletes the node object, the corresponding machine object is marked for deletion immediately, triggering a replacement. The replacement machine is created to maintain the `desired replicas` specified for the machineDeployment/machineSet.
If the user doesn't have access to the machine object, they can directly delete the node object. This causes the corresponding machine object to be immediately marked for deletion, triggering a replacement. The replacement machine is created to maintain the `desired replicas` specified for the machineDeployment/machineSet.

docs/faq.md Outdated
- `node.machine.sapcloud.io/trigger-deletion-by-mcm: "false"` annotation is NOT acted upon by MCM , neither does it mean that MCM will not replace this machine.
- this annotation would delete the desired machine but another machine would be created to maintain `desired replicas` specified for the machineDeployment/machineSet. Currently if the user doesn't have access to machineDeployment/machineSet then they cannot remove a machine without replacement.
- The `node.machine.sapcloud.io/trigger-deletion-by-mcm` annotation is no longer supported on node objects. It is however, still supported on machine and machineDeployment objects (used by the CA-MCM cloud provider integration).
- Setting the annotation to `"false"` has never been acted upon by MCM and does not prevent machine replacement.
Copy link
Member

Choose a reason for hiding this comment

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

The old way is fair enough here

Suggested change
- Setting the annotation to `"false"` has never been acted upon by MCM and does not prevent machine replacement.
- Setting the annotation to `"false"` is NOT acted upon by MCM and does not prevent machine replacement.

NotManagedByMCM = "node.machine.sapcloud.io/not-managed-by-mcm"

// TriggerDeletionByMCM annotation on the node or machine would trigger the deletion of the corresponding node and machine object in the control cluster
// TriggerDeletionByMCM annotation on the machine would trigger the deletion of the corresponding node and machine object in the control cluster
Copy link
Member

Choose a reason for hiding this comment

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

Can this line be removed entirely now, as it gives a false impression that adding the annotation on machine would trigger its deletion which is not the case.

Its only used on the MachineDeployment now.

docs/faq.md Outdated

- `node.machine.sapcloud.io/trigger-deletion-by-mcm: "false"` annotation is NOT acted upon by MCM , neither does it mean that MCM will not replace this machine.
- this annotation would delete the desired machine but another machine would be created to maintain `desired replicas` specified for the machineDeployment/machineSet. Currently if the user doesn't have access to machineDeployment/machineSet then they cannot remove a machine without replacement.
- The `node.machine.sapcloud.io/trigger-deletion-by-mcm` annotation is no longer supported on node objects. It is however, still supported on machine and machineDeployment objects (used by the CA-MCM cloud provider integration).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- The `node.machine.sapcloud.io/trigger-deletion-by-mcm` annotation is no longer supported on node objects. It is however, still supported on machine and machineDeployment objects (used by the CA-MCM cloud provider integration).
- The `node.machine.sapcloud.io/trigger-deletion-by-mcm` annotation is no longer supported on node objects. It is however, still used on the machineDeployment objects (used by the CA-MCM cloud provider integration).

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

Labels

cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments