bitnamicharts/grafana-loki
Bitnami Helm chart for Grafana Loki
100K+
Grafana Loki is a horizontally scalable, highly available, and multi-tenant log aggregation system. It provides real-time long tailing and full persistence to object storage.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/grafana-loki
Looking to use Grafana Loki in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.
This chart bootstraps a Grafana Loki Deployment in a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/grafana-loki
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
The command deploys grafana-loki on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
The loki configuration file loki.yaml
is shared across the different components: distributor
, compactor
, ingester
, querier
and queryFrontend
. This is set in the loki.configuration
value. Check the official Loki Grafana documentation for the list of possible configurations.
This chart can be integrated with Prometheus by setting metrics.enabled
to true. This will expose the Grafana Loki native Prometheus port in both the containers and services. The services will also have the necessary annotations to be automatically scraped by Prometheus.
Prometheus requirements
It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.
Integration with Prometheus Operator
The chart can deploy ServiceMonitor
objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true
. Ensure that the Prometheus Operator CustomResourceDefinitions
are installed in the cluster or it will fail with the following error:
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars
property inside each of the subsections: distributor
, compactor
, ingester
, querier
, queryFrontend
and vulture
.
compactor:
extraEnvVars:
- name: LOG_LEVEL
value: error
distributor:
extraEnvVars:
- name: LOG_LEVEL
value: error
ingester:
extraEnvVars:
- name: LOG_LEVEL
value: error
querier:
extraEnvVars:
- name: LOG_LEVEL
value: error
queryFrontend:
extraEnvVars:
- name: LOG_LEVEL
value: error
vulture:
extraEnvVars:
- name: LOG_LEVEL
value: error
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM
or the extraEnvVarsSecret
values.
If additional containers are needed in the same pod as grafana-loki (such as additional metrics or logging exporters), they can be defined using the sidecars
parameter inside each of the subsections: distributor
, compactor
, ingester
, querier
, queryFrontend
and vulture
.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts
parameter (where available), as shown in the example below:
service:
extraPorts:
- name: extraPort
port: 11311
targetPort: 11311
NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the
--enable-metrics=true
parameter at deployment time. Thesidecars
parameter should therefore only be used for any extra sidecar containers.
If additional init containers are needed in the same pod, they can be defined using the initContainers
parameter. Here is an example:
initContainers:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Learn more about sidecar containers and init containers.
This chart allows you to set your custom affinity using the affinity
parameter. Find more information about Pod affinity in the kubernetes documentation.
As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters inside each of the subsections: distributor
, compactor
, ingester
, querier
, queryFrontend
and vulture
.
You may want to have Grafana Loki connect to an external Memcached rather than installing one inside your cluster. Typical reasons for this are to use a managed cache service, or to share a common cache server for all your applications. To achieve this, the chart allows you to specify credentials for an external database with the externalMemcached
parameter. You should also disable the Memcached installation with the memcached.enabled
option. Here is an example:
memcached.enabled=false
externalMemcached.host=myexternalhost
externalMemcached.port=11211
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
This chart does not function fully when using local filesystem as a persistence store. When using a local filesystem as a persistence store, querying will not be possible (or limited to the ingesters' in-memory caches). For a fully functional deployment of this helm chart, an object storage backend is required.
The Bitnami grafana-loki image stores the grafana-loki ingester
data at the /bitnami
path of the container. Persistent Volume Claims are used to keep the data across deployments.
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.storageClass | DEPRECATED: use global.defaultStorageClass instead | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Override Kubernetes version | "" |
nameOverride | String to partially override common.names.fullname | "" |
fullnameOverride | String to fully override common.names.fullname | "" |
commonLabels | Labels to add to all deployed objects | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
clusterDomain | Kubernetes cluster domain name | cluster.local |
extraDeploy | Array of extra objects to deploy with the release | [] |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | false |
diagnosticMode.command | Command to override all containers in the deployments/statefulsets | ["sleep"] |
diagnosticMode.args | Args to override all containers in the deployments/statefulsets | ["infinity"] |
Name | Description | Value |
---|---|---|
loki.image.registry | Grafana Loki image registry | REGISTRY_NAME |
loki.image.repository | Grafana Loki image repository | REPOSITORY_NAME/grafana-loki |
loki.image.digest | Grafana Loki image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
loki.image.pullPolicy | Grafana Loki image pull policy | IfNotPresent |
loki.image.pullSecrets | Grafana Loki image pull secrets | [] |
loki.configuration | Loki components configuration | "" |
loki.overrideConfiguration | Loki components configuration override. Values defined here takes precedence over loki.configuration | {} |
loki.existingConfigmap | Name of a ConfigMap with the Loki configuration | "" |
loki.dataDir | path to the Loki data directory | /bitnami/grafana-loki |
loki.containerPorts.http | Loki components web container port | 3100 |
loki.containerPorts.grpc | Loki components GRPC container port | 9095 |
loki.containerPorts.gossipRing | Loki components Gossip Ring container port | 7946 |
loki.gossipRing.service.ports.http | Gossip Ring HTTP headless service port | 7946 |
loki.gossipRing.service.annotations | Additional custom annotations for Gossip Ring headless service | {} |
Name | Description | Value |
---|---|---|
compactor.enabled | Enable Compactor deployment | true |
compactor.extraEnvVars | Array with extra environment variables to add to compactor nodes | [] |
compactor.extraEnvVarsCM | Name of existing ConfigMap containing extra env vars for compactor nodes | "" |
compactor.extraEnvVarsSecret | Name of existing Secret containing extra env vars for compactor nodes | "" |
compactor.command | Override default container command (useful when using custom images) | [] |
compactor.args | Override default container args (useful when using custom images) | [] |
compactor.extraArgs | Additional container args (will be concatenated to args, unless diagnosticMode is enabled) | [] |
compactor.replicaCount | Number of Compactor replicas to deploy | 1 |
compactor.livenessProbe.enabled | Enable livenessProbe on Compactor nodes | true |
compactor.livenessProbe.initialDelaySeconds | Initial delay seconds for livenessProbe | 60 |
compactor.livenessProbe.periodSeconds | Period seconds for livenessProbe | 10 |
compactor.livenessProbe.timeoutSeconds | Timeout seconds for livenessProbe | 1 |
compactor.livenessProbe.failureThreshold | Failure threshold for livenessProbe | 3 |
compactor.livenessProbe.successThreshold | Success threshold for livenessProbe | 1 |
compactor.readinessProbe.enabled | Enable readinessProbe on Compactor nodes | true |
compactor.readinessProbe.initialDelaySeconds | Initial delay seconds for readinessProbe | 60 |
compactor.readinessProbe.periodSeconds | Period seconds for readinessProbe | 10 |
compactor.readinessProbe.timeoutSeconds | Timeout seconds for readinessProbe | 1 |
compactor.readinessProbe.failureThreshold | Failure threshold for readinessPro |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/grafana-loki/README.md