Repository navigation
docs(enterprise): document Gen1 file cleanup for the legacy Parquet engine - #7861
Merged
Merged
Conversation
…ngine What changed: - Add an admin page for the Gen1 cleanup endpoint (POST /api/v3/configure/gen1_cleanup): how to run it, which files it deletes and keeps, and how to inspect Gen1 and compacted files. - Link it from the Gen1 note on the file-index page. - Clarify that compaction-cleanup-wait doesn't apply to Gen1 files. - Note that system.parquet_files lists only Gen1 files on the legacy Parquet engine. Why: The file-index note says Gen1 files remain after compaction but not how to remove them. Customers read compaction-cleanup-wait as Gen1 retention and monitor system.parquet_files expecting compacted files. Impact: Documentation only. Verification: Endpoint, defaults, eligibility rules, admin-token requirement, log messages, and system table behavior checked against influxdb_pro v3.12.0 source. lint-codeblocks and Vale (enterprise config) pass on the changed files.
Contributor
Vale Style Check Results
Warnings (1)
✅ Check passed |
github-actions
Bot
added
product:shared
Contributor
🔗 Link Check Results — Link Check Bot✅ All links are valid
|
| Source File | URL | Issue |
|---|---|---|
content/influxdb3/core/reference/config-options/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/admin/clustering/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/admin/file-index/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/admin/gen1-file-cleanup/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/config-options/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
Full details: workflow run summary and artifact. Last updated: 2026-10-07 20:32:31 UTC
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The shared-content edit needs corresponding consumer-stub updates to support reliable incremental rendering.
1 open finding
What changed in this PR
Documents manual Gen1 cleanup for Enterprise’s legacy Parquet engine, extending #7853’s storage-retention clarification.
Changes:
- Adds cleanup instructions, eligibility rules, and inspection queries.
- Clarifies compaction cleanup and monitoring behavior.
- Links existing file-index guidance to the new procedure.
| File | Description |
|---|---|
content/shared/influxdb3-cli/config-options.md |
Clarifies that compaction cleanup excludes Gen1 files. |
content/influxdb3/enterprise/admin/gen1-file-cleanup.md |
Documents cleanup and file inspection. |
content/influxdb3/enterprise/admin/file-index/_index.md |
Links to cleanup instructions. |
content/influxdb3/enterprise/admin/clustering.md |
Clarifies the monitoring table’s Gen1-only scope. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+1898
to
+1899
| On the legacy Parquet storage engine, compaction doesn't mark Gen1 files for | ||
| deletion; see [Gen1 file cleanup](/influxdb3/enterprise/admin/gen1-file-cleanup/). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follows #7853, which notes that the legacy Parquet engine keeps Gen1 files after compaction. This PR documents how to delete them, and fixes two spots that lead readers to expect otherwise.
POST /api/v3/configure/gen1_cleanup, which files it deletes and keeps, and how to inspect Gen1 vs. compacted files.compaction-cleanup-wait: says it doesn't apply to Gen1 files.system.parquet_fileslists only Gen1 files.Behavior was checked against influxdb_pro
v3.12.0source. Related: influxdata/DAR#766.Details
Facts checked in source (v3.12.0)
min_age=24h,batch_size=500(snapshots per request),concurrency=10. It is not in the fine-grained or system permission lists, so it needs an admin token.202 AcceptedwithGen1 cleanup startedorGen1 cleanup already running; one run per node. Completion logsGen1 cleanup finishedorGen1 cleanup: no eligible files found.min_ageare skipped.compaction-cleanup-waitdoesn't cover them.system.parquet_filesreads the ingest and replica Gen1 file lists.system.compacted_dataholds compacted files and errors without atable_namefilter.Checks
lint-codeblockspasses on the changed files.link-checkerisn't installed); relying on CI.Not covered