docs: update CLI docs for refactored object storage config #2179
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.
Overview
This PR updates the documentation for the metadata snapshot CLI commands to reflect the refactored object storage configuration introduced in GreptimeTeam/greptimedb#7009.
What Changed
The CLI object storage configuration has been refactored to use unified, provider-prefixed flags instead of generic flags. This documentation update reflects those changes in the nightly docs for both English and Chinese versions.
Updated Flags
Before:
After:
Documentation Updates
Reorganized options structure with clear sections for:
Added provider-prefixed flags for all supported cloud storage providers:
--enable-s3
,--s3-bucket
,--s3-root
,--s3-access-key-id
,--s3-secret-access-key
,--s3-region
,--s3-endpoint
,--s3-enable-virtual-host-style
--enable-oss
,--oss-bucket
,--oss-root
,--oss-access-key-id
,--oss-access-key-secret
,--oss-endpoint
--enable-gcs
,--gcs-bucket
,--gcs-root
,--gcs-scope
,--gcs-credential-path
,--gcs-credential
,--gcs-endpoint
--enable-azblob
,--azblob-container
,--azblob-root
,--azblob-account-name
,--azblob-account-key
,--azblob-endpoint
,--azblob-sas-token
Updated flag names to match the new implementation:
--output-dir
→--dir
(for export)--input-dir
→--dir
(for import/info)--s3-access-key
→--s3-access-key-id
--s3-secret-key
→--s3-secret-access-key
Added missing documentation for the
info
subcommand that allows viewing metadata snapshot contents without restoringScope
docs/
directory andi18n/zh
current) was modifiedversioned_docs/
)docs/reference/command-lines/utilities/metadata.md
(English)i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/metadata.md
(Chinese)Related
Original prompt
<issue_description>A document change request is generated from GreptimeTeam/greptimedb#7009</issue_description>
<agent_instructions>只需要修改 nightly 的内容,请注意写一下 Prompt 不要修改最新稳定版的文档。</agent_instructions>
Comments on the Issue (you are @copilot in this section)
Fixes #2142
Original prompt
Fixes #2142
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.