Skip to content

Commit b15782e

Browse files
authored
Updated doc about chunks storage deprecation (#4294)
Signed-off-by: Marco Pracucci <[email protected]>
1 parent e511415 commit b15782e

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

docs/configuration/arguments.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Cortex has evolved over several years, and the command-line options sometimes re
1111

1212
Duration arguments should be specified with a unit like `5s` or `3h`. Valid time units are "ms", "s", "m", "h".
1313

14+
**Warning: some of the following config options apply only to chunks storage, which has been deprecated. You're encouraged to use the [blocks storage](../blocks-storage/_index.md).**
15+
1416
## Querier
1517

1618
- `-querier.max-concurrent`

docs/configuration/config-file-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2708,7 +2708,7 @@ chunk_tables_provisioning:
27082708
The `storage_config` configures where Cortex stores the data (chunks storage engine).
27092709

27102710
```yaml
2711-
# The storage engine to use: chunks or blocks.
2711+
# The storage engine to use: chunks (deprecated) or blocks.
27122712
# CLI flag: -store.engine
27132713
[engine: <string> | default = "chunks"]
27142714

pkg/chunk/storage/factory.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
111111
cfg.Swift.RegisterFlags(f)
112112
cfg.GrpcConfig.RegisterFlags(f)
113113

114-
f.StringVar(&cfg.Engine, "store.engine", "chunks", "The storage engine to use: chunks or blocks.")
114+
f.StringVar(&cfg.Engine, "store.engine", "chunks", "The storage engine to use: chunks (deprecated) or blocks.")
115115
cfg.IndexQueriesCacheConfig.RegisterFlagsWithPrefix("store.index-cache-read.", "Cache config for index entry reading. ", f)
116116
f.DurationVar(&cfg.IndexCacheValidity, "store.index-cache-validity", 5*time.Minute, "Cache validity for active index entries. Should be no higher than -ingester.max-chunk-idle.")
117117
}

0 commit comments

Comments
 (0)