pingcap / pingcap/docs

Missing S3/GCS/Azure parameters in URI Formats of External Storage Services

Open
#16,452 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

area/br area/general
Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Change Request

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.

(First of all why do we have both https://docs.pingcap.com/tidb/stable/backup-and-restore-storages and https://docs.pingcap.com/tidb/stable/external-storage-uri? The BR one should be moved into the general one, as the latter failed to describe the authentication procedure.)

Several parameters are undocumented:

  • s3://?region= — clearly an oversight.
  • s3://?provider= — the provider option is sometimes required to solve some subtle compatibility problem when using a non-AWS endpoint.
  • s3://?object-lock-enabled= (pingcap/tidb#37392) — will be automatically checked in BR, so likely intended to be undocumented.
  • gcs://?endpoint=
  • azblob://?endpoint=
  1. Describe your suggestion or addition.

Document at least s3://?region=&provider=.

  1. Provide some reference materials (such as documents and websites) if you could.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the backup-and-restore-storages and external-storage-uri documentation pages named in the issue. Document at least the S3 region and provider parameters, and determine how the requested GCS and Azure endpoint details and authentication procedure fit across those pages; done means the relevant URI parameters are described without duplication.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, azure, gcp
Domain
cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.