kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update finalizers.md

This commit is contained in:
Jordan Liggitt 2022-02-14 09:22:12 -05:00
parent 7dd728cf69
commit fa4cc5965b
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
content/en/docs/concepts/overview/working-with-objects/finalizers.md
View File

@ -21,18 +21,21 @@ your own.
When you create a resource using a manifest file, you can specify finalizers in When you create a resource using a manifest file, you can specify finalizers in
the `metadata.finalizers` field. When you attempt to delete the resource, the the `metadata.finalizers` field. When you attempt to delete the resource, the
controller that manages it notices the values in the `finalizers` field and does API server handling the delete request notices the values in the `finalizers` field
the following: and does the following:
* Modifies the object to add a `metadata.deletionTimestamp` field with the * Modifies the object to add a `metadata.deletionTimestamp` field with the
time you started the deletion. time you started the deletion.
* Marks the object as read-only until its `metadata.finalizers` field is empty. * Prevents the object from being removed until its `metadata.finalizers` field is empty.
* Returns a `202` status code (HTTP "Accepted")
The controller managing that finalizer notices the update to the object setting the
`metadata.deletionTimestamp`, indicating deletion of the object has been requested.
The controller then attempts to satisfy the requirements of the finalizers The controller then attempts to satisfy the requirements of the finalizers
specified for that resource. Each time a finalizer condition is satisfied, the specified for that resource. Each time a finalizer condition is satisfied, the
controller removes that key from the resource's `finalizers` field. When the controller removes that key from the resource's `finalizers` field. When the
field is empty, garbage collection continues. You can also use finalizers to `finalizers` field is emptied, an object with a `deletionTimestamp` field set
prevent deletion of unmanaged resources. is automatically deleted. You can also use finalizers to prevent deletion of unmanaged resources.
A common example of a finalizer is `kubernetes.io/pv-protection`, which prevents A common example of a finalizer is `kubernetes.io/pv-protection`, which prevents
accidental deletion of `PersistentVolume` objects. When a `PersistentVolume` accidental deletion of `PersistentVolume` objects. When a `PersistentVolume`
@ -63,16 +66,18 @@ Kubernetes also processes finalizers when it identifies owner references on a
resource targeted for deletion. resource targeted for deletion.
In some situations, finalizers can block the deletion of dependent objects, In some situations, finalizers can block the deletion of dependent objects,
which can cause the targeted owner object to remain in a read-only state for which can cause the targeted owner object to remain for
longer than expected without being fully deleted. In these situations, you longer than expected without being fully deleted. In these situations, you
should check finalizers and owner references on the target owner and dependent should check finalizers and owner references on the target owner and dependent
objects to troubleshoot the cause. objects to troubleshoot the cause.
{{<note>}} {{<note>}}
In cases where objects are stuck in a deleting state, try to avoid manually In cases where objects are stuck in a deleting state, avoid manually
removing finalizers to allow deletion to continue. Finalizers are usually added removing finalizers to allow deletion to continue. Finalizers are usually added
to resources for a reason, so forcefully removing them can lead to issues in to resources for a reason, so forcefully removing them can lead to issues in
your cluster. your cluster. This should only be done when the purpose of the finalizer is
understood and is accomplished in another way (for example, manually cleaning
up some dependent object).
{{</note>}} {{</note>}}
## {{% heading "whatsnext" %}} ## {{% heading "whatsnext" %}}