summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKubernetes Submit Queue <k8s-merge-robot@users.noreply.github.com>2017-10-12 13:31:35 -0700
committerGitHub <noreply@github.com>2017-10-12 13:31:35 -0700
commitf8bd922053d3b1d5260e88cd10d4d51b57f09ba6 (patch)
tree6813aac1b368e7daa75ad3b2e8a7a554e5beafc4
parent586dcd7a7c1bd0e8aac44f5f14b88dd00a904b5d (diff)
parent1cd86bd62678ab9c276cc44bf03be2e532ef0099 (diff)
Merge pull request #1177 from pospispa/update-deletionTimestamp-with-finalizer-info
Automatic merge from submit-queue. Update deletionTimestamp with information about finalizer effect. Updating description of `deletionTimestamp` as adviced [here](https://github.com/kubernetes/community/pull/1174#discussion_r144286471).
-rw-r--r--contributors/devel/api-conventions.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/contributors/devel/api-conventions.md b/contributors/devel/api-conventions.md
index a29fd9f0..c69617c1 100644
--- a/contributors/devel/api-conventions.md
+++ b/contributors/devel/api-conventions.md
@@ -225,9 +225,12 @@ an object was created
after which this resource will be deleted. This field is set by the server when
a graceful deletion is requested by the user, and is not directly settable by a
client. The resource will be deleted (no longer visible from resource lists, and
-not reachable by name) after the time in this field. Once set, this value may
-not be unset or be set further into the future, although it may be shortened or
-the resource may be deleted prior to this time.
+not reachable by name) after the time in this field except when the object has
+a finalizer set. In case the finalizer is set the deletion of the object is
+postponed at least until the finalizer is removed.
+Once the deletionTimestamp is set, this value may not be unset or be set further
+into the future, although it may be shortened or the resource may be deleted
+prior to this time.
* labels: a map of string keys and values that can be used to organize and
categorize objects (see [the labels docs](https://kubernetes.io/docs/user-guide/labels/))
* annotations: a map of string keys and values that can be used by external