istioctl

Istio configuration command line utility for service operators to debug and diagnose their Istio mesh.

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl analyze

Analyze Istio configuration and print validation messages

istioctl analyze <file>... [flags]
Flags Shorthand Description
--all-namespaces -A Analyze all namespaces
--color Default true. Disable with '=false' or set $TERM to dumb
--context <string> The name of the kubeconfig context to use (default ``)
--failure-threshold <Level> The severity level of analysis at which to set a non-zero exit code. Valid values: [Info Warn Error] (default `Warn`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--list-analyzers -L List the analyzers available to run. Suppresses normal execution.
--meshConfigFile <string> Overrides the mesh config values to use for analysis. (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of [json log yaml] (default `log`)
--output-threshold <Level> The severity level of analysis at which to display messages. Valid values: [Info Warn Error] (default `Info`)
--recursive -R Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory.
--suppress <stringArray> -S Suppress reporting a message code on a specific resource. Values are supplied in the form <code>=<resource> (e.g. '--suppress "IST0102=DestinationRule primary-dr.default"'). Can be repeated. You can include the wildcard character '*' to support a partial match (e.g. '--suppress "IST0102=DestinationRule *.default" ). (default `[]`)
--timeout <duration> the duration to wait before failing (default `30s`)
--use-kube -k Use live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only.
--verbose -v Enable verbose output

Examples


# Analyze the current live cluster
istioctl analyze

# Analyze the current live cluster, simulating the effect of applying additional yaml files
istioctl analyze a.yaml b.yaml my-app-config/

# Analyze the current live cluster, simulating the effect of applying a directory of config recursively
istioctl analyze --recursive my-istio-config/

# Analyze yaml files without connecting to a live cluster
istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/

# Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
istioctl analyze -S "IST0103=Pod mypod.testing"

# Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
# and suppress MisplacedAnnotation on deployment foobar in namespace default.
istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"

# List available analyzers
istioctl analyze -L

istioctl authz

(authz is experimental. Use `istioctl experimental authz`)

istioctl authz [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl convert-ingress

Converts Ingresses into VirtualService configuration on a best effort basis. The output should be considered a starting point for your Istio configuration and probably require some minor modification. Warnings will be generated where configs cannot be converted perfectly. The input must be a Kubernetes Ingress. The conversion of v1alpha1 Istio rules has been removed from istioctl.

istioctl convert-ingress [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--filenames <stringSlice> -f Input filenames (default `[]`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output filename (default `-`)

Examples

istioctl convert-ingress -f samples/bookinfo/platform/kube/bookinfo-ingress.yaml

istioctl dashboard

Access to Istio web UIs

istioctl dashboard [flags]
istioctl dash [flags]
istioctl d [flags]
Flags Shorthand Description
--address <string> Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--port <int> -p Local port to listen to (default `0`)

istioctl dashboard controlz

Open the ControlZ web UI for a pod in the Istio control plane

istioctl dashboard controlz <pod-name[.namespace]> [flags]
Flags Shorthand Description
--address <string> Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)
--context <string> The name of the kubeconfig context to use (default ``)
--ctrlz_port <int> ControlZ port (default `9876`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--port <int> -p Local port to listen to (default `0`)
--selector <string> -l label selector (default ``)

Examples

istioctl dashboard controlz pilot-123-456.istio-system

istioctl dashboard envoy

Open the Envoy admin dashboard for a sidecar

istioctl dashboard envoy <pod-name[.namespace]> [flags]
Flags Shorthand Description
--address <string> Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--port <int> -p Local port to listen to (default `0`)
--selector <string> -l label selector (default ``)

Examples

istioctl dashboard envoy productpage-123-456.default

istioctl dashboard grafana

Open Istio's Grafana dashboard

istioctl dashboard grafana [flags]
Flags Shorthand Description
--address <string> Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--port <int> -p Local port to listen to (default `0`)

Examples

istioctl dashboard grafana

istioctl dashboard jaeger

Open Istio's Jaeger dashboard

istioctl dashboard jaeger [flags]
Flags Shorthand Description
--address <string> Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--port <int> -p Local port to listen to (default `0`)

Examples

istioctl dashboard jaeger

istioctl dashboard kiali

Open Istio's Kiali dashboard

istioctl dashboard kiali [flags]
Flags Shorthand Description
--address <string> Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--port <int> -p Local port to listen to (default `0`)

Examples

istioctl dashboard kiali

istioctl dashboard prometheus

Open Istio's Prometheus dashboard

istioctl dashboard prometheus [flags]
Flags Shorthand Description
--address <string> Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--port <int> -p Local port to listen to (default `0`)

Examples

istioctl dashboard prometheus

istioctl dashboard zipkin

Open Istio's Zipkin dashboard

istioctl dashboard zipkin [flags]
Flags Shorthand Description
--address <string> Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--port <int> -p Local port to listen to (default `0`)

Examples

istioctl dashboard zipkin

istioctl deregister

De-registers a service instance

istioctl deregister <svcname> <ip> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples

# de-register an endpoint 172.17.0.2 from service my-svc:
istioctl deregister my-svc 172.17.0.2

istioctl experimental

Experimental commands that may be modified or deprecated

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental add-to-mesh

'istioctl experimental add-to-mesh' restarts pods with an Istio sidecar or configures meshed pod access to external services.

Use 'add-to-mesh' as an alternate to namespace-wide auto injection for troubleshooting compatibility.

The 'remove-from-mesh' command can be used to restart with the sidecar removed.

THESE COMMANDS ARE UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental add-to-mesh [flags]
istioctl experimental add [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--injectConfigFile <string> injection configuration filename. Cannot be used with --injectConfigMapName (default ``)
--injectConfigMapName <string> ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--meshConfigFile <string> mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)
--meshConfigMapName <string> ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)
--namespace <string> -n Config namespace (default ``)
--valuesFile <string> injection values configuration filename. (default ``)

Examples


# Restart all productpage pods with an Istio sidecar
istioctl experimental add-to-mesh service productpage

# Restart just pods from the productpage-v1 deployment
istioctl experimental add-to-mesh deployment productpage-v1

# Control how meshed pods see an external service
istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126 \
   http:9080 tcp:8888 --labels app=test,version=v1 --annotations env=stage --serviceaccount stageAdmin

istioctl experimental add-to-mesh deployment

'istioctl experimental add-to-mesh deployment' restarts pods with the Istio sidecar. Use 'add-to-mesh' to test deployments for compatibility with Istio. It can be used instead of namespace-wide auto-injection of sidecars and is especially helpful for compatibility testing.

If your deployment does not function after using 'add-to-mesh' you must re-deploy it and troubleshoot it for Istio compatibility. See https://istio.io/docs/setup/kubernetes/additional-setup/requirements/

See also 'istioctl experimental remove-from-mesh deployment' which does the reverse.

THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental add-to-mesh deployment <deployment> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--injectConfigFile <string> injection configuration filename. Cannot be used with --injectConfigMapName (default ``)
--injectConfigMapName <string> ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--meshConfigFile <string> mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)
--meshConfigMapName <string> ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)
--namespace <string> -n Config namespace (default ``)
--revision <string> control plane revision (experimental) (default ``)
--valuesFile <string> injection values configuration filename. (default ``)

Examples


# Restart pods from the productpage-v1 deployment with Istio sidecar
istioctl experimental add-to-mesh deployment productpage-v1

istioctl experimental add-to-mesh external-service

istioctl experimental add-to-mesh external-service create a ServiceEntry and a Service without selector for the specified external service in Istio service mesh. The typical usage scenario is Mesh Expansion on VMs.

See also 'istioctl experimental remove-from-mesh external-service' which does the reverse.

THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental add-to-mesh external-service <svcname> <ip> [name1:]port1 [[name2:]port2] ... [flags]
Flags Shorthand Description
--annotations <stringSlice> -a List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,x=y (default `[]`)
--context <string> The name of the kubeconfig context to use (default ``)
--injectConfigFile <string> injection configuration filename. Cannot be used with --injectConfigMapName (default ``)
--injectConfigMapName <string> ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--labels <stringSlice> -l List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)
--meshConfigFile <string> mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)
--meshConfigMapName <string> ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)
--namespace <string> -n Config namespace (default ``)
--serviceaccount <string> -s Service account to link to the service (default `default`)
--valuesFile <string> injection values configuration filename. (default ``)

Examples


