From 22ec314039dbf853ecbb422d07dbe3ac003a0d0a Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Tue, 22 Mar 2022 09:30:18 +0100 Subject: [PATCH 1/3] Moved shuffle sharding doc to Hugo bundles Signed-off-by: Marco Pracucci --- .../architecture/bucket-index/index.md | 2 +- .../architecture/components/compactor/index.md | 2 +- .../architecture/components/ingester.md | 2 +- .../architecture/components/store-gateway.md | 2 +- .../operators-guide/architecture/hash-ring/index.md | 2 +- .../index.md} | 6 +++--- .../shuffle-sharding-probability.png | Bin .../running-production-environment/scaling-out.md | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) rename docs/sources/operators-guide/configuring/{configuring-shuffle-sharding.md => configuring-shuffle-sharding/index.md} (97%) rename docs/sources/operators-guide/{images => configuring/configuring-shuffle-sharding}/shuffle-sharding-probability.png (100%) diff --git a/docs/sources/operators-guide/architecture/bucket-index/index.md b/docs/sources/operators-guide/architecture/bucket-index/index.md index 793e3c60da2..141497366d2 100644 --- a/docs/sources/operators-guide/architecture/bucket-index/index.md +++ b/docs/sources/operators-guide/architecture/bucket-index/index.md @@ -68,7 +68,7 @@ The following configuration options determine bucket index update intervals: This option configures the frequency with which the bucket store attempts to load a failed bucket index. If a bucket index is unused for the amount of time configured via `-blocks-storage.bucket-store.bucket-index.idle-timeout`, (for example, if a querier instance is not receiving any query from the tenant), the querier offload its, which stops the querier from updating it at regular intervals. -This is useful for tenants that are resharded to different queriers when [shuffle sharding]({{< relref "../../configuring/configuring-shuffle-sharding.md" >}}) is enabled. +This is useful for tenants that are resharded to different queriers when [shuffle sharding]({{< relref "../../configuring/configuring-shuffle-sharding/index.md" >}}) is enabled. At query time the querier and ruler determine how old a bucket index is based on its `updated_at`. If the age is older than the period configured via `-blocks-storage.bucket-store.bucket-index.max-stale-period` a query fails. diff --git a/docs/sources/operators-guide/architecture/components/compactor/index.md b/docs/sources/operators-guide/architecture/components/compactor/index.md index 28d6093b792..7f4fa80fbc1 100644 --- a/docs/sources/operators-guide/architecture/components/compactor/index.md +++ b/docs/sources/operators-guide/architecture/components/compactor/index.md @@ -38,7 +38,7 @@ Compaction can be tuned for clusters with large tenants. Configuration specifies - **Vertical scaling**
The setting `-compactor.compaction-concurrency` configures the max number of concurrent compactions running in a single compactor instance. Each compaction uses one CPU core. - **Horizontal scaling**
- By default, tenant blocks can be compacted by any Grafana Mimir compactor. When you enable compactor [shuffle sharding]({{< relref "../../../configuring/configuring-shuffle-sharding.md" >}}) by setting `-compactor.compactor-tenant-shard-size` (or its respective YAML configuration option) to a value higher than `0` and lower than the number of available compactors, only the specified number of compactors are eligible to compact blocks for a given tenant. + By default, tenant blocks can be compacted by any Grafana Mimir compactor. When you enable compactor [shuffle sharding]({{< relref "../../../configuring/configuring-shuffle-sharding/index.md" >}}) by setting `-compactor.compactor-tenant-shard-size` (or its respective YAML configuration option) to a value higher than `0` and lower than the number of available compactors, only the specified number of compactors are eligible to compact blocks for a given tenant. ## Compaction algorithm diff --git a/docs/sources/operators-guide/architecture/components/ingester.md b/docs/sources/operators-guide/architecture/components/ingester.md index 38f2af14611..454fb4c60d8 100644 --- a/docs/sources/operators-guide/architecture/components/ingester.md +++ b/docs/sources/operators-guide/architecture/components/ingester.md @@ -75,4 +75,4 @@ To set up multi-zone replication, refer to [Configuring zone-aware replication]( Shuffle sharding can be used to reduce the effect that multiple tenants can have on each other. -For more information on shuffle sharding, refer to [Configuring shuffle sharding]({{< relref "../../configuring/configuring-shuffle-sharding.md" >}}). +For more information on shuffle sharding, refer to [Configuring shuffle sharding]({{< relref "../../configuring/configuring-shuffle-sharding/index.md" >}}). diff --git a/docs/sources/operators-guide/architecture/components/store-gateway.md b/docs/sources/operators-guide/architecture/components/store-gateway.md index ff12790029f..df2b110b937 100644 --- a/docs/sources/operators-guide/architecture/components/store-gateway.md +++ b/docs/sources/operators-guide/architecture/components/store-gateway.md @@ -75,7 +75,7 @@ The `store_gateway_tenant_shard_size` in the limits overrides can override the s The default `-store-gateway.tenant-shard-size` value is 0, which means that tenant's blocks are sharded across all store-gateway instances. -For more information about shuffle sharding, refer to [configure shuffle sharding]({{< relref "../../configuring/configuring-shuffle-sharding.md" >}}). +For more information about shuffle sharding, refer to [configure shuffle sharding]({{< relref "../../configuring/configuring-shuffle-sharding/index.md" >}}). ### Auto-forget diff --git a/docs/sources/operators-guide/architecture/hash-ring/index.md b/docs/sources/operators-guide/architecture/hash-ring/index.md index 84eff2bc30c..10e9bc75e5e 100644 --- a/docs/sources/operators-guide/architecture/hash-ring/index.md +++ b/docs/sources/operators-guide/architecture/hash-ring/index.md @@ -95,4 +95,4 @@ Features that are built using the hash ring: - **Service discovery**: Instances can discover each other looking up who is registered in the ring. - **Heartbeating**: Instances periodically send an heartbeat to the ring to signal they're up and running. An instance is considered unhealthy if misses the heartbeat for some period of time. - **Zone-aware replication**: Zone-aware replication is the replication of data across failure domains and can be optionally enabled in Grafana Mimir. For more information, see [configuring zone-aware replication]({{< relref "../../configuring/configuring-zone-aware-replication.md" >}}). -- **Shuffle sharding**: Grafana Mimir optionally supports shuffle sharding in a multi-tenant cluster, to reduce the blast radius of an outage and better isolate tenants. For more information, refer to [configure shuffle sharding]({{< relref "../../configuring/configuring-shuffle-sharding.md" >}}). +- **Shuffle sharding**: Grafana Mimir optionally supports shuffle sharding in a multi-tenant cluster, to reduce the blast radius of an outage and better isolate tenants. For more information, refer to [configure shuffle sharding]({{< relref "../../configuring/configuring-shuffle-sharding/index.md" >}}). diff --git a/docs/sources/operators-guide/configuring/configuring-shuffle-sharding.md b/docs/sources/operators-guide/configuring/configuring-shuffle-sharding/index.md similarity index 97% rename from docs/sources/operators-guide/configuring/configuring-shuffle-sharding.md rename to docs/sources/operators-guide/configuring/configuring-shuffle-sharding/index.md index da556d2e93f..d9cbdb15fb2 100644 --- a/docs/sources/operators-guide/configuring/configuring-shuffle-sharding.md +++ b/docs/sources/operators-guide/configuring/configuring-shuffle-sharding/index.md @@ -50,7 +50,7 @@ Randomly picking two tenants yields the following probabilities: - 0.08% chance that they share 3 instances - 0.0004% chance that their instances fully overlap -![Shuffle sharding probability](../../images/shuffle-sharding-probability.png) +![Shuffle sharding probability](shuffle-sharding-probability.png) [//]: # "Diagram source of shuffle-sharding probability at https://docs.google.com/spreadsheets/d/1FXbiWTXi6bdERtamH-IfmpgFq1fNL4GP_KX_yJvbRi4/edit" @@ -79,7 +79,7 @@ The Grafana Mimir shuffle sharding implementation provides the following benefit - **Shuffling**
Probabilistically and for a large enough cluster, shuffle sharding ensures that every tenant receives a different set of instances with a reduced number of overlapping instances between two tenants, which improves failure isolation. - **Zone-awareness**
- When you enable [zone-aware replication](../guides/zone-replication.md), the subset of instances selected for each tenant contains a balanced number of instances for each availability zone. + When you enable [zone-aware replication]({{< relref "../configuring-zone-aware-replication.md" >}}), the subset of instances selected for each tenant contains a balanced number of instances for each availability zone. ### Ingesters shuffle sharding @@ -170,7 +170,7 @@ You must set this flag on the store-gateway, querier, and ruler. You can override the store-gateway shard size on a per-tenant basis by setting `store_gateway_tenant_shard_size` in the overrides section of the runtime configuration. -For more information about the store-gateway, refer to [store-gateway](../architecture/components/store-gateway.md). +For more information about the store-gateway, refer to [store-gateway]({{< relref "../../architecture/components/store-gateway.md" >}}). ### Ruler shuffle sharding diff --git a/docs/sources/operators-guide/images/shuffle-sharding-probability.png b/docs/sources/operators-guide/configuring/configuring-shuffle-sharding/shuffle-sharding-probability.png similarity index 100% rename from docs/sources/operators-guide/images/shuffle-sharding-probability.png rename to docs/sources/operators-guide/configuring/configuring-shuffle-sharding/shuffle-sharding-probability.png diff --git a/docs/sources/operators-guide/running-production-environment/scaling-out.md b/docs/sources/operators-guide/running-production-environment/scaling-out.md index b00ccc02e2d..809bb04bea8 100644 --- a/docs/sources/operators-guide/running-production-environment/scaling-out.md +++ b/docs/sources/operators-guide/running-production-environment/scaling-out.md @@ -69,7 +69,7 @@ Complete the following steps to scale down ingesters deployed in a single zone. 1. Configure the Grafana Mimir cluster to discover and query new uploaded blocks as quickly as possible. - a. Configure queriers and rulers to always query the long-term storage and to disable ingesters [shuffle sharding]({{< relref "configuring-shuffle-sharding.md" >}}) on the read path: + a. Configure queriers and rulers to always query the long-term storage and to disable ingesters [shuffle sharding]({{< relref "../configuring/configuring-shuffle-sharding/index.md" >}}) on the read path: ``` -querier.query-store-after=0s From cee60a9ddfc7f3733d170151b04cd75b0b8ecf9d Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Tue, 22 Mar 2022 09:32:28 +0100 Subject: [PATCH 2/3] Moved mirroring doc to Hugo bundles Signed-off-by: Marco Pracucci --- Makefile | 2 +- .../index.md} | 6 +++--- .../mirroring-envoy.png | Bin 3 files changed, 4 insertions(+), 4 deletions(-) rename docs/sources/operators-guide/configuring/{mirroring-requests-to-a-second-cluster.md => mirroring-requests-to-a-second-cluster/index.md} (95%) rename docs/sources/operators-guide/{images => configuring/mirroring-requests-to-a-second-cluster}/mirroring-envoy.png (100%) diff --git a/Makefile b/Makefile index 83f8e5a0f29..1e40ed39057 100644 --- a/Makefile +++ b/Makefile @@ -62,7 +62,7 @@ DOC_TEMPLATES := docs/sources/operators-guide/configuring/reference-configuratio # Documents to run through embedding DOC_EMBED := docs/sources/operators-guide/configuring/configuring-the-query-frontend-work-with-prometheus.md \ - docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster.md \ + docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster/index.md \ docs/sources/operators-guide/architecture/components/overrides-exporter.md \ docs/sources/operators-guide/getting-started/_index.md \ operations/mimir/README.md diff --git a/docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster.md b/docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster/index.md similarity index 95% rename from docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster.md rename to docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster/index.md index e3f2debf7d6..d534edb528b 100644 --- a/docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster.md +++ b/docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster/index.md @@ -16,7 +16,7 @@ If you have control over the Prometheus remote write configuration, we recommend ## Mirroring with Envoy proxy You can use [Envoy proxy](https://www.envoyproxy.io/) to mirror HTTP requests to a secondary upstream cluster. -From a network path perspective, run Envoy in front of both clusters' [distributors](../../architecture/distributor). +From a network path perspective, run Envoy in front of both clusters' [distributors]({{< relref "../../architecture/components/distributor.md" >}}). This approach enables the Envoy proxy to make requests to the primary Grafana Mimir cluster and then in the background, Envoy mirrors the requests to the secondary cluster. @@ -29,14 +29,14 @@ The following diagram illustrates a simplified network structure. -![Mirroring with Envoy Proxy - network diagram](../../images/mirroring-envoy.png) +![Mirroring with Envoy Proxy - network diagram](mirroring-envoy.png) ### Example Envoy configuration The following Envoy configuration shows an example that includes two Grafana Mimir clusters. Envoy listens on port `9900` and proxies all requests to `mimir-primary:8080`, while also mirroring them to `mimir-secondary:8080`. -[embedmd]:# (../../../configurations/requests-mirroring-envoy.yaml) +[embedmd]:# (../../../../configurations/requests-mirroring-envoy.yaml) ```yaml admin: # No access logs. diff --git a/docs/sources/operators-guide/images/mirroring-envoy.png b/docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster/mirroring-envoy.png similarity index 100% rename from docs/sources/operators-guide/images/mirroring-envoy.png rename to docs/sources/operators-guide/configuring/mirroring-requests-to-a-second-cluster/mirroring-envoy.png From a461ba75e0fb196600de420e91e4e09b0c7a27dc Mon Sep 17 00:00:00 2001 From: Marco Pracucci Date: Tue, 22 Mar 2022 09:37:46 +0100 Subject: [PATCH 3/3] Moved config reference doc to Hugo bundles Signed-off-by: Marco Pracucci --- Makefile | 2 +- .../architecture/components/alertmanager.md | 2 +- .../architecture/components/querier.md | 2 +- .../architecture/components/ruler.md | 4 ++-- .../architecture/components/store-gateway.md | 2 +- .../configuring/configuring-hash-rings.md | 8 ++++---- .../index.md} | 2 +- .../index.template} | 2 +- .../param-states.png | Bin .../securing/encrypting-data-at-rest.md | 8 ++++---- docs/sources/operators-guide/tools/mimirtool.md | 2 +- .../using-exemplars/about-exemplars.md | 2 +- .../visualizing-metrics/deploying-monitor-mixin.md | 2 +- 13 files changed, 19 insertions(+), 19 deletions(-) rename docs/sources/operators-guide/configuring/{reference-configuration-parameters.md => reference-configuration-parameters/index.md} (99%) rename docs/sources/operators-guide/configuring/{reference-configuration-parameters.template => reference-configuration-parameters/index.template} (98%) rename docs/sources/operators-guide/{images => configuring/reference-configuration-parameters}/param-states.png (100%) diff --git a/Makefile b/Makefile index 1e40ed39057..0f6ba29fc89 100644 --- a/Makefile +++ b/Makefile @@ -58,7 +58,7 @@ MIXIN_OUT_PATH := operations/mimir-mixin-compiled JSONNET_MANIFESTS_PATH := operations/mimir # Doc templates in use -DOC_TEMPLATES := docs/sources/operators-guide/configuring/reference-configuration-parameters.template +DOC_TEMPLATES := docs/sources/operators-guide/configuring/reference-configuration-parameters/index.template # Documents to run through embedding DOC_EMBED := docs/sources/operators-guide/configuring/configuring-the-query-frontend-work-with-prometheus.md \ diff --git a/docs/sources/operators-guide/architecture/components/alertmanager.md b/docs/sources/operators-guide/architecture/components/alertmanager.md index 22d71e08c6a..0f4a0b3f591 100644 --- a/docs/sources/operators-guide/architecture/components/alertmanager.md +++ b/docs/sources/operators-guide/architecture/components/alertmanager.md @@ -60,7 +60,7 @@ Specify a fallback configuration using the `-alertmanager.configs.fallback` comm ### Tenant limits -The Grafana Mimir Alertmanager has a number of per-tenant limits documented in [`limits`]({{< relref "../../configuring/reference-configuration-parameters.md#limits" >}}). +The Grafana Mimir Alertmanager has a number of per-tenant limits documented in [`limits`]({{< relref "../../configuring/reference-configuration-parameters/index.md#limits" >}}). Each Mimir Alertmanager limit configuration parameter has an `alertmanager` prefix. ## Alertmanager UI diff --git a/docs/sources/operators-guide/architecture/components/querier.md b/docs/sources/operators-guide/architecture/components/querier.md index 48c5b129f36..21bc33e3ff1 100644 --- a/docs/sources/operators-guide/architecture/components/querier.md +++ b/docs/sources/operators-guide/architecture/components/querier.md @@ -100,4 +100,4 @@ Additional flags for configuring the metadata cache begin with the prefix `-bloc ## Querier configuration -For details about querier configuration, refer to [querier]({{< relref "../../configuring/reference-configuration-parameters.md#querier" >}}). +For details about querier configuration, refer to [querier]({{< relref "../../configuring/reference-configuration-parameters/index.md#querier" >}}). diff --git a/docs/sources/operators-guide/architecture/components/ruler.md b/docs/sources/operators-guide/architecture/components/ruler.md index f3e88f6047a..de23dd3f2ac 100644 --- a/docs/sources/operators-guide/architecture/components/ruler.md +++ b/docs/sources/operators-guide/architecture/components/ruler.md @@ -20,8 +20,8 @@ The ruler evaluates the expressions in the recording rules at regular intervals The ruler has a built-in querier that evaluates the PromQL expressions and a built-in distributor, so that it can write directly to the ingesters. Configuration of the built-in querier and distributor uses their respective configuration parameters: -- [Querier]({{< relref "../../configuring/reference-configuration-parameters.md#querier" >}}) -- [Distributor]({{< relref "../../configuring/reference-configuration-parameters.md#distributor" >}}) +- [Querier]({{< relref "../../configuring/reference-configuration-parameters/index.md#querier" >}}) +- [Distributor]({{< relref "../../configuring/reference-configuration-parameters/index.md#distributor" >}}) ## Alerting rules diff --git a/docs/sources/operators-guide/architecture/components/store-gateway.md b/docs/sources/operators-guide/architecture/components/store-gateway.md index df2b110b937..588aab31617 100644 --- a/docs/sources/operators-guide/architecture/components/store-gateway.md +++ b/docs/sources/operators-guide/architecture/components/store-gateway.md @@ -211,4 +211,4 @@ Additional flags for configuring metadata cache begin with the prefix `-blocks-s ## Store-gateway configuration -For more information about store-gateway configuration, refer to [store_gateway]({{< relref "../../configuring/reference-configuration-parameters.md#store_gateway" >}}). +For more information about store-gateway configuration, refer to [store_gateway]({{< relref "../../configuring/reference-configuration-parameters/index.md#store_gateway" >}}). diff --git a/docs/sources/operators-guide/configuring/configuring-hash-rings.md b/docs/sources/operators-guide/configuring/configuring-hash-rings.md index b3aaaec7a04..348f1edda5a 100644 --- a/docs/sources/operators-guide/configuring/configuring-hash-rings.md +++ b/docs/sources/operators-guide/configuring/configuring-hash-rings.md @@ -20,7 +20,7 @@ The CLI flags used to configure the hash ring of each component have the followi - (Optional) Alertmanagers: `-alertmanager.sharding-ring.*` The rest of the documentation refers to these prefixes as ``. -You can configure each parameter either via the CLI flag or its respective YAML [config option]({{< relref "../configuring/reference-configuration-parameters.md" >}}). +You can configure each parameter either via the CLI flag or its respective YAML [config option]({{< relref "../configuring/reference-configuration-parameters/index.md" >}}). ## Configuring the key-value store @@ -62,7 +62,7 @@ The default port is `7946`. Grafana Mimir supports TLS for memberlist connections between its components. For more information about TLS configuration, refer to [secure communications with TLS]({{< relref "../securing/securing-communications-with-tls.md" >}}). -To see all supported configuration parameters, refer to [memberlist]({{< relref "../configuring/reference-configuration-parameters.md#memberlist" >}}). +To see all supported configuration parameters, refer to [memberlist]({{< relref "../configuring/reference-configuration-parameters/index.md#memberlist" >}}). #### Configuring the memberlist address and port @@ -99,7 +99,7 @@ To use [Consul](https://www.consul.io) as a backend KV store, set the following - `.consul.hostname`: Consul hostname and port separated by colon. For example, `consul:8500`. - `.consul.acl-token`: [ACL token](https://www.consul.io/docs/security/acl/acl-system) used to authenticate to Consul. If Consul authentication is disabled, you can leave the token empty. -To see all supported configuration parameters, refer [consul]({{< relref "../configuring/reference-configuration-parameters.md#consul" >}}). +To see all supported configuration parameters, refer [consul]({{< relref "../configuring/reference-configuration-parameters/index.md#consul" >}}). ### Etcd @@ -112,7 +112,7 @@ To use [etcd](https://etcd.io) as a backend KV store, set the following paramete Grafana Mimir supports TLS between its components and etcd. For more information about TLS configuration, refer to [secure communications with TLS]({{< relref "../securing/securing-communications-with-tls.md" >}}). -To see all supported configuration parameters, refer to [etcd]({{< relref "../configuring/reference-configuration-parameters.md#etcd" >}}). +To see all supported configuration parameters, refer to [etcd]({{< relref "../configuring/reference-configuration-parameters/index.md#etcd" >}}). ### Multi diff --git a/docs/sources/operators-guide/configuring/reference-configuration-parameters.md b/docs/sources/operators-guide/configuring/reference-configuration-parameters/index.md similarity index 99% rename from docs/sources/operators-guide/configuring/reference-configuration-parameters.md rename to docs/sources/operators-guide/configuring/reference-configuration-parameters/index.md index 28b8d202f42..05be37f137d 100644 --- a/docs/sources/operators-guide/configuring/reference-configuration-parameters.md +++ b/docs/sources/operators-guide/configuring/reference-configuration-parameters/index.md @@ -72,7 +72,7 @@ When new parameters are added, they can be introduced as **basic**, **advanced** If we decide to eliminate a **basic** or **advanced** parameter, we will first mark it deprecated. After two more minor releases, a deprecated flag will be removed entirely. Use the metric `deprecated_flags_inuse_total` to determine whether you're using deprecated flags. -![Parameter states](../images/param-states.png) +![Parameter states](param-states.png) ## Use environment variables in the configuration diff --git a/docs/sources/operators-guide/configuring/reference-configuration-parameters.template b/docs/sources/operators-guide/configuring/reference-configuration-parameters/index.template similarity index 98% rename from docs/sources/operators-guide/configuring/reference-configuration-parameters.template rename to docs/sources/operators-guide/configuring/reference-configuration-parameters/index.template index 265c0947d12..dc8e609ba30 100644 --- a/docs/sources/operators-guide/configuring/reference-configuration-parameters.template +++ b/docs/sources/operators-guide/configuring/reference-configuration-parameters/index.template @@ -72,7 +72,7 @@ When new parameters are added, they can be introduced as **basic**, **advanced** If we decide to eliminate a **basic** or **advanced** parameter, we will first mark it deprecated. After two more minor releases, a deprecated flag will be removed entirely. Use the metric `deprecated_flags_inuse_total` to determine whether you're using deprecated flags. -![Parameter states](../images/param-states.png) +![Parameter states](param-states.png) ## Use environment variables in the configuration diff --git a/docs/sources/operators-guide/images/param-states.png b/docs/sources/operators-guide/configuring/reference-configuration-parameters/param-states.png similarity index 100% rename from docs/sources/operators-guide/images/param-states.png rename to docs/sources/operators-guide/configuring/reference-configuration-parameters/param-states.png diff --git a/docs/sources/operators-guide/securing/encrypting-data-at-rest.md b/docs/sources/operators-guide/securing/encrypting-data-at-rest.md index 5606bfa6e2a..0a41ed03517 100644 --- a/docs/sources/operators-guide/securing/encrypting-data-at-rest.md +++ b/docs/sources/operators-guide/securing/encrypting-data-at-rest.md @@ -31,11 +31,11 @@ You can configure AWS S3 SSE globally or for specific tenants. Configuring AWS S3 SSE globally requires setting SSE for each of the following storage backends: -- [alertmanager_storage]({{< relref "../configuring/reference-configuration-parameters.md#alertmanager_storage" >}}) -- [blocks_storage]({{< relref "../configuring/reference-configuration-parameters.md#blocks_storage" >}}) -- [ruler_storage]({{< relref "../configuring/reference-configuration-parameters.md#ruler_storage" >}}) +- [alertmanager_storage]({{< relref "../configuring/reference-configuration-parameters/index.md#alertmanager_storage" >}}) +- [blocks_storage]({{< relref "../configuring/reference-configuration-parameters/index.md#blocks_storage" >}}) +- [ruler_storage]({{< relref "../configuring/reference-configuration-parameters/index.md#ruler_storage" >}}) -For more information about AWS S3 SSE configuration parameters, refer to [sse]({{< relref "../configuring/reference-configuration-parameters.md#sse" >}}). +For more information about AWS S3 SSE configuration parameters, refer to [sse]({{< relref "../configuring/reference-configuration-parameters/index.md#sse" >}}). The following code sample shows a snippet of a Grafana Mimir configuration file with every backend storage configured to use AWS S3 SSE with and Amazon S3-managed key. diff --git a/docs/sources/operators-guide/tools/mimirtool.md b/docs/sources/operators-guide/tools/mimirtool.md index f629d4d74a8..0a0d7b2d031 100644 --- a/docs/sources/operators-guide/tools/mimirtool.md +++ b/docs/sources/operators-guide/tools/mimirtool.md @@ -640,7 +640,7 @@ mimirtool bucket-validation #### Convert The config convert command converts configuration parameters that work with Cortex v1.10.0 and above to parameters that work with Grafana Mimir v2.0.0. -It supports converting both CLI flags and [YAML configuration files]({{< relref "../configuring/reference-configuration-parameters.md" >}}). +It supports converting both CLI flags and [YAML configuration files]({{< relref "../configuring/reference-configuration-parameters/index.md" >}}). ##### Configuration diff --git a/docs/sources/operators-guide/using-exemplars/about-exemplars.md b/docs/sources/operators-guide/using-exemplars/about-exemplars.md index f6d7dd0d070..9b1cd15dd4e 100644 --- a/docs/sources/operators-guide/using-exemplars/about-exemplars.md +++ b/docs/sources/operators-guide/using-exemplars/about-exemplars.md @@ -11,4 +11,4 @@ An exemplar is a specific trace representative of a repeated pattern of data in Grafana Mimir includes the ability to store exemplars in-memory. Exemplar storage in Grafana Mimir is implemented similarly to how it is in Prometheus. Exemplars are stored as a fixed size circular buffer that stores exemplars in memory for all series. -The [limits]({{< relref "../configuring/reference-configuration-parameters.md#limits" >}}) property can be used to control the size of the circular buffer by the number of exemplars. For reference, an exemplar with just a `traceID=` uses roughly 100 bytes of memory via the in-memory exemplar storage. If the exemplar storage is enabled, Grafana Mimir will also append the exemplars to WAL for local persistence (for WAL duration). +The [limits]({{< relref "../configuring/reference-configuration-parameters/index.md#limits" >}}) property can be used to control the size of the circular buffer by the number of exemplars. For reference, an exemplar with just a `traceID=` uses roughly 100 bytes of memory via the in-memory exemplar storage. If the exemplar storage is enabled, Grafana Mimir will also append the exemplars to WAL for local persistence (for WAL duration). diff --git a/docs/sources/operators-guide/visualizing-metrics/deploying-monitor-mixin.md b/docs/sources/operators-guide/visualizing-metrics/deploying-monitor-mixin.md index 56380c591e9..e360d7cab77 100644 --- a/docs/sources/operators-guide/visualizing-metrics/deploying-monitor-mixin.md +++ b/docs/sources/operators-guide/visualizing-metrics/deploying-monitor-mixin.md @@ -8,7 +8,7 @@ weight: 20 # Deploying the Grafana Mimir monitoring mixin Grafana Mimir exposes a `/metrics` endpoint returning Prometheus metrics. -The endpoint is exposed on the Mimir HTTP server address / port which can be customized through `-server.http-listen-address` and `-server.http-listen-port` CLI flags or their respective YAML [config options]({{< relref "../configuring/reference-configuration-parameters.md" >}}). +The endpoint is exposed on the Mimir HTTP server address / port which can be customized through `-server.http-listen-address` and `-server.http-listen-port` CLI flags or their respective YAML [config options]({{< relref "../configuring/reference-configuration-parameters/index.md" >}}). ## Dashboards and alerts