feat(enterprise): document influx-meta CLI and cleanup-shards command#7022
Draft
jstirnaman wants to merge 4 commits intomasterfrom
Draft
feat(enterprise): document influx-meta CLI and cleanup-shards command#7022jstirnaman wants to merge 4 commits intomasterfrom
jstirnaman wants to merge 4 commits intomasterfrom
Conversation
Add documentation for the `influx-meta` CLI tool with all 9 subcommands. The `cleanup-shards` subcommand (v1.12.3+) gets full documentation with prerequisites, usage, output format, and examples. The remaining 8 subcommands (v1.12.0+) have minimal stub pages with usage and global flags. The influx-meta binary has been shipping undocumented since v1.12.0. closes #6842
jstirnaman
added
release:pending
jstirnaman
requested review from
devanbenz and
sanderson
and removed request for
a team
Contributor
Vale Style Check Results
✅ Check passed |
|
This shouldn't be made public. |
jstirnaman
added
hold off
influx-meta is an internal InfluxData engineering/support tool, not shipped in the InfluxDB Enterprise release. Add draft: true with cascade to the section index and a DO NOT PUBLISH comment to all 10 pages to prevent accidental publication. Refs #6842
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
4 participants
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.
Summary
Add documentation for the
influx-metaCLI tool — an Enterprise metadata management binary that has been shipping undocumented since v1.12.0.cleanup-shards(v1.12.3+): Full documentation with prerequisites, usage, output format, and examplesCommands documented
cleanup-shardsconvertexportfix-shard-ownersimportmake-node-activemake-node-passiverenumber-shard-groupsset-shard-groupChanges
10 new files in
content/enterprise_influxdb/v1/tools/influx-meta/Verified
Binary confirmed on live Enterprise v1.12.3 cluster with all 9 subcommands present.
Test plan
influx-metaappears in the Enterprise Tools navcleanup-shardspage renders with v1.12.3+ metadata badge_index.mdresolvecloses #6842