Skip to content
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Experience with the following is recommended, but not essential:
- Understanding of what the `kubectl` command does.
- Understanding of what the `helm` command does.

> **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" >}}).
> **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/).

### Hardware requirements

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

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

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.
Expand Down Expand Up @@ -377,4 +377,4 @@ First install Grafana, and then add Mimir as a Prometheus data source.

You should be able to query metrics in [Grafana Explore](http://localhost:3000/explore),
as well as create dashboard panels by using your newly configured `Mimir` data source.
For more information, see [Monitor Grafana Mimir]({{< relref "../run-production-environment-with-helm/monitor-system-health.md" >}}).
For more information, see [Monitor Grafana Mimir](../run-production-environment-with-helm/monitor-system-health/).
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Depending on what version of the `mimir-distributed` Helm chart is installed cur

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.

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

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

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

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.

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

## Migrate alertmanager to zone-aware replication

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The `mimir-distributed` Helm chart version 5.0 and later does not install [PodSe
1. If `rbac.create` is `false` or `rbac.type` is `scc`, then there is nothing to do, skip the whole procedure.
1. Choose between the following options:
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.
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.
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.
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:
```yaml
rbac:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To learn about new features and enhancements in Grafana Mimir or GEM, see the re

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).

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

## Features and enhancements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To learn about new features and enhancements in Grafana Mimir or GEM, see the re

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).

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

## Features and enhancements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Grafana Labs is excited to announce version 5.0 of the Grafana Mimir Helm chart,

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).

> **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" >}}).
> **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/).

## Important changes

- **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" >}}).
- **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/).

## Features and enhancements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ weight: 40

# Run Grafana Mimir in production using the Helm chart

In addition to the guide [Get started with Grafana Mimir using the Helm chart]({{< relref "../get-started-helm-charts" >}}),
In addition to the guide [Get started with Grafana Mimir using the Helm chart](../get-started-helm-charts/),
which covers setting up Grafana Mimir on a local Kubernetes cluster or
within a low-risk development environment, you can prepare Grafana Mimir
for production.
Expand Down Expand Up @@ -154,7 +154,7 @@ store_gateway:
### Existing installations

If you are upgrading from a previous `mimir-distributed` Helm chart version
to v4.0, then refer to the [migration guide]({{< relref "../migration-guides/migrate-from-single-zone-with-helm" >}}) to configure
to v4.0, then refer to the [migration guide](../migration-guides/migrate-from-single-zone-with-helm/) to configure
zone-aware replication.

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

## Configure clients to write metrics to Mimir

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" >}})
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)
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).

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

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

Choose a reason for hiding this comment

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

🚫 [doc-validator] reported by reviewdog 🐶
The link to the project page 'configure-helm-ha-deduplication-consul/' is invalid.
Links to project pages must use a Hugo relref shortcode like {{< relref "./path/to/page" >}}.

Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md.


## Deploy on OpenShift

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ If the table is empty, it means there is something wrong with the configuration.

### Distributor metrics

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