Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 69 additions & 57 deletions docs/sources/shared/configuration.md
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is generated using make doc

Original file line number Diff line number Diff line change
Expand Up @@ -226,15 +226,15 @@ ui:
# CLI flag: -ui.ring.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -ui.ring.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -ui.ring.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# Period at which to heartbeat to the ring. 0 = disabled.
# Period at which to heartbeat to the ring.
# CLI flag: -ui.ring.heartbeat-period
[heartbeat_period: <duration> | default = 15s]

Expand Down Expand Up @@ -451,16 +451,16 @@ pattern_ingester:
# CLI flag: -pattern-ingester.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -pattern-ingester.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -pattern-ingester.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# The heartbeat timeout after which ingesters are skipped for
# reads/writes. 0 = never (timeout disabled).
# reads/writes.
# CLI flag: -pattern-ingester.ring.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand All @@ -482,12 +482,11 @@ pattern_ingester:
# CLI flag: -pattern-ingester.num-tokens
[num_tokens: <int> | default = 128]

# Period at which to heartbeat to consul. 0 = disabled.
# Period at which to heartbeat to consul.
# CLI flag: -pattern-ingester.heartbeat-period
[heartbeat_period: <duration> | default = 5s]

# Heartbeat timeout after which instance is assumed to be unhealthy. 0 =
# disabled.
# Heartbeat timeout after which instance is assumed to be unhealthy.
# CLI flag: -pattern-ingester.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand Down Expand Up @@ -1249,16 +1248,16 @@ dataobj:
# CLI flag: -dataobj-consumer.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -dataobj-consumer.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -dataobj-consumer.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# The heartbeat timeout after which ingesters are skipped for
# reads/writes. 0 = never (timeout disabled).
# reads/writes.
# CLI flag: -dataobj-consumer.ring.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand All @@ -1280,12 +1279,11 @@ dataobj:
# CLI flag: -dataobj-consumer.num-tokens
[num_tokens: <int> | default = 128]

# Period at which to heartbeat to consul. 0 = disabled.
# Period at which to heartbeat to consul.
# CLI flag: -dataobj-consumer.heartbeat-period
[heartbeat_period: <duration> | default = 5s]

# Heartbeat timeout after which instance is assumed to be unhealthy. 0 =
# disabled.
# Heartbeat timeout after which instance is assumed to be unhealthy.
# CLI flag: -dataobj-consumer.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand Down Expand Up @@ -1390,11 +1388,11 @@ dataobj:
# CLI flag: -dataobj-consumer.partition-ring.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -dataobj-consumer.partition-ring.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -dataobj-consumer.partition-ring.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

Expand Down Expand Up @@ -1556,16 +1554,16 @@ ingest_limits:
# CLI flag: -ingest-limits.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -ingest-limits.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -ingest-limits.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# The heartbeat timeout after which ingesters are skipped for
# reads/writes. 0 = never (timeout disabled).
# reads/writes.
# CLI flag: -ingest-limits.ring.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand All @@ -1587,12 +1585,11 @@ ingest_limits:
# CLI flag: -ingest-limits.num-tokens
[num_tokens: <int> | default = 128]

# Period at which to heartbeat to consul. 0 = disabled.
# Period at which to heartbeat to consul.
# CLI flag: -ingest-limits.heartbeat-period
[heartbeat_period: <duration> | default = 5s]

# Heartbeat timeout after which instance is assumed to be unhealthy. 0 =
# disabled.
# Heartbeat timeout after which instance is assumed to be unhealthy.
# CLI flag: -ingest-limits.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand Down Expand Up @@ -1726,16 +1723,16 @@ ingest_limits_frontend:
# CLI flag: -ingest-limits-frontend.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -ingest-limits-frontend.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -ingest-limits-frontend.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# The heartbeat timeout after which ingesters are skipped for
# reads/writes. 0 = never (timeout disabled).
# reads/writes.
# CLI flag: -ingest-limits-frontend.ring.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand All @@ -1757,12 +1754,11 @@ ingest_limits_frontend:
# CLI flag: -ingest-limits-frontend.num-tokens
[num_tokens: <int> | default = 128]

# Period at which to heartbeat to consul. 0 = disabled.
# Period at which to heartbeat to consul.
# CLI flag: -ingest-limits-frontend.heartbeat-period
[heartbeat_period: <duration> | default = 5s]

# Heartbeat timeout after which instance is assumed to be unhealthy. 0 =
# disabled.
# Heartbeat timeout after which instance is assumed to be unhealthy.
# CLI flag: -ingest-limits-frontend.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand Down Expand Up @@ -2701,15 +2697,15 @@ ring:
# CLI flag: -common.storage.ring.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -common.storage.ring.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -common.storage.ring.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# Period at which to heartbeat to the ring. 0 = disabled.
# Period at which to heartbeat to the ring.
# CLI flag: -common.storage.ring.heartbeat-period
[heartbeat_period: <duration> | default = 15s]

