Add doc about configuring TLS with Helm (#4328)

* Add doc about configuring TLS with Helm * Add memberlist and readinessProbe to example * Include server config for listening on TLS * Add note about scraping * Update docs/sources/tempo/configuration/network/tls.md Co-authored-by: Markus Toivonen <markus.toivonen@hoxhunt.com> * Update docs/sources/tempo/configuration/network/tls.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Update docs/sources/tempo/configuration/network/tls.md Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com> * Add memcached config for TLS --------- Co-authored-by: Markus Toivonen <markus.toivonen@hoxhunt.com> Co-authored-by: Kim Nylander <104772500+knylander-grafana@users.noreply.github.com>
grafana · Nov 18, 2024 · 7f6ae16 · 7f6ae16
1 parent 9cef442
commit 7f6ae16
Showing 1 changed file with 158 additions and 2 deletions.
diff --git a/docs/sources/tempo/configuration/network/tls.md b/docs/sources/tempo/configuration/network/tls.md
@@ -77,7 +77,7 @@ memberlist:
 
 ### Receiver TLS
 
-Additional receiver configuration can be added to support TLS communication for traces being sent to Tempo. The receiver configuration is pulled in from the Open Telemetry collector, and is [documented upstream here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/receiver/otlpreceiver/config.md#configtls-tlsserversetting).
+Additional receiver configuration can be added to support TLS communication for traces being sent to Tempo. The receiver configuration is pulled in from the Open Telemetry collector, and is [documented upstream here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/receiver/otlpreceiver/config.md#configtls-tlsserversetting). Addition TLS configuration of OTEL components can be found [here](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configtls).
 
 An example `tls` block might look like the following:
 
@@ -86,7 +86,7 @@ tls:
   ca_file: /tls/ca.crt
   cert_file: /tls/tls.crt
   key_file: /tls/tls.key
-  min_version: VersionTLS12
+  min_version: "1.2"
 ```
 
 The above structure can be set on the following receiver configurations:
@@ -96,3 +96,159 @@ The above structure can be set on the following receiver configurations:
 - `distributor.receivers.zipkin.tls`
 - `distributor.receivers.jaeger.protocols.grpc.tls`
 - `distributor.receivers.jaeger.protocols.thrift_http.tls`
+
+### Configure TLS with Helm
+
+To configure TLS with the Helm chart, you must have a TLS key-pair and CA certificate stored in a Kubernetes secret.
+The following example mounts a secret called `tempo-distributed-tls` into the pods at `/tls` and modifies the configuration of Tempo to make use of the files.
+In this example, the Tempo components share a single TLS certificate.
+Note that the `tls_server_name` configuration must match the certificate.
+
+```yaml
+compactor:
+  extraVolumeMounts:
+    - mountPath: /tls
+      name: tempo-distributed-tls
+  extraVolumes:
+    - name: tempo-distributed-tls
+      secret:
+        secretName: tempo-distributed-tls
+distributor:
+  extraVolumeMounts:
+    - mountPath: /tls
+      name: tempo-distributed-tls
+  extraVolumes:
+    - name: tempo-distributed-tls
+      secret:
+        secretName: tempo-distributed-tls
+ingester:
+  extraVolumeMounts:
+    - mountPath: /tls
+      name: tempo-distributed-tls
+  extraVolumes:
+    - name: tempo-distributed-tls
+      secret:
+        secretName: tempo-distributed-tls
+memcached:
+  extraArgs:
+    - -Z
+    - -o
+    - ssl_chain_cert=/tls/tls.crt,ssl_key=/tls/tls.key
+  extraVolumeMounts:
+    - mountPath: /tls
+      name: tempo-distributed-tls
+  extraVolumes:
+    - name: tempo-distributed-tls
+      secret:
+        secretName: tempo-distributed-tls
+metricsGenerator:
+  extraVolumeMounts:
+    - mountPath: /tls
+      name: tempo-distributed-tls
+  extraVolumes:
+    - name: tempo-distributed-tls
+      secret:
+        secretName: tempo-distributed-tls
+querier:
+  extraVolumeMounts:
+    - mountPath: /tls
+      name: tempo-distributed-tls
+  extraVolumes:
+    - name: tempo-distributed-tls
+      secret:
+        secretName: tempo-distributed-tls
+queryFrontend:
+  extraVolumeMounts:
+    - mountPath: /tls
+      name: tempo-distributed-tls
+  extraVolumes:
+    - name: tempo-distributed-tls
+      secret:
+        secretName: tempo-distributed-tls
+tempo:
+  readinessProbe:
+    httpGet:
+      scheme: HTTPS
+  structuredConfig:
+    memberlist:
+      tls_ca_path: /tls/ca.crt
+      tls_cert_path: /tls/tls.crt
+      tls_enabled: true
+      tls_key_path: /tls/tls.key
+      tls_server_name: tempo-distributed.trace.svc.cluster.local
+    distributor:
+      receivers:
+        otlp:
+          protocols:
+            grpc:
+              tls:
+                ca_file: /tls/ca.crt
+                cert_file: /tls/tls.crt
+                key_file: /tls/tls.key
+    ingester_client:
+      grpc_client_config:
+        tls_ca_path: /tls/ca.crt
+        tls_cert_path: /tls/tls.crt
+        tls_enabled: true
+        tls_key_path: /tls/tls.key
+        tls_server_name: tempo-distributed.trace.svc.cluster.local
+    cache:
+      caches:
+        - memcached:
+            consistent_hash: true
+            host: tempo-distributed-memcached
+            service: memcached-client
+            timeout: 500ms
+            tls_ca_path: /tls/ca.crt
+            tls_cert_path: /tls/tls.crt
+            tls_enabled: true
+            tls_key_path: /tls/tls.key
+            tls_server_name: tempo-distributed.trace.svc.cluster.local
+          roles:
+            - parquet-footer
+            - bloom
+            - frontend-search
+    metrics_generator_client:
+      grpc_client_config:
+        tls_ca_path: /tls/ca.crt
+        tls_cert_path: /tls/tls.crt
+        tls_enabled: true
+        tls_key_path: /tls/tls.key
+        tls_server_name: tempo-distributed.trace.svc.cluster.local
+    querier:
+      frontend_worker:
+        grpc_client_config:
+          tls_ca_path: /tls/ca.crt
+          tls_cert_path: /tls/tls.crt
+          tls_enabled: true
+          tls_key_path: /tls/tls.key
+          tls_server_name: tempo-distributed.trace.svc.cluster.local
+    server:
+      grpc_tls_config:
+        cert_file: /tls/tls.crt
+        client_auth_type: VerifyClientCertIfGiven
+        client_ca_file: /tls/ca.crt
+        key_file: /tls/tls.key
+      http_tls_config:
+        cert_file: /tls/tls.crt
+        client_auth_type: VerifyClientCertIfGiven
+        client_ca_file: /tls/ca.crt
+        key_file: /tls/tls.key
+traces:
+  otlp:
+    grpc:
+      enabled: true
+```
+
+Refer to the [`prometheus.scrape` docs for Alloy](https://grafana.com/docs/alloy/<ALLOY_VERSION>/reference/components/prometheus/prometheus.scrape/) to configure TLS on the scrape.
+A relabel configuration like the following will do this configuration for you dynamically.
+
+```json
+{
+  source_labels: ['__meta_kubernetes_pod_annotation_prometheus_io_scheme'],
+  action: 'replace',
+  target_label: '__scheme__',
+  regex: '(https?)',
+  replacement: '$1',
+},
+```