Skip to content

docs(readme): reflect EtcdDefragPolicy scheduled defrag - #366

Open
Andrey Kolkov (androndo) wants to merge 1 commit into
mainfrom
docs/readme-defrag-scheduling
Open

docs(readme): reflect EtcdDefragPolicy scheduled defrag#366
Andrey Kolkov (androndo) wants to merge 1 commit into
mainfrom
docs/readme-defrag-scheduling

Conversation

@androndo

@androndo Andrey Kolkov (androndo) commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator

Follow-up to #363 (EtcdDefragPolicy, merged). The README predated it and still claimed scheduled defragmentation was unsupported.

What

  • What's not supported — drop No defragmentation scheduling. It's now provided by EtcdDefragPolicy. The neighbouring no scheduled snapshot CRD gap stays (still true).
  • Docs index — the Defragmentation link now names EtcdDefrag / EtcdDefragPolicy and says one-shot or on an operator-driven cron schedule instead of only driven from outside on a schedule, matching the updated docs/etcd-defrag.md.

Docs-only; no code or generated files touched.

```release-note
NONE
```

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated defragmentation documentation to describe one-shot defragmentation and operator-driven cron scheduling.
    • Documented the EtcdDefragPolicy configuration option.
    • Removed outdated information stating that defragmentation scheduling is unsupported.

Drop the 'No defragmentation scheduling' limitation and note the
operator-driven cron path alongside one-shot EtcdDefrag.

Signed-off-by: Andrey Kolkov <andrey.kolkov@aenix.io>
@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 22e56cbd-d808-47e3-b7ad-7223489bdce4

📥 Commits

Reviewing files that changed from the base of the PR and between a3d1b19 and 79a0281.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The README now documents EtcdDefragPolicy resources and operator-driven cron scheduling. It no longer lists defragmentation scheduling as unsupported.

Changes

Defragmentation documentation

Layer / File(s) Summary
Update defragmentation support documentation
README.md
The unsupported-features list removes defragmentation scheduling. The defragmentation entry documents EtcdDefragPolicy resources and operator-driven cron scheduling.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 79a02

This documentation-only change updates the README to reflect supported scheduled defragmentation without changing product behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: lllamnyp

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the README documentation update for scheduled defragmentation through EtcdDefragPolicy. It is concise and directly matches the primary change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-defrag-scheduling

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 26, 2026
@androndo
Andrey Kolkov (androndo) marked this pull request as ready for review August 26, 2026 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant