Enabling Live calls

New in v1.0.0

Live calls stream requests from the Linkerd proxies of your meshed workloads. The dashboard connects to each proxy directly. A proxy only accepts these connections from one client, which is named in its LINKERD2_PROXY_TAP_SVC_NAME environment variable. The dashboard includes a tap-injector, an admission webhook that sets that variable to the dashboard’s identity when a meshed pod is created.

This guide shows you how to turn on Live calls for your workloads, and how to choose which workloads Live calls can show.

Prerequisites

  • The Linkerd dashboard installed on your cluster, in its default monitoring namespace. The dashboard pod must be meshed, which the dashboard’s chart does by default.

  • The Linkerd viz extension uninstalled. Its own tap-injector sets a different identity, so proxies would refuse the dashboard. To uninstall it:

    linkerd viz uninstall | kubectl delete -f -
    
The dashboard’s install fails while the viz extension’s tap-injector is present, with an error that names it. Uninstall viz, then install again. To install anyway, set tapInjector.failIfVizInstalled to false, however Live calls will not work for pods that viz changes. To install the dashboard without the tap-injector, set tapInjector.enabled to false. See the configuration reference for more details.

Restart your workloads

The tap-injector is installed with the dashboard and is on by default. It only changes pods as they are created, so restart your workloads. For example:

kubectl -n <namespace> rollout restart deployment

Choose which workloads can be tapped

By default, the tap-injector changes every meshed pod outside kube-system and the Linkerd control plane. To stop Live calls for a namespace, annotate it:

kubectl annotate namespace <namespace> tap.buoyant.io/enabled=false

To stop or allow Live calls for one workload, add the annotation to the workload’s pod template. A workload’s annotation takes precedence over its namespace’s:

spec:
  template:
    metadata:
      annotations:
        tap.buoyant.io/enabled: "true"

Restart the workload after you change the annotation.

Upgrading Buoyant Enterprise for Linkerd

The tap-injector leaves pods alone whose proxy already has LINKERD2_PROXY_TAP_SVC_NAME. You can keep it on when you upgrade Buoyant Enterprise for Linkerd.