chore(docs): Include serviceAccountNamespace for tracing collector

This separates out the service account namespace from the name to make it clearer how to set the correct service account for the trace collector.

Signed-off-by: Scott Fleener <[email protected]>

Author: sfleen

charts/linkerd-control-plane/values.yaml

@@ -288,10 +288,13 @@ proxy:
       endpoint: ""
       # -- The identity of the collector in the linkerd mesh.
       meshIdentity:
-        # -- Service account name for the trace collector. For most cases, this will be
-        # "<collector service name>.<namespace>", e.g. For a service `collector` in the `monitoring` namespace,
-        # this should be set to `collector.monitoring`.
+        # -- Service account name for the trace collector. If there's no explicitly set service account for the trace
+        # collector, this will be the name of the deployment/stateful set/daemonset of the trace collector instead.
         serviceAccountName: ""
+        # -- Service account namespace for the trace collector. If there's no explicitly set service account for the
+        # trace collector, this will be the namespace of the deployment/stateful set/daemonset of the trace collector
+        # instead.
+        serviceAccountNamespace: ""
   inbound:
     server:
       http2:

charts/partials/templates/_proxy.tpl

@@ -160,10 +160,14 @@ env:
 {{- end }}
 - name: LINKERD2_PROXY_TRACE_COLLECTOR_SVC_ADDR
   value: {{ .Values.proxy.tracing.collector.endpoint }}
-{{ if .Values.proxy.tracing.collector.meshIdentity.serviceAccountName -}}
+{{- if empty .Values.proxy.tracing.collector.meshIdentity.serviceAccountName }}
+{{- fail "proxy.tracing.collector.meshIdentity.serviceAccountName must be set if proxy tracing is enabled" }}
+{{- end }}
+{{- if empty .Values.proxy.tracing.collector.meshIdentity.serviceAccountNamespace }}
+{{- fail "proxy.tracing.collector.meshIdentity.serviceAccountNamespace must be set if proxy tracing is enabled" }}
+{{- end }}
 - name: LINKERD2_PROXY_TRACE_COLLECTOR_SVC_NAME
-  value: {{ .Values.proxy.tracing.collector.meshIdentity.serviceAccountName }}.serviceaccount.identity.{{.Release.Namespace}}.{{ .Values.clusterDomain }}
-{{ end -}}
+  value: {{ .Values.proxy.tracing.collector.meshIdentity.serviceAccountName }}.{{ .Values.proxy.tracing.collector.meshIdentity.serviceAccountNamespace }}.serviceaccount.identity.{{.Release.Namespace}}.{{ .Values.clusterDomain }}
 - name: LINKERD2_PROXY_TRACE_EXTRA_ATTRIBUTES
   value: |
     k8s.pod.ip=$(_pod_ip)

cli/cmd/install_test.go

@@ -130,7 +130,8 @@ func TestRender(t *testing.T) {
 				Collector: &charts.ProxyTracingCollector{
 					Endpoint: "",
 					MeshIdentity: &charts.ProxyTracingCollectorIdentity{
-						ServiceAccountName: "",
+						ServiceAccountName:      "",
+						ServiceAccountNamespace: "",
 					},
 				},
 			},