fix(helm): only default bucket names when using minio (#12548)

Author: trevorwhitney

Makefile

@@ -191,6 +191,9 @@ production/helm/loki/src/helm-test/helm-test:
 helm-lint: ## run helm linter
 	$(MAKE) -BC production/helm/loki lint
 
+helm-docs:
+	helm-docs -c production/helm/loki -g production/helm/loki
+
 #################
 # Loki-QueryTee #
 #################

docs/sources/setup/install/helm/reference.md

@@ -2572,7 +2572,7 @@ null
   },
   "canarySecret": null,
   "cluster_name": null,
-  "config": "{{- if .Values.enterprise.adminApi.enabled }}\n{{- if or .Values.minio.enabled (eq .Values.loki.storage.type \"s3\") (eq .Values.loki.storage.type \"gcs\") (eq .Values.loki.storage.type \"azure\") }}\nadmin_client:\n  storage:\n    s3:\n      bucket_name: {{ .Values.loki.storage.bucketNames.admin }}\n{{- end }}\n{{- end }}\nauth:\n  type: {{ .Values.enterprise.adminApi.enabled | ternary \"enterprise\" \"trust\" }}\nauth_enabled: {{ .Values.loki.auth_enabled }}\ncluster_name: {{ include \"loki.clusterName\" . }}\nlicense:\n  path: /etc/loki/license/license.jwt\n",
+  "config": "{{- if .Values.enterprise.adminApi.enabled }}\n{{- if or .Values.minio.enabled (eq .Values.loki.storage.type \"s3\") (eq .Values.loki.storage.type \"gcs\") (eq .Values.loki.storage.type \"azure\") }}\nadmin_client:\n  storage:\n    s3:\n      bucket_name: admin\n{{- end }}\n{{- end }}\nauth:\n  type: {{ .Values.enterprise.adminApi.enabled | ternary \"enterprise\" \"trust\" }}\nauth_enabled: {{ .Values.loki.auth_enabled }}\ncluster_name: {{ include \"loki.clusterName\" . }}\nlicense:\n  path: /etc/loki/license/license.jwt\n",
   "enabled": false,
   "externalConfigName": "",
   "externalLicenseName": null,
@@ -5311,11 +5311,6 @@ null
       "useManagedIdentity": false,
       "userAssignedId": null
     },
-    "bucketNames": {
-      "admin": "admin",
-      "chunks": "chunks",
-      "ruler": "ruler"
-    },
     "filesystem": {
       "chunks_directory": "/var/loki/chunks",
       "rules_directory": "/var/loki/rules"
@@ -5777,11 +5772,6 @@ null
     "useManagedIdentity": false,
     "userAssignedId": null
   },
-  "bucketNames": {
-    "admin": "admin",
-    "chunks": "chunks",
-    "ruler": "ruler"
-  },
   "filesystem": {
     "chunks_directory": "/var/loki/chunks",
     "rules_directory": "/var/loki/rules"

production/helm/loki/Chart.yaml

@@ -3,7 +3,7 @@ name: loki
 description: Helm chart for Grafana Loki in simple, scalable mode
 type: application
 appVersion: 3.0.0
-version: 6.0.0
+version: 6.1.0
 home: https://grafana.github.io/helm-charts
 sources:
   - https://github.com/grafana/loki

production/helm/loki/README.md

@@ -1,6 +1,6 @@
 # loki
 
-![Version: 6.0.0](https://img.shields.io/badge/Version-6.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.0.0](https://img.shields.io/badge/AppVersion-3.0.0-informational?style=flat-square)
+![Version: 6.1.0](https://img.shields.io/badge/Version-6.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 3.0.0](https://img.shields.io/badge/AppVersion-3.0.0-informational?style=flat-square)
 
 Helm chart for Grafana Loki in simple, scalable mode
 

production/helm/loki/ci/default-single-binary-values.yaml

@@ -3,6 +3,11 @@ loki:
   commonConfig:
     replication_factor: 1
   useTestSchema: true
+  storage:
+    bucketNames:
+      chunks: chunks
+      ruler: ruler
+      admin: admin
 deploymentMode: SingleBinary
 singleBinary:
   replicas: 1

production/helm/loki/ci/default-values.yaml

@@ -3,6 +3,11 @@ loki:
   commonConfig:
     replication_factor: 1
   useTestSchema: true
+  storage:
+    bucketNames:
+      chunks: chunks
+      ruler: ruler
+      admin: admin
 read:
   replicas: 1
 write:

production/helm/loki/ci/ingress-values.yaml

@@ -12,6 +12,11 @@ loki:
   commonConfig:
     replication_factor: 1
   useTestSchema: true
+  storage:
+    bucketNames:
+      chunks: chunks
+      ruler: ruler
+      admin: admin
 read:
   replicas: 1
 write:

production/helm/loki/ci/legacy-monitoring-values.yaml

@@ -3,6 +3,11 @@ loki:
   commonConfig:
     replication_factor: 1
   useTestSchema: true
+  storage:
+    bucketNames:
+      chunks: chunks
+      ruler: ruler
+      admin: admin
 read:
   replicas: 1
 write:

production/helm/loki/templates/_helpers.tpl

@@ -208,7 +208,7 @@ Generated storage config for loki common config
 {{- if .Values.minio.enabled -}}
 s3:
   endpoint: {{ include "loki.minio" $ }}
-  bucketnames: {{ $.Values.loki.storage.bucketNames.chunks }}
+  bucketnames: chunks
   secret_access_key: {{ $.Values.minio.rootPassword }}
   access_key_id: {{ $.Values.minio.rootUser }}
   s3forcepathstyle: true
@@ -346,7 +346,7 @@ Storage config for ruler
 {{- if .Values.minio.enabled -}}
 type: "s3"
 s3:
-  bucketnames: {{ $.Values.loki.storage.bucketNames.ruler }}
+  bucketnames: ruler
 {{- else if eq .Values.loki.storage.type "s3" -}}
 {{- with .Values.loki.storage.s3 }}
 type: "s3"

production/helm/loki/values.yaml

@@ -311,10 +311,12 @@ loki:
     compactor_address: '{{ include "loki.compactorAddress" . }}'
   # -- Storage config. Providing this will automatically populate all necessary storage configs in the templated config.
   storage:
-    bucketNames:
-      chunks: chunks
-      ruler: ruler
-      admin: admin
+    # Loki requires a bucket for chunks and the ruler. GEL requires a third bucket for the admin API.
+    # Please provide these values if you are using object storage.
+    # bucketNames:
+    #   chunks: FIXME
+    #   ruler: FIXME
+    #   admin: FIXME
     type: s3
     s3:
       s3: null
@@ -477,7 +479,7 @@ enterprise:
     admin_client:
       storage:
         s3:
-          bucket_name: {{ .Values.loki.storage.bucketNames.admin }}
+          bucket_name: admin
     {{- end }}
     {{- end }}
     auth: