From 8b653073ad095521f93fbb63ef51ff4ef51cfc82 Mon Sep 17 00:00:00 2001 From: Trevor Lichfield Date: Mon, 23 Sep 2024 14:19:58 -0600 Subject: [PATCH] docs: add additional clarification for single binary helm installation (#14144) Co-authored-by: J Stickler (cherry picked from commit de249454bf270de773370e9b4d6c0335a093d9bf) --- .../setup/install/helm/install-monolithic/_index.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/sources/setup/install/helm/install-monolithic/_index.md b/docs/sources/setup/install/helm/install-monolithic/_index.md index fd52c11c20034..4373907dcfbb1 100644 --- a/docs/sources/setup/install/helm/install-monolithic/_index.md +++ b/docs/sources/setup/install/helm/install-monolithic/_index.md @@ -12,7 +12,12 @@ weight: 100 This Helm Chart installation runs the Grafana Loki *single binary* within a Kubernetes cluster. -If you set the `singleBinary.replicas` value to 1 and set the deployment mode to `SingleBinary`, this chart configures Loki to run the `all` target in a [monolithic mode](https://grafana.com/docs/loki//get-started/deployment-modes/#monolithic-mode), designed to work with a filesystem storage. It will also configure meta-monitoring of metrics and logs. +If you set the `singleBinary.replicas` value to 1 and set the deployment mode to `SingleBinary`, this chart configures Loki to run the `all` target in a [monolithic mode](https://grafana.com/docs/loki//get-started/deployment-modes/#monolithic-mode), designed to work with the filesystem storage configuration. It will also configure meta-monitoring of metrics and logs. + +{{< admonition type="note" >}} +You must specify `commonConfig.replication_factor: 1` if you are only using 1 replica, otherwise requests will fail. +{{< /admonition >}} + If you set the `singleBinary.replicas` value to 2 or more, this chart configures Loki to run a *single binary* in a replicated, highly available mode. When running replicas of a single binary, you must configure object storage. **Before you begin: Software Requirements**