[Docs] Update Helm installation to include backend (#11191)

**What this PR does / why we need it**:
Updates the Helm Charts documentation to include `backend` target
Fixes broken links

**Which issue(s) this PR fixes**:
Fixes #11189

**Special notes for your reviewer**:
I walked through this with @monodot earlier today.

Co-authored-by: Michel Hollands <42814411+MichelHollands@users.noreply.github.com>
pull/11199/head^2
J Stickler 2 years ago committed by GitHub
parent 1d90a8b956
commit 10a21cfe9b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      docs/sources/send-data/promtail/pipelines.md
  2. 2
      docs/sources/send-data/promtail/stages/match.md
  3. 109
      docs/sources/setup/install/helm/install-scalable/_index.md

@ -203,5 +203,5 @@ given log entry.
## Stages
Refer to the [Promtail Stages Configuration Reference]({{< relref "./stages/_index.md#prometheus-pipeline-stages" >}}) for the
Refer to the [Promtail Stages Configuration Reference]({{< relref "./stages/_index.md#promtail-pipeline-stages" >}}) for the
schema on the various supported stages supported.

@ -48,7 +48,7 @@ match:
[<stages>...]
```
Refer to the [Promtail Stages Configuration Reference]({{< relref "./_index.md#prometheus-pipeline-stages" >}}) for the
Refer to the [Promtail Stages Configuration Reference]({{< relref "./_index.md#promtail-pipeline-stages" >}}) for the
schema on the various stages supported here.
### Example

@ -13,70 +13,83 @@ keywords:
<!-- vale Grafana.Quotes = NO -->
<!-- vale Grafana.Quotes = YES -->
This Helm Chart installation runs the Grafana Loki cluster within a Kubernetes cluster.
This Helm Chart deploys Grafana Loki on Kubernetes.
If object storge is configured, this chart configures Loki to run `read` and `write` targets in a [scalable mode]({{< relref "../../../../get-started/deployment-modes#simple-scalable" >}}), highly available architecture (3 replicas of each) designed to work with AWS S3 object storage. It will also configure meta-monitoring of metrics and logs.
This chart configures Loki to run `read`, `write`, and `backend` targets in a [scalable mode]({{< relref "../../../../get-started/deployment-modes#simple-scalable" >}}), highly available architecture designed to work with AWS S3 object storage. The chart also supports self-monitoring or meta-monitoring by deploying Grafana Agent to monitor Loki itself, by scraping its metrics and logs.
It is not possible to run the scalable mode with the `filesystem` storage.
The default Helm chart deploys the following components:
- Read component (3 replicas)
- Write component (3 replicas)
- Backend component (3 replicas)
- Loki Canary (1 DaemonSet)
- Gateway (1 NGINX replica)
- Minio (optional, if `minio.enabled=true`)
- Grafana Agent Operator + Grafana Agent (1 DaemonSet) - configured to monitor the Loki application.
**Before you begin:**
<!--TODO - Update when meta-monitoring chart releases-->
It is not recommended to run scalable mode with `filesystem` storage.
**Prerequisites**
- Helm 3 or above. See [Installing Helm](https://helm.sh/docs/intro/install/).
- A running Kubernetes cluster.
- A Prometheus operator installation in case meta-monitoring should be used.
- Optionally a Memcached deployment for better performance. Consult the [caching section]({{< relref "../../../../operations/caching" >}}) on how to configure Memcached.
- (Optional) A Memcached deployment for better query performance. For information on configuring Memcached, refer to [caching section]({{< relref "../../../../operations/caching" >}}).
**To deploy Loki in simple scalable mode:**
**To deploy Loki in scalable mode:**
1. Add [Grafana's chart repository](https://github.com/grafana/helm-charts) to Helm:
```bash
helm repo add grafana https://grafana.github.io/helm-charts
```
```bash
helm repo add grafana https://grafana.github.io/helm-charts
```
1. Update the chart repository:
```bash
helm repo update
```
```bash
helm repo update
```
1. Configure the object storage:
- Create the configuration file `values.yaml`. The example below illustrates a s3 configuration:
```yaml
loki:
storage:
bucketNames:
chunks: chunks
ruler: ruler
admin: admin
type: s3
s3:
endpoint: <endpoint>
region: <AWS region>
secretAccessKey: <AWS secret access key>
accessKeyId: <AWS access key ID>
s3ForcePathStyle: false
insecure: false
```
Consult the [Reference]({{< relref "../reference" >}}) for configuring other storage providers.
- If you're just trying things, you can use the following configuration instead, that sets MinIO as storage:
```yaml
minio:
enabled: true
```
- Create the configuration file `values.yaml`. The example below illustrates a s3 configuration:
```yaml
loki:
storage:
bucketNames:
chunks: chunks
ruler: ruler
admin: admin
type: s3
s3:
endpoint: <endpoint>
region: <AWS region>
secretAccessKey: <AWS secret access key>
accessKeyId: <AWS access key ID>
s3ForcePathStyle: false
insecure: false
```
To configure other storage providers, refer to the [Helm Chart Reference]({{< relref "../reference" >}}).
- If you're just trying things, you can use the following configuration, that sets MinIO as storage:
```yaml
minio:
enabled: true
```
1. Install or upgrade the Loki deployment.
- To install:
```bash
helm install --values values.yaml loki grafana/loki
```
- To upgrade:
- To install:
```bash
helm upgrade --values values.yaml loki grafana/loki
```
helm install --values values.yaml loki grafana/loki
```
- To upgrade:
```bash
helm upgrade --values values.yaml loki grafana/loki
```
## Next Steps
Configure an agent to [send log data to Loki](/docs/loki/latest/send-data/).

Loading…
Cancel
Save