Skip to content

docs: update nightly remote WAL logical pruning docs#2553

Merged
v0y4g3r merged 4 commits into
mainfrom
copilot/update-zh-en-nightly-docs
Jun 11, 2026
Merged

docs: update nightly remote WAL logical pruning docs#2553
v0y4g3r merged 4 commits into
mainfrom
copilot/update-zh-en-nightly-docs

Conversation

Copilot AI commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

What's Changed in this PR

This updates the nightly Remote WAL documentation for the new auto_prune_logical_delete metasrv option introduced by the upstream feature. The English and Chinese nightly docs now show how to enable logical pruning for Kafka deployments that do not support DeleteRecords.

  • Nightly Remote WAL config

    • Added auto_prune_logical_delete = false with an inline comment to the metasrv configuration example in the EN and ZH nightly docs, clarifying when to set it to true.
  • Option reference

    • Documented that the option advances GreptimeDB's metadata prune marker without issuing Kafka DeleteRecords.
    • Clarified that it is intended for Kafka environments where DeleteRecords is unavailable.
    • Added note that when enabled, actual data removal from Kafka topics relies on Kafka's own retention and cleanup policies.
  • Kafka permissions section

    • Updated the Delete records permission entry to indicate it is not required when auto_prune_logical_delete = true, resolving the contradiction for deployments that enable logical pruning.
[wal]
auto_prune_interval = "30m"
auto_prune_logical_delete = false  # set to true if your Kafka deployment does not support DeleteRecords

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 10, 2026

Copy link
Copy Markdown

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 68af16c
Status: ✅  Deploy successful!
Preview URL: https://80d7eac3.greptime-docs.pages.dev
Branch Preview URL: https://copilot-update-zh-en-nightly.greptime-docs.pages.dev

View logs

Copilot AI changed the title [WIP] Update documentation for remote WAL logical pruning support docs: update nightly remote WAL logical pruning docs Jun 10, 2026
Copilot AI requested a review from WenyXu June 10, 2026 06:38
@WenyXu WenyXu requested a review from Copilot June 10, 2026 06:42

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the nightly Remote WAL documentation (EN + ZH) to include and describe the new auto_prune_logical_delete Metasrv option for Kafka environments where DeleteRecords is unavailable.

Changes:

  • Added auto_prune_logical_delete to the Metasrv configuration example in the nightly Remote WAL docs (EN/ZH).
  • Added an option reference entry explaining that logical pruning advances GreptimeDB’s metadata marker while skipping Kafka DeleteRecords.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
docs/user-guide/deployments-administration/wal/remote-wal/configuration.md Adds the new Metasrv Remote WAL pruning option to the example config and options table.
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/wal/remote-wal/configuration.md Mirrors the same option addition and explanation for the Chinese nightly docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/user-guide/deployments-administration/wal/remote-wal/configuration.md Outdated
@WenyXu

WenyXu commented Jun 10, 2026

Copy link
Copy Markdown
Member

@copilot apply suggestions

Copilot AI commented Jun 10, 2026

Copy link
Copy Markdown
Contributor Author

@copilot apply suggestions

Applied all four suggestions in commit docs: apply reviewer suggestions for auto_prune_logical_delete:

  • Added inline comments in both EN and ZH config examples clarifying when to set auto_prune_logical_delete = true
  • Updated the option description in both files to note that when enabled, actual data removal from Kafka topics relies on Kafka's own retention and cleanup policies
  • Updated the permissions sections in both files to indicate that the Delete permission is not required when auto_prune_logical_delete = true

@WenyXu WenyXu marked this pull request as ready for review June 11, 2026 02:46
@v0y4g3r v0y4g3r merged commit 513c62b into main Jun 11, 2026
5 checks passed
@v0y4g3r v0y4g3r deleted the copilot/update-zh-en-nightly-docs branch June 11, 2026 02:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs for feat: support remote WAL logical pruning

4 participants