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.
This commit is contained in:
Mark Mandel
2017-12-28 17:06:28 -08:00
parent a3fa110feb
commit 1c01017319
@@ -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`.