Create garbage collection docs #28870

shannonxtreme · 2021-07-08T21:46:52Z

Overview

Consolidate and improve docs on Garbage Collection.

The following tasks should be completed before review:

Create a GC concept page
Create a Finalizers concept page
Create GC glossary term
Create finalizers glossary term
Create task for configuring kubelet GC (tracked in Create a task page for using finalizers to control deletion #28909)
Create task for configuring cascading deletion
Create task for using Finalizers to control deletion (or link to blog post)
Find a new home for the garbage collection concept topic

/sig docs
/sig apps
/wg api-expression
/assign
/cc @sftim
/do-not-merge work-in-progress

shannonxtreme · 2021-07-08T21:50:20Z

@\sftim: for configuring container and image garbage collection, we already have a task for configuring kubelet using a file or in a live node. Maybe instead of a new task that duplicates some of the content, we can link to that page and to the kubeletconfiguration reference so users can build off that?

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

netlify · 2021-07-08T22:03:15Z

✔️ Deploy Preview for kubernetes-io-main-staging ready!

🔨 Explore the source changes: b1573ad

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/60edf8947cec370007e87184

😎 Browse the preview: https://deploy-preview-28870--kubernetes-io-main-staging.netlify.app

sftim

More feedback

The main thing is to find a new home for the overall Garbage Collection concept. I suggest placing it within https://k8s.io/docs/concepts/architecture/ (as the last topic)

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

content/en/docs/concepts/overview/working-with-objects/owners-dependents.md

content/en/docs/reference/glossary/finalizer.md

sftim · 2021-07-08T22:02:34Z

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

+**Kubernetes version 1.20.x and later**
+
+Run the following command:
+
+```shell
+kubectl delete deployment nginx-deployment --cascade=background
+```
+
+**Kubernetes versions prior to 1.20.x**
+
+Run the following command:
+
+```shell
+kubectl delete deployment nginx-deployment --cascade=true
+```


Having seen the preview, I'd prefer to make this Kubernetes version choice happen in tabs, and use headings to separate the kubectl vs. API + curl approaches.

The second tab can also refer readers to https://kubernetes.io/docs/home/supported-doc-versions/

Okay. Can you confirm what the actual version number is? I wasn't sure from the commit (I've added a TODO comment in the MD to remind myself to verify)

I don't know when the change happened (I'd have to ask Google or, failing that, spelunk in the source code history for kubectl).

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

shannonxtreme · 2021-07-09T19:19:45Z

Running a little behind on creating tasks. I'll create the final two topics on Monday and then make sure all my TODOs are resolved.

sftim · 2021-07-12T09:48:04Z

@shannonxtreme it'd be OK to log issues about the final 2 task pages, and then adapt this PR to leave room for those new tasks. We don't need to land all the improvements on the first go.

shannonxtreme · 2021-07-12T15:43:52Z

@shannonxtreme it'd be OK to log issues about the final 2 task pages, and then adapt this PR to leave room for those new tasks. We don't need to land all the improvements on the first go.

@sftim Ready for review :) updated redirects as well and moved GC topic to /concepts/architecture.

sftim

LGTM

This is really good work.
I've got more feedback, but if this merged as-is, it'd already be a strong improvement.

content/en/docs/concepts/architecture/garbage-collection.md

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

content/en/docs/concepts/architecture/garbage-collection.md

content/en/docs/reference/glossary/garbage-collection.md

content/en/docs/concepts/architecture/garbage-collection.md

sftim · 2021-07-12T17:35:37Z

BTW I don't see a tracking issue for Create task for configuring kubelet GC

sftim · 2021-07-26T22:16:39Z

LGTM

Even if further SIG / WG review isn't forthcoming soon, this feels correct to me. I'd be inclined to merge it on the basis that it's going to be an overall strong improvement even if we happen to bring in a new inaccurate detail somewhere.

kbhawkey · 2021-07-27T01:42:39Z

