istioctl

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

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl admin

A group of commands used to manage istiod configuration

istioctl admin [flags]
istioctl istiod [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--selector <string>-llabel selector (default `app=istiod`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Retrieve information about istiod configuration.
  istioctl admin log

istioctl admin log

Retrieve or update logging levels of istiod components.

istioctl admin log [<pod-name>] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[-r|--reset]|[--output|-o short|yaml] [flags]
istioctl admin l [<pod-name>] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[-r|--reset]|[--output|-o short|yaml] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--ctrlz_port <int>ControlZ port (default `9876`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--level <string>Comma-separated list of output logging level for scopes in format <scope>:<level>[,<scope>:<level>,...]Possible values for <level>: none, error, warn, info, debug (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|short (default `short`)
--reset-rReset levels to default value. (info)
--selector <string>-llabel selector (default `app=istiod`)
--stack-trace-level <string>Comma-separated list of stack trace level for scopes in format <scope>:<stack-trace-level>[,<scope>:<stack-trace-level>,...] Possible values for <stack-trace-level>: none, error, warn, info, debug (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Retrieve information about istiod logging levels.
  istioctl admin log

  # Retrieve information about istiod logging levels on a specific control plane pod.
  istioctl admin l istiod-5c868d8bdd-pmvgg

  # Update levels of the specified loggers.
  istioctl admin log --level ads:debug,authorization:debug

  # Reset levels of all the loggers to default value (info).
  istioctl admin log -r

istioctl analyze

Analyze Istio configuration and print validation messages

istioctl analyze <file>... [flags]
FlagsShorthandDescription
--all-namespaces-AAnalyze all namespaces
--colorDefault 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 Warning Error] (default `Error`)
--ignore-unknownDon't complain about un-parseable input documents, for cases where analyze should run only on k8s compliant inputs.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--list-analyzers-LList the analyzers available to run. Suppresses normal execution.
--meshConfigFile <string>Overrides the mesh config values to use for analysis. (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of [log json yaml] (default `log`)
--output-threshold <Level>The severity level of analysis at which to display messages. Valid values: [Info Warning Error] (default `Info`)
--recursive-RProcess directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory.
--suppress <stringArray>-SSuppress 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-kUse live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only.
--verbose-vEnable verbose output
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl bug-report

bug-report selectively captures cluster information and logs into an archive to help diagnose problems. Proxy logs can be filtered using: --include|--exclude ns1,ns2.../dep1,dep2.../pod1,pod2.../lbl1=val1,lbl2=val2.../ann1=val1,ann2=val2.../cntr1,cntr... where ns=namespace, dep=deployment, lbl=label, ann=annotation, cntr=container

The filter spec is interpreted as 'must be in (ns1 OR ns2) AND (dep1 OR dep2) AND (cntr1 OR cntr2)...' The log will be included only if the container matches at least one include filter and does not match any exclude filters. All parts of the filter are optional and can be omitted e.g. ns1//pod1 filters only for namespace ns1 and pod1. All names except label and annotation keys support '*' glob matching pattern.

e.g. --include ns1,ns2 (only namespaces ns1 and ns2) --include n*//p*/l=v* (pods with name beginning with 'p' in namespaces beginning with 'n' and having label 'l' with value beginning with 'v'.)

istioctl bug-report [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--critical-errs <stringSlice>List of comma separated glob patterns to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`)
--dir <string>Set a specific directory for temporary artifact storage. (default ``)
--dry-runOnly log commands that would be run, don't fetch or write.
--duration <duration>How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, --start-time must be unset. (default `0s`)
--end-time <string>End time for the range of log entries to include in the archive. Default is now. (default ``)
--exclude <stringSlice>Spec for which pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-node-lease,kube-public,kube-system,local-path-storage"]`)
--filename <string>-fPath to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``)
--full-secretsIf set, secret contents are included in output.
--ignore-errs <stringSlice>List of comma separated glob patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`)
--include <stringSlice>Spec for which pod's proxy logs to include in the archive. See above for format and examples. (default `[]`)
--istio-namespace <string>Namespace where Istio control plane is installed. (default `istio-system`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--start-time <string>Start time for the range of log entries to include in the archive. Default is the infinite past. If set, --duration must be unset. (default ``)
--timeout <duration>Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl bug-report version

Prints out build version information

istioctl bug-report version [flags]
FlagsShorthandDescription
--context <string>Name of the kubeconfig Context to use. (default ``)
--critical-errs <stringSlice>List of comma separated glob patterns to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`)
--dir <string>Set a specific directory for temporary artifact storage. (default ``)
--dry-runOnly log commands that would be run, don't fetch or write.
--duration <duration>How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, --start-time must be unset. (default `0s`)
--end-time <string>End time for the range of log entries to include in the archive. Default is now. (default ``)
--exclude <stringSlice>Spec for which pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-node-lease,kube-public,kube-system,local-path-storage"]`)
--filename <string>-fPath to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``)
--full-secretsIf set, secret contents are included in output.
--ignore-errs <stringSlice>List of comma separated glob patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`)
--include <stringSlice>Spec for which pod's proxy logs to include in the archive. See above for format and examples. (default `[]`)
--istio-namespace <string>Namespace where Istio control plane is installed. (default `istio-system`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cPath to kube config. (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOne of 'yaml' or 'json'. (default ``)
--short-sUse --short=false to generate full version information
--start-time <string>Start time for the range of log entries to include in the archive. Default is the infinite past. If set, --duration must be unset. (default ``)
--timeout <duration>Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl completion

Generate the autocompletion script for istioctl for the specified shell. See each sub-command's help for details on how to use the generated script.

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl completion bash

Generate the autocompletion script for the bash shell.

This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

source <(istioctl completion bash)

To load completions for every new session, execute once:

#### Linux:

istioctl completion bash > /etc/bash_completion.d/istioctl

#### macOS:

istioctl completion bash > /usr/local/etc/bash_completion.d/istioctl

You will need to start a new shell for this setup to take effect.

istioctl completion bash
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--no-descriptionsdisable completion descriptions
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl completion fish

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

istioctl completion fish | source

To load completions for every new session, execute once:

istioctl completion fish > ~/.config/fish/completions/istioctl.fish

You will need to start a new shell for this setup to take effect.

istioctl completion fish [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--no-descriptionsdisable completion descriptions
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl completion powershell

Generate the autocompletion script for powershell.

To load completions in your current shell session:

istioctl completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command to your powershell profile.

istioctl completion powershell [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--no-descriptionsdisable completion descriptions
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl completion zsh

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions for every new session, execute once:

#### Linux:

istioctl completion zsh > "${fpath[1]}/_istioctl"

#### macOS:

istioctl completion zsh > /usr/local/share/zsh/site-functions/_istioctl

You will need to start a new shell for this setup to take effect.

istioctl completion zsh [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--no-descriptionsdisable completion descriptions
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl dashboard

Access to Istio web UIs

istioctl dashboard [flags]
istioctl dash [flags]
istioctl d [flags]
FlagsShorthandDescription
--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`)
--browserWhen --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--port <int>-pLocal port to listen to (default `0`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl dashboard controlz

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

istioctl dashboard controlz [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--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`)
--browserWhen --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.
--context <string>The name of the kubeconfig context to use (default ``)
--ctrlz_port <int>ControlZ port (default `9876`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--selector <string>-lLabel selector (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Open ControlZ web UI for the istiod-123-456.istio-system pod
  istioctl dashboard controlz istiod-123-456.istio-system

  # Open ControlZ web UI for the istiod-56dd66799-jfdvs pod in a custom namespace
  istioctl dashboard controlz istiod-123-456 -n custom-ns

  # Open ControlZ web UI for any Istiod pod
  istioctl dashboard controlz deployment/istiod.istio-system

  # with short syntax
  istioctl dash controlz pilot-123-456.istio-system
  istioctl d controlz pilot-123-456.istio-system

istioctl dashboard envoy

Open the Envoy admin dashboard for a sidecar

istioctl dashboard envoy [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--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`)
--browserWhen --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--selector <string>-lLabel selector (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Open Envoy dashboard for the productpage-123-456.default pod
  istioctl dashboard envoy productpage-123-456.default

  # Open Envoy dashboard for one pod under a deployment
  istioctl dashboard envoy deployment/productpage-v1

  # with short syntax
  istioctl dash envoy productpage-123-456.default
  istioctl d envoy productpage-123-456.default

istioctl dashboard grafana

Open Istio's Grafana dashboard

istioctl dashboard grafana [flags]
FlagsShorthandDescription
--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`)
--browserWhen --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl dashboard grafana

  # with short syntax
  istioctl dash grafana
  istioctl d grafana

istioctl dashboard jaeger

Open Istio's Jaeger dashboard

istioctl dashboard jaeger [flags]
FlagsShorthandDescription
--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`)
--browserWhen --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl dashboard jaeger

  # with short syntax
  istioctl dash jaeger
  istioctl d jaeger

istioctl dashboard kiali

Open Istio's Kiali dashboard

istioctl dashboard kiali [flags]
FlagsShorthandDescription
--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`)
--browserWhen --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl dashboard kiali

  # with short syntax
  istioctl dash kiali
  istioctl d kiali

istioctl dashboard prometheus

Open Istio's Prometheus dashboard

istioctl dashboard prometheus [flags]
FlagsShorthandDescription
--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`)
--browserWhen --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl dashboard prometheus

  # with short syntax
  istioctl dash prometheus
  istioctl d prometheus

istioctl dashboard skywalking

Open the Istio dashboard in the SkyWalking UI

istioctl dashboard skywalking [flags]
FlagsShorthandDescription
--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`)
--browserWhen --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl dashboard skywalking

  # with short syntax
  istioctl dash skywalking
  istioctl d skywalking

istioctl dashboard zipkin

Open Istio's Zipkin dashboard

istioctl dashboard zipkin [flags]
FlagsShorthandDescription
--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`)
--browserWhen --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl dashboard zipkin

  # with short syntax
  istioctl dash zipkin
  istioctl d zipkin

