From 40eb87123525fc2a1973e41d29678afd438f4e13 Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Fri, 18 Jun 2021 14:44:50 +0200 Subject: [PATCH] Updated doc about chunks storage deprecation Signed-off-by: Marco Pracucci --- docs/configuration/arguments.md | 2 ++ docs/configuration/config-file-reference.md | 2 +- pkg/chunk/storage/factory.go | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/configuration/arguments.md b/docs/configuration/arguments.md index 6ea8f1baa9..997399ba14 100644 --- a/docs/configuration/arguments.md +++ b/docs/configuration/arguments.md @@ -11,6 +11,8 @@ Cortex has evolved over several years, and the command-line options sometimes re Duration arguments should be specified with a unit like `5s` or `3h`. Valid time units are "ms", "s", "m", "h". +**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).** + ## Querier - `-querier.max-concurrent` diff --git a/docs/configuration/config-file-reference.md b/docs/configuration/config-file-reference.md index 99dc0b5e8b..13c2b4adb7 100644 --- a/docs/configuration/config-file-reference.md +++ b/docs/configuration/config-file-reference.md @@ -2708,7 +2708,7 @@ chunk_tables_provisioning: The `storage_config` configures where Cortex stores the data (chunks storage engine). ```yaml -# The storage engine to use: chunks or blocks. +# The storage engine to use: chunks (deprecated) or blocks. # CLI flag: -store.engine [engine: | default = "chunks"] diff --git a/pkg/chunk/storage/factory.go b/pkg/chunk/storage/factory.go index 73c96ed2ed..20caae7462 100644 --- a/pkg/chunk/storage/factory.go +++ b/pkg/chunk/storage/factory.go @@ -111,7 +111,7 @@ func (cfg *Config) RegisterFlags(f *flag.FlagSet) { cfg.Swift.RegisterFlags(f) cfg.GrpcConfig.RegisterFlags(f) - f.StringVar(&cfg.Engine, "store.engine", "chunks", "The storage engine to use: chunks or blocks.") + f.StringVar(&cfg.Engine, "store.engine", "chunks", "The storage engine to use: chunks (deprecated) or blocks.") cfg.IndexQueriesCacheConfig.RegisterFlagsWithPrefix("store.index-cache-read.", "Cache config for index entry reading. ", f) 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.") }