You are viewing docs for an older version of Linkerd.
You may want the latest documentation for this page instead.
CLI
The Linkerd CLI is the primary way to interact with Linkerd. It can install the control plane to your cluster, add the proxy to your service and provide detailed metrics for how your service is performing.
As reference, check out the commands below:
Command | Description |
---|---|
check | Check the Linkerd installation for potential problems |
completion | Output shell completion code for the specified shell (bash, zsh or fish) |
diagnostics | Commands used to diagnose Linkerd components |
identity | Display the certificate(s) of one or more selected pod(s) |
inject | Add the Linkerd proxy to a Kubernetes config |
install | Output Kubernetes configs to install Linkerd |
install-cni | Output Kubernetes configs to install Linkerd CNI |
jaeger | jaeger manages the jaeger extension of Linkerd service mesh |
multicluster | Manages the multicluster setup for Linkerd |
profile | Output service profile config for Kubernetes |
repair | Output the secret/linkerd-config-overrides resource if it has been deleted |
uninject | Remove the Linkerd proxy from a Kubernetes config |
uninstall | Output Kubernetes resources to uninstall Linkerd control plane |
upgrade | Output Kubernetes configs to upgrade an existing Linkerd control plane |
version | Print the client and server version information |
viz | viz manages the linkerd-viz extension of Linkerd service mesh |
Global flags
The following flags are available for all linkerd CLI commands:
Flag | Usage |
---|---|
--api-addr | Override kubeconfig and communicate directly with the control plane at host:port (mostly for testing) |
--context | Name of the kubeconfig context to use |
--help -h | help for linkerd |
--kubeconfig | Path to the kubeconfig file to use for CLI requests |
--linkerd-namespace -l | Namespace in which Linkerd is installed [$LINKERD_NAMESPACE] |
--verbose | Turn on debug logging |
--as | Username to impersonate for Kubernetes operations |