Skip to content

Commit 417d639

Browse files
authored
[Chore] Edit metadata cache supported values description (#6252)
1 parent e449374 commit 417d639

File tree

4 files changed

+9
-4
lines changed

4 files changed

+9
-4
lines changed

docs/blocks-storage/querier.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1020,7 +1020,8 @@ blocks_storage:
10201020
[subrange_ttl: <duration> | default = 24h]
10211021

10221022
metadata_cache:
1023-
# Backend for metadata cache, if not empty. Supported values: memcached.
1023+
# Backend for metadata cache, if not empty. Supported values: memcached,
1024+
# redis, and '' (disable).
10241025
# CLI flag: -blocks-storage.bucket-store.metadata-cache.backend
10251026
[backend: <string> | default = ""]
10261027

docs/blocks-storage/store-gateway.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1135,7 +1135,8 @@ blocks_storage:
11351135
[subrange_ttl: <duration> | default = 24h]
11361136

11371137
metadata_cache:
1138-
# Backend for metadata cache, if not empty. Supported values: memcached.
1138+
# Backend for metadata cache, if not empty. Supported values: memcached,
1139+
# redis, and '' (disable).
11391140
# CLI flag: -blocks-storage.bucket-store.metadata-cache.backend
11401141
[backend: <string> | default = ""]
11411142

docs/configuration/config-file-reference.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1568,7 +1568,8 @@ bucket_store:
15681568
[subrange_ttl: <duration> | default = 24h]
15691569

15701570
metadata_cache:
1571-
# Backend for metadata cache, if not empty. Supported values: memcached.
1571+
# Backend for metadata cache, if not empty. Supported values: memcached,
1572+
# redis, and '' (disable).
15721573
# CLI flag: -blocks-storage.bucket-store.metadata-cache.backend
15731574
[backend: <string> | default = ""]
15741575

pkg/storage/tsdb/caching_bucket.go

+3-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ import (
2424
)
2525

2626
var (
27+
supportedMetadataCacheBackends = []string{CacheBackendMemcached, CacheBackendRedis}
28+
2729
errUnsupportedChunkCacheBackend = errors.New("unsupported chunk cache backend")
2830
)
2931

@@ -140,7 +142,7 @@ type MetadataCacheConfig struct {
140142
}
141143

142144
func (cfg *MetadataCacheConfig) RegisterFlagsWithPrefix(f *flag.FlagSet, prefix string) {
143-
f.StringVar(&cfg.Backend, prefix+"backend", "", fmt.Sprintf("Backend for metadata cache, if not empty. Supported values: %s.", CacheBackendMemcached))
145+
f.StringVar(&cfg.Backend, prefix+"backend", "", fmt.Sprintf("Backend for metadata cache, if not empty. Supported values: %s, and '' (disable).", strings.Join(supportedMetadataCacheBackends, ", ")))
144146

145147
cfg.Memcached.RegisterFlagsWithPrefix(f, prefix+"memcached.")
146148
cfg.Redis.RegisterFlagsWithPrefix(f, prefix+"redis.")

0 commit comments

Comments
 (0)