Skip to content

Commit 2d05ccf

Browse files
roystchiangroystchiang
committed
update documentation
Signed-off-by: Roy Chiang <[email protected]>
1 parent 269e396 commit 2d05ccf

File tree

5 files changed

+20
-11
lines changed

5 files changed

+20
-11
lines changed

‎docs/blocks-storage/querier.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,8 @@ blocks_storage:
512512
# CLI flag: -blocks-storage.bucket-store.index-cache.memcached.max-item-size
513513
[max_item_size: <int> | default = 1048576]
514514
515-
# Use memcached auto-discovery instead of DNS resolution
515+
# Use memcached auto-discovery mechanism provided by some cloud provider
516+
# like GCP and AWS
516517
# CLI flag: -blocks-storage.bucket-store.index-cache.memcached.auto-discovery
517518
[auto_discovery: <boolean> | default = false]
518519
@@ -563,7 +564,8 @@ blocks_storage:
563564
# CLI flag: -blocks-storage.bucket-store.chunks-cache.memcached.max-item-size
564565
[max_item_size: <int> | default = 1048576]
565566
566-
# Use memcached auto-discovery instead of DNS resolution
567+
# Use memcached auto-discovery mechanism provided by some cloud provider
568+
# like GCP and AWS
567569
# CLI flag: -blocks-storage.bucket-store.chunks-cache.memcached.auto-discovery
568570
[auto_discovery: <boolean> | default = false]
569571
@@ -633,7 +635,8 @@ blocks_storage:
633635
# CLI flag: -blocks-storage.bucket-store.metadata-cache.memcached.max-item-size
634636
[max_item_size: <int> | default = 1048576]
635637
636-
# Use memcached auto-discovery instead of DNS resolution
638+
# Use memcached auto-discovery mechanism provided by some cloud provider
639+
# like GCP and AWS
637640
# CLI flag: -blocks-storage.bucket-store.metadata-cache.memcached.auto-discovery
638641
[auto_discovery: <boolean> | default = false]
639642

‎docs/blocks-storage/store-gateway.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,8 @@ blocks_storage:
576576
# CLI flag: -blocks-storage.bucket-store.index-cache.memcached.max-item-size
577577
[max_item_size: <int> | default = 1048576]
578578
579-
# Use memcached auto-discovery instead of DNS resolution
579+
# Use memcached auto-discovery mechanism provided by some cloud provider
580+
# like GCP and AWS
580581
# CLI flag: -blocks-storage.bucket-store.index-cache.memcached.auto-discovery
581582
[auto_discovery: <boolean> | default = false]
582583
@@ -627,7 +628,8 @@ blocks_storage:
627628
# CLI flag: -blocks-storage.bucket-store.chunks-cache.memcached.max-item-size
628629
[max_item_size: <int> | default = 1048576]
629630
630-
# Use memcached auto-discovery instead of DNS resolution
631+
# Use memcached auto-discovery mechanism provided by some cloud provider
632+
# like GCP and AWS
631633
# CLI flag: -blocks-storage.bucket-store.chunks-cache.memcached.auto-discovery
632634
[auto_discovery: <boolean> | default = false]
633635
@@ -697,7 +699,8 @@ blocks_storage:
697699
# CLI flag: -blocks-storage.bucket-store.metadata-cache.memcached.max-item-size
698700
[max_item_size: <int> | default = 1048576]
699701
700-
# Use memcached auto-discovery instead of DNS resolution
702+
# Use memcached auto-discovery mechanism provided by some cloud provider
703+
# like GCP and AWS
701704
# CLI flag: -blocks-storage.bucket-store.metadata-cache.memcached.auto-discovery
702705
[auto_discovery: <boolean> | default = false]
703706

‎docs/configuration/arguments.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -533,7 +533,7 @@ The DNS service discovery, inspired from Thanos DNS SD, supports different disco
533533

534534
If **no prefix** is provided, the provided IP or hostname will be used straightaway without pre-resolving it.
535535