/lgtm

k8s-ci-robot · 2021-07-27T01:42:45Z

LGTM label has been added.

Git tree hash: cbf41d945172a76ec0fbbeee5320b83a699fe63a

tengqm · 2021-07-27T05:35:36Z

content/en/docs/concepts/architecture/garbage-collection.md

+considers the following disk usage limits when making garbage collection
+decisions:
+
+  * `HighThresholdPercent`


This and the following field names should be spelt in the way how users see it, i.e. highThresholdPercent rather than how developers see it.

tengqm · 2021-07-27T05:39:36Z

/approve
Thanks.

k8s-ci-robot · 2021-07-27T05:39:45Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [tengqm]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

liggitt · 2021-08-19T22:49:09Z

content/en/docs/concepts/workloads/controllers/garbage-collection.md

-```
-
-{{< note >}}
-Cross-namespace owner references are disallowed by design.


This content appears to have been lost in this rework and is critical to communicate

Opened #29480 to track restoring that bit

sftim · 2021-10-19T08:56:00Z

/kind refactor
Note this to help other teams, eg localization

k8s-ci-robot · 2021-10-19T08:56:01Z

@sftim: The label(s) kind/refactor cannot be applied, because the repository doesn't have them.

In response to this:

/kind refactor
Note this to help other teams, eg localization

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

sftim · 2021-10-19T08:56:18Z

/label refactor

k8s-ci-robot · 2021-10-19T08:56:19Z

@sftim: The label(s) /label refactor cannot be applied. These labels are supported: api-review, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, team/katacoda

In response to this:

/label refactor

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

reylejano · 2021-11-01T16:34:28Z

/label refactor

I’ve been a member for a fair bit. Reviewed, worked on, or been involved in tracking 50+ PRs. Some highlights: * kubernetes#26848 * kubernetes#27716 * kubernetes#27739 * kubernetes#28870 * kubernetes#28740 * kubernetes#28617 Search for PRs involving me: https://github.com/kubernetes/website/pulls?page=2&q=is%3Apr+involves%3Ashannonxtreme

k8s-ci-robot assigned shannonxtreme Jul 8, 2021

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/apps Categorizes an issue or PR as relevant to SIG Apps. labels Jul 8, 2021

k8s-ci-robot requested a review from sftim July 8, 2021 21:46

shannonxtreme mentioned this pull request Jul 8, 2021

Add feature gate JobTrackingWithFinalizers #28841

Merged

shannonxtreme force-pushed the gc-docs branch from 11ab81c to 1d589e1 Compare July 8, 2021 21:49

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 8, 2021

sftim reviewed Jul 8, 2021

View reviewed changes

content/en/docs/concepts/overview/working-with-objects/finalizers.md Outdated Show resolved Hide resolved

sftim reviewed Jul 8, 2021

View reviewed changes

sftim mentioned this pull request Jul 9, 2021

Fix pending CSR delete time is 24 hours #28878

Merged

shannonxtreme force-pushed the gc-docs branch 2 times, most recently from 376399c to 205ffac Compare July 9, 2021 19:18

shannonxtreme mentioned this pull request Jul 12, 2021

Create a task page for using finalizers to control deletion #28909

Closed

shannonxtreme force-pushed the gc-docs branch from 205ffac to 8c33e62 Compare July 12, 2021 15:40

shannonxtreme marked this pull request as ready for review July 12, 2021 15:41

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 12, 2021

shannonxtreme force-pushed the gc-docs branch from 8c33e62 to 0502d14 Compare July 12, 2021 15:43

sftim reviewed Jul 12, 2021

View reviewed changes

k8s-ci-robot assigned kbhawkey Jul 27, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 27, 2021

tengqm reviewed Jul 27, 2021

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 27, 2021

k8s-ci-robot merged commit d078b42 into kubernetes:main Jul 27, 2021

shannonxtreme deleted the gc-docs branch July 27, 2021 13:43

liggitt reviewed Aug 19, 2021

View reviewed changes

liggitt mentioned this pull request Aug 19, 2021

Restore cross-namespace and invalid ownerReference info to garbage collection topic #29480

Closed

reylejano mentioned this pull request Aug 20, 2021

Add note on owner references back to garbage collection page #29482

Merged

k8s-ci-robot added the refactor Indicates a PR with large refactoring changes e.g. removes files or moves content label Nov 1, 2021

shannonxtreme mentioned this pull request Nov 11, 2021

Add shannon to reviewers #30443

Merged

t-inu mentioned this pull request Sep 5, 2022

[ja] Update content/ja/docs/concepts/containers/images.md to the latest. #35809

Merged

s-kawamura-w664 mentioned this pull request Mar 6, 2023

[ja] Update page weights under security, storage and workloads. #39797

Merged

s-kawamura-w664 mentioned this pull request Mar 20, 2023

[ja] Remove two pages of garbage collection #40150

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create garbage collection docs #28870

Create garbage collection docs #28870

shannonxtreme commented Jul 8, 2021 •

edited

Loading

shannonxtreme commented Jul 8, 2021 •

edited

Loading

netlify bot commented Jul 8, 2021 •

edited

Loading

sftim left a comment

sftim Jul 8, 2021

shannonxtreme Jul 9, 2021

sftim Jul 12, 2021

shannonxtreme commented Jul 9, 2021

sftim commented Jul 12, 2021

shannonxtreme commented Jul 12, 2021 •

edited

Loading

sftim left a comment

sftim commented Jul 12, 2021

sftim commented Jul 26, 2021

kbhawkey commented Jul 27, 2021

k8s-ci-robot commented Jul 27, 2021

tengqm Jul 27, 2021

tengqm commented Jul 27, 2021

k8s-ci-robot commented Jul 27, 2021

liggitt Aug 19, 2021

liggitt Aug 19, 2021

sftim commented Oct 19, 2021

k8s-ci-robot commented Oct 19, 2021

sftim commented Oct 19, 2021

k8s-ci-robot commented Oct 19, 2021

reylejano commented Nov 1, 2021

Create garbage collection docs #28870

Create garbage collection docs #28870

Conversation

shannonxtreme commented Jul 8, 2021 • edited Loading

Overview

shannonxtreme commented Jul 8, 2021 • edited Loading

netlify bot commented Jul 8, 2021 • edited Loading

sftim left a comment

Choose a reason for hiding this comment

sftim Jul 8, 2021

Choose a reason for hiding this comment

shannonxtreme Jul 9, 2021

Choose a reason for hiding this comment

sftim Jul 12, 2021

Choose a reason for hiding this comment

shannonxtreme commented Jul 9, 2021

sftim commented Jul 12, 2021

shannonxtreme commented Jul 12, 2021 • edited Loading

sftim left a comment

Choose a reason for hiding this comment

sftim commented Jul 12, 2021

sftim commented Jul 26, 2021

kbhawkey commented Jul 27, 2021

k8s-ci-robot commented Jul 27, 2021

tengqm Jul 27, 2021

Choose a reason for hiding this comment

tengqm commented Jul 27, 2021

k8s-ci-robot commented Jul 27, 2021

liggitt Aug 19, 2021

Choose a reason for hiding this comment

liggitt Aug 19, 2021

Choose a reason for hiding this comment

sftim commented Oct 19, 2021

k8s-ci-robot commented Oct 19, 2021

sftim commented Oct 19, 2021

k8s-ci-robot commented Oct 19, 2021

reylejano commented Nov 1, 2021

shannonxtreme commented Jul 8, 2021 •

edited

Loading

shannonxtreme commented Jul 8, 2021 •

edited

Loading

netlify bot commented Jul 8, 2021 •

edited

Loading

shannonxtreme commented Jul 12, 2021 •

edited

Loading