[loki] Set deploymentMode to Monolithic

Signed-off-by: Jan-Otto Kröpke <mail@jkroepke.de>

Author: jkroepke

charts/loki/Chart.yaml

@@ -4,7 +4,7 @@ description: Helm chart for Grafana Loki supporting monolithic, simple scalable,
 type: application
 # renovate: docker=docker.io/grafana/loki
 appVersion: 3.7.1
-version: 11.4.5
+version: 12.0.0
 kubeVersion: ">=1.25.0-0"
 home: https://grafana-community.github.io/helm-charts
 sources:

charts/loki/README.md

@@ -53,6 +53,15 @@ See the [changelog](https://grafana-community.github.io/helm-charts/changelog/?c
 
 ## Upgrading
 
+### From 11.x to 12.0.0 ([#258](https://github.com/grafana-community/helm-charts/pull/258))
+
+The `deploymentMode` default value has been changed to `Monolithic`. `SingleBinary` has been renamed to `Monolithic`. 
+The old naming `SingleBinary` is still supported. `SimpleScalable` is still supported but will be removed in Loki 4.0.0.
+
+Actions required:
+- If you are using `SimpleScalable` deployment mode, you have to explicitly set `deploymentMode: SimpleScalable` in your values file to avoid breaking changes. Consider migrating to `Monolithic` deployment mode as `SimpleScalable` will be removed in Loki 4.0.0.
+- If you are using `SingleBinary` deployment mode, you have to explicitly set `deploymentMode: Monolithic` in your values file to avoid breaking changes.
+
 ### From 10.x to 11.0.0 ([#273](https://github.com/grafana-community/helm-charts/pull/273))
 
 The `read.legacyReadTarget` option has been removed. Simple scalable deployments always requires a dedicated backend target.

…ult-single-binary-filesystem-values.yaml …efault-monolithic-filesystem-values.yamlcharts/loki/ci/default-single-binary-filesystem-values.yaml renamed to charts/loki/ci/default-monolithic-filesystem-values.yaml charts/loki/ci/default-single-binary-filesystem-values.yaml renamed to charts/loki/ci/default-monolithic-filesystem-values.yaml

@@ -8,12 +8,13 @@ loki:
       chunks: chunks
       ruler: ruler
       admin: admin
-deploymentMode: SingleBinary
-singleBinary:
-  replicas: 1
+deploymentMode: SimpleScalable
 read:
-  replicas: 0
+  replicas: 1
 write:
-  replicas: 0
+  replicas: 1
 backend:
-  replicas: 0
+  replicas: 1
+sidecar:
+  rules:
+    enabled: true

…oki/ci/default-single-binary-values.yaml charts/loki/ci/default-ssd-values.yamlcharts/loki/ci/default-single-binary-values.yaml renamed to charts/loki/ci/default-ssd-values.yaml charts/loki/ci/default-single-binary-values.yaml renamed to charts/loki/ci/default-ssd-values.yaml

@@ -8,12 +8,15 @@ loki:
       chunks: chunks
       ruler: ruler
       admin: admin
-read:
+deploymentMode: Monolithic
+singleBinary:
   replicas: 1
+read:
+  replicas: 0
 write:
-  replicas: 1
+  replicas: 0
 backend:
-  replicas: 1
+  replicas: 0
 
 sidecar:
   rules:

charts/loki/ci/default-values.yaml

@@ -1,4 +1,5 @@
 ---
+deploymentMode: SimpleScalable
 gateway:
   ingress:
     enabled: true

charts/loki/ci/ingress-values.yaml

@@ -1,7 +1,7 @@
 ---
 commonLabels:
   labelA: valueA
-  labelA: valueB
+  labelB: valueB
 loki:
   commonConfig:
     replication_factor: 1
@@ -31,7 +31,7 @@ loki:
 #          - path: /
 #            pathType: Prefix
 
-deploymentMode: SingleBinary
+deploymentMode: Monolithic
 singleBinary:
   replicas: 1
   resources:

charts/loki/single-binary-values.yaml charts/loki/monolithic-values.yamlcharts/loki/single-binary-values.yaml renamed to charts/loki/monolithic-values.yaml

@@ -17,7 +17,7 @@ If pods are taking too long to schedule make sure pod affinity can be fulfilled
 Installed components:
 ***********************************************************************
 
-{{- if eq (include "loki.deployment.isSingleBinary" .) "true" }}
+{{- if eq (include "loki.deployment.isMonolithic" .) "true" }}
 * loki
 {{- else -}}
 {{- if .Values.gateway.enabled }}
@@ -43,7 +43,7 @@ Installed components:
 {{- end }}
 
 
-{{- if eq (include "loki.deployment.isSingleBinary" .) "true" }}
+{{- if eq (include "loki.deployment.isMonolithic" .) "true" }}
 
 Loki has been deployed as a single binary.
 This means a single pod is handling reads and writes. You can scale that pod vertically by adding more CPU and memory resources.
@@ -68,9 +68,9 @@ You can send logs from inside the cluster using the cluster DNS:
 http://{{ include "loki.gatewayFullname" . }}.{{ include "loki.namespace" . }}.svc.{{ .Values.global.clusterDomain }}/loki/api/v1/push
 
 {{- else }}
-{{- if eq (include "loki.deployment.isSingleBinary" .) "true" }}
+{{- if eq (include "loki.deployment.isMonolithic" .) "true" }}
 
-http://{{ include "loki.singleBinaryFullname" . }}.{{ include "loki.namespace" . }}.svc.{{ .Values.global.clusterDomain }}:{{ .Values.loki.server.http_listen_port }}/loki/api/v1/push
+http://{{ include "loki.monolithicFullname" . }}.{{ include "loki.namespace" . }}.svc.{{ .Values.global.clusterDomain }}:{{ .Values.loki.server.http_listen_port }}/loki/api/v1/push
 
 {{- end}}
 {{- if eq (include "loki.deployment.isScalable" .) "true" }}
@@ -91,9 +91,9 @@ You can test to send data from outside the cluster by port-forwarding the gatewa
   kubectl port-forward --namespace {{ include "loki.namespace" $ }} svc/{{ include "loki.gatewayFullname" . }} 3100:{{ .Values.gateway.service.port }} &
 
 {{- else }}
-{{- if eq (include "loki.deployment.isSingleBinary" .) "true" }}
+{{- if eq (include "loki.deployment.isMonolithic" .) "true" }}
 
-  kubectl port-forward --namespace {{ include "loki.namespace" $ }} svc/{{ include "loki.singleBinaryFullname" . }} 3100:{{ .Values.loki.server.http_listen_port }} &
+  kubectl port-forward --namespace {{ include "loki.namespace" $ }} svc/{{ include "loki.monolithicFullname" . }} 3100:{{ .Values.loki.server.http_listen_port }} &
 
 {{- end}}
 {{- if eq (include "loki.deployment.isScalable" .) "true" }}
@@ -135,9 +135,9 @@ If Grafana operates within the cluster, you'll set up a new Loki datasource by u
 http://{{ include "loki.gatewayFullname" . }}.{{ include "loki.namespace" . }}.svc.{{ .Values.global.clusterDomain }}/
 
 {{- else }}
-{{- if eq (include "loki.deployment.isSingleBinary" .) "true" }}
+{{- if eq (include "loki.deployment.isMonolithic" .) "true" }}
 
-http://{{ include "loki.singleBinaryFullname" . }}.{{ include "loki.namespace" . }}.svc.{{ .Values.global.clusterDomain }}:{{ .Values.loki.server.http_listen_port }}/
+http://{{ include "loki.monolithicFullname" . }}.{{ include "loki.namespace" . }}.svc.{{ .Values.global.clusterDomain }}:{{ .Values.loki.server.http_listen_port }}/
 
 {{- end}}
 {{- if eq (include "loki.deployment.isScalable" .) "true" }}

charts/loki/templates/NOTES.txt

@@ -29,9 +29,9 @@ Allow the release namespace to be overridden for multi-namespace deployments in
 {{- end -}}
 
 {{/*
-singleBinary fullname
+monolithic fullname
 */}}
-{{- define "loki.singleBinaryFullname" -}}
+{{- define "loki.monolithicFullname" -}}
 {{- if .Values.fullnameOverride -}}
 {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
 {{- else -}}
@@ -66,14 +66,14 @@ Params:
 Return if deployment mode is simple scalable
 */}}
 {{- define "loki.deployment.isScalable" -}}
