# Dashboard configuration reference

## Helm values

These values are set in the dashboard's Helm chart. When `helm upgrade` changes
`authPolicy` or `tapHeadersEnabled`, the dashboard restarts to pick them up.

The dashboard stores these settings in the `linkerd-dashboard` ConfigMap and
reads them when it starts. If you edit the ConfigMap directly instead of with
Helm, restart the dashboard yourself:

```bash
kubectl -n monitoring rollout restart deployment/linkerd-dashboard
```

The next `helm upgrade` replaces direct edits with the chart's values.

| Value                                      | Description                                                                                                                                                                                           | Default                                                        |
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| `authPolicy`                               | Set to `insecure` to turn off login. Not case sensitive. Any other value requires login.                                                                                                              | `default`                                                      |
| `tapHeadersEnabled`                        | Set to `true` to include HTTP headers in Live calls.                                                                                                                                                  | `false`                                                        |
| `oscal.authorizedServiceAccounts`          | Service accounts allowed to read the OSCAL endpoint, as a list of `{name, namespace}` entries. `namespace` defaults to the dashboard's namespace. Empty denies all.                                   | `[]`                                                           |
| `tapInjector.enabled`                      | Run the [tap-injector](/linkerd-dashboard/guides/enabling-live-calls/), which names the dashboard as the tap client of meshed pods' proxies.                                                                          | `true`                                                         |
| `tapInjector.failIfVizInstalled`           | Fail the install or upgrade while the viz extension's tap-injector is present.                                                                                                                        | `true`                                                         |
| `tapInjector.failurePolicy`                | Webhook failure policy. With `Ignore`, pods created while the dashboard is unavailable start without Live calls. With `Fail`, they aren't created at all.                                             | `Ignore`                                                       |
| `tapInjector.namespaceSelector`            | Namespaces the webhook applies to.                                                                                                                                                                    | all but `kube-system` and namespaces with Linkerd webhooks off |
| `tapInjector.objectSelector`               | Pods the webhook applies to.                                                                                                                                                                          | all                                                            |
| `tapInjector.externalSecret`               | Don't create the webhook's TLS secret `linkerd-dashboard-tap-injector-k8s-tls`; provide it yourself. Also set `tapInjector.caBundle`, `tapInjector.injectCaFrom` or `tapInjector.injectCaFromSecret`. | `false`                                                        |
| `tapInjector.crtPEM`, `tapInjector.keyPEM` | The webhook's certificate and private key, in PEM.                                                                                                                                                    | kept from the existing secret, or generated                    |
| `tapInjector.caBundle`                     | CA certificates for the webhook, in PEM.                                                                                                                                                              | the webhook's certificate                                      |
| `tapInjector.injectCaFrom`                 | cert-manager `Certificate` (`<namespace>/<name>`) whose CA cert-manager injects into the webhook.                                                                                                     | none                                                           |
| `tapInjector.injectCaFromSecret`           | Secret (`<namespace>/<name>`) whose CA cert-manager injects into the webhook.                                                                                                                         | none                                                           |

## Proxy annotations

These annotations are set on a workload's pod template or on its namespace. A
workload's annotation takes precedence over its namespace's. They are applied
when the workload's pod is created, so restart the workload after you change
them.

`tap.buoyant.io/enabled` is read by the dashboard and the
[tap-injector](/linkerd-dashboard/guides/enabling-live-calls/):

| Annotation               | Description                                                                                                                 | Default |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------- | ------- |
| `tap.buoyant.io/enabled` | Set to `false` to stop Live calls for this workload. Set to `true` on a workload to allow it when its namespace is `false`. | `true`  |

As of `enterprise-2.20.6`, these annotations are applied to the workload's
Linkerd proxy when it is injected:

| Annotation                      | Description                                                                                                       | Default                              |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
| `tap.buoyant.io/headers-allow`  | Comma-separated list of headers to show in Live calls for this workload. An empty string (`""`) shows no headers. | proxy default allow list (see below) |
| `tap.buoyant.io/max-concurrent` | Maximum number of concurrent tap streams.                                                                         | proxy default max concurrent (100)   |
| `tap.buoyant.io/max-lifetime`   | Maximum lifetime of a tap stream. When the proxy ends a stream, the dashboard reconnects, so Live calls continue. | proxy default max lifetime (`90s`)   |

The proxy default allow list is `Accept`, `Content-Length`, `Content-Type`,
`Date`, `Host`, `Last-Modified`, `Server`, and `User-Agent`.
