Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Oct 20, 2025

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:

greptime cli meta snapshot save \
  --s3 \
  --s3-bucket my-bucket \
  --s3-access-key <key> \
  --s3-secret-key <secret> \
  --output-dir /path/to/export

After:

greptime cli meta snapshot save \
  --enable-s3 \
  --s3-bucket my-bucket \
  --s3-access-key-id <key-id> \
  --s3-secret-access-key <secret> \
  --dir /path/to/export

Documentation Updates

  1. Reorganized options structure with clear sections for:

    • Storage Backend Options (etcd, PostgreSQL, MySQL)
    • File Options (local file system)
    • Object Storage Options (cloud providers)
  2. Added provider-prefixed flags for all supported cloud storage providers:

    • S3: --enable-s3, --s3-bucket, --s3-root, --s3-access-key-id, --s3-secret-access-key, --s3-region, --s3-endpoint, --s3-enable-virtual-host-style
    • OSS: --enable-oss, --oss-bucket, --oss-root, --oss-access-key-id, --oss-access-key-secret, --oss-endpoint
    • GCS: --enable-gcs, --gcs-bucket, --gcs-root, --gcs-scope, --gcs-credential-path, --gcs-credential, --gcs-endpoint
    • Azure Blob: --enable-azblob, --azblob-container, --azblob-root, --azblob-account-name, --azblob-account-key, --azblob-endpoint, --azblob-sas-token
  3. 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
  4. Added missing documentation for the info subcommand that allows viewing metadata snapshot contents without restoring

Scope

  • ✅ Only nightly documentation (docs/ directory and i18n/zh current) was modified
  • ✅ No changes to stable version documentation (versioned_docs/)
  • ✅ Applied to:
    • docs/reference/command-lines/utilities/metadata.md (English)
    • i18n/zh/docusaurus-plugin-content-docs/current/reference/command-lines/utilities/metadata.md (Chinese)

Related

[!WARNING]

Original prompt

This section details on the original issue you should resolve

<filter_complete></filter_complete>

<issue_title>Update docs for refactor(cli): refactor object storage config</issue_title>
<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

This section details on the original issue you should resolve

<issue_title>Update docs for refactor(cli): refactor object storage config</issue_title>
<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


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copy link

cloudflare-workers-and-pages bot commented Oct 20, 2025

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 06c1896
Status: ✅  Deploy successful!
Preview URL: https://dacfd9e6.greptime-docs.pages.dev
Branch Preview URL: https://copilot-update-nightly-docs.greptime-docs.pages.dev

View logs

@WenyXu
Copy link
Member

WenyXu commented Oct 20, 2025

@copilot Don’t forget to update the Chinese document as well

@Copilot Copilot AI changed the title [WIP] Update documentation for object storage config refactor docs: update CLI docs for refactored object storage config Oct 20, 2025
@Copilot Copilot AI requested a review from WenyXu October 20, 2025 02:55
Copilot finished work on behalf of WenyXu October 20, 2025 02:55
Copy link
Contributor Author

Copilot AI commented Oct 20, 2025

@copilot Don’t forget to update the Chinese document as well

Done! I've updated the Chinese documentation in commit 6c9e4fa. The changes mirror the English version, including:

  • New provider-prefixed flags (--enable-s3, --s3-access-key-id, etc.)
  • Documentation for all object storage providers (S3, OSS, GCS, Azure Blob)
  • Updated flag names (--dir instead of --output-dir/--input-dir)
  • Added info command documentation

Copilot finished work on behalf of WenyXu October 20, 2025 03:00
@WenyXu WenyXu marked this pull request as ready for review October 20, 2025 06:15
@fengjiachun fengjiachun merged commit 5937940 into main Oct 21, 2025
7 checks passed
@fengjiachun fengjiachun deleted the copilot/update-nightly-docs-for-refactor branch October 21, 2025 06:07
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 refactor(cli): refactor object storage config

4 participants