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

Merge pull request #31631 from tengqm/fix-gc-cascade 

Fix the cascading deletion page
This commit is contained in:
Kubernetes Prow Robot 2022-02-13 23:09:28 -08:00 committed by GitHub
parent 7ef7a39cf1 d4f6e0be55
commit 1f4ca9f802
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 123 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

245
content/en/docs/tasks/administer-cluster/use-cascading-deletion.md
View File

@ -5,7 +5,8 @@ content_type: task
<!--overview--> <!--overview-->
This page shows you how to specify the type of [cascading deletion](/docs/concepts/workloads/controllers/garbage-collection/#cascading-deletion) This page shows you how to specify the type of
[cascading deletion](/docs/concepts/architecture/garbage-collection/#cascading-deletion)
to use in your cluster during {{<glossary_tooltip text="garbage collection" term_id="garbage-collection">}}. to use in your cluster during {{<glossary_tooltip text="garbage collection" term_id="garbage-collection">}}.
## {{% heading "prerequisites" %}} ## {{% heading "prerequisites" %}}
@ -26,7 +27,7 @@ kubectl get pods -l app=nginx --output=yaml
The output has an `ownerReferences` field similar to this: The output has an `ownerReferences` field similar to this:
``` ```yaml
apiVersion: v1 apiVersion: v1
... ...
ownerReferences: ownerReferences:
@ -41,7 +42,7 @@ apiVersion: v1
## Use foreground cascading deletion {#use-foreground-cascading-deletion} ## Use foreground cascading deletion {#use-foreground-cascading-deletion}
By default, Kubernetes uses [background cascading deletion](/docs/concepts/workloads/controllers/garbage-collection/#background-deletion) By default, Kubernetes uses [background cascading deletion](/docs/concepts/architecture/garbage-collection/#background-deletion)
to delete dependents of an object. You can switch to foreground cascading deletion to delete dependents of an object. You can switch to foreground cascading deletion
using either `kubectl` or the Kubernetes API, depending on the Kubernetes using either `kubectl` or the Kubernetes API, depending on the Kubernetes
version your cluster runs. {{<version-check>}} version your cluster runs. {{<version-check>}}
@ -64,9 +65,9 @@ kubectl delete deployment nginx-deployment --cascade=foreground
1. Start a local proxy session: 1. Start a local proxy session:
```shell ```shell
kubectl proxy --port=8080 kubectl proxy --port=8080
``` ```
1. Use `curl` to trigger deletion: 1. Use `curl` to trigger deletion:
@ -80,19 +81,19 @@ kubectl delete deployment nginx-deployment --cascade=foreground
like this: like this:
``` ```
"kind": "Deployment", "kind": "Deployment",
"apiVersion": "apps/v1", "apiVersion": "apps/v1",
"metadata": { "metadata": {
"name": "nginx-deployment", "name": "nginx-deployment",
"namespace": "default", "namespace": "default",
"uid": "d1ce1b02-cae8-4288-8a53-30e84d8fa505", "uid": "d1ce1b02-cae8-4288-8a53-30e84d8fa505",
"resourceVersion": "1363097", "resourceVersion": "1363097",
"creationTimestamp": "2021-07-08T20:24:37Z", "creationTimestamp": "2021-07-08T20:24:37Z",
"deletionTimestamp": "2021-07-08T20:27:39Z", "deletionTimestamp": "2021-07-08T20:27:39Z",
"finalizers": [ "finalizers": [
"foregroundDeletion" "foregroundDeletion"
] ]
... ...
``` ```
{{% /tab %}} {{% /tab %}}
@ -104,9 +105,9 @@ For details, read the [documentation for your Kubernetes version](/docs/home/sup
1. Start a local proxy session: 1. Start a local proxy session:
```shell ```shell
kubectl proxy --port=8080 kubectl proxy --port=8080
``` ```
1. Use `curl` to trigger deletion: 1. Use `curl` to trigger deletion:
@ -120,19 +121,19 @@ For details, read the [documentation for your Kubernetes version](/docs/home/sup
like this: like this:
``` ```
"kind": "Deployment", "kind": "Deployment",
"apiVersion": "apps/v1", "apiVersion": "apps/v1",
"metadata": { "metadata": {
"name": "nginx-deployment", "name": "nginx-deployment",
"namespace": "default", "namespace": "default",
"uid": "d1ce1b02-cae8-4288-8a53-30e84d8fa505", "uid": "d1ce1b02-cae8-4288-8a53-30e84d8fa505",
"resourceVersion": "1363097", "resourceVersion": "1363097",
"creationTimestamp": "2021-07-08T20:24:37Z", "creationTimestamp": "2021-07-08T20:24:37Z",
"deletionTimestamp": "2021-07-08T20:27:39Z", "deletionTimestamp": "2021-07-08T20:27:39Z",
"finalizers": [ "finalizers": [
"foregroundDeletion" "foregroundDeletion"
] ]
... ...
``` ```
{{% /tab %}} {{% /tab %}}
{{</tabs>}} {{</tabs>}}
@ -165,32 +166,32 @@ kubectl delete deployment nginx-deployment --cascade=background
1. Start a local proxy session: 1. Start a local proxy session:
```shell ```shell
kubectl proxy --port=8080 kubectl proxy --port=8080
``` ```
1. Use `curl` to trigger deletion: 1. Use `curl` to trigger deletion:
```shell ```shell
curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/deployments/nginx-deployment \ curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/deployments/nginx-deployment \
-d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Background"}' \ -d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Background"}' \
-H "Content-Type: application/json" -H "Content-Type: application/json"
``` ```
The output is similar to this: The output is similar to this:
``` ```
"kind": "Status", "kind": "Status",
"apiVersion": "v1", "apiVersion": "v1",
... ...
"status": "Success", "status": "Success",
"details": { "details": {
"name": "nginx-deployment", "name": "nginx-deployment",
"group": "apps", "group": "apps",
"kind": "deployments", "kind": "deployments",
"uid": "cc9eefb9-2d49-4445-b1c1-d261c9396456" "uid": "cc9eefb9-2d49-4445-b1c1-d261c9396456"
} }
``` ```
{{% /tab %}} {{% /tab %}}
{{% tab name="Versions prior to Kubernetes 1.20.x" %}} {{% tab name="Versions prior to Kubernetes 1.20.x" %}}
Kubernetes uses background cascading deletion by default, and does so Kubernetes uses background cascading deletion by default, and does so
@ -211,32 +212,32 @@ kubectl delete deployment nginx-deployment --cascade=true
1. Start a local proxy session: 1. Start a local proxy session:
```shell ```shell
kubectl proxy --port=8080 kubectl proxy --port=8080
``` ```
1. Use `curl` to trigger deletion: 1. Use `curl` to trigger deletion:
```shell ```shell
curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/deployments/nginx-deployment \ curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/deployments/nginx-deployment \
-d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Background"}' \ -d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Background"}' \
-H "Content-Type: application/json" -H "Content-Type: application/json"
``` ```
The output is similar to this: The output is similar to this:
``` ```
"kind": "Status", "kind": "Status",
"apiVersion": "v1", "apiVersion": "v1",
... ...
"status": "Success", "status": "Success",
"details": { "details": {
"name": "nginx-deployment", "name": "nginx-deployment",
"group": "apps", "group": "apps",
"kind": "deployments", "kind": "deployments",
"uid": "cc9eefb9-2d49-4445-b1c1-d261c9396456" "uid": "cc9eefb9-2d49-4445-b1c1-d261c9396456"
} }
``` ```
{{% /tab %}} {{% /tab %}}
{{</tabs>}} {{</tabs>}}
@ -264,33 +265,33 @@ kubectl delete deployment nginx-deployment --cascade=orphan
1. Start a local proxy session: 1. Start a local proxy session:
```shell ```shell
kubectl proxy --port=8080 kubectl proxy --port=8080
``` ```
1. Use `curl` to trigger deletion: 1. Use `curl` to trigger deletion:
```shell ```shell
curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/deployments/nginx-deployment \ curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/deployments/nginx-deployment \
-d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Orphan"}' \ -d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Orphan"}' \
-H "Content-Type: application/json" -H "Content-Type: application/json"
``` ```
The output contains `orphan` in the `finalizers` field, similar to this: The output contains `orphan` in the `finalizers` field, similar to this:
``` ```
"kind": "Deployment", "kind": "Deployment",
"apiVersion": "apps/v1", "apiVersion": "apps/v1",
"namespace": "default", "namespace": "default",
"uid": "6f577034-42a0-479d-be21-78018c466f1f", "uid": "6f577034-42a0-479d-be21-78018c466f1f",
"creationTimestamp": "2021-07-09T16:46:37Z", "creationTimestamp": "2021-07-09T16:46:37Z",
"deletionTimestamp": "2021-07-09T16:47:08Z", "deletionTimestamp": "2021-07-09T16:47:08Z",
"deletionGracePeriodSeconds": 0, "deletionGracePeriodSeconds": 0,
"finalizers": [ "finalizers": [
"orphan" "orphan"
], ],
... ...
``` ```
{{% /tab %}} {{% /tab %}}
{{% tab name="Versions prior to Kubernetes 1.20.x" %}} {{% tab name="Versions prior to Kubernetes 1.20.x" %}}
@ -309,33 +310,33 @@ kubectl delete deployment nginx-deployment --cascade=orphan
1. Start a local proxy session: 1. Start a local proxy session:
```shell ```shell
kubectl proxy --port=8080 kubectl proxy --port=8080
``` ```
1. Use `curl` to trigger deletion: 1. Use `curl` to trigger deletion:
```shell ```shell
curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/deployments/nginx-deployment \ curl -X DELETE localhost:8080/apis/apps/v1/namespaces/default/deployments/nginx-deployment \
-d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Orphan"}' \ -d '{"kind":"DeleteOptions","apiVersion":"v1","propagationPolicy":"Orphan"}' \
-H "Content-Type: application/json" -H "Content-Type: application/json"
``` ```
The output contains `orphan` in the `finalizers` field, similar to this: The output contains `orphan` in the `finalizers` field, similar to this:
``` ```
"kind": "Deployment", "kind": "Deployment",
"apiVersion": "apps/v1", "apiVersion": "apps/v1",
"namespace": "default", "namespace": "default",
"uid": "6f577034-42a0-479d-be21-78018c466f1f", "uid": "6f577034-42a0-479d-be21-78018c466f1f",
"creationTimestamp": "2021-07-09T16:46:37Z", "creationTimestamp": "2021-07-09T16:46:37Z",
"deletionTimestamp": "2021-07-09T16:47:08Z", "deletionTimestamp": "2021-07-09T16:47:08Z",
"deletionGracePeriodSeconds": 0, "deletionGracePeriodSeconds": 0,
"finalizers": [ "finalizers": [
"orphan" "orphan"
], ],
... ...
``` ```
{{% /tab %}} {{% /tab %}}
{{</tabs>}} {{</tabs>}}
@ -349,4 +350,4 @@ kubectl get pods -l app=nginx
* Learn about [owners and dependents](/docs/concepts/overview/working-with-objects/owners-dependents/) in Kubernetes. * Learn about [owners and dependents](/docs/concepts/overview/working-with-objects/owners-dependents/) in Kubernetes.
* Learn about Kubernetes [finalizers](/docs/concepts/overview/working-with-objects/finalizers/). * Learn about Kubernetes [finalizers](/docs/concepts/overview/working-with-objects/finalizers/).
* Learn about [garbage collection](/docs/concepts/workloads/controllers/garbage-collection/). * Learn about [garbage collection](/docs/concepts/architecture/garbage-collection/).