Docs: revise block names (ring and filesystem) and correct spelling (#5015)

* Docs: revise block names (ring and filesystem) and correct spelling

* Docs: scheduler_ring and compactor_ring point to ring config
   Change made per review comment.
pull/4857/head
Karen Miller 4 years ago committed by GitHub
parent acbbe4ddfd
commit 9a49ab78fe
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 34
      docs/sources/configuration/_index.md

@ -321,7 +321,7 @@ The `query_scheduler` block configures the Loki query scheduler.
# The hash ring configuration. This option is required only if use_scheduler_ring is true
# The CLI flags prefix for this block config is scheduler.ring
[scheduler_ring: <ring_config>]
[scheduler_ring: <ring>]
```
## frontend
@ -453,7 +453,7 @@ storage:
# Configures backend rule storage for Swift.
[swift: <swift_storage_config>]
# Configures backend rule storage for a local filesystem directory.
# Configures backend rule storage for a local file system directory.
[local: <local_storage_config>]
# The `hedging_config` configures how to hedge requests for the storage.
@ -877,7 +877,7 @@ You should configure the latency based on your p99 of object store requests.
## local_storage_config
The `local_storage_config` configures a (local) filesystem as a general storage for different data generated by Loki.
The `local_storage_config` configures a (local) file system as a general storage for different data generated by Loki.
```yaml
# Filesystem directory to be used as storage.
@ -1577,14 +1577,14 @@ swift:
[container_name: <string> | default = "cortex"]
# Configures storing index in BoltDB. Required fields only
# required when boltdb is present in config.
# required when boltdb is present in the configuration.
boltdb:
# Location of BoltDB index files.
# CLI flag: -boltdb.dir
directory: <string>
# Configures storing the chunks on the local filesystem. Required
# fields only required when filesystem is present in config.
# Configures storing the chunks on the local file system. Required
# fields only required when filesystem is present in the configuration.
filesystem:
# Directory to store chunks in.
# CLI flag: -local.chunk-directory
@ -1917,7 +1917,7 @@ compacts index shards to more performant forms.
# The hash ring configuration used by compactors to elect a single instance for running compactions
# The CLI flags prefix for this block config is: boltdb.shipper.compactor.ring
[compactor_ring: <ring_config>]
[compactor_ring: <ring>]
```
## limits_config
@ -2376,7 +2376,7 @@ This way, one doesn't have to replicate configuration in multiple places.
# For instance, you can expect the `heartbeat_period` defined in the common section
# to be used by the distributor's ring, but only if the distributor's ring itself
# doesn't have a `heartbeat_period` set.
[ring: <ring_config>]
[ring: <ring>]
```
### storage
@ -2398,29 +2398,29 @@ If any specific configuration for an object storage client have been provided el
# Configures Swift as the common storage.
[swift: <swift_storage_config>]
# Configures a (local) filesystem as the common storage.
[filesystem: <fs_storage_config>]
# Configures a (local) file system as the common storage.
[filesystem: <filesystem>]
# The `hedging_config` configures how to hedge requests for the storage.
[hedging: <hedging_config>]
```
### fs_storage_config
### filesystem
The `fs_storage_config` configures a local filesystem as a general
storage for different data generated by Loki.
The common `filesystem` block configures a local file system as a general
storage for various types of data generated by Loki.
```yaml
# Filesystem directory to be used for chunks storage.
# File system directory to be used for chunks storage.
[chunks_directory: <filename> | default = ""]
# Filesystem directory to be used for rules storage.
# File system directory to be used for rules storage.
[rules_directory: <filename> | default = ""]
```
### ring_config
### ring
The `ring_config` blocks defines a ring configuration used by Loki component.
The common `ring` block defines a ring configuration used by a Loki component.
```yaml
# The key-value store used to share the hash ring across multiple instances.

Loading…
Cancel
Save