Merge pull request #3564 from ie-pham/tempogen

[tempo] rename overrides section

Author: ie-pham

charts/tempo/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: tempo
 description: Grafana Tempo Single Binary Mode
 type: application
-version: 1.18.3
+version: 1.19.0
 appVersion: 2.7.1
 engine: gotpl
 home: https://grafana.net

charts/tempo/README.md

@@ -1,6 +1,6 @@
 # tempo
 
-![Version: 1.18.3](https://img.shields.io/badge/Version-1.18.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.7.1](https://img.shields.io/badge/AppVersion-2.7.1-informational?style=flat-square)
+![Version: 1.19.0](https://img.shields.io/badge/Version-1.19.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.7.1](https://img.shields.io/badge/AppVersion-2.7.1-informational?style=flat-square)
 
 Grafana Tempo Single Binary Mode
 
@@ -61,7 +61,6 @@ Grafana Tempo Single Binary Mode
 | tempo.extraEnv | list | `[]` | Environment variables to add |
 | tempo.extraEnvFrom | list | `[]` | Environment variables from secrets or configmaps to add to the ingester pods |
 | tempo.extraVolumeMounts | list | `[]` | Volume mounts to add |
-| tempo.global_overrides.per_tenant_override_config | string | `"/conf/overrides.yaml"` |  |
 | tempo.ingester | object | `{}` | Configuration options for the ingester. Refers to: https://grafana.com/docs/tempo/latest/configuration/#ingester |
 | tempo.livenessProbe.failureThreshold | int | `3` |  |
 | tempo.livenessProbe.httpGet.path | string | `"/ready"` |  |
@@ -74,7 +73,10 @@ Grafana Tempo Single Binary Mode
 | tempo.metricsGenerator.enabled | bool | `false` | If true, enables Tempo's metrics generator (https://grafana.com/docs/tempo/next/metrics-generator/) |
 | tempo.metricsGenerator.remoteWriteUrl | string | `"http://prometheus.monitoring:9090/api/v1/write"` |  |
 | tempo.multitenancyEnabled | bool | `false` |  |
-| tempo.overrides | object | `{}` |  |
+| tempo.overrides | object | `{"defaults":{},"per_tenant_override_config":"/conf/overrides.yaml"}` | The standard overrides configuration section. This can include a `defaults` object for applying to all tenants (not to be confused with the `global` property of the same name, which overrides `max_byte_per_trace` for all tenants). For an example on how to enable the metrics generator using the `overrides` object, see the 'Activate metrics generator' section below. Refer to [Standard overrides](https://grafana.com/docs/tempo/latest/configuration/#standard-overrides) for more details. |
+| tempo.overrides.defaults | object | `{}` | Default config values for all tenants, can be overridden by per-tenant overrides. If a tenant's specific overrides are not found in the `per_tenant_overrides` block, the values in this `default` block will be used. Configs inside this block should follow the new overrides indentation format |
+| tempo.overrides.per_tenant_override_config | string | `"/conf/overrides.yaml"` | Path to the per tenant override config file. The values of the `per_tenant_overrides` config below will be written to the default path `/conf/overrides.yaml`. Users can set tenant-specific overrides settings in a separate file and point per_tenant_override_config to it if not using the per_tenant_overrides block below. |
+| tempo.per_tenant_overrides | object | `{}` | The `per tenant` aka `tenant-specific` runtime overrides. This allows overriding values set in the configuration on a per-tenant basis. Note that *all* values must be given for each per-tenant configuration block. Refer to [Runtime overrides](https://grafana.com/docs/tempo/latest/configuration/#runtime-overrides) and [Tenant-Specific overrides](https://grafana.com/docs/tempo/latest/configuration/#tenant-specific-overrides) documentation for more details. |
 | tempo.pullPolicy | string | `"IfNotPresent"` |  |
 | tempo.querier | object | `{}` | Configuration options for the querier. Refers to: https://grafana.com/docs/tempo/latest/configuration/#querier |
 | tempo.queryFrontend | object | `{}` | Configuration options for the query-fronted. Refers to: https://grafana.com/docs/tempo/latest/configuration/#query-frontend |
@@ -153,6 +155,13 @@ The command removes all the Kubernetes components associated with the chart and
 
 A major chart version change indicates that there is an incompatible breaking change needing manual actions.
 
+### From Chart versions < 1.19.0
+* Breaking Change *
+In order to reduce confusion, the overrides configurations have been renamed as below. 
+
+`global_overrides` =>  `overrides` (this is where the defaults for every tenant is set)
+`overrides` => `per_tenant_overrides` (this is where configurations for specific tenants can be set)
+
 ### From Chart versions < 1.17.0
 
 Please be aware that we've updated the Tempo version to 2.7, which includes some breaking changes

charts/tempo/README.md.gotmpl

@@ -40,6 +40,13 @@ The command removes all the Kubernetes components associated with the chart and
 
 A major chart version change indicates that there is an incompatible breaking change needing manual actions.
 
+### From Chart versions < 1.19.0
+* Breaking Change *
+In order to reduce confusion, the overrides configurations have been renamed as below.  
+
+`global_overrides` =>  `overrides` (this is where the defaults for every tenant is set)
+`overrides` => `per_tenant_overrides` (this is where configurations for specific tenants can be set)
+
 ### From Chart versions < 1.17.0
 
 Please be aware that we've updated the Tempo version to 2.7, which includes some breaking changes

charts/tempo/templates/configmap-tempo.yaml

@@ -8,6 +8,6 @@ metadata:
 data:
   overrides.yaml: |
     overrides:
-      {{- toYaml .Values.tempo.overrides | nindent 6 }}
+      {{- toYaml .Values.tempo.per_tenant_overrides | nindent 6 }}
   tempo.yaml: |
     {{- tpl .Values.config . | nindent 4 }}

charts/tempo/values.yaml

@@ -65,10 +65,24 @@ tempo:
   #  search:
   #    concurrent_jobs: 2000
   retention: 24h
-  # Global overrides
-  global_overrides:
+  # -- The standard overrides configuration section. This can include a `defaults` object for applying to all tenants (not to be confused with the `global` property of the same name, which overrides `max_byte_per_trace` for all tenants). For an example on how to enable the metrics generator using the `overrides` object, see the 'Activate metrics generator' section below. Refer to [Standard overrides](https://grafana.com/docs/tempo/latest/configuration/#standard-overrides) for more details.
+  overrides:
+    # -- Default config values for all tenants, can be overridden by per-tenant overrides. If a tenant's specific overrides are not found in the `per_tenant_overrides` block, the values in this `default` block will be used. Configs inside this block should follow the new overrides indentation format
+    defaults: {}
+    #  metrics_generator:
+    #    processors:
+    #      - service-graphs
+    #      - span-metrics
+
+    # -- Path to the per tenant override config file. The values of the `per_tenant_overrides` config below will be written to the default path `/conf/overrides.yaml`. Users can set tenant-specific overrides settings in a separate file and point per_tenant_override_config to it if not using the per_tenant_overrides block below.
     per_tenant_override_config: /conf/overrides.yaml
-  overrides: {}
+  # -- The `per tenant` aka `tenant-specific` runtime overrides. This allows overriding values set in the configuration on a per-tenant basis. Note that *all* values must be given for each per-tenant configuration block. Refer to [Runtime overrides](https://grafana.com/docs/tempo/latest/configuration/#runtime-overrides) and [Tenant-Specific overrides](https://grafana.com/docs/tempo/latest/configuration/#tenant-specific-overrides) documentation for more details.
+  per_tenant_overrides: {}
+    # 'tenant-id':
+    #  metrics_generator:
+    #    processors:
+    #      - service-graphs
+    #      - span-metrics
 
   # Tempo server configuration.
   # Refers to: https://grafana.com/docs/tempo/latest/configuration/#server
@@ -177,11 +191,8 @@ config: |
     query_frontend:
       {{- toYaml .Values.tempo.queryFrontend | nindent 6 }}
     overrides:
-      {{- toYaml .Values.tempo.global_overrides | nindent 6 }}
+      {{- toYaml .Values.tempo.overrides | nindent 6 }}
       {{- if .Values.tempo.metricsGenerator.enabled }}
-          metrics_generator_processors:
-          - 'service-graphs'
-          - 'span-metrics'
     metrics_generator:
           storage:
             path: "/tmp/tempo"