Expand Down Expand Up @@ -2907,15 +2903,15 @@ compactor_ring:
# CLI flag: -compactor.ring.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -compactor.ring.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -compactor.ring.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# Period at which to heartbeat to the ring. 0 = disabled.
# Period at which to heartbeat to the ring.
# CLI flag: -compactor.ring.heartbeat-period
[heartbeat_period: <duration> | default = 15s]

Expand Down Expand Up @@ -3177,15 +3173,15 @@ ring:
# CLI flag: -distributor.ring.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -distributor.ring.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -distributor.ring.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# Period at which to heartbeat to the ring. 0 = disabled.
# Period at which to heartbeat to the ring.
# CLI flag: -distributor.ring.heartbeat-period
[heartbeat_period: <duration> | default = 5s]

Expand Down Expand Up @@ -3631,7 +3627,7 @@ backoff_config:
[connect_backoff_max_delay: <duration> | default = 5s]

cluster_validation:
# Optionally define the cluster validation label.
# Primary cluster validation label.
# CLI flag: -<prefix>.cluster-validation.label
[label: <string> | default = ""]
```
Expand Down Expand Up @@ -3684,15 +3680,15 @@ ring:
# CLI flag: -index-gateway.ring.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -index-gateway.ring.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -index-gateway.ring.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# Period at which to heartbeat to the ring. 0 = disabled.
# Period at which to heartbeat to the ring.
# CLI flag: -index-gateway.ring.heartbeat-period
[heartbeat_period: <duration> | default = 15s]

Expand Down Expand Up @@ -3779,16 +3775,15 @@ lifecycler:
# CLI flag: -multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# The heartbeat timeout after which ingesters are skipped for reads/writes.
# 0 = never (timeout disabled).
# CLI flag: -ring.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand All @@ -3810,12 +3805,11 @@ lifecycler:
# CLI flag: -ingester.num-tokens
[num_tokens: <int> | default = 128]

# Period at which to heartbeat to consul. 0 = disabled.
# Period at which to heartbeat to consul.
# CLI flag: -ingester.heartbeat-period
[heartbeat_period: <duration> | default = 5s]

# Heartbeat timeout after which instance is assumed to be unhealthy. 0 =
# disabled.
# Heartbeat timeout after which instance is assumed to be unhealthy.
# CLI flag: -ingester.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

Expand Down Expand Up @@ -4073,11 +4067,11 @@ kafka_ingestion:
# CLI flag: -ingester.partition-ring.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -ingester.partition-ring.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -ingester.partition-ring.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

Expand Down Expand Up @@ -5085,6 +5079,19 @@ When a memberlist config with atleast 1 join_members is defined, kvstore of type
# The TLS configuration.
# The CLI flags prefix for this block configuration is: memberlist
[<tls_config>]

zone_aware_routing:
# Enable zone-aware routing for memberlist gossip.
# CLI flag: -memberlist.zone-aware-routing.enabled
[enabled: <boolean> | default = false]

# Availability zone where this node is running.
# CLI flag: -memberlist.zone-aware-routing.instance-availability-zone
[instance_availability_zone: <string> | default = ""]

# Role of this node in the cluster. Valid values: member, bridge.
# CLI flag: -memberlist.zone-aware-routing.role
[role: <string> | default = "member"]
```

### named_stores_config
Expand Down Expand Up @@ -5504,15 +5511,15 @@ scheduler_ring:
# CLI flag: -query-scheduler.ring.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -query-scheduler.ring.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -query-scheduler.ring.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# Period at which to heartbeat to the ring. 0 = disabled.
# Period at which to heartbeat to the ring.
# CLI flag: -query-scheduler.ring.heartbeat-period
[heartbeat_period: <duration> | default = 15s]

Expand Down Expand Up @@ -5753,15 +5760,15 @@ ring:
# CLI flag: -ruler.ring.multi.secondary
[secondary: <string> | default = ""]

# Mirror writes to secondary store.
# Mirror writes to the secondary store.
# CLI flag: -ruler.ring.multi.mirror-enabled
[mirror_enabled: <boolean> | default = false]

# Timeout for storing value to secondary store.
# Timeout for storing a value to the secondary store.
# CLI flag: -ruler.ring.multi.mirror-timeout
[mirror_timeout: <duration> | default = 2s]

# Interval between heartbeats sent to the ring. 0 = disabled.
# Interval between heartbeats sent to the ring.
# CLI flag: -ruler.ring.heartbeat-period
[heartbeat_period: <duration> | default = 5s]

Expand Down Expand Up @@ -6309,10 +6316,15 @@ grpc_tls_config:
[http_path_prefix: <string> | default = ""]

cluster_validation:
# Optionally define the cluster validation label.
# Primary cluster validation label.
# CLI flag: -server.cluster-validation.label
[label: <string> | default = ""]

# Comma-separated list of additional cluster validation labels that the server
# will accept from incoming requests.
# CLI flag: -server.cluster-validation.additional-labels
[additional_labels: <string> | default = ""]

grpc:
# When enabled, cluster label validation is executed: configured cluster
# validation label is compared with the cluster validation label received
Expand Down
Loading
Loading