From 1c01017319cb2d0f644f3b7490a0d8085dc75d24 Mon Sep 17 00:00:00 2001 From: Mark Mandel Date: Thu, 28 Dec 2017 17:06:28 -0800 Subject: [PATCH] Cascading deletion policy correction In the previous version it read as if you could specify the `propagationPolicy` on the Object itself, which isn't possible. Change the documentation to make it clear that the `propagationPolicy` is set on the `deleteOptions` argument when invoking a Object deletion function. --- docs/concepts/workloads/controllers/garbage-collection.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/concepts/workloads/controllers/garbage-collection.md b/docs/concepts/workloads/controllers/garbage-collection.md index 98c78d184c..8957411b19 100644 --- a/docs/concepts/workloads/controllers/garbage-collection.md +++ b/docs/concepts/workloads/controllers/garbage-collection.md @@ -102,8 +102,8 @@ the background. ### Setting the cascading deletion policy -To control the cascading deletion policy, set the `deleteOptions.propagationPolicy` -field on your owner object. Possible values include "Orphan", +To control the cascading deletion policy, set the `propagationPolicy` +field on the `deleteOptions` argument when deleting an Object. Possible values include "Orphan", "Foreground", or "Background". Prior to Kubernetes 1.9, the default garbage collection policy for many controller resources was `orphan`.