Missing S3/GCS/Azure parameters in URI Formats of External Storage Services
Nobody has claimed this yet.
- 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!
- 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=— theprovideroption 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=
- Describe your suggestion or addition.
Document at least s3://?region=&provider=.
- Provide some reference materials (such as documents and websites) if you could.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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