This Helm Chart installation runs the Grafana Loki *single binary* within a Kubernetes cluster.
If the storage type is set to `filesystem`, this chart configures Loki to run the `all` target in a [monolithic mode]({{<relref "../../../fundamentals/architecture/deployment-modes#monolithic-mode">}}), designed to work with a filesystem storage. It will also configure meta-monitoring of metrics and logs.
It is not possible to install the single binary with a different storage type.
If you set the `singleBinary.replicas` value to 1, this chart configures Loki to run the `all` target in a [monolithic mode]({{<relref "../../../fundamentals/architecture/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 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**
@ -35,9 +34,9 @@ It is not possible to install the single binary with a different storage type.
helm repo update
```
1. Configure the `filesystem` storage:
1. Create the configuration file `values.yaml`:
- Create the configuration file `values.yaml`:
- If running a single replica of Loki, configure the `filesystem` storage:
```yaml
loki:
@ -45,6 +44,25 @@ It is not possible to install the single binary with a different storage type.
replication_factor: 1
storage:
type: 'filesystem'
singleBinary:
replicas: 1
```
- If running Loki with a replication factor greater than 1, set the desired number replicas and provide object storage credentials:
```yaml
loki:
commonConfig:
replication_factor: 3
storage:
type: 's3'
s3:
endpoint: foo.aws.com
bucketnames: loki-chunks
secret_access_key: supersecret
access_key_id: secret
singleBinary:
replicas: 3
```
1. Deploy the Loki cluster using one of these commands.
@ -58,5 +76,5 @@ It is not possible to install the single binary with a different storage type.
- Deploy with the defined configuration in a custom Kubernetes cluster namespace:
By default this Helm Chart configures meta-monitoring of metrics (service monitoring) and logs (self monitoring).
The `ServiceMonitor` resource works with either the Prometheus Operator or the Grafana Agent Operator, and defines how Loki's metrics should be scraped. Scraping this Loki cluster using the scrape config defined in the `ServiceMonitor` resource is required for the included dashboards to work. A `MetricsInstance` can be configured to write the metrics to a remote Prometheus instance such as Grafana Cloud Metrics.
The `ServiceMonitor` resource works with either the Prometheus Operator or the Grafana Agent Operator, and defines how Loki's metrics should be scraped. Scraping this Loki cluster using the scrape config defined in the `SerivceMonitor` resource is required for the included dashboards to work. A `MetricsInstance` can be configured to write the metrics to a remote Prometheus instance such as Grafana Cloud Metrics.
_Self monitoring_ is enabled by default. This will deploy a `GrafanaAgent`, `LogsInstance`, and `PodLogs` resource which will instruct the Grafana Agent Operator (installed seperately) on how to scrape this Loki cluster's logs and send them back to itself. Scraping this Loki cluster using the scrape config defined in the `PodLogs` resource is required for the included dashboards to work.
@ -13,6 +13,10 @@ Entries should include a reference to the pull request that introduced the chang
[//]: # (<AUTOMATED_UPDATES_LOCATOR> : do not remove this line. Add your changelog bellow this line. This locator is used by CI pipeline to find the place where to put changelog entry.)
## 4.5
- [ENHANCEMENT] Single binary mode is now possible for more than 1 replica, with a gateway and object storage backend.
## 4.4.2
- [CHANGE] Bump Loki version to 2.7.2 and GEL version to 1.6.1