docs: Helm: Don't show defaults for loki section (#12747)

(cherry picked from commit 1933f0e)

Author: DylanGuedes

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

@@ -3455,9 +3455,9 @@ null
 		<tr>
 			<td>gateway.basicAuth.htpasswd</td>
 			<td>string</td>
-			<td>Uses the specified users from the `loki.tenants` list to create the htpasswd file if `loki.tenants` is not set, the `gateway.basicAuth.username` and `gateway.basicAuth.password` are used The value is templated using `tpl`. Override this to use a custom htpasswd, e.g. in case the default causes high CPU load.</td>
-			<td><pre lang="json">
-"{{ if .Values.loki.tenants }}\n\n  {{- range $t := .Values.loki.tenants }}\n{{ htpasswd (required \"All tenants must have a 'name' set\" $t.name) (required \"All tenants must have a 'password' set\" $t.password) }}\n\n  {{- end }}\n{{ else }} {{ htpasswd (required \"'gateway.basicAuth.username' is required\" .Values.gateway.basicAuth.username) (required \"'gateway.basicAuth.password' is required\" .Values.gateway.basicAuth.password) }} {{ end }}"
+			<td>Uses the specified users from the `loki.tenants` list to create the htpasswd file. if `loki.tenants` is not set, the `gateway.basicAuth.username` and `gateway.basicAuth.password` are used. The value is templated using `tpl`. Override this to use a custom htpasswd, e.g. in case the default causes high CPU load.</td>
+			<td><pre lang="">
+Either `loki.tenants` or `gateway.basicAuth.username` and `gateway.basicAuth.password`.
 </pre>
 </td>
 		</tr>
@@ -5200,204 +5200,8 @@ null
 			<td>loki</td>
 			<td>object</td>
 			<td>Configuration for running Loki</td>