-  {{- and (eq (include "loki.isUsingObjectStorage" . ) "true") (or (eq .Values.deploymentMode "SingleBinary<->SimpleScalable") (eq .Values.deploymentMode "SimpleScalable") (eq .Values.deploymentMode "SimpleScalable<->Distributed")) }}
+  {{- and (eq (include "loki.isUsingObjectStorage" . ) "true") (or (eq .Values.deploymentMode "SingleBinary<->SimpleScalable")  (eq .Values.deploymentMode "Monolithic<->SimpleScalable") (eq .Values.deploymentMode "SimpleScalable") (eq .Values.deploymentMode "SimpleScalable<->Distributed")) }}
 {{- end -}}
 
 {{/*
 Return if deployment mode is single binary
 */}}
-{{- define "loki.deployment.isSingleBinary" -}}
-  {{- or (eq .Values.deploymentMode "SingleBinary") (eq .Values.deploymentMode "SingleBinary<->SimpleScalable") }}
+{{- define "loki.deployment.isMonolithic" -}}
+  {{- or (eq .Values.deploymentMode "SingleBinary") (eq .Values.deploymentMode "Monolithic") (eq .Values.deploymentMode "SingleBinary<->SimpleScalable") (eq .Values.deploymentMode "Monolithic<->SimpleScalable") }}
 {{- end -}}
 
 {{/*
@@ -465,8 +465,8 @@ configMap:
 Generate list of ingress service paths based on deployment type
 */}}
 {{- define "loki.ingress.servicePaths" -}}
