diff --git a/docs/configuration/arguments.md b/docs/configuration/arguments.md index 590eb13b91..de5628dffe 100644 --- a/docs/configuration/arguments.md +++ b/docs/configuration/arguments.md @@ -385,21 +385,6 @@ It also talks to a KVStore and has it's own copies of the same flags used by the Where you don't want to cache every chunk written by ingesters, but you do want to take advantage of chunk write deduplication, this option will make ingesters write a placeholder to the cache for each chunk. Make sure you configure ingesters with a different cache to queriers, which need the whole value. -#### WAL - -- `-ingester.wal-dir` - Directory where the WAL data should be stored and/or recovered from. - -- `-ingester.wal-enabled` - - Setting this to `true` enables writing to WAL during ingestion. - -- `-ingester.checkpoint-duration` - This is the interval at which checkpoints should be created. - -- `-ingester.recover-from-wal` - Set this to `true` to recover data from an existing WAL. The data is recovered even if WAL is disabled and this is set to `true`. The WAL dir needs to be set for this. - #### Flusher - `-flusher.wal-dir` diff --git a/docs/configuration/config-file-reference.md b/docs/configuration/config-file-reference.md index 9798863c96..61ce833758 100644 --- a/docs/configuration/config-file-reference.md +++ b/docs/configuration/config-file-reference.md @@ -549,6 +549,8 @@ ring: The `ingester_config` configures the Cortex ingester. ```yaml +# Configures the Write-Ahead Log (WAL) for the Cortex chunks storage. This +# config is ignored when running the Cortex blocks storage. walconfig: # Enable writing of ingested data into WAL. # CLI flag: -ingester.wal-enabled diff --git a/pkg/ingester/ingester.go b/pkg/ingester/ingester.go index 09196efd59..9c7dbc151b 100644 --- a/pkg/ingester/ingester.go +++ b/pkg/ingester/ingester.go @@ -50,7 +50,7 @@ var ( // Config for an Ingester. type Config struct { - WALConfig WALConfig `yaml:"walconfig"` + WALConfig WALConfig `yaml:"walconfig" doc:"description=Configures the Write-Ahead Log (WAL) for the Cortex chunks storage. This config is ignored when running the Cortex blocks storage."` LifecyclerConfig ring.LifecyclerConfig `yaml:"lifecycler"` // Config for transferring chunks. Zero or negative = no retries.