From ece0e4181a65a328a2309ff61932484bd50b33fe Mon Sep 17 00:00:00 2001 From: Ben Ye Date: Mon, 25 Mar 2024 08:46:08 +0000 Subject: [PATCH] update docs Signed-off-by: Ben Ye --- docs/blocks-storage/querier.md | 11 +++++++++++ docs/blocks-storage/store-gateway.md | 11 +++++++++++ docs/configuration/config-file-reference.md | 11 +++++++++++ 3 files changed, 33 insertions(+) diff --git a/docs/blocks-storage/querier.md b/docs/blocks-storage/querier.md index cc9b5f04793..bdb418cea12 100644 --- a/docs/blocks-storage/querier.md +++ b/docs/blocks-storage/querier.md @@ -1314,6 +1314,17 @@ blocks_storage: # CLI flag: -blocks-storage.bucket-store.bucket-index.max-stale-period [max_stale_period: | default = 1h] + # One of concurrent, recursive, bucket_index. When set to concurrent, stores + # will concurrently issue one call per directory to discover active blocks + # in the bucket. The recursive strategy iterates through all objects in the + # bucket, recursively traversing into each directory. This avoids N+1 calls + # at the expense of having slower bucket iterations. bucket_index strategy + # can be used in Compactor only and utilizes the existing bucket index to + # fetch block IDs to sync. This avoids iterating the bucket but can be + # impacted by delays of cleaner creating bucket index. + # CLI flag: -blocks-storage.bucket-store.block-discovery-strategy + [block_discovery_strategy: | default = "concurrent"] + # Max size - in bytes - of a chunks pool, used to reduce memory allocations. # The pool is shared across all tenants. 0 to disable the limit. # CLI flag: -blocks-storage.bucket-store.max-chunk-pool-bytes diff --git a/docs/blocks-storage/store-gateway.md b/docs/blocks-storage/store-gateway.md index 51bc6a59331..a33b129bb9a 100644 --- a/docs/blocks-storage/store-gateway.md +++ b/docs/blocks-storage/store-gateway.md @@ -1423,6 +1423,17 @@ blocks_storage: # CLI flag: -blocks-storage.bucket-store.bucket-index.max-stale-period [max_stale_period: | default = 1h] + # One of concurrent, recursive, bucket_index. When set to concurrent, stores + # will concurrently issue one call per directory to discover active blocks + # in the bucket. The recursive strategy iterates through all objects in the + # bucket, recursively traversing into each directory. This avoids N+1 calls + # at the expense of having slower bucket iterations. bucket_index strategy + # can be used in Compactor only and utilizes the existing bucket index to + # fetch block IDs to sync. This avoids iterating the bucket but can be + # impacted by delays of cleaner creating bucket index. + # CLI flag: -blocks-storage.bucket-store.block-discovery-strategy + [block_discovery_strategy: | default = "concurrent"] + # Max size - in bytes - of a chunks pool, used to reduce memory allocations. # The pool is shared across all tenants. 0 to disable the limit. # CLI flag: -blocks-storage.bucket-store.max-chunk-pool-bytes diff --git a/docs/configuration/config-file-reference.md b/docs/configuration/config-file-reference.md index e0597f15b2a..eb9c6979e9b 100644 --- a/docs/configuration/config-file-reference.md +++ b/docs/configuration/config-file-reference.md @@ -1850,6 +1850,17 @@ bucket_store: # CLI flag: -blocks-storage.bucket-store.bucket-index.max-stale-period [max_stale_period: | default = 1h] + # One of concurrent, recursive, bucket_index. When set to concurrent, stores + # will concurrently issue one call per directory to discover active blocks in + # the bucket. The recursive strategy iterates through all objects in the + # bucket, recursively traversing into each directory. This avoids N+1 calls at + # the expense of having slower bucket iterations. bucket_index strategy can be + # used in Compactor only and utilizes the existing bucket index to fetch block + # IDs to sync. This avoids iterating the bucket but can be impacted by delays + # of cleaner creating bucket index. + # CLI flag: -blocks-storage.bucket-store.block-discovery-strategy + [block_discovery_strategy: | default = "concurrent"] + # Max size - in bytes - of a chunks pool, used to reduce memory allocations. # The pool is shared across all tenants. 0 to disable the limit. # CLI flag: -blocks-storage.bucket-store.max-chunk-pool-bytes