-{{- if (eq (include "loki.deployment.isSingleBinary" .) "true") -}}
-{{- include "loki.ingress.singleBinaryServicePaths" . }}
+{{- if (eq (include "loki.deployment.isMonolithic" .) "true") -}}
+{{- include "loki.ingress.monolithicServicePaths" . }}
 {{- else if (eq (include "loki.deployment.isDistributed" .) "true") -}}
 {{- include "loki.ingress.distributedServicePaths" . }}
 {{- else if and (eq (include "loki.deployment.isScalable" .) "true") -}}
@@ -504,8 +504,8 @@ Ingress service paths for simple scalable deployment when backend components wer
 {{/*
 Ingress service paths for single binary deployment
 */}}
-{{- define "loki.ingress.singleBinaryServicePaths" -}}
-{{- $serviceName := include "loki.singleBinaryFullname" . }}
+{{- define "loki.ingress.monolithicServicePaths" -}}
+{{- $serviceName := include "loki.monolithicFullname" . }}
 {{- include "loki.ingress.servicePath" (dict "ctx" . "serviceName" $serviceName "paths" .Values.ingress.paths.distributor )}}
 {{- include "loki.ingress.servicePath" (dict "ctx" . "serviceName" $serviceName "paths" .Values.ingress.paths.queryFrontend )}}
 {{- include "loki.ingress.servicePath" (dict "ctx" . "serviceName" $serviceName "paths" .Values.ingress.paths.ruler )}}
@@ -561,10 +561,10 @@ Create the service endpoint including port for MinIO.
 
 {{/* Determine the public host for the Loki cluster */}}
 {{- define "loki.host" -}}
-{{- $isSingleBinary := eq (include "loki.deployment.isSingleBinary" .) "true" -}}
+{{- $isMonolithic := eq (include "loki.deployment.isMonolithic" .) "true" -}}
 {{- $url := printf "%s.%s.svc.%s.:%s" (include "loki.resourceName" (dict "ctx" . "component" "gateway")) (include "loki.namespace" .) .Values.global.clusterDomain (.Values.gateway.service.port | toString)  }}
-{{- if and $isSingleBinary (not .Values.gateway.enabled)  }}
-  {{- $url = printf "%s.%s.svc.%s.:%s" (include "loki.singleBinaryFullname" .) (include "loki.namespace" .) .Values.global.clusterDomain (.Values.loki.server.http_listen_port | toString) }}
+{{- if and $isMonolithic (not .Values.gateway.enabled)  }}
+  {{- $url = printf "%s.%s.svc.%s.:%s" (include "loki.monolithicFullname" .) (include "loki.namespace" .) .Values.global.clusterDomain (.Values.loki.server.http_listen_port | toString) }}
 {{- end }}
 {{- printf "%s" $url -}}
 {{- end -}}
