Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
kennytm opened this issue Feb 6, 2024 · 0 comments
Open
Labels
area/br Indicates that the Issue or PR belongs to the area of BR (Backup & Restore). area/general Relates to TiDB overview, architecture, and other general descriptions.

Comments

@kennytm
Copy link
Contributor

kennytm commented Feb 6, 2024

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= (cloud: support backup to s3 when object lock enabled. 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.
@kennytm kennytm added area/general Relates to TiDB overview, architecture, and other general descriptions. area/br Indicates that the Issue or PR belongs to the area of BR (Backup & Restore). labels Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/br Indicates that the Issue or PR belongs to the area of BR (Backup & Restore). area/general Relates to TiDB overview, architecture, and other general descriptions.
Projects
None yet
Development

No branches or pull requests

1 participant