Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidate Garbage Collection docs #28840

Closed

Conversation

shannonxtreme
Copy link
Contributor

Fixes #4322

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
  • Create task for configuring cascading deletion
  • Create task for using Finalizers to control deletion (or link to blog post)

/sig docs
/assign
/cc @sftim
/do-not-merge work-in-progress

@k8s-ci-robot 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. labels Jul 7, 2021
@k8s-ci-robot k8s-ci-robot requested a review from sftim July 7, 2021 16:12
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 7, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign onlydole after the PR has been reviewed.
You can assign the PR to them by writing /assign @onlydole in a comment when ready.

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

Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 7, 2021
@shannonxtreme
Copy link
Contributor Author

Tim: I haven't added glossary links and all that fun stuff yet. I'm working on drafting the tasks based on existing content so that all our hyperlinks have actual destinations. ETA end of the week on the remaining tasks :)

@netlify
Copy link

netlify bot commented Jul 7, 2021

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

🔨 Explore the source changes: 8e07037

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

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

@sftim
Copy link
Contributor

sftim commented Jul 8, 2021

/wg api-expression
for parts of this

@k8s-ci-robot k8s-ci-robot added the wg/api-expression Categorizes an issue or PR as relevant to WG API Expression. label Jul 8, 2021
Comment on lines +8 to +21
{{<glossary_definition term_id="garbage-collection" length="short">}} This
allows the clean up of resources like the following:

* [Objects without owner references](#owners-dependents)
* [Unused containers and container images](#containers-images)
* [Failed pods](/docs/concepts/workloads/pods/pod-lifecycle/#pod-garbage-collection)
* [Dynamically provisioned PersistentVolumes with a StorageClass reclaim policy of Delete](/docs/concepts/storage/persistent-volumes/#delete)
* [Stale or expired CertificateSigningRequests (CSRs)](/reference/access-authn-authz/certificate-signing-requests/#request-signing-process)
* Nodes deleted in the following scenarios:
* On a cloud when the cluster uses a [cloud controller manager](/docs/concepts/architecture/cloud-controller/)
* On-premises when the cluster uses an addon similar to a cloud controller
manager
* [Node Lease objects](/docs/concepts/architecture/nodes/#heartbeats)
* [Completed Jobs](/docs/concepts/workloads/controllers/ttlafterfinished/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As this is in currently part of workloads section, this page should either:

  • focus on cleanup for completed jobs
  • move somewhere else

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By this page, do you mean the TTLafterfinished page?

@sftim
Copy link
Contributor

sftim commented Jul 8, 2021

/sig apps
for Job cleanup

@k8s-ci-robot k8s-ci-robot added the sig/apps Categorizes an issue or PR as relevant to SIG Apps. label Jul 8, 2021
@shannonxtreme
Copy link
Contributor Author

@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?

@k8s-ci-robot 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
@shannonxtreme shannonxtreme deleted the garbage-collection branch February 17, 2022 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. language/en Issues or PRs related to English language sig/apps Categorizes an issue or PR as relevant to SIG Apps. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. wg/api-expression Categorizes an issue or PR as relevant to WG API Expression.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Better docs for garbage collection
3 participants