@@ -704,8 +704,8 @@ http {
     {{- $backendUrl = .Values.gateway.nginxConfig.customBackendUrl }}
     {{- end }}
 
-    {{- $singleBinaryHost := include "loki.singleBinaryFullname" . }}
-    {{- $singleBinaryUrl  := printf "%s://%s.%s.svc.%s:%s" $httpSchema $singleBinaryHost $namespace .Values.global.clusterDomain (.Values.loki.server.http_listen_port | toString) }}
+    {{- $monolithicHost := include "loki.monolithicFullname" . }}
+    {{- $monolithicUrl  := printf "%s://%s.%s.svc.%s:%s" $httpSchema $monolithicHost $namespace .Values.global.clusterDomain (.Values.loki.server.http_listen_port | toString) }}
 
     {{- $distributorHost := include "loki.resourceName" (dict "ctx" . "component" "distributor") }}
     {{- $ingesterHost := include "loki.resourceName" (dict "ctx" . "component" "ingester") }}
@@ -725,15 +725,15 @@ http {
     {{- $schedulerUrl := printf "%s://%s.%s.svc.%s:%s" $httpSchema $schedulerHost $namespace .Values.global.clusterDomain (.Values.loki.server.http_listen_port | toString) }}
     {{- $querierUrl := printf "%s://%s.%s.svc.%s:%s" $httpSchema $querierHost $namespace .Values.global.clusterDomain (.Values.loki.server.http_listen_port | toString) }}
 
-    {{- if eq (include "loki.deployment.isSingleBinary" .) "true"}}
-    {{- $distributorUrl = $singleBinaryUrl }}
-    {{- $ingesterUrl = $singleBinaryUrl }}
-    {{- $queryFrontendUrl = $singleBinaryUrl }}
-    {{- $indexGatewayUrl = $singleBinaryUrl }}
-    {{- $rulerUrl = $singleBinaryUrl }}
-    {{- $compactorUrl = $singleBinaryUrl }}
-    {{- $schedulerUrl = $singleBinaryUrl }}
-    {{- $querierUrl = $singleBinaryUrl }}
+    {{- if eq (include "loki.deployment.isMonolithic" .) "true"}}
+    {{- $distributorUrl = $monolithicUrl }}
+    {{- $ingesterUrl = $monolithicUrl }}
+    {{- $queryFrontendUrl = $monolithicUrl }}
+    {{- $indexGatewayUrl = $monolithicUrl }}
+    {{- $rulerUrl = $monolithicUrl }}
+    {{- $compactorUrl = $monolithicUrl }}
+    {{- $schedulerUrl = $monolithicUrl }}
+    {{- $querierUrl = $monolithicUrl }}
     {{- else if eq (include "loki.deployment.isScalable" .) "true"}}
     {{- $distributorUrl = $writeUrl }}
     {{- $ingesterUrl = $writeUrl }}
@@ -994,11 +994,11 @@ enableServiceLinks: false
 {{- define "loki.compactorAddress" -}}
 {{- $isSimpleScalable := eq (include "loki.deployment.isScalable" .) "true" -}}
 {{- $isDistributed := eq (include "loki.deployment.isDistributed" .) "true" -}}
-{{- $isSingleBinary := eq (include "loki.deployment.isSingleBinary" .) "true" -}}
+{{- $isMonolithic := eq (include "loki.deployment.isMonolithic" .) "true" -}}
 {{- $compactorAddress := include "loki.resourceName" (dict "ctx" . "component" "backend") -}}
-{{- if $isSingleBinary -}}
+{{- if $isMonolithic -}}
 {{/* single binary */}}
-{{- $compactorAddress = include "loki.singleBinaryFullname" . -}}
+{{- $compactorAddress = include "loki.monolithicFullname" . -}}
 {{/* distributed */}}
 {{- else if $isDistributed -}}
 {{- $compactorAddress = include "loki.resourceName" (dict "ctx" . "component" "compactor") -}}

charts/loki/templates/_helpers.tpl

@@ -17,7 +17,7 @@ metadata:
   {{- end }}
 spec:
 {{- if and (not .Values.backend.autoscaling.enabled) (not .Values.backend.kedaAutoscaling.enabled) }}
-  {{- if eq .Values.deploymentMode "SingleBinary" }}
+  {{- if or (eq .Values.deploymentMode "SingleBinary") (eq .Values.deploymentMode "Monolithic") }}
   replicas: 0
   {{- else }}
   replicas: {{ .Values.backend.replicas }}