536-
If you are using a managed memcached service from [Google Cloud](https://cloud.google.com/memorystore/docs/memcached/auto-discovery-overview), or [AWS](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/AutoDiscovery.HowAutoDiscoveryWorks.html), use the [auto-discovery](./config-file-reference.md#memcached-client-config) flag instead of DNS discovery.
536+
If you are using a managed memcached service from [Google Cloud](https://cloud.google.com/memorystore/docs/memcached/auto-discovery-overview), or [AWS](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/AutoDiscovery.HowAutoDiscoveryWorks.html), use the [auto-discovery](./config-file-reference.md#memcached-client-config) flag instead of DNS discovery, then use the discovery/configuration endpoint as the domain name without any prefix.
537537

538538
## Logging of IP of reverse proxy
539539

‎docs/configuration/config-file-reference.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4765,7 +4765,8 @@ bucket_store:
47654765
# CLI flag: -blocks-storage.bucket-store.index-cache.memcached.max-item-size
47664766
[max_item_size: <int> | default = 1048576]
47674767
4768-
# Use memcached auto-discovery instead of DNS resolution
4768+
# Use memcached auto-discovery mechanism provided by some cloud provider
4769+
# like GCP and AWS
47694770
# CLI flag: -blocks-storage.bucket-store.index-cache.memcached.auto-discovery
47704771
[auto_discovery: <boolean> | default = false]
47714772
@@ -4816,7 +4817,8 @@ bucket_store:
48164817
# CLI flag: -blocks-storage.bucket-store.chunks-cache.memcached.max-item-size
48174818
[max_item_size: <int> | default = 1048576]
48184819
4819-
# Use memcached auto-discovery instead of DNS resolution
4820+
# Use memcached auto-discovery mechanism provided by some cloud provider
4821+
# like GCP and AWS
48204822
# CLI flag: -blocks-storage.bucket-store.chunks-cache.memcached.auto-discovery
48214823
[auto_discovery: <boolean> | default = false]
48224824
@@ -4885,7 +4887,8 @@ bucket_store:
48854887
# CLI flag: -blocks-storage.bucket-store.metadata-cache.memcached.max-item-size
48864888
[max_item_size: <int> | default = 1048576]
48874889
4888-
# Use memcached auto-discovery instead of DNS resolution
4890+
# Use memcached auto-discovery mechanism provided by some cloud provider
4891+
# like GCP and AWS
48894892
# CLI flag: -blocks-storage.bucket-store.metadata-cache.memcached.auto-discovery
48904893
[auto_discovery: <boolean> | default = false]
48914894

‎pkg/storage/tsdb/memcache_client_config.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func (cfg *MemcachedClientConfig) RegisterFlagsWithPrefix(f *flag.FlagSet, prefi
3030
f.IntVar(&cfg.MaxGetMultiConcurrency, prefix+"max-get-multi-concurrency", 100, "The maximum number of concurrent connections running get operations. If set to 0, concurrency is unlimited.")
3131
f.IntVar(&cfg.MaxGetMultiBatchSize, prefix+"max-get-multi-batch-size", 0, "The maximum number of keys a single underlying get operation should run. If more keys are specified, internally keys are split into multiple batches and fetched concurrently, honoring the max concurrency. If set to 0, the max batch size is unlimited.")
3232
f.IntVar(&cfg.MaxItemSize, prefix+"max-item-size", 1024*1024, "The maximum size of an item stored in memcached. Bigger items are not stored. If set to 0, no maximum size is enforced.")
33-
f.BoolVar(&cfg.AutoDiscovery, prefix+"auto-discovery", false, "Use memcached auto-discovery instead of DNS resolution")
33+
f.BoolVar(&cfg.AutoDiscovery, prefix+"auto-discovery", false, "Use memcached auto-discovery mechanism provided by some cloud provider like GCP and AWS")
3434
}
3535

3636
func (cfg *MemcachedClientConfig) GetAddresses() []string {

0 commit comments

Comments
 (0)