Skip to content

docs: simplify auto-compaction documentation#1132

Merged
jberkus merged 1 commit intoetcd-io:mainfrom
kovan:docs/simplify-auto-compaction
Apr 9, 2026
Merged

docs: simplify auto-compaction documentation#1132
jberkus merged 1 commit intoetcd-io:mainfrom
kovan:docs/simplify-auto-compaction

Conversation

@kovan
Copy link
Copy Markdown
Contributor

@kovan kovan commented Mar 14, 2026

Summary

  • Replaces the version-by-version historical account (v3.0 through v3.3.3) with a clear description of current auto-compaction behavior
  • Documents both periodic and revision compaction modes with dedicated subsections
  • Adds recommended retention values per @ahrtr's guidance in the issue
  • Documents the compaction interval rules: every hour for periods >1h, every period for periods <=1h
  • Keeps the --auto-compaction-retention=10h timeline example (useful) but removes the "previously/now" framing
  • Applied to v3.5, v3.6, and v3.7 docs; v3.4 left unchanged to preserve historical context

Verified against server/etcdserver/api/v3compactor/periodic.go and revision.go.

Fixes #932

@k8s-ci-robot
Copy link
Copy Markdown

Hi @kovan. Thanks for your PR.

I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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-sigs/prow repository.

Comment thread content/en/docs/v3.5/op-guide/maintenance.md Outdated
Comment thread content/en/docs/v3.7/op-guide/maintenance.md Outdated
@jberkus
Copy link
Copy Markdown
Contributor

jberkus commented Apr 8, 2026

/ok-to-test

@jberkus
Copy link
Copy Markdown
Contributor

jberkus commented Apr 8, 2026

@ronaldngounou
Copy link
Copy Markdown
Member

/lgtm

@ronaldngounou
Copy link
Copy Markdown
Member

@kovan Could you please squash your commits? Thanks

Signed-off-by: Kit Dallege <xaum.io@gmail.com>
@kovan kovan force-pushed the docs/simplify-auto-compaction branch from f3b0019 to 951cda0 Compare April 9, 2026 01:13
@k8s-ci-robot k8s-ci-robot removed the lgtm label Apr 9, 2026
@k8s-ci-robot
Copy link
Copy Markdown

New changes are detected. LGTM label has been removed.

@jberkus
Copy link
Copy Markdown
Contributor

jberkus commented Apr 9, 2026

/approve

@k8s-ci-robot
Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jberkus, kovan, ronaldngounou

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

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [jberkus,ronaldngounou]

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

@jberkus jberkus merged commit 8204a0e into etcd-io:main Apr 9, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Simplify the document for etcd auto-compaction

4 participants