Skip to content

Commit 071502d

Browse files
authored
Clarified supported S3 endpoints for the blocks storage (#2900)
* Clarified supported S3 endpoints for the blocks storage Signed-off-by: Marco Pracucci <[email protected]> * Updated CLI flag description Signed-off-by: Marco Pracucci <[email protected]>
1 parent 77490f9 commit 071502d

File tree

4 files changed

+10
-4
lines changed

4 files changed

+10
-4
lines changed

docs/blocks-storage/querier.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,9 @@ tsdb:
482482
[max_tsdb_opening_concurrency_on_startup: <int> | default = 10]
483483
484484
s3:
485-
# S3 endpoint without schema
485+
# The S3 bucket endpoint. It could be an AWS S3 endpoint listed at
486+
# https://docs.aws.amazon.com/general/latest/gr/s3.html or the address of an
487+
# S3-compatible service in hostname:port format.
486488
# CLI flag: -experimental.tsdb.s3.endpoint
487489
[endpoint: <string> | default = ""]
488490

docs/blocks-storage/store-gateway.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,9 @@ tsdb:
509509
[max_tsdb_opening_concurrency_on_startup: <int> | default = 10]
510510
511511
s3:
512-
# S3 endpoint without schema
512+
# The S3 bucket endpoint. It could be an AWS S3 endpoint listed at
513+
# https://docs.aws.amazon.com/general/latest/gr/s3.html or the address of an
514+
# S3-compatible service in hostname:port format.
513515
# CLI flag: -experimental.tsdb.s3.endpoint
514516
[endpoint: <string> | default = ""]
515517

docs/configuration/config-file-reference.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3244,7 +3244,9 @@ bucket_store:
32443244
[max_tsdb_opening_concurrency_on_startup: <int> | default = 10]
32453245
32463246
s3:
3247-
# S3 endpoint without schema
3247+
# The S3 bucket endpoint. It could be an AWS S3 endpoint listed at
3248+
# https://docs.aws.amazon.com/general/latest/gr/s3.html or the address of an
3249+
# S3-compatible service in hostname:port format.
32483250
# CLI flag: -experimental.tsdb.s3.endpoint
32493251
[endpoint: <string> | default = ""]
32503252

pkg/storage/backend/s3/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
2525
f.StringVar(&cfg.AccessKeyID, prefix+"s3.access-key-id", "", "S3 access key ID")
2626
f.Var(&cfg.SecretAccessKey, prefix+"s3.secret-access-key", "S3 secret access key")
2727
f.StringVar(&cfg.BucketName, prefix+"s3.bucket-name", "", "S3 bucket name")
28-
f.StringVar(&cfg.Endpoint, prefix+"s3.endpoint", "", "S3 endpoint without schema")
28+
f.StringVar(&cfg.Endpoint, prefix+"s3.endpoint", "", "The S3 bucket endpoint. It could be an AWS S3 endpoint listed at https://docs.aws.amazon.com/general/latest/gr/s3.html or the address of an S3-compatible service in hostname:port format.")
2929
f.BoolVar(&cfg.Insecure, prefix+"s3.insecure", false, "If enabled, use http:// for the S3 endpoint instead of https://. This could be useful in local dev/test environments while using an S3-compatible backend storage, like Minio.")
3030
}

0 commit comments

Comments
 (0)