istioctl experimental

Experimental commands that may be modified or deprecated

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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.

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

istioctl experimental add-to-mesh [flags]
istioctl experimental add [flags]
FlagsShorthandDescription
--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>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes 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>-nConfig namespace (default ``)
--valuesFile <string>Injection values configuration filename. (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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

  # Restart just pods from the details-v1 deployment
  istioctl x add deployment details-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/v1.14/docs/ops/deployment/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]
istioctl experimental add-to-mesh deploy <deployment> [flags]
istioctl experimental add-to-mesh dep <deployment> [flags]
FlagsShorthandDescription
--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>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes 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>-nConfig namespace (default ``)
--revision <string>-rControl plane revision (default ``)
--valuesFile <string>Injection values configuration filename. (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

  # Restart pods from the details-v1 deployment with Istio sidecar
  istioctl x add-to-mesh deploy details-v1

  # Restart pods from the ratings-v1 deployment with Istio sidecar
  istioctl x add dep ratings-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]
istioctl experimental add-to-mesh es <svcname> <ip> [name1:]port1 [[name2:]port2] ... [flags]
FlagsShorthandDescription
--annotations <stringSlice>-aList 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>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--labels <stringSlice>-lList 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>-nConfig namespace (default ``)
--serviceaccount <string>-sService account to link to the service (default `default`)
--valuesFile <string>Injection values configuration filename. (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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/v1.14/docs/ops/deployment/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]
istioctl experimental add-to-mesh svc <service> [flags]
FlagsShorthandDescription
--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>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes 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>-nConfig namespace (default ``)
--revision <string>-rControl plane revision (default ``)
--valuesFile <string>Injection values configuration filename. (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

  # Restart all details-v1 pods with an Istio sidecar
  istioctl x add-to-mesh svc details-v1

  # Restart all ratings-v1 pods with an Istio sidecar
  istioctl x add svc ratings-v1

istioctl experimental authz

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

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl experimental authz check

Check prints the AuthorizationPolicy applied to a pod by directly checking the Envoy configuration of the pod. The command is especially useful for inspecting the policy propagation from Istiod to Envoy and the final AuthorizationPolicy list merged from multiple sources (mesh-level, namespace-level and workload-level).

The command also supports reading from a standalone config dump file with flag -f.

istioctl experimental authz check [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--file <string>-fThe json file with Envoy config dump to be checked (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Check AuthorizationPolicy applied to pod httpbin-88ddbcfdd-nt5jb:
  istioctl x authz check httpbin-88ddbcfdd-nt5jb

  # Check AuthorizationPolicy applied to one pod under a deployment
  istioctl x authz check deployment/productpage-v1

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

istioctl experimental config

Configure istioctl defaults

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # list configuration parameters
  istioctl config list

istioctl experimental config list

List istio configurable defaults

istioctl experimental config list [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl experimental create-remote-secret

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

istioctl experimental create-remote-secret [flags]
FlagsShorthandDescription
--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 ``)
--create-service-accountIf true, the service account needed for creating the remote secret will be created if it doesn't exist.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (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>-nConfig namespace (default ``)
--secret-name <string>The name of the specific secret to use from the service-account. Needed when there are multiple secrets in the service account. (default ``)
--server <string>The address and port of the Kubernetes API server. (default ``)
--service-account <string>Create a secret with this service account's credentials. Default value is "istio-reader-service-account" if --type is "remote", "istiod" if --type is "config". (default ``)
--type <SecretType>Type of the generated secret. supported values = [remote config] (default `remote`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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 describe

Describe resource and related Istio configuration

istioctl experimental describe [flags]
istioctl experimental des [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl experimental describe pod

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

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

istioctl experimental describe pod <pod> [flags]
istioctl experimental describe po <pod> [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--ignoreUnmeshedSuppress warnings for unmeshed pods
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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 UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl experimental describe service <svc> [flags]
istioctl experimental describe svc <svc> [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--ignoreUnmeshedSuppress warnings for unmeshed pods
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl experimental describe service productpage

istioctl experimental envoy-stats

Retrieve Envoy emitted metrics for the specified pod.

istioctl experimental envoy-stats [<type>/]<name>[.<namespace>] [flags]
istioctl experimental es [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|prom (default `short`)
--type <string>-tWhere to grab the stats: one of server|clusters (default `server`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Retrieve Envoy emitted metrics for the specified pod.
  istioctl experimental envoy-stats <pod-name[.namespace]>

  # Retrieve Envoy server metrics in prometheus format
  istioctl experimental envoy-stats <pod-name[.namespace]> --output prom

  # Retrieve Envoy server metrics in prometheus format with merged application metrics
  istioctl experimental envoy-stats <pod-name[.namespace]> --output prom-merged

  # Retrieve Envoy cluster metrics
  istioctl experimental envoy-stats <pod-name[.namespace]> --type clusters

istioctl experimental injector

List sidecar injector and sidecar versions

istioctl experimental injector [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl experimental injector list

istioctl experimental injector list

List sidecar injector and sidecar versions

istioctl experimental injector list [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl experimental injector list

istioctl experimental internal-debug

Retrieves the debug information from Istiod or Pods in the mesh using the service account from the pod if --cert-dir is empty. By default it will use the default serviceAccount from (istio-system) namespace if the pod is not specified.

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

istioctl experimental internal-debug [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--allSend the same request to all instances of Istiod. Only applicable for in-cluster deployment.
--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 ``)
--insecureSkip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--plaintextUse plain-text HTTP/2 when connecting to server (no TLS).
--revision <string>-rControl plane revision (default ``)
--timeout <duration>The duration to wait before failing (default `30s`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--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 x internal-debug syncz

  # Retrieve sync diff for a single Envoy and Istiod
  istioctl x internal-debug syncz istio-egressgateway-59585c5b9c-ndc59.istio-system

  # SECURITY OPTIONS

  # Retrieve syncz debug information directly from the control plane, using token security
  # (This is the usual way to get the debug information with an out-of-cluster control plane.)
  istioctl x internal-debug syncz --xds-address istio.cloudprovider.example.com:15012

  # Retrieve syncz debug information via Kubernetes config, using token security
  # (This is the usual way to get the debug information with an in-cluster control plane.)
  istioctl x internal-debug syncz

  # Retrieve syncz debug information directly from the control plane, using RSA certificate security
  # (Certificates must be obtained before this step.  The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
  istioctl x internal-debug syncz --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs

  # Retrieve syncz information via XDS from specific control plane in multi-control plane in-cluster configuration
  # (Select a specific control plane in an in-cluster canary Istio configuration.)
  istioctl x internal-debug syncz --xds-label istio.io/rev=default

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]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--filename <string>-fInput Kubernetes resource filename (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oModified output Kubernetes resource filename (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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>...
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--duration <duration>-dDuration of query metrics, default value is 1m. (default `1m0s`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

  # Retrieve workload metrics for various services with custom duration
  istioctl experimental metrics productpage-v1 -d 2m

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

istioctl experimental precheck

precheck inspects a Kubernetes cluster for Istio install and upgrade requirements.

istioctl experimental precheck [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--revision <string>-rControl plane revision (default ``)
--skip-controlplaneskip checking the control plane
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Verify that Istio can be installed or upgraded
  istioctl x precheck

  # Check only a single namespace
  istioctl x precheck --namespace default

istioctl experimental proxy-status

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

istioctl experimental proxy-status [<type>/]<name>[.<namespace>] [flags]
istioctl experimental ps [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--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 ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--insecureSkip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--plaintextUse plain-text HTTP/2 when connecting to server (no TLS).
--revision <string>-rControl plane revision (default ``)
--timeout <duration>The duration to wait before failing (default `30s`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--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 x proxy-status

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

  # SECURITY OPTIONS

  # Retrieve proxy status information directly from the control plane, using token security
  # (This is the usual way to get the proxy-status with an out-of-cluster control plane.)
  istioctl x ps --xds-address istio.cloudprovider.example.com:15012

  # Retrieve proxy status information via Kubernetes config, using token security
  # (This is the usual way to get the proxy-status with an in-cluster control plane.)
  istioctl x proxy-status

  # Retrieve proxy status information directly from the control plane, using RSA certificate security
  # (Certificates must be obtained before this step.  The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
  istioctl x ps --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs

  # Retrieve proxy status information via XDS from specific control plane in multi-control plane in-cluster configuration
  # (Select a specific control plane in an in-cluster canary Istio configuration.)
  istioctl x ps --xds-label istio.io/rev=default

istioctl experimental remote-clusters

Lists the remote clusters each istiod instance is connected to.

istioctl experimental remote-clusters [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--revision <string>-rControl plane revision (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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.

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

istioctl experimental remove-from-mesh [flags]
istioctl experimental rm [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

  # Restart all details-v1 pods without an Istio sidecar
  istioctl x rm service details-v1

  # Restart all ratings-v1 pods without an Istio sidecar
  istioctl x rm deploy ratings-v1

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]
istioctl experimental remove-from-mesh deploy <deployment> [flags]
istioctl experimental remove-from-mesh dep <deployment> [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

  # Restart all details-v1 pods without an Istio sidecar
  istioctl x remove-from-mesh deploy details-v1

  # Restart all ratings-v1 pods without an Istio sidecar
  istioctl x rm dep ratings-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]
istioctl experimental remove-from-mesh es <svcname> [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

  # Remove "vmhttp" service entry rules
  istioctl x remove-from-mesh es vmhttp

  # Remove "vmhttp" service entry rules
  istioctl x rm es 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]
istioctl experimental remove-from-mesh svc <service> [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

  # Restart all details-v1 pods without an Istio sidecar
  istioctl x remove-from-mesh svc details-v1

  # Restart all ratings-v1 pods without an Istio sidecar
  istioctl x rm svc ratings-v1

istioctl experimental revision

The revision command provides a revision centric view of istio deployments. It provides insight into IstioOperator CRs defining the revision, istiod and gateway pods which are part of deployment of a particular revision.

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format for revision description (available formats: table,json) (default `table`)
--verbose-vEnable verbose output
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl experimental revision describe

Show information about a revision, including customizations, istiod version and which pods/gateways are using it.

istioctl experimental revision describe [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format for revision description (available formats: table,json) (default `table`)
--verbose-vEnable verbose output
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # View the details of a revision named 'canary'
  istioctl x revision describe canary

  # View the details of a revision named 'canary' and also the pods
  # under that particular revision
  istioctl x revision describe canary -v

  # Get details about a revision in json format (default format is human-friendly table format)
  istioctl x revision describe canary -v -o json

istioctl experimental revision list

Show list of control plane and gateway revisions that are currently installed in cluster

istioctl experimental revision list [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format for revision description (available formats: table,json) (default `table`)
--verbose-vEnable verbose output
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # View summary of revisions installed in the current cluster
  # which can be overridden with --context parameter.
  istioctl x revision list

  # View list of revisions including customizations, istiod and gateway pods
  istioctl x revision list -v

istioctl experimental revision tag

Command group used to interact with revision tags. Revision tags allow for the creation of mutable aliases referring to control plane revisions for sidecar injection.

With revision tags, rather than relabeling a namespace from "istio.io/rev=revision-a" to "istio.io/rev=revision-b" to change which control plane revision handles injection, it's possible to create a revision tag "prod" and label our namespace "istio.io/rev=prod". The "prod" revision tag could point to "1-7-6" initially and then be changed to point to "1-8-1" at some later point.

This allows operators to change which Istio control plane revision should handle injection for a namespace or set of namespaces without manual relabeling of the "istio.io/rev" tag.

istioctl experimental revision tag [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format for revision description (available formats: table,json) (default `table`)
--verbose-vEnable verbose output
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl experimental revision tag generate

Create a revision tag and output to the command's stdout. Tag an Istio control plane revision for use with namespace istio.io/rev injection labels.

istioctl experimental revision tag generate <revision-tag> [flags]
FlagsShorthandDescription
--auto-inject-namespacesIf set to true, the sidecars should be automatically injected into all namespaces by default
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format for revision description (available formats: table,json) (default `table`)
--overwriteIf true, allow revision tags to be overwritten, otherwise reject revision tag updates that overwrite existing revision tags.
--revision <string>-rControl plane revision to reference from a given revision tag (default ``)
--skip-confirmation-yThe 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.
--verbose-vEnable verbose output
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--webhook-name <string>Name to use for a revision tag's mutating webhook configuration. (default ``)

Examples

 # Create a revision tag from the "1-8-0" revision
 istioctl tag generate prod --revision 1-8-0 > tag.yaml

 # Apply the tag to cluster
 kubectl apply -f tag.yaml

 # Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
 kubectl label ns test-ns istio.io/rev=prod

 # Rollout namespace "test-ns" to update workloads to the "1-8-0" revision
 kubectl rollout restart deployments -n test-ns

istioctl experimental revision tag list

List existing revision tags

istioctl experimental revision tag list [flags]
istioctl experimental revision tag show [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format for revision description (available formats: table,json) (default `table`)
--verbose-vEnable verbose output
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

istioctl tag list

istioctl experimental revision tag remove

Remove Istio control plane revision tag.

Removing a revision tag should be done with care. Removing a revision tag will disrupt sidecar injection in namespaces that reference the tag in an "istio.io/rev" label. Verify that there are no remaining namespaces referencing a revision tag before removing using the "istioctl tag list" command.

istioctl experimental revision tag remove <revision-tag> [flags]
istioctl experimental revision tag delete <revision-tag> [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format for revision description (available formats: table,json) (default `table`)
--skip-confirmation-yThe 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.
--verbose-vEnable verbose output
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

 # Remove the revision tag "prod"
	istioctl tag remove prod

istioctl experimental revision tag set

Create or modify revision tags. Tag an Istio control plane revision for use with namespace istio.io/rev injection labels.

istioctl experimental revision tag set <revision-tag> [flags]
FlagsShorthandDescription
--auto-inject-namespacesIf set to true, the sidecars should be automatically injected into all namespaces by default
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format for revision description (available formats: table,json) (default `table`)
--overwriteIf true, allow revision tags to be overwritten, otherwise reject revision tag updates that overwrite existing revision tags.
--revision <string>-rControl plane revision to reference from a given revision tag (default ``)
--skip-confirmation-yThe 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.
--verbose-vEnable verbose output
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--webhook-name <string>Name to use for a revision tag's mutating webhook configuration. (default ``)

Examples

 # Create a revision tag from the "1-8-0" revision
 istioctl tag set prod --revision 1-8-0

 # Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
 kubectl label ns test-ns istio.io/rev=prod

 # Change the revision tag to reference the "1-8-1" revision
 istioctl tag set prod --revision 1-8-1 --overwrite

 # Make revision "1-8-1" the default revision, both resulting in that revision handling injection for "istio-injection=enabled"
 # and validating resources cluster-wide
 istioctl tag set default --revision 1-8-1

 # Rollout namespace "test-ns" to update workloads to the "1-8-1" revision
 kubectl rollout restart deployments -n test-ns

istioctl experimental uninstall

The uninstall command uninstalls Istio from a cluster

istioctl experimental uninstall [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--filename <string>-fThe filename of the IstioOperator CR. (default ``)
--forceProceed even with validation errors.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--purgeDelete all Istio related sources for all versions
--revision <string>-rTarget control plane revision for the command. (default ``)
--set <stringArray>-sOverride an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.14/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-confirmation-yThe 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.
--verbose-vVerbose output.
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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 version

Prints out build version information

istioctl experimental version [flags]
FlagsShorthandDescription
--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 ``)
--insecureSkip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOne of 'yaml' or 'json'. (default ``)
--plaintextUse plain-text HTTP/2 when connecting to server (no TLS).
--remoteUse --remote=false to suppress control plane check
--revision <string>-rControl plane revision (default ``)
--short-sUse --short=false to generate full version information
--timeout <duration>The duration to wait before failing (default `30s`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--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 the control plane, using token security
# (This is the usual way to get the control plane version with an out-of-cluster control plane.)
istioctl x version --xds-address istio.cloudprovider.example.com:15012

# Retrieve version information via Kubernetes config, using token security
# (This is the usual way to get the control plane version with an in-cluster control plane.)
istioctl x version

# Retrieve version information directly from the control plane, using RSA certificate security
# (Certificates must be obtained before this step.  The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
istioctl x version --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs

# Retrieve version information via XDS from specific control plane in multi-control plane in-cluster configuration
# (Select a specific control plane in an in-cluster canary Istio configuration.)
istioctl x version --xds-label istio.io/rev=default

istioctl experimental wait

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

istioctl experimental wait [flags] <type> <name>[.<namespace>]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--for <string>Wait condition, must be 'distribution' or 'delete' (default `distribution`)
--generation <string>Wait for a specific generation of config to become current, rather than using whatever is latest in Kubernetes (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--revision <string>-rControl plane revision (default ``)
--threshold <float32>The ratio of distribution required for success (default `1`)
--timeout <duration>The duration to wait before failing (default `30s`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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 experimental workload

Commands to assist in configuring and deploying workloads running on VMs and other non-Kubernetes environments

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # workload group yaml generation
  workload group create

  # workload entry configuration generation
  workload entry configure

istioctl experimental workload entry

Commands dealing with WorkloadEntry resources

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

entry configure -f workloadgroup.yaml -o outputDir

istioctl experimental workload entry configure

Generates all the required configuration files for workload instance on a VM or non-Kubernetes environment from a WorkloadGroup artifact. This includes a MeshConfig resource, the cluster.env file, and necessary certificates and security tokens. Configure requires either the WorkloadGroup artifact path or its location on the API server.

istioctl experimental workload entry configure [flags]
FlagsShorthandDescription
--autoregisterCreates a WorkloadEntry upon connection to istiod (if enabled in pilot).
--capture-dnsEnables the capture of outgoing DNS packets on port 53, redirecting to istio-agent
--clusterID <string>The ID used to identify the cluster (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--externalIP <string>External IP address of the workload (default ``)
--file <string>-ffilename of the WorkloadGroup artifact. Leave this field empty if using the API server (default ``)
--ingressIP <string>IP address of the ingress gateway (default ``)
--ingressService <string>Name of the Service to be used as the ingress gateway, in the format <service>.<namespace>. If no namespace is provided, the default istio-system namespace will be used. (default `istio-eastwestgateway`)
--internalIP <string>Internal IP address of the workload (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--name <string>The name of the workload group (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput directory for generated files (default ``)
--revision <string>-rControl plane revision (default ``)
--tokenDuration <int>The token duration in seconds (default: 1 hour) (default `3600`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # configure example using a local WorkloadGroup artifact
  configure -f workloadgroup.yaml -o config

  # configure example using the API server
  configure --name foo --namespace bar -o config

istioctl experimental workload group

Commands dealing with WorkloadGroup resources

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

group create --name foo --namespace bar --labels app=foobar

istioctl experimental workload group create

Creates a WorkloadGroup resource that provides a template for associated WorkloadEntries. The default output is serialized YAML, which can be piped into 'kubectl apply -f -' to send the artifact to the API Server.

istioctl experimental workload group create [flags]
FlagsShorthandDescription
--annotations <stringSlice>-aThe annotations to apply to the workload instances (default `[]`)
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--labels <stringSlice>-lThe labels to apply to the workload instances; e.g. -l env=prod,vers=2 (default `[]`)
--name <string>The name of the workload group (default ``)
--namespace <string>-nConfig namespace (default ``)
--ports <stringSlice>-pThe incoming ports exposed by the workload instance (default `[]`)
--serviceAccount <string>-sThe service identity to associate with the workload instances (default `default`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

create --name foo --namespace bar --labels app=foo,bar=baz --ports grpc=3550,http=8080 --annotations annotation=foobar --serviceAccount sa

istioctl install

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

istioctl install [flags]
istioctl apply [flags]
FlagsShorthandDescription
--charts <string>Deprecated, use --manifests instead. (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--filename <stringSlice>-fPath 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 `[]`)
--forceProceed even with validation errors.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--readiness-timeout <duration>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--revision <string>-rTarget control plane revision for the command. (default ``)
--set <stringArray>-sOverride an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.14/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-confirmation-yThe 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.
--verifyVerify the Istio control plane after installation/in-place upgrade
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Apply a default Istio installation
  istioctl install

  # Enable Tracing
  istioctl install --set meshConfig.enableTracing=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"

  # For setting boolean-string option, it should be enclosed quotes and escaped with a backslash (\).
  istioctl install --set meshConfig.defaultConfig.proxyMetadata.PROXY_XDS_VIA_AGENT=\"false\"

istioctl kube-inject

kube-inject manually injects the Istio 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. When in doubt re-run istioctl kube-inject on deployments to get the most up-to-date changes.

It's best to do kube-inject when the resource is initially created.

istioctl kube-inject [flags]
FlagsShorthandDescription
--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 ``)
--filename <string>-fInput Kubernetes resource filename (default ``)
--injectConfigFile <string>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)
--insecureSkip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes 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>-nConfig namespace (default ``)
--operatorFileName <string>Path to file containing IstioOperator custom resources. If configs from files like meshConfigFile, valuesFile are provided, they will be overridden by iop config values. (default ``)
--output <string>-oModified output Kubernetes resource filename (default ``)
--plaintextUse plain-text HTTP/2 when connecting to server (no TLS).
--revision <string>-rControl plane revision (default ``)
--timeout <duration>The duration to wait before failing (default `30s`)
--valuesFile <string>Injection values configuration filename. (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--webhookConfig <string>MutatingWebhookConfiguration name for Istio (default `istio-sidecar-injector`)
--xds-address <string>XDS Endpoint (default ``)
--xds-label <string>Istiod pod label selector (default ``)
--xds-port <int>Istiod pod port (default `15012`)

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 Istio 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 command generates and diffs Istio manifests.

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl manifest diff

The diff subcommand compares manifests from two files or directories. The output is a list of changed paths with the value changes shown as OLD-VALUE -> NEW-VALUE. List order changes are shown as [OLD-INDEX->NEW-INDEX], with ? used where a list item is added or removed.

istioctl manifest diff <file|dir> <file|dir> [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--directory-rCompare directory.
--dry-runConsole/log output only, make no changes.
--ignore <string>Ignore all listed items during comparison, using the same list format as selectResources. (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig 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-vVerbose output.
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl manifest generate

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

istioctl manifest generate [flags]
FlagsShorthandDescription
--charts <string>Deprecated, use --manifests instead. (default ``)
--component <stringSlice>Specify which component to generate manifests for. (default `[]`)
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--filename <stringSlice>-fPath 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 `[]`)
--forceProceed even with validation errors.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oManifest output directory path. (default ``)
--revision <string>-rTarget control plane revision for the command. (default ``)
--set <stringArray>-sOverride an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.14/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Generate a default Istio installation
  istioctl manifest generate

  # Enable Tracing
  istioctl manifest generate --set meshConfig.enableTracing=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"

  # For setting boolean-string option, it should be enclosed quotes and escaped with a backslash (\).
  istioctl manifest generate --set meshConfig.defaultConfig.proxyMetadata.PROXY_XDS_VIA_AGENT=\"false\"

istioctl manifest install

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

istioctl manifest install [flags]
istioctl manifest apply [flags]
FlagsShorthandDescription
--charts <string>Deprecated, use --manifests instead. (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--filename <stringSlice>-fPath 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 `[]`)
--forceProceed even with validation errors.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--readiness-timeout <duration>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--revision <string>-rTarget control plane revision for the command. (default ``)
--set <stringArray>-sOverride an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.14/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-confirmation-yThe 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.
--verifyVerify the Istio control plane after installation/in-place upgrade
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Apply a default Istio installation
  istioctl install

  # Enable Tracing
  istioctl install --set meshConfig.enableTracing=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"

  # For setting boolean-string option, it should be enclosed quotes and escaped with a backslash (\).
  istioctl install --set meshConfig.defaultConfig.proxyMetadata.PROXY_XDS_VIA_AGENT=\"false\"

istioctl operator

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

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl operator dump

The dump subcommand dumps the Istio operator controller manifest.

istioctl operator dump [flags]
FlagsShorthandDescription
--charts <string>Deprecated, use --manifests instead. (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--hub <string>The hub for the operator controller image. (default `unknown`)
--imagePullSecrets <stringSlice>The imagePullSecrets are used to pull the operator image from the private registry, could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (default `[]`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--operatorNamespace <string>The namespace the operator controller is installed into. (default `istio-operator`)
--output <string>-oOutput format: one of json|yaml (default `yaml`)
--revision <string>-rTarget revision for the operator. (default ``)
--tag <string>The tag for the operator controller image. (default `unknown`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--watchedNamespaces <string>The namespaces the operator controller watches, could be namespace list separated by comma, eg. 'ns1,ns2' (default `istio-system`)

istioctl operator init

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

istioctl operator init [flags]
FlagsShorthandDescription
--charts <string>Deprecated, use --manifests instead. (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--filename <string>-fPath 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 ``)
--hub <string>The hub for the operator controller image. (default `unknown`)
--imagePullSecrets <stringSlice>The imagePullSecrets are used to pull the operator image from the private registry, could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (default `[]`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--operatorNamespace <string>The namespace the operator controller is installed into. (default `istio-operator`)
--revision <string>-rTarget revision for the operator. (default ``)
--tag <string>The tag for the operator controller image. (default `unknown`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--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]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--forceProceed even with validation errors.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--operatorNamespace <string>The namespace the operator controller is installed into. (default `istio-operator`)
--revision <string>-rTarget revision for the operator. (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl options

Displays istioctl global options

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl profile

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

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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 <profile|file1.yaml> <profile|file2.yaml> [flags]
FlagsShorthandDescription
--charts <string>Deprecated, use --manifests instead. (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Profile diff by providing yaml files
  istioctl profile diff manifests/profiles/default.yaml manifests/profiles/demo.yaml

  # Profile diff by providing a profile name
  istioctl profile diff default demo

istioctl profile dump

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

istioctl profile dump [<profile>] [flags]
FlagsShorthandDescription
--charts <string>Deprecated, use --manifests instead. (default ``)
--config-path <string>-pThe 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-runConsole/log output only, make no changes.
--filename <stringSlice>-fPath 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>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|flags (default `yaml`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl profile list

The list subcommand lists the available Istio configuration profiles.

istioctl profile list [flags]
FlagsShorthandDescription
--charts <string>Deprecated, use --manifests instead. (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl proxy-config

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

FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

istioctl proxy-config all

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

istioctl proxy-config all [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config a [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--address <string>Filter listeners by address field (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--direction <string>Filter clusters by Direction field (default ``)
--file <string>-fEnvoy config dump file (default ``)
--fqdn <string>Filter clusters by substring of Service FQDN field (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--name <string>Filter listeners by route name field (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--port <int>Filter clusters and listeners by Port field (default `0`)
--subset <string>Filter clusters by substring of Subset field (default ``)
--type <string>Filter listeners by type field (default ``)
--verboseOutput more information
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

  # Retrieve full cluster dump as JSON
  istioctl proxy-config all <pod-name[.namespace]> -o json

  # Retrieve full cluster dump with short syntax
  istioctl pc a <pod-name[.namespace]>

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

istioctl proxy-config bootstrap

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

istioctl proxy-config bootstrap [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config b [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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

  # Show a human-readable Istio and Envoy version summary
  istioctl proxy-config bootstrap -o short

istioctl proxy-config cluster

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

istioctl proxy-config cluster [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config clusters [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config c [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--direction <string>Filter clusters by Direction field (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--fqdn <string>Filter clusters by substring of Service FQDN field (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--port <int>Filter clusters by Port field (default `0`)
--subset <string>Filter clusters by substring of Subset field (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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 [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config endpoints [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config ep [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--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>-fEnvoy config dump JSON file (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--port <int>Filter endpoints by Port field (default `0`)
--status <string>Filter endpoints by status field (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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 [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config listeners [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config l [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--address <string>Filter listeners by address field (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--port <int>Filter listeners by Port field (default `0`)
--type <string>Filter listeners by type field (default ``)
--verboseOutput more information
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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 [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config o [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes 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>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--reset-rReset levels to default value (warning).
--selector <string>-lLabel selector (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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 rootca-compare

Compare ROOTCA values for given 2 pods to check the connectivity between them.

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

istioctl proxy-config rootca-compare [pod/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [flags]
istioctl proxy-config rc [pod/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Compare ROOTCA values for given 2 pods to check the connectivity between them.
  istioctl proxy-config rootca-compare <pod-name-1[.namespace]> <pod-name-2[.namespace]>

istioctl proxy-config route

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

istioctl proxy-config route [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config routes [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config r [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--name <string>Filter listeners by route name field (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--verboseOutput more information
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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

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

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

istioctl proxy-config secret [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config secrets [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config s [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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

istioctl proxy-status

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

istioctl proxy-status [<type>/]<name>[.<namespace>] [flags]
istioctl ps [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--revision <string>-rControl plane revision (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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

  # Retrieve sync diff between Istiod and one pod under a deployment
  istioctl proxy-status deployment/productpage-v1

  # 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 tag

Command group used to interact with revision tags. Revision tags allow for the creation of mutable aliases referring to control plane revisions for sidecar injection.

With revision tags, rather than relabeling a namespace from "istio.io/rev=revision-a" to "istio.io/rev=revision-b" to change which control plane revision handles injection, it's possible to create a revision tag "prod" and label our namespace "istio.io/rev=prod". The "prod" revision tag could point to "1-7-6" initially and then be changed to point to "1-8-1" at some later point.

This allows operators to change which Istio control plane revision should handle injection for a namespace or set of namespaces without manual relabeling of the "istio.io/rev" tag.

istioctl tag [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl tag generate

Create a revision tag and output to the command's stdout. Tag an Istio control plane revision for use with namespace istio.io/rev injection labels.

istioctl tag generate <revision-tag> [flags]
FlagsShorthandDescription
--auto-inject-namespacesIf set to true, the sidecars should be automatically injected into all namespaces by default
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--overwriteIf true, allow revision tags to be overwritten, otherwise reject revision tag updates that overwrite existing revision tags.
--revision <string>-rControl plane revision to reference from a given revision tag (default ``)
--skip-confirmation-yThe 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.
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--webhook-name <string>Name to use for a revision tag's mutating webhook configuration. (default ``)

Examples

 # Create a revision tag from the "1-8-0" revision
 istioctl tag generate prod --revision 1-8-0 > tag.yaml

 # Apply the tag to cluster
 kubectl apply -f tag.yaml

 # Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
 kubectl label ns test-ns istio.io/rev=prod

 # Rollout namespace "test-ns" to update workloads to the "1-8-0" revision
 kubectl rollout restart deployments -n test-ns

istioctl tag list

List existing revision tags

istioctl tag list [flags]
istioctl tag show [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

istioctl tag list

istioctl tag remove

Remove Istio control plane revision tag.

Removing a revision tag should be done with care. Removing a revision tag will disrupt sidecar injection in namespaces that reference the tag in an "istio.io/rev" label. Verify that there are no remaining namespaces referencing a revision tag before removing using the "istioctl tag list" command.

istioctl tag remove <revision-tag> [flags]
istioctl tag delete <revision-tag> [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--skip-confirmation-yThe 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.
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

 # Remove the revision tag "prod"
	istioctl tag remove prod

istioctl tag set

Create or modify revision tags. Tag an Istio control plane revision for use with namespace istio.io/rev injection labels.

istioctl tag set <revision-tag> [flags]
FlagsShorthandDescription
--auto-inject-namespacesIf set to true, the sidecars should be automatically injected into all namespaces by default
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--overwriteIf true, allow revision tags to be overwritten, otherwise reject revision tag updates that overwrite existing revision tags.
--revision <string>-rControl plane revision to reference from a given revision tag (default ``)
--skip-confirmation-yThe 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.
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--webhook-name <string>Name to use for a revision tag's mutating webhook configuration. (default ``)

Examples

 # Create a revision tag from the "1-8-0" revision
 istioctl tag set prod --revision 1-8-0

 # Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
 kubectl label ns test-ns istio.io/rev=prod

 # Change the revision tag to reference the "1-8-1" revision
 istioctl tag set prod --revision 1-8-1 --overwrite

 # Make revision "1-8-1" the default revision, both resulting in that revision handling injection for "istio-injection=enabled"
 # and validating resources cluster-wide
 istioctl tag set default --revision 1-8-1

 # Rollout namespace "test-ns" to update workloads to the "1-8-1" revision
 kubectl rollout restart deployments -n test-ns

istioctl upgrade

The upgrade command is an alias for the install command that performs additional upgrade-related checks.

istioctl upgrade [flags]
FlagsShorthandDescription
--charts <string>Deprecated, use --manifests instead. (default ``)
--context <string>The name of the kubeconfig context to use (default ``)
--dry-runConsole/log output only, make no changes.
--filename <stringSlice>-fPath 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 `[]`)
--forceProceed even with validation errors.
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--readiness-timeout <duration>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--set <stringArray>-sOverride an IstioOperator value, e.g. to choose a profile (--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.14/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-confirmation-yThe 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.
--verifyVerify the Istio control plane after installation/in-place upgrade
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl validate

Validate Istio policy and rules files

istioctl validate -f FILENAME [options] [flags]
istioctl v -f FILENAME [options] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--filename <stringSlice>-fNames of files to validate (default `[]`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--referential-xEnable structural validation for policy and telemetry
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Validate bookinfo-gateway.yaml
  istioctl validate -f samples/bookinfo/networking/bookinfo-gateway.yaml

  # Validate bookinfo-gateway.yaml with shorthand syntax
  istioctl v -f samples/bookinfo/networking/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 an installation it will check for an IstioOperator resource and will verify if pods and services defined in it are present.

Note: For verifying whether your cluster is ready for Istio installation, see istioctl experimental precheck.

istioctl verify-install [-f <deployment or istio operator file>] [--revision <revision>] [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--filename <stringSlice>-fIstio YAML installation file. (default `[]`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--manifests <string>-dSpecify a path to a directory of charts and profiles (e.g. ~/Downloads/istio-1.14.0/manifests) or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.14.0/istio-1.14.0-linux-amd64.tar.gz). (default ``)
--namespace <string>-nConfig namespace (default ``)
--revision <string>-rControl plane revision (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Verify that Istio is installed correctly via Istio Operator
  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>

  # Verify the installation of specific revision
  istioctl verify-install -r 1-9-0

istioctl version

Prints out build version information

istioctl version [flags]
FlagsShorthandDescription
--context <string>The name of the kubeconfig context to use (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nConfig namespace (default ``)
--output <string>-oOne of 'yaml' or 'json'. (default ``)
--remoteUse --remote=false to suppress control plane check
--revision <string>-rControl plane revision (default ``)
--short-sUse --short=false to generate full version information
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Environment variables

These environment variables affect the behavior of the istioctl command. Please use with caution as these environment variables are experimental and can change anytime.
Variable NameTypeDefault ValueDescription
AUTO_RELOAD_PLUGIN_CERTSBooleanfalseIf enabled, if user introduces new intermediate plug-in CA, user need not to restart istiod to pick up certs.Istiod picks newly added intermediate plug-in CA certs and updates it. Plug-in new Root-CA not supported.
CERT_SIGNER_DOMAINStringThe cert signer domain info
CLOUD_PLATFORMStringCloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none
CLUSTER_IDStringKubernetesDefines the cluster and service registry that this Istiod instance is belongs to
ENABLE_AUTO_MTLS_CHECK_POLICIESBooleantrueEnable the auto mTLS EDS output to consult the PeerAuthentication Policy, only set the {tlsMode: istio} when server side policy enables mTLS PERMISSIVE or STRICT.
ENABLE_AUTO_SNIBooleanfalseIf enabled, automatically set SNI when `DestinationRules` do not specify the same
ENABLE_CA_SERVERBooleantrueIf this is set to false, will not create CA server in istiod.
ENABLE_DEBUG_ON_HTTPBooleantrueIf this is set to false, the debug interface will not be enabled, recommended for production
ENABLE_LEGACY_FSGROUP_INJECTIONBooleantrueIf true, Istiod will set the pod fsGroup to 1337 on injection. This is required for Kubernetes 1.18 and older (see https://github.com/kubernetes/kubernetes/issues/57923 for details) unless JWT_POLICY is "first-party-jwt".
ENABLE_LEGACY_LB_ALGORITHM_DEFAULTBooleanfalseIf enabled, destinations for which no LB algorithm is specified will use the legacy default, ROUND_ROBIN. Care should be taken when using ROUND_ROBIN in general as it can overburden endpoints, especially when weights are used.
ENABLE_MCS_AUTO_EXPORTBooleanfalseIf enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded.
ENABLE_MCS_CLUSTER_LOCALBooleanfalseIf enabled, istiod will treat the host `<svc>.<namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled.
ENABLE_MCS_HOSTBooleanfalseIf enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (<svc>.<namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled.
ENABLE_MCS_SERVICE_DISCOVERYBooleanfalseIf enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport.
ENABLE_MULTICLUSTER_HEADLESSBooleantrueIf true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster.
ENABLE_PROBE_KEEPALIVE_CONNECTIONSBooleanfalseIf enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's.
ENABLE_TLS_ON_SIDECAR_INGRESSBooleanfalseIf enabled, the TLS configuration on Sidecar.ingress will take effect
ENABLE_WASM_TELEMETRYBooleanfalseIf enabled, Wasm-based telemetry will be enabled.
EXTERNAL_ISTIODBooleanfalseIf this is set to true, one Istiod will control remote clusters including CA.
GCP_METADATAStringPipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE
GCP_QUOTA_PROJECTStringAllows specification of a quota project to be used in requests to GCP APIs.
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLEDBooleantrue
INJECTION_WEBHOOK_CONFIG_NAMEStringistio-sidecar-injectorName of the mutatingwebhookconfiguration to patch, if istioctl is not used.
ISTIOCONFIGString$HOME/.istioctl/config.yamlDefault values for istioctl flags
ISTIOCTL_AUTHORITYStringThe istioctl --authority override
ISTIOCTL_CERT_DIRStringThe istioctl --cert-dir override
ISTIOCTL_INSECUREBooleanfalseThe istioctl --insecure override
ISTIOCTL_ISTIONAMESPACEStringistio-systemThe istioctl --istioNamespace override
ISTIOCTL_PLAINTEXTBooleanfalseThe istioctl --plaintext override
ISTIOCTL_PREFER_EXPERIMENTALBooleanfalseThe istioctl should use experimental subcommand variants
ISTIOCTL_XDS_ADDRESSStringThe istioctl --xds-address override
ISTIOCTL_XDS_PORTInteger15012The istioctl --xds-port override
ISTIOD_CUSTOM_HOSTStringCustom host name of istiod that istiod signs the server cert. Multiple custom host names are supported, and multiple values are separated by commas.
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSIONBooleantrueIf enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file.
ISTIO_BOOTSTRAPString
ISTIO_DEFAULT_REQUEST_TIMEOUTTime Duration0sDefault Http and gRPC Request timeout
ISTIO_DELTA_XDSBooleanfalseIf enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas.
ISTIO_GATEWAY_STRIP_HOST_PORTBooleanfalseIf enabled, Gateway will remove any port from host/authority header before any processing of request by HTTP filters or routing.
ISTIO_GPRC_MAXRECVMSGSIZEInteger4194304Sets the max receive buffer size of gRPC stream in bytes.
ISTIO_GPRC_MAXSTREAMSInteger100000Sets the maximum number of concurrent grpc streams.
ISTIO_MULTIROOT_MESHBooleanfalseIf enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS
ISTIO_PROMETHEUS_ANNOTATIONSString
JWT_POLICYStringthird-party-jwtThe JWT validation policy.
K8S_INGRESS_NSString
K_REVISIONStringKNative revision, set if running in knative
LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIESBooleanfalseIf enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints.
MCS_API_GROUPStringmulticluster.x-k8s.ioThe group to be used for the Kubernetes Multi-Cluster Services (MCS) API.
MCS_API_VERSIONStringv1alpha1The version to be used for the Kubernets Multi-Cluster Services (MCS) API.
PILOT_ANALYSIS_INTERVALTime Duration10sIf analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources
PILOT_CERT_PROVIDERStringistiodThe provider of Pilot DNS certificate.
PILOT_DEBOUNCE_AFTERTime Duration100msThe delay added to config/registry events for debouncing. This will delay the push by at least this interval. 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_MAXTime Duration10sThe 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_DISTRIBUTION_HISTORY_RETENTIONTime Duration1m0sIf enabled, Pilot will keep track of old versions of distributed config for this duration.
PILOT_ENABLE_ALPN_FILTERBooleantrueIf true, pilot will add Istio ALPN filters, required for proper protocol sniffing.
PILOT_ENABLE_ANALYSISBooleanfalseIf enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources
PILOT_ENABLE_CDS_CACHEBooleantrueIf true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE.
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKINGBooleantrueIf 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_CROSS_CLUSTER_WORKLOAD_ENTRYBooleantrueIf enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster.
PILOT_ENABLE_DESTINATION_RULE_INHERITANCEBooleanfalseIf set, workload specific DestinationRules will inherit configurations settings from mesh and namespace level rules
PILOT_ENABLE_EDS_DEBOUNCEBooleantrueIf 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_SERVICESBooleanfalseIf 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_GATEWAY_APIBooleantrueIf this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed.
PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLERBooleantrueIf this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc
PILOT_ENABLE_GATEWAY_API_STATUSBooleantrueIf this is set to true, gateway-api resources will have status written to them
PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERSBooleantrueIf 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_INBOUND_PASSTHROUGHBooleantrueIf enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration.
PILOT_ENABLE_ISTIO_TAGSBooleantrueDetermines whether or not trace spans generated by Envoy will include Istio-specific tags.
PILOT_ENABLE_LEGACY_AUTO_PASSTHROUGHBooleanfalseIf enabled, pilot will allow any upstream cluster to be used with AUTO_PASSTHROUGH. This option is intended for backwards compatibility only and is not secure with untrusted downstreams; it will be removed in the future.
PILOT_ENABLE_LEGACY_ISTIO_MUTUAL_CREDENTIAL_NAMEBooleanfalseIf enabled, Gateway's with ISTIO_MUTUAL mode and credentialName configured will use simple TLS. This is to retain legacy behavior only and not recommended for use beyond migration.
PILOT_ENABLE_METADATA_EXCHANGEBooleantrueIf true, pilot will add metadata exchange filters, which will be consumed by telemetry filter.
PILOT_ENABLE_MONGO_FILTERBooleantrueEnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain.
PILOT_ENABLE_MYSQL_FILTERBooleanfalseEnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain.
PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUNDBooleantrueIf enabled, protocol sniffing will be used for inbound listeners whose port protocol is not specified or unsupported
PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_OUTBOUNDBooleantrueIf enabled, protocol sniffing will be used for outbound listeners whose port protocol is not specified or unsupported
PILOT_ENABLE_QUIC_LISTENERSBooleanfalseIf true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP)
PILOT_ENABLE_RDS_CACHEBooleantrueIf true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE.
PILOT_ENABLE_REDIS_FILTERBooleanfalseEnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain.
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATIONBooleantrueIf true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization.
PILOT_ENABLE_SERVICEENTRY_SELECT_PODSBooleantrueIf 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_STATUSBooleanfalseIf enabled, pilot will update the CRD Status field of all istio resources with reconciliation status.
PILOT_ENABLE_TELEMETRY_LABELBooleantrueIf true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter.
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATIONBooleantrueEnables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload.
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKSBooleantrueEnables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup
PILOT_ENABLE_XDS_CACHEBooleantrueIf true, Pilot will cache XDS responses.
PILOT_ENABLE_XDS_IDENTITY_CHECKBooleantrueIf enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for.
PILOT_ENDPOINT_TELEMETRY_LABELBooleantrueIf true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter.
PILOT_ENVOY_FILTER_STATSBooleanfalseIf true, Pilot will collect metrics for envoy filter operations.
PILOT_FILTER_GATEWAY_CLUSTER_CONFIGBooleanfalseIf enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway
PILOT_FLOW_CONTROL_TIMEOUTTime Duration15sIf set, the max amount of time to delay a push by. Depends on PILOT_ENABLE_FLOW_CONTROL.
PILOT_HTTP10BooleanfalseEnables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.
PILOT_INBOUND_PROTOCOL_DETECTION_TIMEOUTTime Duration1sProtocol detection timeout for inbound listener
PILOT_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONSStringComma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`.
PILOT_JWT_ENABLE_REMOTE_JWKSBooleanfalseIf enabled, checks to see if the configured JwksUri in RequestAuthentication is a mesh cluster URL and configures remote Jwks to let Envoy fetch the Jwks instead of Istiod.
PILOT_JWT_PUB_KEY_REFRESH_INTERVALTime Duration20m0sThe interval for istiod to fetch the jwks_uri for the jwks public key.
PILOT_LEGACY_INGRESS_BEHAVIORBooleanfalseIf this is set to true, istio ingress will perform the legacy behavior, which does not meet https://kubernetes.io/docs/concepts/services-networking/ingress/#multiple-matches.
PILOT_MAX_REQUESTS_PER_SECONDFloating-Point25Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently.
PILOT_PARTIAL_FULL_PUSHESBooleanfalseIf enabled, pilot will send partial pushes in for child resources (RDS, EDS, etc) when possible. This occurs for EDS in many cases regardless of this setting.
PILOT_PUSH_THROTTLEInteger100Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes
PILOT_REMOTE_CLUSTER_TIMEOUTTime Duration30sAfter this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior.
PILOT_SCOPE_GATEWAY_TO_NAMESPACEBooleanfalseIf 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_SEND_UNHEALTHY_ENDPOINTSBooleanfalseIf enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold).
PILOT_SIDECAR_USE_REMOTE_ADDRESSBooleanfalseUseRemoteAddress sets useRemoteAddress to true for side car outbound listeners.
PILOT_SKIP_VALIDATE_TRUST_DOMAINBooleanfalseSkip validating the peer is from the same trust domain when mTLS is enabled in authentication policy
PILOT_STATUS_BURSTInteger500If 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_MAX_WORKERSInteger100The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments.
PILOT_STATUS_QPSFloating-Point100If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS
PILOT_STATUS_UPDATE_INTERVALTime Duration500msInterval to update the XDS distribution status.
PILOT_TRACE_SAMPLINGFloating-Point1Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0.
PILOT_USE_ENDPOINT_SLICEBooleanfalseIf 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
PILOT_WORKLOAD_ENTRY_GRACE_PERIODTime Duration10sThe amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up.
PILOT_XDS_CACHE_SIZEInteger60000The maximum number of cache entries for the XDS cache.
PILOT_XDS_CACHE_STATSBooleanfalseIf true, Pilot will collect metrics for XDS cache efficiency.
PILOT_XDS_SEND_TIMEOUTTime Duration0sThe timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push.
POD_NAMEString
PRIORITIZED_LEADER_ELECTIONBooleantrueIf enabled, the default revision will steal leader locks from non-default revisions
REQUIRE_3P_TOKENBooleanfalseReject k8s default tokens, without audience. If false, default K8S token will be accepted
RESOLVE_HOSTNAME_GATEWAYSBooleantrueIf true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways.
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATIONBooleanfalseIf enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior.
REWRITE_TCP_PROBESBooleantrueIf false, TCP probes will not be rewritten and therefor always succeed when a sidecar is used.
SHARED_MESH_CONFIGStringAdditional config map to load for shared MeshConfig settings. The standard mesh config will take precedence.
SPIFFE_BUNDLE_ENDPOINTSStringThe 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
TERMStringSpecifies terminal type. Use 'dumb' to suppress color output
TOKEN_AUDIENCESStringistio-caA list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences
UNSAFE_ENABLE_ADMIN_ENDPOINTSBooleanfalseIf this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production.
UNSAFE_PILOT_ENABLE_DELTA_TESTBooleanfalseIf enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not production.
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONSBooleanfalseIf enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing.
VALIDATION_WEBHOOK_CONFIG_NAMEStringistio-istio-systemName of the validatingwebhookconfiguration to patch. Empty will skip using cluster admin to patch.
VERIFY_CERTIFICATE_AT_CLIENTBooleanfalseIf enabled, certificates received by the proxy will be verified against the OS CA certificate bundle.
VERIFY_SDS_CERTIFICATEBooleantrueIf enabled, certificates fetched from SDS server will be verified before sending back to proxy.
XDS_AUTHBooleantrueIf true, will authenticate XDS clients.
XDS_AUTH_PLAINTEXTBooleanfalseAuthenticate plain text requests - used if Istiod is behind a gateway handling TLS

Exported metrics

Metric NameTypeDescription
auto_registration_deletes_totalSumTotal number of auto registration cleaned up by periodic timer.
auto_registration_errors_totalSumTotal number of auto registration errors.
auto_registration_success_totalSumTotal number of successful auto registrations.
auto_registration_unregister_totalSumTotal number of unregistrations.
auto_registration_updates_totalSumTotal number of auto registration updates.
cache_flush_totalSumnumber of times operator cache was flushed
controller_sync_errors_totalSumTotal number of errorMetric syncing controllers.
cr_deletion_totalSumNumber of IstioOperator CR deleted
cr_merge_failure_totalSumNumber of IstioOperator CR merge failures
cr_validation_error_totalSumNumber of IstioOperator CR validation failures
endpoint_no_podLastValueEndpoints without an associated pod.
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
get_cr_error_totalSumNumber of times fetching CR from apiserver failed
istio_buildLastValueIstio component build info
istiod_managed_clustersLastValueNumber of clusters managed by istiod
legacy_path_translation_totalSumNumber of times a legacy API path is translated
manifest_patch_error_totalSumNumber of times K8S patch overlays failed
manifest_render_error_totalSumNumber of times error occurred during rendering output manifest
num_outgoing_retriesSumNumber of outgoing retry requests (e.g. to a token exchange server, CA, etc.)
owned_resource_totalLastValueNumber of resources currently owned by the operator
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_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_cfg_eventsSumEvents from k8s config.
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_sds_certificate_errors_totalSumTotal number of failures to fetch SDS key and certificate.
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_config_size_bytesDistributionDistribution of configuration sizes pushed to clients
pilot_xds_delayed_push_timeouts_totalSumTotal number of XDS pushes that are delayed and timed out
pilot_xds_delayed_pushes_totalSumTotal number of XDS pushes that are delayed.
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_send_timeDistributionTotal time in seconds Pilot takes to send generated configuration.
pilot_xds_write_timeoutSumPilot XDS response write timeouts.
remote_cluster_sync_timeouts_totalSumNumber of times remote clusters took too long to sync, causing slow startup that excludes remote clusters.
render_manifest_totalSumNumber of component manifests rendered
resource_creation_totalSumNumber of resources created by the operator
resource_deletion_totalSumNumber of resources deleted by the operator
resource_prune_totalSumNumber of resources pruned by the operator
resource_update_totalSumNumber of resources updated by the operator
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.
startup_duration_secondsLastValueThe time from the process starting to being marked ready.
versionLastValueVersion of operator binary
wasm_cache_entriesLastValuenumber of Wasm remote fetch cache entries.
wasm_cache_lookup_countSumnumber of Wasm remote fetch cache lookups.
wasm_config_conversion_countSumnumber of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint.
wasm_config_conversion_durationDistributionTotal time in milliseconds istio-agent spends on converting remote load in Wasm config.
wasm_remote_fetch_countSumnumber of Wasm remote fetches and results, including success, download failure, and checksum mismatch.
webhook_patch_attempts_totalSumWebhook patching attempts
webhook_patch_failures_totalSumWebhook patching total failures
webhook_patch_retries_totalSumWebhook patching retries
xds_cache_evictionsSumTotal number of xds cache evictions.
xds_cache_readsSumTotal number of xds cache xdsCacheReads.
xds_cache_sizeLastValueCurrent size of xds cache
Was this information useful?
Do you have any suggestions for improvement?

Thanks for your feedback!