# Control how meshed pods contact 172.12.23.125 and .126
istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126 \
   http:9080 tcp:8888 --labels app=test,version=v1 --annotations env=stage --serviceaccount stageAdmin

istioctl experimental add-to-mesh service

istioctl experimental add-to-mesh service restarts pods with the Istio sidecar. Use 'add-to-mesh' to test deployments for compatibility with Istio. It can be used instead of namespace-wide auto-injection of sidecars and is especially helpful for compatibility testing.

If your service does not function after using 'add-to-mesh' you must re-deploy it and troubleshoot it for Istio compatibility. See https://istio.io/docs/setup/kubernetes/additional-setup/requirements/

See also 'istioctl experimental remove-from-mesh service' which does the reverse.

THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental add-to-mesh service <service> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--injectConfigFile <string> injection configuration filename. Cannot be used with --injectConfigMapName (default ``)
--injectConfigMapName <string> ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--meshConfigFile <string> mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)
--meshConfigMapName <string> ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)
--namespace <string> -n Config namespace (default ``)
--revision <string> control plane revision (experimental) (default ``)
--valuesFile <string> injection values configuration filename. (default ``)

Examples


# Restart all productpage pods with an Istio sidecar
istioctl experimental add-to-mesh service productpage

istioctl experimental analyze

Analyze Istio configuration and print validation messages (analyze has graduated. Use `istioctl analyze`)

