Skip to content

Commit 0ae519a

Browse files
authored
relref replace - mimir helm (#10911)
1 parent 1484f36 commit 0ae519a

File tree

8 files changed

+15
-15
lines changed

8 files changed

+15
-15
lines changed

docs/sources/helm-charts/mimir-distributed/get-started-helm-charts/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Experience with the following is recommended, but not essential:
2626
- Understanding of what the `kubectl` command does.
2727
- Understanding of what the `helm` command does.
2828

29-
> **Caution:** This procedure is primarily aimed at local or development setups. To set up in a production environment, see [Run Grafana Mimir in production using the Helm chart]({{< relref "../run-production-environment-with-helm" >}}).
29+
> **Caution:** This procedure is primarily aimed at local or development setups. To set up in a production environment, see [Run Grafana Mimir in production using the Helm chart](../run-production-environment-with-helm/).
3030
3131
### Hardware requirements
3232

@@ -68,7 +68,7 @@ The reason is that the installation includes a deployment of MinIO. The [minio/m
6868
is not compatible with running under a Restricted policy or the PodSecurityPolicy that the mimir-distributed chart provides.
6969

7070
If you are using the PodSecurityPolicy admission controller, then it is not possible to deploy the mimir-distributed chart with MinIO.
71-
Refer to [Run Grafana Mimir in production using the Helm chart]({{< relref "../run-production-environment-with-helm" >}}) for instructions on
71+
Refer to [Run Grafana Mimir in production using the Helm chart](../run-production-environment-with-helm/) for instructions on
7272
setting up an external object storage and disable the built-in MinIO deployment with `minio.enabled: false` in the Helm values file.
7373

7474
If you are using the [Pod Security](https://kubernetes.io/docs/concepts/security/pod-security-admission/) admission controller, then MinIO and the mimir-distributed chart can successfully deploy under the [baseline](https://kubernetes.io/docs/concepts/security/pod-security-admission/#pod-security-levels) pod security level.
@@ -377,4 +377,4 @@ First install Grafana, and then add Mimir as a Prometheus data source.
377377

378378
You should be able to query metrics in [Grafana Explore](http://localhost:3000/explore),
379379
as well as create dashboard panels by using your newly configured `Mimir` data source.
380-
For more information, see [Monitor Grafana Mimir]({{< relref "../run-production-environment-with-helm/monitor-system-health.md" >}}).
380+
For more information, see [Monitor Grafana Mimir](../run-production-environment-with-helm/monitor-system-health/).

docs/sources/helm-charts/mimir-distributed/migration-guides/migrate-from-single-zone-with-helm.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Depending on what version of the `mimir-distributed` Helm chart is installed cur
4141
4242
1. If you have modified the `mimir.config` value, either make sure to merge in the latest version from the chart, or consider using `mimir.structuredConfig` instead.
4343

44-
For more information, see [Manage the configuration of Grafana Mimir with Helm]({{< relref "../run-production-environment-with-helm/configuration-with-helm" >}}).
44+
For more information, see [Manage the configuration of Grafana Mimir with Helm](../../run-production-environment-with-helm/configuration-with-helm/).
4545

4646
- If the current version of the `mimir-distributed` Helm chart is greater than 4.0.0 (version >= 4.0.0).
4747

@@ -57,7 +57,7 @@ Depending on what version of the `mimir-distributed` Helm chart is installed cur
5757

5858
1. If you have modified the `mimir.config` value, either make sure to merge in the latest version from the chart, or consider using `mimir.structuredConfig` instead.
5959

60-
For more information, see [Manage the configuration of Grafana Mimir with Helm]({{< relref "../run-production-environment-with-helm/configuration-with-helm" >}}).
60+
For more information, see [Manage the configuration of Grafana Mimir with Helm](../../run-production-environment-with-helm/configuration-with-helm/).
6161

6262
## Migrate alertmanager to zone-aware replication
6363

docs/sources/helm-charts/mimir-distributed/migration-guides/migrate-helm-chart-4.x-to-5.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The `mimir-distributed` Helm chart version 5.0 and later does not install [PodSe
1818
1. If `rbac.create` is `false` or `rbac.type` is `scc`, then there is nothing to do, skip the whole procedure.
1919
1. Choose between the following options:
2020
1. If you are on Kubernetes version 1.22 or later and already have [Pod Security Admission](https://kubernetes.io/docs/concepts/security/pod-security-admission/) set up, you don't need to do anything and can upgrade to Helm chart version 5.0.
21-
1. If you are on Kubernetes version 1.22 or later but don't have [Pod Security Admission](https://kubernetes.io/docs/concepts/security/pod-security-admission/) set up and want to upgrade to Kubernetes version 1.25 after this procedure, then follow the [Migrate to Kubernetes version 1.25]({{< relref "./migrate-to-kubernetes-version-1.25.md" >}}) guide.
21+
1. If you are on Kubernetes version 1.22 or later but don't have [Pod Security Admission](https://kubernetes.io/docs/concepts/security/pod-security-admission/) set up and want to upgrade to Kubernetes version 1.25 after this procedure, then follow the [Migrate to Kubernetes version 1.25](../migrate-to-kubernetes-version-1.25/) guide.
2222
1. If you are on Kubernetes version 1.24 and want to keep using PodSecurityPolicy, then merge the following setting into your custom values file:
2323
```yaml
2424
rbac:

docs/sources/helm-charts/mimir-distributed/release-notes/v3.2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To learn about new features and enhancements in Grafana Mimir or GEM, see the re
1313

1414
The highlights that follow include the top features, enhancements, and bugfixes in this release. For a comprehensive list of changes, see the [Helm chart changelog](https://github.com/grafana/mimir/tree/main/operations/helm/charts/mimir-distributed/CHANGELOG.md).
1515

16-
> **Note:** If you are upgrading from Grafana Mimir Helm chart 3.1, review the [list of important changes]({{< relref "#important-changes" >}}) that follow.
16+
> **Note:** If you are upgrading from Grafana Mimir Helm chart 3.1, review the [list of important changes](#important-changes) that follow.
1717
1818
## Features and enhancements
1919

docs/sources/helm-charts/mimir-distributed/release-notes/v4.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To learn about new features and enhancements in Grafana Mimir or GEM, see the re
1313

1414
The highlights that follow include the top features, enhancements, and bugfixes in this release. For a comprehensive list of changes, see the [Helm chart changelog](https://github.com/grafana/mimir/tree/main/operations/helm/charts/mimir-distributed/CHANGELOG.md).
1515

16-
> **Note:** If you are upgrading from Grafana Mimir Helm chart 3.3, review the [list of important changes]({{< relref "#important-changes" >}}) that follow.
16+
> **Note:** If you are upgrading from Grafana Mimir Helm chart 3.3, review the [list of important changes](#important-changes) that follow.
1717
1818
## Features and enhancements
1919

docs/sources/helm-charts/mimir-distributed/release-notes/v5.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Grafana Labs is excited to announce version 5.0 of the Grafana Mimir Helm chart,
1111

1212
The highlights that follow include the top features, enhancements, and bugfixes in this release. For a comprehensive list of changes, see the [Helm chart changelog](https://github.com/grafana/mimir/tree/main/operations/helm/charts/mimir-distributed/CHANGELOG.md).
1313

14-
> **Note:** For a migration guide from `mimir-distributed` version 4.X to 5.0, see [Migrate the Helm chart from version 4.x to 5.0]({{< relref "../migration-guides/migrate-helm-chart-4.x-to-5.0.md" >}}).
14+
> **Note:** For a migration guide from `mimir-distributed` version 4.X to 5.0, see [Migrate the Helm chart from version 4.x to 5.0](../../migration-guides/migrate-helm-chart-4.x-to-5.0/).
1515
1616
## Important changes
1717

18-
- **Breaking change: PodSecurityPolicy objects are no longer rendered on Kubernetes versions 1.24 or higher.** This resource type was deprecated in Kubernetes version 1.21 and was removed in version 1.25. Due to how Helm manages release histories, the `mimir-distributed` Helm chart can no longer be upgraded if a PodSecurityPolicy was present during a Kubernetes upgrade from 1.24 to 1.25. In order to remediate this, `mimir-distributed` no longer renders the PodSecurityPolicy on Kubernetes 1.24. For a migration guide from `mimir-distributed` version 4.X to 5.0, see [Migrate the Helm chart from version 4.x to 5.0]({{< relref "../migration-guides/migrate-helm-chart-4.x-to-5.0.md" >}}).
18+
- **Breaking change: PodSecurityPolicy objects are no longer rendered on Kubernetes versions 1.24 or higher.** This resource type was deprecated in Kubernetes version 1.21 and was removed in version 1.25. Due to how Helm manages release histories, the `mimir-distributed` Helm chart can no longer be upgraded if a PodSecurityPolicy was present during a Kubernetes upgrade from 1.24 to 1.25. In order to remediate this, `mimir-distributed` no longer renders the PodSecurityPolicy on Kubernetes 1.24. For a migration guide from `mimir-distributed` version 4.X to 5.0, see [Migrate the Helm chart from version 4.x to 5.0](../../migration-guides/migrate-helm-chart-4.x-to-5.0/).
1919

2020
## Features and enhancements
2121

docs/sources/helm-charts/mimir-distributed/run-production-environment-with-helm/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ weight: 40
1010

1111
# Run Grafana Mimir in production using the Helm chart
1212

13-
In addition to the guide [Get started with Grafana Mimir using the Helm chart]({{< relref "../get-started-helm-charts" >}}),
13+
In addition to the guide [Get started with Grafana Mimir using the Helm chart](../get-started-helm-charts/),
1414
which covers setting up Grafana Mimir on a local Kubernetes cluster or
1515
within a low-risk development environment, you can prepare Grafana Mimir
1616
for production.
@@ -154,7 +154,7 @@ store_gateway:
154154
### Existing installations
155155
156156
If you are upgrading from a previous `mimir-distributed` Helm chart version
157-
to v4.0, then refer to the [migration guide]({{< relref "../migration-guides/migrate-from-single-zone-with-helm" >}}) to configure
157+
to v4.0, then refer to the [migration guide](../migration-guides/migrate-from-single-zone-with-helm/) to configure
158158
zone-aware replication.
159159

160160
## Configure Mimir to use object storage
@@ -286,7 +286,7 @@ Your Grafana Mimir cluster can now ingest metrics in production.
286286

287287
## Configure clients to write metrics to Mimir
288288

289-
To configure each client to remote-write metrics to Mimir, refer to [Configure Prometheus to write to Grafana Mimir]({{< relref "../get-started-helm-charts#configure-prometheus-to-write-to-grafana-mimir" >}})
289+
To configure each client to remote-write metrics to Mimir, refer to [Configure Prometheus to write to Grafana Mimir](../get-started-helm-charts/#configure-prometheus-to-write-to-grafana-mimir)
290290
and [Configure Grafana Alloy to write to Grafana Mimir](https://grafana.com/docs/helm-charts/mimir-distributed/latest/get-started-helm-charts/#configure-grafana-alloy-to-write-to-grafana-mimir).
291291

292292
## Set up redundant Prometheus or Grafana Alloy instances for high availability
@@ -295,7 +295,7 @@ If you need redundancy on the write path before it reaches Mimir, then you
295295
can set up redundant instances of Prometheus or Grafana Alloy to
296296
write metrics to Mimir.
297297

298-
For more information, see [Configure high-availability deduplication with Consul]({{< relref "./configure-helm-ha-deduplication-consul" >}}).
298+
For more information, see [Configure high-availability deduplication with Consul](configure-helm-ha-deduplication-consul/).
299299

300300
## Deploy on OpenShift
301301

docs/sources/helm-charts/mimir-distributed/run-production-environment-with-helm/configure-helm-ha-deduplication-consul/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ If the table is empty, it means there is something wrong with the configuration.
149149

150150
### Distributor metrics
151151

152-
If you have set up [metamonitoring]({{< relref "../monitor-system-health.md" >}}) or if you
152+
If you have set up [metamonitoring](../monitor-system-health/) or if you
153153
run GEM with built-in system monitoring,
154154
Mimir [distributor](https://grafana.com/docs/mimir/<MIMIR_VERSION>/references/architecture/components/distributor/)
155155
exposes some metrics related to HA deduplication. The relevant metrics are those with `cortex_ha_tracker_` prefix.

0 commit comments

Comments
 (0)