-			<td><pre lang="json">
-{
-  "analytics": {},
-  "annotations": {},
-  "auth_enabled": true,
-  "commonConfig": {
-    "compactor_address": "{{ include \"loki.compactorAddress\" . }}",
-    "path_prefix": "/var/loki",
-    "replication_factor": 3
-  },
-  "compactor": {},
-  "config": "{{- if .Values.enterprise.enabled}}\n{{- tpl .Values.enterprise.config . }}\n{{- else }}\nauth_enabled: {{ .Values.loki.auth_enabled }}\n{{- end }}\n\n{{- with .Values.loki.server }}\nserver:\n  {{- toYaml . | nindent 2}}\n{{- end}}\n\nmemberlist:\n{{- if .Values.loki.memberlistConfig }}\n  {{- toYaml .Values.loki.memberlistConfig | nindent 2 }}\n{{- else }}\n{{- if .Values.loki.extraMemberlistConfig}}\n{{- toYaml .Values.loki.extraMemberlistConfig | nindent 2}}\n{{- end }}\n  join_members:\n    - {{ include \"loki.memberlist\" . }}\n    {{- with .Values.migrate.fromDistributed }}\n    {{- if .enabled }}\n    - {{ .memberlistService }}\n    {{- end }}\n    {{- end }}\n{{- end }}\n\n{{- with .Values.loki.ingester }}\ningester:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\n{{- if .Values.loki.commonConfig}}\ncommon:\n{{- toYaml .Values.loki.commonConfig | nindent 2}}\n  storage:\n  {{- include \"loki.commonStorageConfig\" . | nindent 4}}\n{{- end}}\n\n{{- with .Values.loki.limits_config }}\nlimits_config:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\nruntime_config:\n  file: /etc/loki/runtime-config/runtime-config.yaml\n\n{{- with .Values.chunksCache }}\n{{- if .enabled }}\nchunk_store_config:\n  chunk_cache_config:\n    default_validity: {{ .defaultValidity }}\n    background:\n      writeback_goroutines: {{ .writebackParallelism }}\n      writeback_buffer: {{ .writebackBuffer }}\n      writeback_size_limit: {{ .writebackSizeLimit }}\n    memcached:\n      batch_size: {{ .batchSize }}\n      parallelism: {{ .parallelism }}\n    memcached_client:\n      addresses: dnssrvnoa+_memcached-client._tcp.{{ template \"loki.fullname\" $ }}-chunks-cache.{{ $.Release.Namespace }}.svc\n      consistent_hash: true\n      timeout: {{ .timeout }}\n      max_idle_conns: 72\n{{- end }}\n{{- end }}\n\n{{- if .Values.loki.schemaConfig }}\nschema_config:\n{{- toYaml .Values.loki.schemaConfig | nindent 2}}\n{{- end }}\n\n{{- if .Values.loki.useTestSchema }}\nschema_config:\n{{- toYaml .Values.loki.testSchemaConfig | nindent 2}}\n{{- end }}\n\n{{ include \"loki.rulerConfig\" . }}\n\n{{- if or .Values.tableManager.retention_deletes_enabled .Values.tableManager.retention_period }}\ntable_manager:\n  retention_deletes_enabled: {{ .Values.tableManager.retention_deletes_enabled }}\n  retention_period: {{ .Values.tableManager.retention_period }}\n{{- end }}\n\nquery_range:\n  align_queries_with_step: true\n  {{- with .Values.loki.query_range }}\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n  {{- end }}\n  {{- if .Values.resultsCache.enabled }}\n  {{- with .Values.resultsCache }}\n  cache_results: true\n  results_cache:\n    cache:\n      default_validity: {{ .defaultValidity }}\n      background:\n        writeback_goroutines: {{ .writebackParallelism }}\n        writeback_buffer: {{ .writebackBuffer }}\n        writeback_size_limit: {{ .writebackSizeLimit }}\n      memcached_client:\n        consistent_hash: true\n        addresses: dnssrvnoa+_memcached-client._tcp.{{ template \"loki.fullname\" $ }}-results-cache.{{ $.Release.Namespace }}.svc\n        timeout: {{ .timeout }}\n        update_interval: 1m\n  {{- end }}\n  {{- end }}\n\n{{- with .Values.loki.storage_config }}\nstorage_config:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\n{{- with .Values.loki.query_scheduler }}\nquery_scheduler:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\n{{- with .Values.loki.compactor }}\ncompactor:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\n{{- with .Values.loki.analytics }}\nanalytics:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\n{{- with .Values.loki.querier }}\nquerier:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\n{{- with .Values.loki.index_gateway }}\nindex_gateway:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\n{{- with .Values.loki.frontend }}\nfrontend:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\n{{- with .Values.loki.frontend_worker }}\nfrontend_worker:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\n{{- with .Values.loki.distributor }}\ndistributor:\n  {{- tpl (. | toYaml) $ | nindent 4 }}\n{{- end }}\n\ntracing:\n  enabled: {{ .Values.loki.tracing.enabled }}\n",
-  "configObjectName": "{{ include \"loki.name\" . }}",
-  "configStorageType": "ConfigMap",
-  "containerSecurityContext": {
-    "allowPrivilegeEscalation": false,
-    "capabilities": {
-      "drop": [
-        "ALL"
-      ]
-    },
-    "readOnlyRootFilesystem": true
-  },
-  "distributor": {},
-  "enableServiceLinks": true,
-  "extraMemberlistConfig": {},
-  "frontend": {
-    "scheduler_address": "{{ include \"loki.querySchedulerAddress\" . }}",
-    "tail_proxy_url": "{{ include \"loki.querierAddress\" . }}"
-  },
-  "frontend_worker": {
-    "scheduler_address": "{{ include \"loki.querySchedulerAddress\" . }}"
-  },
-  "generatedConfigObjectName": "{{ include \"loki.name\" . }}",
-  "image": {
-    "digest": null,
-    "pullPolicy": "IfNotPresent",
-    "registry": "docker.io",
-    "repository": "grafana/loki",
-    "tag": null
-  },
-  "index_gateway": {
-    "mode": "simple"
-  },
-  "ingester": {},
-  "limits_config": {
-    "max_cache_freshness_per_query": "10m",
-    "query_timeout": "300s",
-    "reject_old_samples": true,
-    "reject_old_samples_max_age": "168h",
-    "split_queries_by_interval": "15m"
-  },
-  "memberlistConfig": {},
-  "memcached": {
-    "chunk_cache": {
-      "batch_size": 256,
-      "enabled": false,
-      "host": "",
-      "parallelism": 10,
-      "service": "memcached-client"
-    },
-    "results_cache": {
-      "default_validity": "12h",
-      "enabled": false,
-      "host": "",
-      "service": "memcached-client",
-      "timeout": "500ms"
-    }
-  },
-  "podAnnotations": {},
-  "podLabels": {},
-  "podSecurityContext": {
-    "fsGroup": 10001,
-    "runAsGroup": 10001,
-    "runAsNonRoot": true,
-    "runAsUser": 10001
-  },
-  "querier": {},
-  "query_range": {},
-  "query_scheduler": {},
-  "readinessProbe": {
-    "httpGet": {
-      "path": "/ready",
-      "port": "http-metrics"
-    },
-    "initialDelaySeconds": 30,
-    "timeoutSeconds": 1
-  },
-  "revisionHistoryLimit": 10,
-  "rulerConfig": {},
-  "runtimeConfig": {},
-  "schemaConfig": {},
-  "server": {
-    "grpc_listen_port": 9095,
-    "http_listen_port": 3100,
-    "http_server_read_timeout": "600s",
-    "http_server_write_timeout": "600s"
-  },
-  "serviceAnnotations": {},
-  "serviceLabels": {},
-  "storage": {
-    "azure": {
-      "accountKey": null,
-      "accountName": null,
-      "connectionString": null,
-      "endpointSuffix": null,
-      "requestTimeout": null,
-      "useFederatedToken": false,
-      "useManagedIdentity": false,
-      "userAssignedId": null
-    },
-    "bucketNames": {
-      "admin": "admin",
-      "chunks": "chunks",
-      "ruler": "ruler"
-    },
-    "filesystem": {
-      "chunks_directory": "/var/loki/chunks",
-      "rules_directory": "/var/loki/rules"
-    },
-    "gcs": {
-      "chunkBufferSize": 0,
-      "enableHttp2": true,
-      "requestTimeout": "0s"
-    },
-    "s3": {
-      "accessKeyId": null,
-      "backoff_config": {},
-      "endpoint": null,
-      "http_config": {},
-      "insecure": false,
-      "region": null,
-      "s3": null,
-      "s3ForcePathStyle": false,
-      "secretAccessKey": null,
-      "signatureVersion": null
-    },
-    "swift": {
-      "auth_url": null,
-      "auth_version": null,
-      "connect_timeout": null,
-      "container_name": null,
-      "domain_id": null,
-      "domain_name": null,
-      "internal": null,
-      "max_retries": null,
-      "password": null,
-      "project_domain_id": null,
-      "project_domain_name": null,
-      "project_id": null,
-      "project_name": null,
-      "region_name": null,
-      "request_timeout": null,
-      "user_domain_id": null,
-      "user_domain_name": null,
-      "user_id": null,
-      "username": null
-    },
-    "type": "s3"
-  },
-  "storage_config": {
-    "boltdb_shipper": {
-      "index_gateway_client": {
-        "server_address": "{{ include \"loki.indexGatewayAddress\" . }}"
-      }
-    },
-    "hedging": {
-      "at": "250ms",
-      "max_per_second": 20,
-      "up_to": 3
-    },
-    "tsdb_shipper": {
-      "index_gateway_client": {
-        "server_address": "{{ include \"loki.indexGatewayAddress\" . }}"
-      }
-    }
-  },
-  "structuredConfig": {},
-  "tenants": [],
-  "testSchemaConfig": {
-    "configs": [
-      {
-        "from": "2024-04-01",
-        "index": {
-          "period": "24h",
-          "prefix": "index_"
-        },
-        "object_store": "filesystem",
-        "schema": "v13",
-        "store": "tsdb"
-      }
-    ]
-  },
-  "tracing": {
-    "enabled": false
-  },
-  "useTestSchema": false
-}
+			<td><pre lang="">
+See values.yaml
 </pre>
 </td>
 		</tr>

production/helm/loki/values.yaml

@@ -37,6 +37,7 @@ deploymentMode: SimpleScalable
 #
 ######################################################################################################################
 # -- Configuration for running Loki
+# @default -- See values.yaml
 loki:
   # Configures the readiness probe for all of the Loki pods
   readinessProbe:
@@ -1011,10 +1012,11 @@ gateway:
     username: null
     # -- The basic auth password for the gateway
     password: null
-    # -- Uses the specified users from the `loki.tenants` list to create the htpasswd file
-    # if `loki.tenants` is not set, the `gateway.basicAuth.username` and `gateway.basicAuth.password` are used
+    # -- Uses the specified users from the `loki.tenants` list to create the htpasswd file.
+    # if `loki.tenants` is not set, the `gateway.basicAuth.username` and `gateway.basicAuth.password` are used.
     # The value is templated using `tpl`. Override this to use a custom htpasswd, e.g. in case the default causes
     # high CPU load.
+    # @default -- Either `loki.tenants` or `gateway.basicAuth.username` and `gateway.basicAuth.password`.
     htpasswd: >-
       {{ if .Values.loki.tenants }}