istioctl experimental analyze <file>... [flags]
Flags Shorthand Description
--all-namespaces -A Analyze all namespaces
--color Default true. Disable with '=false' or set $TERM to dumb
--context <string> The name of the kubeconfig context to use (default ``)
--failure-threshold <Level> The severity level of analysis at which to set a non-zero exit code. Valid values: [Info Warn Error] (default `Warn`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--list-analyzers -L List the analyzers available to run. Suppresses normal execution.
--meshConfigFile <string> Overrides the mesh config values to use for analysis. (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of [json log yaml] (default `log`)
--output-threshold <Level> The severity level of analysis at which to display messages. Valid values: [Info Warn Error] (default `Info`)
--recursive -R Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory.
--suppress <stringArray> -S Suppress reporting a message code on a specific resource. Values are supplied in the form <code>=<resource> (e.g. '--suppress "IST0102=DestinationRule primary-dr.default"'). Can be repeated. You can include the wildcard character '*' to support a partial match (e.g. '--suppress "IST0102=DestinationRule *.default" ). (default `[]`)
--timeout <duration> the duration to wait before failing (default `30s`)
--use-kube -k Use live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only.
--verbose -v Enable verbose output

Examples


# Analyze the current live cluster
istioctl analyze

# Analyze the current live cluster, simulating the effect of applying additional yaml files
istioctl analyze a.yaml b.yaml my-app-config/

# Analyze the current live cluster, simulating the effect of applying a directory of config recursively
istioctl analyze --recursive my-istio-config/

# Analyze yaml files without connecting to a live cluster
istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/

# Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
istioctl analyze -S "IST0103=Pod mypod.testing"

# Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
# and suppress MisplacedAnnotation on deployment foobar in namespace default.
istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"

# List available analyzers
istioctl analyze -L

istioctl experimental authz

Commands to inspect and interact with the authorization policies check - check Envoy config dump for authorization configuration

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples

  # Check Envoy authorization configuration for pod httpbin-88ddbcfdd-nt5jb:
  istioctl x authz check httpbin-88ddbcfdd-nt5jb

istioctl experimental authz check

Check reads the Envoy config dump and checks the filter configuration related to authorization. For example, it shows whether or not the Envoy is configured with authorization and the rules used in the authorization.

The Envoy config dump could be provided either by pod name or from a config dump file (the whole output of http://localhost:15000/config_dump of an Envoy instance).

THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental authz check <pod-name>[.<pod-namespace>] [flags]
Flags Shorthand Description
--all -a Show additional information (e.g. SNI and ALPN)
--context <string> The name of the kubeconfig context to use (default ``)
--file <string> -f The json file with Envoy config dump to be checked (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples

  # Check Envoy authorization configuration for pod httpbin-88ddbcfdd-nt5jb:
  istioctl x authz check httpbin-88ddbcfdd-nt5jb

  # Check Envoy authorization configuration from a config dump file:
  istioctl x authz check -f httpbin_config_dump.json

istioctl experimental config

Gonfigure istioctl defaults

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples


# list configuration parameters
istioctl config list

istioctl experimental config list

List istio configurable defaults

istioctl experimental config list [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental convert-ingress

(convert-ingress has graduated. Use `istioctl convert-ingress`)

istioctl experimental convert-ingress [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental create-remote-secret

Create a secret with credentials to allow Istio to access remote Kubernetes apiservers

istioctl experimental create-remote-secret [flags]
Flags Shorthand Description
--auth-plugin-config <stringToString> authenticator plug-in configuration. --auth-type=plugin must be set with this option (default `[]`)
--auth-plugin-name <string> authenticator plug-in name. --auth-type=plugin must be set with this option (default ``)
--auth-type <RemoteSecretAuthType> type of authentication to use. supported values = [bearer-token plugin] (default `bearer-token`)
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--name <string> Name of the local cluster whose credentials are stored in the secret. If a name is not specified the kube-system namespace's UUID of the local cluster will be used. (default ``)
--namespace <string> -n Config namespace (default ``)
--service-account <string> create a secret with this service account's credentials. (default `istio-reader-service-account`)

Examples


# Create a secret to access cluster c0's apiserver and install it in cluster c1.
istioctl --Kubeconfig=c0.yaml x create-remote-secret --name c0 \
    | kubectl --Kubeconfig=c1.yaml apply -f -

# Delete a secret that was previously installed in c1
istioctl --Kubeconfig=c0.yaml x create-remote-secret --name c0 \
    | kubectl --Kubeconfig=c1.yaml delete -f -

# Create a secret access a remote cluster with an auth plugin
istioctl --Kubeconfig=c0.yaml x create-remote-secret --name c0 --auth-type=plugin --auth-plugin-name=gcp \
    | kubectl --Kubeconfig=c1.yaml apply -f -

istioctl experimental dashboard

(dashboard has graduated. Use `istioctl dashboard`)

istioctl experimental dashboard [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental describe

Describe resource and related Istio configuration

istioctl experimental describe [flags]
istioctl experimental des [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental describe pod

Analyzes pod, its Services, DestinationRules, and VirtualServices and reports the configuration objects that affect that pod.

THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental describe pod <pod> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--ignoreUnmeshed Suppress warnings for unmeshed pods
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples

istioctl experimental describe pod productpage-v1-c7765c886-7zzd4

istioctl experimental describe service

Analyzes service, pods, DestinationRules, and VirtualServices and reports the configuration objects that affect that service.

THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental describe service <svc> [flags]
istioctl experimental describe svc <svc> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--ignoreUnmeshed Suppress warnings for unmeshed pods
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples

istioctl experimental describe service productpage

istioctl experimental kube-uninject

kube-uninject is used to prevent Istio from adding a sidecar and also provides the inverse of "istioctl kube-inject -f".

istioctl experimental kube-uninject [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--filename <string> -f Input Kubernetes resource filename (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Modified output Kubernetes resource filename (default ``)

Examples


# Update resources before applying.
kubectl apply -f <(istioctl experimental kube-uninject -f <resource.yaml>)

# Create a persistent version of the deployment by removing Envoy sidecar.
istioctl experimental kube-uninject -f deployment.yaml -o deployment-uninjected.yaml

# Update an existing deployment.
kubectl get deployment -o yaml | istioctl experimental kube-uninject -f - | kubectl apply -f -

istioctl experimental metrics

Prints the metrics for the specified service(s) when running in Kubernetes.

This command finds a Prometheus pod running in the specified istio system namespace. It then executes a series of queries per requested workload to find the following top-level workload metrics: total requests per second, error rate, and request latency at p50, p90, and p99 percentiles. The query results are printed to the console, organized by workload name.

All metrics returned are from server-side reports. This means that latencies and error rates are from the perspective of the service itself and not of an individual client (or aggregate set of clients). Rates and latencies are calculated over a time interval of 1 minute.

istioctl experimental metrics <workload name>...
istioctl experimental m <workload name>...
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples


# Retrieve workload metrics for productpage-v1 workload
istioctl experimental metrics productpage-v1

# Retrieve workload metrics for various services in the different namespaces
istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz

istioctl experimental multicluster

Commands to assist in managing a multi-cluster mesh

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental multicluster apply

Update clusters in a multi-cluster mesh based on mesh topology

istioctl experimental multicluster apply  -f <mesh.yaml> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--filename <string> -f filename of the multicluster mesh description (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental multicluster describe

Describe status of the multi-cluster mesh's control plane'

istioctl experimental multicluster describe -f <mesh.yaml> [--all] [flags]
Flags Shorthand Description
--all describe the status of all clustersByContext in the mesh
--context <string> The name of the kubeconfig context to use (default ``)
--filename <string> -f filename of the multicluster mesh description (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental multicluster generate

generate a cluster-specific control plane configuration based on the mesh description and runtime state

istioctl experimental multicluster generate -f <mesh.yaml> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--filename <string> -f filename of the multicluster mesh description (default ``)
--from <string> optional source configuration to generate multicluster aware configuration from (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--wait-for-gateways wait for all cluster's istio-ingressgateway IPs to be ready before generating configuration.

istioctl experimental post-install

Commands related to post-install

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental post-install webhook

webhook command to manage webhook configurations

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl experimental post-install webhook disable

Disable webhook configurations

istioctl experimental post-install webhook disable [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--injection Disable mutating webhook (default true).
--injection-config <string> The mutating webhook configuration to disable. (default `istio-sidecar-injector`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--validation Disable validating webhook (default true).
--validation-config <string> The validating webhook configuration to disable. (default `istio-galley`)

Examples


# Disable all webhooks
istioctl experimental post-install webhook disable

# Disable all webhooks except injection
istioctl experimental post-install webhook disable --injection=false

istioctl experimental post-install webhook enable

This command is used to enable webhook configurations after installing Istio. For previous Istio versions (e.g., 1.2, 1.3, etc), this command is not needed because in previous versions webhooks manage their own configurations.

istioctl experimental post-install webhook enable [flags]
Flags Shorthand Description
--ca-bundle-file <string> PEM encoded CA bundle which will be used to validate the webhook's server certificates. If this is empty, the kube-apisever's root CA is used if it can be confirmed to have signed the webhook's certificates. This condition is sometimes true but is not guaranteed (see https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping) (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--injection Enable injection webhook (default true).
--injection-path <string> The file path of the injection webhook configuration. (default ``)
--injection-service <string> The service name of the injection webhook to manage. (default `istio-pilot`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--read-cert-timeout <duration> Max time for waiting the webhook certificate to be readable. (default `1m0s`)
--timeout <duration> Max time for checking the validating webhook server. If the validating webhook server is not readyin the given time, exit. Otherwise, apply the webhook configuration. (default `1m0s`)
--validation Enable validatation webhook (default true).
--validation-path <string> The file path of the validation webhook configuration. (default ``)
--validation-service <string> The service name of the validation webhook to manage. (default `istio-galley`)
--webhook-secret <string> The name of an existing Kubernetes secret of a webhook. istioctl will verify that the webhook certificate is issued by the CA certificate. (default ``)

Examples


# Enable the webhook configuration of Galley with the given webhook configuration
istioctl experimental post-install webhook enable --validation --webhook-secret istio.webhook.galley 
    --namespace istio-system --validation-path validatingwebhookconfiguration.yaml

# Enable the webhook configuration of Galley with the given webhook configuration and CA certificate
istioctl experimental post-install webhook enable --validation --webhook-secret istio.webhook.galley 
    --namespace istio-system --validation-path validatingwebhookconfiguration.yaml --ca-bundle-file ./k8s-ca-cert.pem

istioctl experimental post-install webhook status

Get webhook configurations

istioctl experimental post-install webhook status [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--injection Display the injection webhook configuration.
--injection-config <string> The name of the MutatingWebhookConfiguration to display. (default `istio-sidecar-injector`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--validation Display the validating webhook configuration.
--validation-config <string> The name of the ValidatingWebhookConfiguration to display. (default `istio-galley`)

Examples


# Display the webhook configuration of Galley
istioctl experimental post-install webhook status --validation --validation-config istio-galley
# Display the webhook configuration of Galley and Sidecar Injector
istioctl experimental post-install webhook status --validation --validation-config istio-galley 
  --injection --injection-config istio-sidecar-injector

istioctl experimental precheck

precheck inspects a Kubernetes cluster for Istio install requirements.

istioctl experimental precheck [-f <deployment or istio operator file>] [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--filename <stringSlice> -f Istio YAML installation file. (default `[]`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--recursive -R Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--revision <string> control plane revision (default ``)

Examples


		# Verify that Istio can be installed
		istioctl experimental precheck

		# Verify the deployment matches a custom Istio deployment configuration
		istioctl x precheck --set profile=demo

		# Verify the deployment matches the Istio Operator deployment definition
		istioctl x precheck -f iop.yaml

istioctl experimental proxy-status

Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh

istioctl experimental proxy-status [<pod-name[.namespace]>] [flags]
istioctl experimental ps [<pod-name[.namespace]>] [flags]
Flags Shorthand Description
--authority <string> XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)
--cert-dir <string> XDS Endpoint certificate directory (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--insecure Skip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--revision <string> control plane revision (default ``)
--timeout <duration> the duration to wait before failing (default `30s`)
--xds-address <string> XDS Endpoint (default ``)
--xds-label <string> Istiod pod label selector (default ``)
--xds-port <int> Istiod pod port (default `15012`)

Examples

# Retrieve sync status for all Envoys in a mesh
	istioctl proxy-status

# Retrieve sync diff for a single Envoy and Istiod
	istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system

istioctl experimental remove-from-mesh

'istioctl experimental remove-from-mesh' restarts pods without an Istio sidecar or removes external service access configuration.

Use 'remove-from-mesh' to quickly test uninjected behavior as part of compatibility troubleshooting.

The 'add-to-mesh' command can be used to add or restore the sidecar.

THESE COMMANDS ARE UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental remove-from-mesh [flags]
istioctl experimental rm [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples


# Restart all productpage pods without an Istio sidecar
istioctl experimental remove-from-mesh service productpage

istioctl experimental remove-from-mesh deployment

'istioctl experimental remove-from-mesh deployment' restarts pods with the Istio sidecar un-injected.

'remove-from-mesh' is a compatibility troubleshooting tool.

THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental remove-from-mesh deployment <deployment> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples


# Restart all productpage-v1 pods without an Istio sidecar
istioctl experimental remove-from-mesh deployment productpage-v1

istioctl experimental remove-from-mesh external-service

'istioctl experimental remove-from-mesh external-service' removes the ServiceEntry and the Kubernetes Service for the specified external service (e.g. services running on a VM) from Istio service mesh. The typical usage scenario is Mesh Expansion on VMs.

THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental remove-from-mesh external-service <svcname> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples


# Remove "vmhttp" service entry rules
istioctl experimental remove-from-mesh external-service vmhttp

istioctl experimental remove-from-mesh service

'istioctl experimental remove-from-mesh service' restarts pods with the Istio sidecar un-injected.

'remove-from-mesh' is a compatibility troubleshooting tool.

THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental remove-from-mesh service <service> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples


# Restart all productpage pods without an Istio sidecar
istioctl experimental remove-from-mesh service productpage

istioctl experimental sidecar-bootstrap

(experimental) Takes in one or more WorkloadEntries generates identities for them, and copies to the particular identities to the workloads over SSH. Optionally allowing for saving the certificates locally for use in CI like environments, and starting istio-proxy where no special configuration is needed. This allows for workloads to participate in the Istio mesh.

To autenticate to a remote node you can use either SSH Keys, or SSH Passwords. If using passwords you must have a TTY for you to be asked your password, we do not accept an argument for it so it cannot be left inside your shell history.

Copying is performed with scp, and as such is required if you'd like to copy a file over. If SCP is not at the standard path "/usr/bin/scp", you should provide it's location with the "--remote-scp-path" option.

In order to start Istio on the remote node you must have docker installed on the remote node. Istio will be started on the host network as a docker container in capture mode.

istioctl experimental sidecar-bootstrap <workloadEntry>.<namespace> [flags]
Flags Shorthand Description
--all -a attempt to bootstrap all workload entries
--context <string> The name of the kubeconfig context to use (default ``)
--duration <duration> (experimental) duration the certificates generated are valid for. (default `8760h0m0s`)
--ignore-host-keys (experimental) ignore host keys on the remote host
--istio-image <string> (experimental) the Istio proxy image to start up when starting Istio (default `istio/proxyv2:latest`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--local-dir <string> -d directory to place certs in locally as opposed to copying (default ``)
--mutual-tls (experimental) enable mutual TLS if starting Istio-Proxy.
--namespace <string> -n Config namespace (default ``)
--organization <string> -o (experimental) the organization to use on the certificate, defaults to the same as the root cert. (default ``)
--remote-directory <string> (experimental) the directory to create on the remote machine. (default `/var/run/istio`)
--remote-scp-path <string> (experimental) the scp binary location on the target machine if not at /usr/bin/scp (default `/usr/bin/scp`)
--spiffe-trust-domain <string> (experimental) the SPIFFE trust domain for the generated certs (default ``)
--ssh-key <string> -k (experimental) the location of the SSH key (default ``)
--ssh-port <int> (experimental) the port to SSH to the machine on (default `22`)
--ssh-user <string> -u (experimental) the user to SSH as, defaults to the current user (default ``)
--start-istio-proxy start Istio proxy on a remote host after copying certs
--timeout <duration> (experimental) the timeout for copying certificates (default `1m0s`)

Examples

  # Copy certificates to a WorkloadEntry named "we" in the "ns" namespace:
	istioctl x sidecar-bootstrap we.ns

	# Copy certificates, and start istio to a WorkloadEntry named "we" in the "ns" namespace:
	istioctl x sidecar-bootstrap we.ns --start-istio-proxy

	# Generate Certs locally, but do not copy them to a WorkloadEntry named "we" in the "ns" namespace:
	istioctl x sidecar-bootstrap we.ns --local-dir path/where/i/want/certs/

istioctl experimental uninstall

The uninstall command uninstalls Istio from a cluster

istioctl experimental uninstall [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--filename <string> -f The filename of the IstioOperator CR. (default ``)
--force Proceed even with validation errors.
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--purge Delete all Istio related sources for all versions
--revision <string> -r Target control plane revision for the command. (default ``)
--set <stringArray> -s Override an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.policy.enabled=true), or override Istio settings (--set values.grafana.enabled=true). See documentation for more info: https://istio.io/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-confirmation -y skipConfirmation determines whether the user is prompted for confirmation. If set to true, the user is not prompted and a Yes response is assumed in all cases.

Examples

  # Uninstall a single control plane by revision
  istioctl x uninstall --revision foo

  # Uninstall a single control plane by iop file
  istioctl x uninstall -f iop.yaml
  
  # Uninstall all control planes and shared resources
  istioctl x uninstall --purge

istioctl experimental upgrade

The upgrade command checks for upgrade version eligibility and, if eligible, upgrades the Istio control plane components in-place. Warning: traffic may be disrupted during upgrade. Please ensure PodDisruptionBudgets are defined to maintain service continuity.

istioctl experimental upgrade [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--filename <stringSlice> -f Path to file containing IstioOperator custom resource (default `[]`)
--force Apply the upgrade without eligibility checks
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--readiness-timeout <duration> Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--set <stringArray> -s Override an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.policy.enabled=true), or override Istio settings (--set values.grafana.enabled=true). See documentation for more info: https://istio.io/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-confirmation -y If skip-confirmation is set, skips the prompting confirmation for value changes in this upgrade

istioctl experimental version

Prints out build version information

istioctl experimental version [flags]
Flags Shorthand Description
--authority <string> XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)
--cert-dir <string> XDS Endpoint certificate directory (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--insecure Skip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o One of 'yaml' or 'json'. (default ``)
--remote Use --remote=false to suppress control plane check
--revision <string> control plane revision (default ``)
--short -s Use --short=false to generate full version information
--timeout <duration> the duration to wait before failing (default `30s`)
--xds-address <string> XDS Endpoint (default ``)
--xds-label <string> Istiod pod label selector (default ``)
--xds-port <int> Istiod pod port (default `15012`)

Examples

# Retrieve version information directly from XDS, without security
istioctl x version --xds-address localhost:15012

# Retrieve version information directly from XDS, with security
# (the certificates must be retrieved before this step)
istioctl x version --xds-address localhost:15010 --cert-dir ~/.istio-certs

# Retrieve version information via XDS from all Istio pods in a Kubernetes cluster
# (without security)
istioctl x version --xds-port 15010

# Retrieve version information via XDS from all Istio pods in a Kubernetes cluster
# (the certificates must be retrieved before this step)
istioctl x version --cert-dir ~/.istio-certs

# Retrieve version information via XDS from default control plane Istio pods
# in a Kubernetes cluster, without security
istioctl x version --xds-label istio.io/rev=default --xds-port 15010

istioctl experimental wait

Waits for the specified condition to be true of an Istio resource.

istioctl experimental wait [flags] <type> <name>[.<namespace>]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--for <string> wait condition, must be 'distribution' or 'delete' (default `distribution`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--resource-version <string> wait for a specific version of config to become current, rather than using whatever is latest in kubernetes (default ``)
--revision <string> control plane revision (default ``)
--threshold <float32> the ratio of distribution required for success (default `1`)
--timeout <duration> the duration to wait before failing (default `30s`)

Examples


# Wait until the bookinfo virtual service has been distributed to all proxies in the mesh
istioctl experimental wait --for=distribution virtualservice bookinfo.default

# Wait until 99% of the proxies receive the distribution, timing out after 5 minutes
istioctl experimental wait --for=distribution --threshold=.99 --timeout=300 virtualservice bookinfo.default

istioctl install

The install generates an Istio install manifest and applies it to a cluster.

istioctl install [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--filename <stringSlice> -f Path to file containing IstioOperator custom resource This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)
--force Proceed even with validation errors.
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--readiness-timeout <duration> Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--revision <string> -r Target control plane revision for the command. (default ``)
--set <stringArray> -s Override an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.policy.enabled=true), or override Istio settings (--set values.grafana.enabled=true). See documentation for more info: https://istio.io/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-confirmation -y skipConfirmation determines whether the user is prompted for confirmation. If set to true, the user is not prompted and a Yes response is assumed in all cases.

Examples

  # Apply a default Istio installation
  istioctl install

  # Enable grafana dashboard
  istioctl install --set values.grafana.enabled=true

  # Generate the demo profile and don't wait for confirmation
  istioctl install --set profile=demo --skip-confirmation

  # To override a setting that includes dots, escape them with a backslash (\).  Your shell may require enclosing quotes.
  istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"

istioctl kube-inject

kube-inject manually injects the Envoy sidecar into Kubernetes workloads. Unsupported resources are left unmodified so it is safe to run kube-inject over a single file that contains multiple Service, ConfigMap, Deployment, etc. definitions for a complex application. It's best to do this when the resource is initially created.

k8s.io/docs/concepts/workloads/pods/pod-overview/#pod-templates is updated for Job, DaemonSet, ReplicaSet, Pod and Deployment YAML resource documents. Support for additional pod-based resource types can be added as necessary.

The Istio project is continually evolving so the Istio sidecar configuration may change unannounced. When in doubt re-run istioctl kube-inject on deployments to get the most up-to-date changes.

istioctl kube-inject [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--filename <string> -f Input Kubernetes resource filename (default ``)
--injectConfigFile <string> injection configuration filename. Cannot be used with --injectConfigMapName (default ``)
--injectConfigMapName <string> ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--meshConfigFile <string> mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)
--meshConfigMapName <string> ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Modified output Kubernetes resource filename (default ``)
--revision <string> control plane revision (default ``)
--valuesFile <string> injection values configuration filename. (default ``)

Examples


# Update resources on the fly before applying.
kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)

# Create a persistent version of the deployment with Envoy sidecar
# injected.
istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml

# Update an existing deployment.
kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -

# Capture cluster configuration for later use with kube-inject
kubectl -n istio-system get cm istio-sidecar-injector  -o jsonpath="{.data.config}" > /tmp/inj-template.tmpl
kubectl -n istio-system get cm istio -o jsonpath="{.data.mesh}" > /tmp/mesh.yaml
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.values}" > /tmp/values.json
# Use kube-inject based on captured configuration
istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \
	--injectConfigFile /tmp/inj-template.tmpl \
	--meshConfigFile /tmp/mesh.yaml \
	--valuesFile /tmp/values.json

istioctl manifest

The manifest subcommand generates, applies, diffs or migrates Istio manifests.

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl manifest diff

The diff subcommand compares manifests from two files or directories.

istioctl manifest diff <file|dir> <file|dir> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--directory -r Compare directory.
--dry-run Console/log output only, make no changes.
--ignore <string> Ignore all listed items during comparison, using the same list format as selectResources. (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--rename <string> Rename resources before comparison. The format of each renaming pair is A->B, all renaming pairs are comma separated. e.g. Service:*:istiod->Service:*:istio-control - rename istiod service into istio-control (default ``)
--select <string> Constrain the list of resources to compare to only the ones in this list, ignoring all others. The format of each list item is "::" and the items are comma separated. The "*" character represents wildcard selection. e.g. Deployment:istio-system:* - compare all deployments in istio-system namespace Service:*:istiod - compare Services called "istiod" in all namespaces (default `::`)
--verbose -v Verbose output.

istioctl manifest generate

The generate subcommand generates an Istio install manifest and outputs to the console by default.

istioctl manifest generate [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--filename <stringSlice> -f Path to file containing IstioOperator custom resource This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)
--force Proceed even with validation errors.
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Manifest output directory path. (default ``)
--revision <string> -r Target control plane revision for the command. (default ``)
--set <stringArray> -s Override an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.policy.enabled=true), or override Istio settings (--set values.grafana.enabled=true). See documentation for more info: https://istio.io/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)

Examples

  # Generate a default Istio installation
  istioctl manifest generate

  # Enable grafana dashboard
  istioctl manifest generate --set values.grafana.enabled=true

  # Generate the demo profile
  istioctl manifest generate --set profile=demo

  # To override a setting that includes dots, escape them with a backslash (\).  Your shell may require enclosing quotes.
  istioctl manifest generate --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"

istioctl manifest install

The install generates an Istio install manifest and applies it to a cluster.

istioctl manifest install [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--filename <stringSlice> -f Path to file containing IstioOperator custom resource This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)
--force Proceed even with validation errors.
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--readiness-timeout <duration> Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--revision <string> -r Target control plane revision for the command. (default ``)
--set <stringArray> -s Override an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.policy.enabled=true), or override Istio settings (--set values.grafana.enabled=true). See documentation for more info: https://istio.io/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-confirmation -y skipConfirmation determines whether the user is prompted for confirmation. If set to true, the user is not prompted and a Yes response is assumed in all cases.

Examples

  # Apply a default Istio installation
  istioctl install

  # Enable grafana dashboard
  istioctl install --set values.grafana.enabled=true

  # Generate the demo profile and don't wait for confirmation
  istioctl install --set profile=demo --skip-confirmation

  # To override a setting that includes dots, escape them with a backslash (\).  Your shell may require enclosing quotes.
  istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"

istioctl operator

The operator subcommand installs, removes and shows the status of the operator controller.

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl operator dump

The dump subcommand dumps the Istio operator controller manifest.

istioctl operator dump [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--hub <string> The hub for the operator controller image (default `unknown`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--operatorNamespace <string> The namespace the operator controller is installed into (default `istio-operator`)
--tag <string> The tag for the operator controller image (default `unknown`)

istioctl operator init

The init subcommand installs the Istio operator controller in the cluster.

istioctl operator init [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--filename <string> -f Path to file containing IstioOperator custom resource (default ``)
--hub <string> The hub for the operator controller image (default `unknown`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--operatorNamespace <string> The namespace the operator controller is installed into (default `istio-operator`)
--revision <string> -r Target control plane revision for the command. (default ``)
--tag <string> The tag for the operator controller image (default `unknown`)
--watchedNamespaces <string> The namespaces the operator controller watches, could be namespace list separated by comma, eg. 'ns1,ns2' (default `istio-system`)

istioctl operator remove

The remove subcommand removes the Istio operator controller from the cluster.

istioctl operator remove [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--force Proceed even with errors
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--operatorNamespace <string> The namespace the operator controller is installed into (default `istio-operator`)
--revision <string> -r Target control plane revision for the command. (default ``)

istioctl options

Displays istioctl global options

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl profile

The profile subcommand lists, dumps or diffs Istio configuration profiles.

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)

Examples

istioctl profile list
istioctl install --set profile=demo  # Use a profile from the list

istioctl profile diff

The diff subcommand displays the differences between two Istio configuration profiles.

istioctl profile diff <file1.yaml> <file2.yaml> [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl profile dump

The dump subcommand dumps the values in an Istio configuration profile.

istioctl profile dump [<profile>] [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--config-path <string> -p The path the root of the configuration subtree to dump e.g. components.pilot. By default, dump whole tree (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--filename <stringSlice> -f Path to file containing IstioOperator custom resource This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of json|yaml|flags (default `yaml`)

istioctl profile list

The list subcommand lists the available Istio configuration profiles.

istioctl profile list [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)

istioctl proxy-config

A group of commands used to retrieve information about proxy configuration from the Envoy config dump

Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of json|short (default `short`)

Examples

  # Retrieve information about proxy configuration from an Envoy instance.
  istioctl proxy-config <clusters|listeners|routes|endpoints|bootstrap> <pod-name[.namespace]>

istioctl proxy-config bootstrap

Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.

istioctl proxy-config bootstrap [<pod-name[.namespace]>] [flags]
istioctl proxy-config b [<pod-name[.namespace]>] [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--file <string> -f Envoy config dump JSON file (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of json|short (default `short`)

Examples

  # Retrieve full bootstrap configuration for a given pod from Envoy.
  istioctl proxy-config bootstrap <pod-name[.namespace]>

  # Retrieve full bootstrap without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config bootstrap --file envoy-config.json

istioctl proxy-config cluster

Retrieve information about cluster configuration for the Envoy instance in the specified pod.

istioctl proxy-config cluster [<pod-name[.namespace]>] [flags]
istioctl proxy-config clusters [<pod-name[.namespace]>] [flags]
istioctl proxy-config c [<pod-name[.namespace]>] [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--direction <string> Filter clusters by Direction field (default ``)
--file <string> -f Envoy config dump JSON file (default ``)
--fqdn <string> Filter clusters by substring of Service FQDN field (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of json|short (default `short`)
--port <int> Filter clusters by Port field (default `0`)
--subset <string> Filter clusters by substring of Subset field (default ``)

Examples

  # Retrieve summary about cluster configuration for a given pod from Envoy.
  istioctl proxy-config clusters <pod-name[.namespace]>

  # Retrieve cluster summary for clusters with port 9080.
  istioctl proxy-config clusters <pod-name[.namespace]> --port 9080

  # Retrieve full cluster dump for clusters that are inbound with a FQDN of details.default.svc.cluster.local.
  istioctl proxy-config clusters <pod-name[.namespace]> --fqdn details.default.svc.cluster.local --direction inbound -o json

  # Retrieve cluster summary without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config clusters --file envoy-config.json

istioctl proxy-config endpoint

Retrieve information about endpoint configuration for the Envoy instance in the specified pod.

istioctl proxy-config endpoint [<pod-name[.namespace]>] [flags]
istioctl proxy-config endpoints [<pod-name[.namespace]>] [flags]
istioctl proxy-config ep [<pod-name[.namespace]>] [flags]
Flags Shorthand Description
--address <string> Filter endpoints by address field (default ``)
--cluster <string> Filter endpoints by cluster name field (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--file <string> -f Envoy config dump JSON file (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of json|short (default `short`)
--port <int> Filter endpoints by Port field (default `0`)
--status <string> Filter endpoints by status field (default ``)

Examples

  # Retrieve full endpoint configuration for a given pod from Envoy.
  istioctl proxy-config endpoint <pod-name[.namespace]>

  # Retrieve endpoint summary for endpoint with port 9080.
  istioctl proxy-config endpoint <pod-name[.namespace]> --port 9080

  # Retrieve full endpoint with a address (172.17.0.2).
  istioctl proxy-config endpoint <pod-name[.namespace]> --address 172.17.0.2 -o json

  # Retrieve full endpoint with a cluster name (outbound|9411||zipkin.istio-system.svc.cluster.local).
  istioctl proxy-config endpoint <pod-name[.namespace]> --cluster "outbound|9411||zipkin.istio-system.svc.cluster.local" -o json
  # Retrieve full endpoint with the status (healthy).
  istioctl proxy-config endpoint <pod-name[.namespace]> --status healthy -ojson

  # Retrieve endpoint summary without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/clusters?format=json' > envoy-clusters.json
  istioctl proxy-config endpoints --file envoy-clusters.json

istioctl proxy-config listener

Retrieve information about listener configuration for the Envoy instance in the specified pod.

istioctl proxy-config listener [<pod-name[.namespace]>] [flags]
istioctl proxy-config listeners [<pod-name[.namespace]>] [flags]
istioctl proxy-config l [<pod-name[.namespace]>] [flags]
Flags Shorthand Description
--address <string> Filter listeners by address field (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--file <string> -f Envoy config dump JSON file (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of json|short (default `short`)
--port <int> Filter listeners by Port field (default `0`)
--type <string> Filter listeners by type field (default ``)
--verbose Output more information

Examples

  # Retrieve summary about listener configuration for a given pod from Envoy.
  istioctl proxy-config listeners <pod-name[.namespace]>

  # Retrieve listener summary for listeners with port 9080.
  istioctl proxy-config listeners <pod-name[.namespace]> --port 9080

  # Retrieve full listener dump for HTTP listeners with a wildcard address (0.0.0.0).
  istioctl proxy-config listeners <pod-name[.namespace]> --type HTTP --address 0.0.0.0 -o json

  # Retrieve listener summary without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config listeners --file envoy-config.json

istioctl proxy-config log

(experimental) Retrieve information about logging levels of the Envoy instance in the specified pod, and update optionally

istioctl proxy-config log <pod-name[.namespace]> [flags]
istioctl proxy-config o <pod-name[.namespace]> [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--level <string> Comma-separated minimum per-logger level of messages to output, in the form of [<logger>:]<level>,[<logger>:]<level>,... where logger can be one of admin, aws, assert, backtrace, client, config, connection, conn_handler, dubbo, file, filter, forward_proxy, grpc, hc, health_checker, http, http2, hystrix, init, io, jwt, kafka, lua, main, misc, mongo, quic, pool, rbac, redis, router, runtime, stats, secret, tap, testing, thrift, tracing, upstream, udp, wasm and level can be one of [trace, debug, info, warning, error, critical, off] (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of json|short (default `short`)
--reset -r Reset levels to default value (warning).

Examples

  # Retrieve information about logging levels for a given pod from Envoy.
  istioctl proxy-config log <pod-name[.namespace]>

  # Update levels of the all loggers
  istioctl proxy-config log <pod-name[.namespace]> --level none

  # Update levels of the specified loggers.
  istioctl proxy-config log <pod-name[.namespace]> --level http:debug,redis:debug

  # Reset levels of all the loggers to default value (warning).
  istioctl proxy-config log <pod-name[.namespace]> -r

istioctl proxy-config route

Retrieve information about route configuration for the Envoy instance in the specified pod.

istioctl proxy-config route [<pod-name[.namespace]>] [flags]
istioctl proxy-config routes [<pod-name[.namespace]>] [flags]
istioctl proxy-config r [<pod-name[.namespace]>] [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--file <string> -f Envoy config dump JSON file (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--name <string> Filter listeners by route name field (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of json|short (default `short`)
--verbose Output more information

Examples

  # Retrieve summary about route configuration for a given pod from Envoy.
  istioctl proxy-config routes <pod-name[.namespace]>

  # Retrieve route summary for route 9080.
  istioctl proxy-config route <pod-name[.namespace]> --name 9080

  # Retrieve full route dump for route 9080
  istioctl proxy-config route <pod-name[.namespace]> --name 9080 -o json

  # Retrieve route summary without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config routes --file envoy-config.json

istioctl proxy-config secret

(experimental) Retrieve information about secret configuration for the Envoy instance in the specified pod.

istioctl proxy-config secret [<pod-name[.namespace]>] [flags]
istioctl proxy-config s [<pod-name[.namespace]>] [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--file <string> -f Envoy config dump JSON file (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o Output format: one of json|short (default `short`)

Examples

  # Retrieve full secret configuration for a given pod from Envoy.
  istioctl proxy-config secret <pod-name[.namespace]>

  # Retrieve full bootstrap without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config secret --file envoy-config.json

THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl proxy-status

Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh

istioctl proxy-status [<pod-name[.namespace]>] [flags]
istioctl ps [<pod-name[.namespace]>] [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--file <string> -f Envoy config dump JSON file (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--revision <string> control plane revision (default ``)

Examples

# Retrieve sync status for all Envoys in a mesh
	istioctl proxy-status

# Retrieve sync diff for a single Envoy and Istiod
	istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system

# Write proxy config-dump to file, and compare to Istio control plane
    kubectl port-forward -n istio-system istio-egressgateway-59585c5b9c-ndc59 15000 &
    curl localhost:15000/config_dump > cd.json
    istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system --file cd.json

istioctl register

Registers a service instance (e.g. VM) joining the mesh

istioctl register <svcname> <ip> [name1:]port1 [name2:]port2 ... [flags]
Flags Shorthand Description
--annotations <stringSlice> -a List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,test,x=y (default `[]`)
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--labels <stringSlice> -l List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)
--namespace <string> -n Config namespace (default ``)
--serviceaccount <string> -s Service account to link to the service (default `default`)

istioctl upgrade

The upgrade command checks for upgrade version eligibility and, if eligible, upgrades the Istio control plane components in-place. Warning: traffic may be disrupted during upgrade. Please ensure PodDisruptionBudgets are defined to maintain service continuity.

istioctl upgrade [flags]
Flags Shorthand Description
--charts <string> Deprecated, use --manifests instead. (default ``)
--context <string> The name of the kubeconfig context to use (default ``)
--dry-run Console/log output only, make no changes.
--filename <stringSlice> -f Path to file containing IstioOperator custom resource (default `[]`)
--force Apply the upgrade without eligibility checks
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--readiness-timeout <duration> Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--set <stringArray> -s Override an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.policy.enabled=true), or override Istio settings (--set values.grafana.enabled=true). See documentation for more info: https://istio.io/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-confirmation -y If skip-confirmation is set, skips the prompting confirmation for value changes in this upgrade

istioctl validate

Validate Istio policy and rules (NOTE: validate is deprecated and will be removed in 1.6. Use 'istioctl analyze' to validate configuration.)

istioctl validate -f FILENAME [options] [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--filename <stringSlice> -f Names of files to validate (default `[]`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--referential -x Enable structural validation for policy and telemetry

Examples


		# Validate bookinfo-gateway.yaml
		istioctl validate -f bookinfo-gateway.yaml
		
		# Validate current deployments under 'default' namespace within the cluster
		kubectl get deployments -o yaml |istioctl validate -f -

		# Validate current services under 'default' namespace within the cluster
		kubectl get services -o yaml |istioctl validate -f -

		# Also see the related command 'istioctl analyze'
		istioctl analyze samples/bookinfo/networking/bookinfo-gateway.yaml

istioctl verify-install

verify-install verifies Istio installation status against the installation file you specified when you installed Istio. It loops through all the installation resources defined in your installation file and reports whether all of them are in ready status. It will report failure when any of them are not ready.

If you do not specify installation file it will perform pre-check for your cluster and report whether the cluster is ready for Istio installation.

istioctl verify-install [-f <deployment or istio operator file>] [--revision <revision>] [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--enableVerbose Enable verbose output
--filename <stringSlice> -f Istio YAML installation file. (default `[]`)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--manifests <string> -d Specify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.7.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.7.0/istio-1.7.0-linux-amd64.tar.gz). (default ``)
--namespace <string> -n Config namespace (default ``)
--recursive -R Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--revision <string> control plane revision (default ``)

Examples


		# Verify that Istio can be freshly installed
		istioctl verify-install

		# Verify the deployment matches a custom Istio deployment configuration
		istioctl verify-install -f $HOME/istio.yaml

		# Verify the deployment matches the Istio Operator deployment definition
		istioctl verify-install --revision <canary>

istioctl version

Prints out build version information

istioctl version [flags]
Flags Shorthand Description
--context <string> The name of the kubeconfig context to use (default ``)
--istioNamespace <string> -i Istio system namespace (default `istio-system`)
--kubeconfig <string> -c Kubernetes configuration file (default ``)
--namespace <string> -n Config namespace (default ``)
--output <string> -o One of 'yaml' or 'json'. (default ``)
--remote Use --remote=false to suppress control plane check
--revision <string> control plane revision (default ``)
--short -s Use --short=false to generate full version information

Environment variables

These environment variables affect the behavior of the istioctl command.
Variable Name Type Default Value Description
BYPASS_OOP_MTLS_SAN_VERIFICATION Boolean false Whether or not to validate SANs for out-of-process adapters auth.
CENTRAL_ISTIOD Boolean false If this is set to true, one Istiod will control remote clusters including CA.
CLUSTER_ID String Kubernetes Defines the cluster and service registry that this Istiod instance is belongs to
ENABLE_CA_SERVER Boolean true If this is set to false, will not create CA server in istiod.
INGRESS_GATEWAY_NAMESPACE String
INJECTION_WEBHOOK_CONFIG_NAME String istio-sidecar-injector Name of the mutatingwebhookconfiguration to patch, if istioctl is not used.
ISTIOCONFIG String $HOME/.istioctl/config.yaml Default values for istioctl flags
ISTIOCTL_AUTHORITY String istioctl --authority override
ISTIOCTL_CERT_DIR String istioctl --cert-dir override
ISTIOCTL_INSECURE Boolean false istioctl --insecure override
ISTIOCTL_ISTIONAMESPACE String istio-system istioctl --istioNamespace override
ISTIOCTL_PREFER_EXPERIMENTAL Boolean false istioctl should use experimental subcommand variants
ISTIOCTL_XDS_ADDRESS String istioctl --xds-address override
ISTIOCTL_XDS_PORT Integer 15012 istioctl --xds-port override
ISTIOD_CUSTOM_HOST String Custom host name of istiod that istiod signs the server cert.
ISTIO_DEFAULT_REQUEST_TIMEOUT Time Duration 0s Default Http and gRPC Request timeout
ISTIO_GPRC_MAXRECVMSGSIZE Integer 4194304 Sets the max receive buffer size of gRPC stream in bytes.
ISTIO_GPRC_MAXSTREAMS Integer 100000 Sets the maximum number of concurrent grpc streams.
ISTIO_LANG String Selects the attribute expression language runtime for Mixer.
ISTIO_PROMETHEUS_ANNOTATIONS String
JWT_POLICY String third-party-jwt The JWT validation policy.
K8S_INGRESS_NS String
PILOT_CERT_PROVIDER String istiod the provider of Pilot DNS certificate.
PILOT_DEBOUNCE_AFTER Time Duration 100ms The delay added to config/registry events for debouncing. This will delay the push by at least this internal. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX.
PILOT_DEBOUNCE_MAX Time Duration 10s The maximum amount of time to wait for events while debouncing. If events keep showing up with no breaks for this time, we'll trigger a push.
PILOT_DEBUG_ADSZ_CONFIG Boolean false
PILOT_DISTRIBUTION_HISTORY_RETENTION Time Duration 1m0s If enabled, Pilot will keep track of old versions of distributed config for this duration.
PILOT_ENABLED_SERVICE_APIS Boolean false If this is set to true, support for Kubernetes service-apis (github.com/kubernetes-sigs/service-apis) will be enabled. This feature is currently experimental, and is off by default.
PILOT_ENABLE_ANALYSIS Boolean false If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING Boolean true If enabled, Pilot will assign meaningful nonces to each Envoy configuration message, and allow users to interrogate which envoy has which config from the debug interface.
PILOT_ENABLE_CRD_VALIDATION Boolean false If enabled, pilot will validate CRDs while retrieving CRDs from kubernetes cache.Use this flag to enable validation of CRDs in Pilot, especially in deployments that do not have galley installed.
PILOT_ENABLE_EDS_DEBOUNCE Boolean true If enabled, Pilot will include EDS pushes in the push debouncing, configured by PILOT_DEBOUNCE_AFTER and PILOT_DEBOUNCE_MAX. EDS pushes may be delayed, but there will be fewer pushes. By default this is enabled
PILOT_ENABLE_EDS_FOR_HEADLESS_SERVICES Boolean false If enabled, for headless service in Kubernetes, pilot will send endpoints over EDS, allowing the sidecar to load balance among pods in the headless service. This feature should be enabled if applications access all services explicitly via a HTTP proxy port in the sidecar.
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS Boolean true If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.
PILOT_ENABLE_INCREMENTAL_MCP Boolean false If enabled, pilot will set the incremental flag of the options in the mcp controller to true, and then galley may push data incrementally, it depends on whether the resource supports incremental. By default, this is false.
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES Boolean true If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature
PILOT_ENABLE_MYSQL_FILTER Boolean false EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain.
PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUND Boolean true If enabled, protocol sniffing will be used for inbound listeners whose port protocol is not specified or unsupported
PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_OUTBOUND Boolean true If enabled, protocol sniffing will be used for outbound listeners whose port protocol is not specified or unsupported
PILOT_ENABLE_REDIS_FILTER Boolean false EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain.
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS Boolean true If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature
PILOT_ENABLE_STATUS Boolean false If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status.
PILOT_ENABLE_TCP_METADATA_EXCHANGE Boolean true If enabled, metadata exchange will be enabled for TCP using ALPN and Network Metadata Exchange filters in Envoy
PILOT_ENABLE_THRIFT_FILTER Boolean false EnableThriftFilter enables injection of `envoy.filters.network.thrift_proxy` in the filter chain.
PILOT_ENABLE_VIRTUAL_SERVICE_DELEGATE Boolean false If enabled, Pilot will merge virtual services with delegates. By default, this is false, and virtualService with delegate will be ignored
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG Boolean false
PILOT_HTTP10 Boolean false Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.
PILOT_INBOUND_PROTOCOL_DETECTION_TIMEOUT Time Duration 1s Protocol detection timeout for inbound listener
PILOT_INITIAL_FETCH_TIMEOUT Time Duration 0s Specifies the initial_fetch_timeout for config. If this time is reached without a response to the config requested by Envoy, the Envoy will move on with the init phase. This prevents envoy from getting stuck waiting on config during startup.
PILOT_PUSH_THROTTLE Integer 100 Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes
PILOT_SCOPE_GATEWAY_TO_NAMESPACE Boolean false If enabled, a gateway workload can only select gateway resources in the same namespace. Gateways with same selectors in different namespaces will not be applicable.
PILOT_SIDECAR_USE_REMOTE_ADDRESS Boolean false UseRemoteAddress sets useRemoteAddress to true for side car outbound listeners.
PILOT_SKIP_VALIDATE_TRUST_DOMAIN Boolean false Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy
PILOT_STATUS_BURST Integer 500 If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst
PILOT_STATUS_QPS Floating-Point 100 If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS
PILOT_TRACE_SAMPLING Floating-Point 100 Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 100, not recommended for production use.
PILOT_USE_ENDPOINT_SLICE Boolean false If enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used
POD_NAME String
SECRET_WATCHER_RESYNC_PERIOD String
SPIFFE_BUNDLE_ENDPOINTS String The SPIFFE bundle trust domain to endpoint mappings. Istiod retrieves the root certificate from each SPIFFE bundle endpoint and uses it to verify client certifiates from that trust domain. The endpoint must be compliant to the SPIFFE Bundle Endpoint standard. For details, please refer to https://github.com/spiffe/spiffe/blob/master/standards/SPIFFE_Trust_Domain_and_Bundle.md . No need to configure this for root certificates issued via Istiod or web-PKI based root certificates. Use || between <trustdomain, endpoint> tuples. Use | as delimiter between trust domain and endpoint in each tuple. For example: foo|https://url/for/foo||bar|https://url/for/bar
TERM String Specifies terminal type. Use 'dumb' to suppress color output
TERMINATION_DRAIN_DURATION_SECONDS Integer 5 The amount of time allowed for connections to complete on pilot-agent shutdown. On receiving SIGTERM or SIGINT, pilot-agent tells the active Envoy to start draining, preventing any new connections and allowing existing connections to complete. It then sleeps for the TerminationDrainDuration and then kills any remaining active Envoy processes.
XDS_AUTH Boolean true If true, will authenticate XDS clients.

Exported metrics

Metric NameTypeDescription
endpoint_no_podLastValueEndpoints without an associated pod.
galley_runtime_processor_event_span_duration_millisecondsDistributionThe duration between each incoming event
galley_runtime_processor_events_processed_totalCountThe number of events that have been processed
galley_runtime_processor_snapshot_events_totalDistributionThe number of events per snapshot
galley_runtime_processor_snapshot_lifetime_duration_millisecondsDistributionThe duration of each snapshot
galley_runtime_processor_snapshots_published_totalCountThe number of snapshots that have been published
galley_runtime_state_type_instances_totalLastValueThe number of type instances per type URL
galley_runtime_strategy_on_change_totalCountThe number of times the strategy's onChange has been called
galley_runtime_strategy_timer_max_time_reached_totalCountThe number of times the max time has been reached
galley_runtime_strategy_timer_quiesce_reached_totalCountThe number of times a quiesce has been reached
galley_runtime_strategy_timer_resets_totalCountThe number of times the timer has been reset
galley_source_kube_dynamic_converter_failure_totalCountThe number of times a dynamnic kubernetes source failed converting a resources
galley_source_kube_dynamic_converter_success_totalCountThe number of times a dynamic kubernetes source successfully converted a resource
galley_source_kube_event_error_totalCountThe number of times a kubernetes source encountered errored while handling an event
galley_source_kube_event_success_totalCountThe number of times a kubernetes source successfully handled an event
galley_validation_config_delete_errorCountk8s webhook configuration delete error
galley_validation_config_loadCountk8s webhook configuration (re)loads
galley_validation_config_load_errorCountk8s webhook configuration (re)load error
galley_validation_config_update_errorCountk8s webhook configuration update error
galley_validation_config_updatesCountk8s webhook configuration updates
istio_buildLastValueIstio component build info
istio_mcp_clients_totalLastValueThe number of streams currently connected.
istio_mcp_message_sizes_bytesDistributionSize of messages received from clients.
istio_mcp_reconnectionsSumThe number of times the sink has reconnected.
istio_mcp_recv_failures_totalSumThe number of recv failures in the source.
istio_mcp_request_acks_totalSumThe number of request acks received by the source.
istio_mcp_request_nacks_totalSumThe number of request nacks received by the source.
istio_mcp_send_failures_totalSumThe number of send failures in the source.
mixer_config_adapter_info_config_errors_totalLastValueThe number of errors encountered during processing of the adapter info configuration.
mixer_config_adapter_info_configs_totalLastValueThe number of known adapters in the current config.
mixer_config_attributes_totalLastValueThe number of known attributes in the current config.
mixer_config_handler_configs_totalLastValueThe number of known handlers in the current config.
mixer_config_handler_validation_error_totalLastValueThe number of errors encountered because handler validation returned error.
mixer_config_instance_config_errors_totalLastValueThe number of errors encountered during processing of the instance configuration.
mixer_config_instance_configs_totalLastValueThe number of known instances in the current config.
mixer_config_rule_config_errors_totalLastValueThe number of errors encountered during processing of the rule configuration.
mixer_config_rule_config_match_error_totalLastValueThe number of rule conditions that was not parseable.
mixer_config_rule_configs_totalLastValueThe number of known rules in the current config.
mixer_config_template_config_errors_totalLastValueThe number of errors encountered during processing of the template configuration.
mixer_config_template_configs_totalLastValueThe number of known templates in the current config.
mixer_config_unsatisfied_action_handler_totalLastValueThe number of actions that failed due to handlers being unavailable.
mixer_dispatcher_destinations_per_requestDistributionNumber of handlers dispatched per request by Mixer
mixer_dispatcher_destinations_per_variety_totalLastValueNumber of Mixer adapter destinations by template variety type
mixer_dispatcher_instances_per_requestDistributionNumber of instances created per request by Mixer
mixer_handler_closed_handlers_totalLastValueThe number of handlers that were closed during config transition.
mixer_handler_daemons_totalLastValueThe current number of active daemon routines in a given adapter environment.
mixer_handler_handler_build_failures_totalLastValueThe number of handlers that failed creation during config transition.
mixer_handler_handler_close_failures_totalLastValueThe number of errors encountered while closing handlers during config transition.
mixer_handler_new_handlers_totalLastValueThe number of handlers that were newly created during config transition.
mixer_handler_reused_handlers_totalLastValueThe number of handlers that were re-used during config transition.
mixer_handler_workers_totalLastValueThe current number of active worker routines in a given adapter environment.
mixer_runtime_dispatch_duration_secondsDistributionDuration in seconds for adapter dispatches handled by Mixer.
mixer_runtime_dispatches_totalCountTotal number of adapter dispatches handled by Mixer.
num_failed_outgoing_requestsSumNumber of failed outgoing requests (e.g. to a token exchange server, CA, etc.)
num_outgoing_requestsSumNumber of total outgoing requests (e.g. to a token exchange server, CA, etc.)
num_outgoing_retriesSumNumber of outgoing retry requests (e.g. to a token exchange server, CA, etc.)
outgoing_latencySumThe latency of outgoing requests (e.g. to a token exchange server, CA, etc.) in milliseconds.
pilot_conflict_inbound_listenerLastValueNumber of conflicting inbound listeners.
pilot_conflict_outbound_listener_http_over_current_tcpLastValueNumber of conflicting wildcard http listeners with current wildcard tcp listener.
pilot_conflict_outbound_listener_tcp_over_current_httpLastValueNumber of conflicting wildcard tcp listeners with current wildcard http listener.
pilot_conflict_outbound_listener_tcp_over_current_tcpLastValueNumber of conflicting tcp listeners with current tcp listener.
pilot_destrule_subsetsLastValueDuplicate subsets across destination rules for same host
pilot_duplicate_envoy_clustersLastValueDuplicate envoy clusters caused by service entries with same hostname
pilot_eds_no_instancesLastValueNumber of clusters without instances.
pilot_endpoint_not_readyLastValueEndpoint found in unready state.
pilot_inbound_updatesSumTotal number of updates received by pilot.
pilot_invalid_out_listenersLastValueNumber of invalid outbound listeners.
pilot_jwks_resolver_network_fetch_fail_totalSumTotal number of failed network fetch by pilot jwks resolver
pilot_jwks_resolver_network_fetch_success_totalSumTotal number of successfully network fetch by pilot jwks resolver
pilot_k8s_endpoints_pending_podLastValueNumber of endpoints that do not currently have any corresponding pods.
pilot_k8s_endpoints_with_no_podsSumEndpoints that does not have any corresponding pods.
pilot_k8s_reg_eventsSumEvents from k8s registry.
pilot_no_ipLastValuePods not found in the endpoint table, possibly invalid.
pilot_proxy_convergence_timeDistributionDelay in seconds between config change and a proxy receiving all required configuration.
pilot_proxy_queue_timeDistributionTime in seconds, a proxy is in the push queue before being dequeued.
pilot_push_triggersSumTotal number of times a push was triggered, labeled by reason for the push.
pilot_servicesLastValueTotal services known to pilot.
pilot_total_rejected_configsSumTotal number of configs that Pilot had to reject or ignore.
pilot_total_xds_internal_errorsSumTotal number of internal XDS errors in pilot.
pilot_total_xds_rejectsSumTotal number of XDS responses from pilot rejected by proxy.
pilot_virt_servicesLastValueTotal virtual services known to pilot.
pilot_vservice_dup_domainLastValueVirtual services with dup domains.
pilot_xdsLastValueNumber of endpoints connected to this pilot using XDS.
pilot_xds_cds_rejectLastValuePilot rejected CDS configs.
pilot_xds_eds_rejectLastValuePilot rejected EDS.
pilot_xds_expired_nonceSumTotal number of XDS requests with an expired nonce.
pilot_xds_lds_rejectLastValuePilot rejected LDS.
pilot_xds_push_context_errorsSumNumber of errors (timeouts) initiating push context.
pilot_xds_push_timeDistributionTotal time in seconds Pilot takes to push lds, rds, cds and eds.
pilot_xds_pushesSumPilot build and send errors for lds, rds, cds and eds.
pilot_xds_rds_rejectLastValuePilot rejected RDS.
pilot_xds_write_timeoutSumPilot XDS response write timeouts.
scrape_failures_totalSumThe total number of failed scrapes.
scrapes_totalSumThe total number of scrapes.
sidecar_injection_failure_totalSumTotal number of failed sidecar injection requests.
sidecar_injection_requests_totalSumTotal number of sidecar injection requests.
sidecar_injection_skip_totalSumTotal number of skipped sidecar injection requests.
sidecar_injection_success_totalSumTotal number of successful sidecar injection requests.
Was this information useful?
Do you have any suggestions for improvement?

Thanks for your feedback!