istioctl

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

FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--selector <string>-llabel selector (default `app=istiod`)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|yaml] [flags]
istioctl admin l [<pod-name>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|yaml] [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--ctrlz_port <int>ControlZ port (default `9876`)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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 the format of <scope>:<level>[,<scope>:<level>,...]. Possible values for <level>: none, error, warn, info, debug (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--resetReset levels to default value. (info)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--selector <string>-llabel selector (default `app=istiod`)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--stack-trace-level <string>Comma-separated list of stack trace level for scopes in the format of <scope>:<stack-trace-level>[,<scope>:<stack-trace-level>,...]. Possible values for <stack-trace-level>: none, error, warn, info, debug (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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

  # Retrieve information about istiod logging levels for a specified revision.
  istioctl admin log --revision v1

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

istioctl analyze

Analyze Istio configuration and print validation messages

istioctl analyze <file>... [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--all-namespaces-AAnalyze all namespaces
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--colorDefault true. Disable with '=false' or set $TERM to dumb
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (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`)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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 ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (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`)
--project <string>Implementation's project (default ``)
--recursive-RProcess directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory.
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>analyze a specific revision deployed. (default `default`)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--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`)
--url <string>Implementation's url (default ``)
--use-kube-kUse live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only.
--verbose-vEnable verbose output
--version <string>Implementation's version (default ``)
--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 for a specific revision
  istioctl analyze --revision 1-16

  # 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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--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 `[]`)
--debugWhether to print debug logs
--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"]`)
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--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.
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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 ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output-dir <string>Set a specific directory for output archive file. (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--rq-concurrency <int>Set the concurrency limit of requests to the Kubernetes API server, defaults to 32. (default `0`)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (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 ``)
--supported-features <string>Supported features included in conformance tests suites (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`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--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 `[]`)
--debugWhether to print debug logs
--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"]`)
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--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.
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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 ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOne of 'yaml' or 'json'. (default ``)
--output-dir <string>Set a specific directory for output archive file. (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--rq-concurrency <int>Set the concurrency limit of requests to the Kubernetes API server, defaults to 32. (default `0`)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--short-sUse --short=false to generate full version information
--skip-tests <string>Comma-separated list of tests to skip (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 ``)
--supported-features <string>Supported features included in conformance tests suites (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`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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 > $(brew --prefix)/etc/bash_completion.d/istioctl

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

istioctl completion bash
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--no-descriptionsdisable completion descriptions
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--no-descriptionsdisable completion descriptions
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--no-descriptionsdisable completion descriptions
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 in your current shell session:

source <(istioctl completion zsh)

To load completions for every new session, execute once:

#### Linux:

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

#### macOS:

istioctl completion zsh > $(brew --prefix)/share/zsh/site-functions/_istioctl

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

istioctl completion zsh [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--no-descriptionsdisable completion descriptions
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl create-remote-secret

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

istioctl create-remote-secret [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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`)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--create-service-accountIf true, the service account needed for creating the remote secret will be created if it doesn't exist.
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `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>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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 ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--type <SecretType>Type of the generated secret. supported values = [remote config] (default `remote`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 create-remote-secret --name c0 \
    | kubectl --kubeconfig=c1.yaml apply -f -

  # Delete a secret that was previously installed in c1
  istioctl --kubeconfig=c0.yaml 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 create-remote-secret --name c0 --auth-type=plugin --auth-plugin-name=gcp \
    | kubectl --kubeconfig=c1.yaml apply -f -

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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--ctrlz_port <int>ControlZ port (default `9876`)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--selector <string>-lLabel selector (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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

Note: envoy command is deprecated and can be replaced with proxy command, e.g. `istioctl dashboard proxy --help`

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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--selector <string>-lLabel selector (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--ui-port <int>The component dashboard UI port. (default `15000`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--ui-port <int>The component dashboard UI port. (default `3000`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 istiod-debug

Open the debug web UI for a Istio control plane pod

istioctl dashboard istiod-debug [<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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--selector <string>-lLabel selector (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

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

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

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

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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--ui-port <int>The component dashboard UI port. (default `16686`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--ui-port <int>The component dashboard UI port. (default `20001`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--ui-port <int>The component dashboard UI port. (default `9090`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 proxy

Open the admin dashboard for a proxy, like envoy and ztunnel pods

istioctl dashboard proxy [<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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--selector <string>-lLabel selector (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--ui-port <int>The component dashboard UI port. (default `15000`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

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

  # Open dashboard for the ztunnel-bwh89.istio-system pod
  istioctl dashboard proxy ztunnel-bwh89.istio-system

  # Open dashboard for a waypoint pod
  istioctl dashboard proxy namespace-istio-waypoint-869b56b69c-7khz4

  # with short syntax
  istioctl dash proxy ztunnel-bwh89.istio-system
  istioctl d proxy ztunnel-bwh89.istio-system

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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--ui-port <int>The component dashboard UI port. (default `8080`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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`)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--port <int>-pLocal port to listen to (default `0`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--ui-port <int>The component dashboard UI port. (default `9411`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl experimental authz

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

FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fThe json file with Envoy config dump to be checked (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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 check-inject

Checks associated resources of the given resource, and running webhooks to examine whether the pod can be or will be injected or not.

istioctl experimental check-inject [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--labels <string>-lCheck namespace and label pairs injection status, split multiple labels by commas (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Check the injection status of a pod
  istioctl experimental check-inject details-v1-fcff6c49c-kqnfk.test
	
  # Check the injection status of a pod under a deployment
  istioctl x check-inject deployment/details-v1

  # Check the injection status of a pod under a deployment in namespace test
  istioctl x check-inject deployment/details-v1 -n test

  # Check the injection status of label pairs in a specific namespace before actual injection 
  istioctl x check-inject -n test -l app=helloworld,version=v1

istioctl experimental config

Configure istioctl defaults

FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # list configuration parameters
  istioctl experimental config list

istioctl experimental config list

List istio configurable defaults

istioctl experimental config list [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl experimental describe

Describe resource and related Istio configuration

istioctl experimental describe [flags]
istioctl experimental des [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--ignoreUnmeshedSuppress warnings for unmeshed pods
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--ignoreUnmeshedSuppress warnings for unmeshed pods
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short|prom|prom-merged (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--type <string>-tWhere to grab the stats: one of server|clusters (default `server`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 custom proxy admin port
  istioctl experimental envoy-stats <pod-name[.namespace]> --output prom --proxy-admin-port 15000

  # 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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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.
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--authority <string>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)
--cert-dir <string>XDS Endpoint certificate directory (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--insecureSkip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--plaintextUse plain-text HTTP/2 when connecting to server (no TLS).
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--timeout <duration>The duration to wait before failing (default `30s`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--duration <duration>-dDuration of query metrics, default value is 1m. (default `1m0s`)
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--from-version <string>-fcheck changes since the provided version (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of [log json yaml] (default `log`)
--output-threshold <Level>The severity level of precheck at which to display messages. Valid values: [Info Warning Error] (default `Warning`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-controlplaneskip checking the control plane
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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

  # Check for behavioral changes since a specific version
  istioctl x precheck --from-version 1.10

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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--authority <string>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)
--cert-dir <string>XDS Endpoint certificate directory (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--insecureSkip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--plaintextUse plain-text HTTP/2 when connecting to server (no TLS).
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--timeout <duration>The duration to wait before failing (default `30s`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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`)
--xds-via-agentsAccess Istiod via the tap service of each agent
--xds-via-agents-limit <xds-via-agent>Maximum number of pods being visited by istioctl when xds-via-agent flag is true.To iterate all the agent pods without limit, set to 0 (default `100`)

Examples

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

  # Retrieve sync status for Envoys in a specific namespace
  istioctl proxy-status --namespace foo

  # Retrieve sync diff for a single Envoy and Istiod
  istioctl 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 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 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 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 ps --xds-label istio.io/rev=default

istioctl experimental version

Prints out build version information

istioctl experimental version [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--authority <string>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)
--cert-dir <string>XDS Endpoint certificate directory (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--insecureSkip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOne of 'yaml' or 'json'. (default ``)
--plaintextUse plain-text HTTP/2 when connecting to server (no TLS).
--project <string>Implementation's project (default ``)
--remoteUse --remote=false to suppress control plane check
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--short-sUse --short=false to generate full version information
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--timeout <duration>The duration to wait before failing (default `30s`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--for <string>Wait condition, must be 'distribution' or 'delete' (default `distribution`)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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 ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--proxy <string>Name of a specific proxy to wait for the condition to be satisfied (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--threshold <float32>The ratio of distribution required for success (default `1`)
--timeout <duration>The duration to wait before failing (default `30s`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 the bookinfo virtual service has been distributed to a specific proxy
  istioctl experimental wait --for=distribution virtualservice bookinfo.default --proxy workload-instance.namespace

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

istioctl experimental waypoint

A group of commands used to manage waypoint configuration

istioctl experimental waypoint [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--name <string>name of the waypoint (default `default-namespace`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Apply a waypoint to the current namespace
  istioctl x waypoint apply

  # Generate a waypoint as yaml
  istioctl x waypoint generate --namespace default

  # List all waypoints in a specific namespace
  istioctl x waypoint list --namespace default

istioctl experimental waypoint apply

Apply a waypoint configuration to the cluster

istioctl experimental waypoint apply [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--enroll-namespaceIf set, the namespace will be annotated with the waypoint name
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--for <string>Specify the traffic type [service workload all none] for the waypoint (default `service`)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--name <string>name of the waypoint (default `default-namespace`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rThe revision to label the waypoint with (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--wait-wWait for the waypoint to be ready

Examples

  # Apply a waypoint to the current namespace
  istioctl x waypoint apply

  # Apply a waypoint to a specific namespace and wait for it to be ready
  istioctl x waypoint apply --namespace default --wait

istioctl experimental waypoint delete

Delete a waypoint configuration from the cluster

istioctl experimental waypoint delete [flags]
FlagsShorthandDescription
--allDelete all waypoints in the namespace
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--name <string>name of the waypoint (default `default-namespace`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Delete a waypoint from the default namespace
  istioctl x waypoint delete

  # Delete a waypoint by name, which can obtain from istioctl x waypoint list
  istioctl x waypoint delete waypoint-name --namespace default

  # Delete several waypoints by name
  istioctl x waypoint delete waypoint-name1 waypoint-name2 --namespace default

  # Delete all waypoints in a specific namespace
  istioctl x waypoint delete --all --namespace default

istioctl experimental waypoint generate

Generate a waypoint configuration as YAML

istioctl experimental waypoint generate [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--name <string>name of the waypoint (default `default-namespace`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rThe revision to label the waypoint with (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Generate a waypoint as yaml
  istioctl x waypoint generate --namespace default

istioctl experimental waypoint list

List managed waypoint configurations in the cluster

istioctl experimental waypoint list [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--all-namespaces-AList all waypoints in all namespaces
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--name <string>name of the waypoint (default `default-namespace`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # List all waypoints in a specific namespace
  istioctl x waypoint list --namespace default

  # List all waypoints in the cluster
  istioctl x waypoint list -A

istioctl experimental workload

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

FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # workload group yaml generation
  istioctl x workload group create

  # workload entry configuration generation
  istioctl x workload entry configure

istioctl experimental workload entry

Commands dealing with WorkloadEntry resources

FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl x workload 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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--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
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--clusterID <string>The ID used to identify the cluster (default ``)
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (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 ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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 ``)
--mode <string>The operating mode of the implementation. (default `default`)
--name <string>The name of the workload group (default ``)
--namespace <string>-nThe namespace that the workload instances belong to (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput directory for generated files (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--tokenDuration <int>The token duration in seconds (default: 1 hour) (default `3600`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # configure example using a local WorkloadGroup artifact
  istioctl x workload entry configure -f workloadgroup.yaml -o config

  # configure example using the API server
  istioctl x workload entry configure --name foo --namespace bar -o config

istioctl experimental workload group

Commands dealing with WorkloadGroup resources

FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  istioctl x workload 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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--annotations <stringSlice>-aThe annotations to apply to the workload instances (default `[]`)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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 `[]`)
--mode <string>The operating mode of the implementation. (default `default`)
--name <string>The name of the workload group (default ``)
--namespace <string>-nThe namespace that the workload instances will belong to (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--ports <stringSlice>-pThe incoming ports exposed by the workload instance (default `[]`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--serviceAccount <string>-sThe service identity to associate with the workload instances (default `default`)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

istioctl experimental ztunnel-config

A group of commands used to update or retrieve Ztunnel configuration from a Ztunnel instance.

FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Ztunnel proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

  # Retrieve summary about workload configuration for a given Ztunnel instance.
	istioctl ztunnel-config <workload> <ztunnel-name[.namespace]>

istioctl experimental ztunnel-config log

Retrieve information about logging levels of the Ztunnel instance in the specified pod, and update optionally.

istioctl experimental ztunnel-config log [<type>/]<name>[.<namespace>] [flags]
istioctl experimental ztunnel-config o [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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>,... or <level> to change all active loggers, where logger components can be listed by running "istioctl ztunnel-config log <pod-name[.namespace]>", and level can be one of [trace, debug, info, warning, error, critical, off] (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Ztunnel proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--reset-rReset levels to default value (warning).
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--selector <string>-lLabel selector (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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 Ztunnel.
  istioctl ztunnel-config log <pod-name[.namespace]>

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

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

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

istioctl experimental ztunnel-config workload

Retrieve information about workload configuration for the Ztunnel instance.

istioctl experimental ztunnel-config workload [<type>/]<name>[.<namespace>] [flags]
istioctl experimental ztunnel-config workloads [<type>/]<name>[.<namespace>] [flags]
istioctl experimental ztunnel-config w [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--address <string>Filter workloads by address field (default ``)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fZtunnel config dump JSON file (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--node <string>Filter workloads by node field (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Ztunnel proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--verboseOutput more information
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
--workload-namespace <string>Filter workloads by namespace field (default ``)

Examples

  # Retrieve summary about workload configuration for a given Ztunnel instance.
  istioctl ztunnel-config workload <ztunnel-name[.namespace]>

  # Retrieve summary of workloads on node XXXX for a given Ztunnel instance.
  istioctl ztunnel-config workload <ztunnel-name[.namespace]> --node ambient-worker

  # Retrieve full workload dump of workloads with address XXXX for a given Ztunnel instance.
  istioctl ztunnel-config workload <ztunnel-name[.namespace]> --address 0.0.0.0 -o json

  # Retrieve Ztunnel config dump separately and inspect from file.
  kubectl exec -it $ZTUNNEL -n istio-system -- curl localhost:15000/config_dump > ztunnel-config.json
  istioctl ztunnel-config workloads --file ztunnel-config.json

  # Retrieve workload summary for a specific namespace
  istioctl ztunnel-config workloads <ztunnel-name[.namespace]> --workloads-namespace foo

istioctl install

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

istioctl install [flags]
istioctl apply [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--charts <string>Deprecated, use --manifests instead. (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--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.
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--readiness-timeout <duration>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rTarget control plane revision for the command. (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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.22/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.
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--verifyVerify the Istio control plane after installation/in-place upgrade
--version <string>Implementation's version (default ``)
--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"

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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--authority <string>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)
--cert-dir <string>XDS Endpoint certificate directory (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--filename <string>-fInput Kubernetes resource filename (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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`)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (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 ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oModified output Kubernetes resource filename (default ``)
--plaintextUse plain-text HTTP/2 when connecting to server (no TLS).
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--timeout <duration>The duration to wait before failing (default `30s`)
--url <string>Implementation's url (default ``)
--valuesFile <string>Injection values configuration filename. (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--directory-rCompare directory.
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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 ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (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 ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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 `::`)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--verbose-vVerbose output.
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--charts <string>Deprecated, use --manifests instead. (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--cluster-specificIf enabled, the current cluster will be checked for cluster-specific setting detection.
--component <stringSlice>Specify which component to generate manifests for. (default `[]`)
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--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.
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oManifest output directory path. (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rTarget control plane revision for the command. (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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.22/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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"

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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--charts <string>Deprecated, use --manifests instead. (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--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.
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--readiness-timeout <duration>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rTarget control plane revision for the command. (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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.22/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.
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--verifyVerify the Istio control plane after installation/in-place upgrade
--version <string>Implementation's version (default ``)
--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"

istioctl operator

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

FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--charts <string>Deprecated, use --manifests instead. (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--operatorNamespace <string>The namespace the operator controller is installed into. (default `istio-operator`)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml (default `yaml`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rTarget revision for the operator. (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--tag <string>The tag for the operator controller image. (default `unknown`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--charts <string>Deprecated, use --manifests instead. (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--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 ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--operatorNamespace <string>The namespace the operator controller is installed into. (default `istio-operator`)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rTarget revision for the operator. (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--tag <string>The tag for the operator controller image. (default `unknown`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--forceProceed even with validation errors.
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--operatorNamespace <string>The namespace the operator controller is installed into. (default `istio-operator`)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--purgeRemove all versions of Istio operator.
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rTarget revision for the operator. (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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.
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

istioctl options

Displays istioctl global options

FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--charts <string>Deprecated, use --manifests instead. (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--charts <string>Deprecated, use --manifests instead. (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--config-path <string>-pThe path the root of the configuration subtree to dump e.g. components.pilot. By default, dump whole tree (default ``)
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--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 `[]`)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|flags (default `yaml`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--charts <string>Deprecated, use --manifests instead. (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 ``)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--direction <string>Filter clusters by Direction field (default ``)
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump file (default ``)
--fqdn <string>Filter clusters by substring of Service FQDN field (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--name <string>Filter listeners by route name field (default ``)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--port <int>Filter clusters and listeners by Port field (default `0`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--subset <string>Filter clusters by substring of Subset field (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--type <string>Filter listeners by type field (default ``)
--url <string>Implementation's url (default ``)
--verboseOutput more information
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `json`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 <pod-name[.namespace]> -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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--direction <string>Filter clusters by Direction field (default ``)
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--fqdn <string>Filter clusters by substring of Service FQDN field (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--port <int>Filter clusters by Port field (default `0`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--subset <string>Filter clusters by substring of Subset field (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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 ecds

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

istioctl proxy-config ecds [<type>/]<name>[.<namespace>] [flags]
istioctl proxy-config ec [<type>/]<name>[.<namespace>] [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

Examples

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

  # Retrieve endpoint summary without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config ecds --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 ``)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--cluster <string>Filter endpoints by cluster name field (default ``)
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--port <int>Filter endpoints by Port field (default `0`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--status <string>Filter endpoints by status field (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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 ``)
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--port <int>Filter listeners by Port field (default `0`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--type <string>Filter listeners by type field (default ``)
--url <string>Implementation's url (default ``)
--verboseOutput more information
--version <string>Implementation's version (default ``)
--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

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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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>,... or <level> to change all active loggers, where logger components can be listed by running "istioctl proxy-config log <pod-name[.namespace]>"or referred from https://github.com/envoyproxy/envoy/blob/main/source/common/common/logger.h, and level can be one of [trace, debug, info, warning, error, critical, off] (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--reset-rReset levels to default value (warning).
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--selector <string>-lLabel selector (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--name <string>Filter listeners by route name field (default ``)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--verboseOutput more information
--version <string>Implementation's version (default ``)
--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.

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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format: one of json|yaml|short (default `short`)
--project <string>Implementation's project (default ``)
--proxy-admin-port <int>Envoy proxy admin port (default `15000`)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--authority <string>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)
--cert-dir <string>XDS Endpoint certificate directory (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--file <string>-fEnvoy config dump JSON file (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--insecureSkip server certificate and domain verification. (NOT SECURE!)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--plaintextUse plain-text HTTP/2 when connecting to server (no TLS).
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--timeout <duration>The duration to wait before failing (default `30s`)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 proxy-status

  # Retrieve sync status for Envoys in a specific namespace
  istioctl proxy-status --namespace foo

  # Retrieve sync diff for a single Envoy and Istiod
  istioctl 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 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 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 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 ps --xds-label istio.io/rev=default

istioctl remote-clusters

Lists the remote clusters each istiod instance is connected to.

istioctl remote-clusters [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)

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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--auto-inject-namespacesIf set to true, the sidecars should be automatically injected into all namespaces by default
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--overwriteIf true, allow revision tags to be overwritten, otherwise reject revision tag updates that overwrite existing revision tags.
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision to reference from a given revision tag (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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.
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOutput format for tag description (available formats: table,json) (default `table`)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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.
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--auto-inject-namespacesIf set to true, the sidecars should be automatically injected into all namespaces by default
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--overwriteIf true, allow revision tags to be overwritten, otherwise reject revision tag updates that overwrite existing revision tags.
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision to reference from a given revision tag (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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.
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 uninstall

The uninstall command uninstalls Istio from a cluster

istioctl uninstall [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--filename <string>-fThe filename of the IstioOperator CR. (default ``)
--forceProceed even with validation errors.
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--purgeDelete all Istio related sources for all versions
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rTarget control plane revision for the command. (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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.22/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.
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--verbose-vVerbose output.
--version <string>Implementation's version (default ``)
--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 uninstall --revision foo

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

istioctl upgrade

The upgrade command is an alias for the install command

istioctl upgrade [flags]
FlagsShorthandDescription
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--charts <string>Deprecated, use --manifests instead. (default ``)
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--dry-runConsole/log output only, make no changes.
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--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.
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--readiness-timeout <duration>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rTarget control plane revision for the command. (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (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.22/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.
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--verifyVerify the Istio control plane after installation/in-place upgrade
--version <string>Implementation's version (default ``)
--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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--filename <stringSlice>-fInputs of files to validate (default `[]`)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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 all yaml files under samples/bookinfo/networking directory
  istioctl validate -f samples/bookinfo/networking

  # 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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--filename <stringSlice>-fIstio YAML installation file. (default `[]`)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--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.22.0/manifests). (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--project <string>Implementation's project (default ``)
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (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
--all-featuresWhether to enable all supported features for conformance tests
--allow-crds-mismatchFlag to allow the suite not to fail in case there is a mismatch between CRDs versions and channels.
--cleanup-base-resourcesWhether to cleanup base test resources after the run
--conformance-profiles <string>Comma-separated list of the conformance profiles to run (default ``)
--contact <string>Comma-separated list of contact information for the maintainers (default ``)
--context <string>Kubernetes configuration context (default ``)
--debugWhether to print debug logs
--exempt-features <string>Exempt Features excluded from conformance tests suites (default ``)
--gateway-class <string>Name of GatewayClass to use for tests (default `gateway-conformance`)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--mode <string>The operating mode of the implementation. (default `default`)
--namespace <string>-nKubernetes namespace (default ``)
--namespace-annotations <string>Comma-separated list of name=value annotations to add to test namespaces (default ``)
--namespace-labels <string>Comma-separated list of name=value labels to add to test namespaces (default ``)
--organization <string>Implementation's Organization (default ``)
--output <string>-oOne of 'yaml' or 'json'. (default ``)
--project <string>Implementation's project (default ``)
--remoteUse --remote=false to suppress control plane check
--report-output <string>The file where to write the conformance report (default ``)
--revision <string>-rControl plane revision (default ``)
--run-test <string>Name of a single test to run, instead of the whole suite (default ``)
--short-sUse --short=false to generate full version information
--skip-tests <string>Comma-separated list of tests to skip (default ``)
--supported-features <string>Supported features included in conformance tests suites (default ``)
--url <string>Implementation's url (default ``)
--version <string>Implementation's version (default ``)
--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
CA_TRUSTED_NODE_ACCOUNTSStringIf set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies.
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 belongs to
COMPLIANCE_POLICYStringIf set, applies policy-specific restrictions over all existing TLS settings, including in-mesh mTLS and external TLS. Valid values are: * '' or unset places no additional restrictions. * 'fips-140-2' which enforces a version of the TLS protocol and a subset of cipher suites overriding any user preferences or defaults for all runtime components, including Envoy, gRPC Go SDK, and gRPC C++ SDK. WARNING: Setting compliance policy in the control plane is a necessary but not a sufficient requirement to achieve compliance. There are additional steps necessary to claim compliance, including using the validated cryptograhic modules (please consult https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fips-140-2).
ENABLE_AUTO_SNIBooleantrueIf 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_ENHANCED_RESOURCE_SCOPINGBooleantrueIf enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution.
ENABLE_EXTERNAL_NAME_ALIASBooleantrueIf enabled, ExternalName Services will be treated as simple aliases: anywhere where we would match the concrete service, we also match the ExternalName. In general, this mirrors Kubernetes behavior more closely. However, it means that policies (routes and DestinationRule) cannot be applied to the ExternalName service. If disabled, ExternalName behaves in fairly unexpected manner. Port matters, while it does not in Kubernetes. If it is a TCP port, all traffic on that port will be matched, which can have disastrous consequences. Additionally, the destination is seen as an opaque destination; even if it is another service in the mesh, policies such as mTLS and load balancing will not be used when connecting to it.
ENABLE_HCM_INTERNAL_NETWORKSBooleanfalseIf enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager
ENABLE_LEADER_ELECTIONBooleantrueIf enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election.
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_NATIVE_SIDECARSBooleanfalseIf set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag.
ENABLE_OPTIMIZED_CONFIG_REBUILDBooleantrueIf enabled, pilot will only rebuild config for resources that have changed
ENABLE_OTEL_BUILTIN_RESOURCE_LABELSBooleanfalseIf enabled, envoy will send builtin labels(e.g. node_name) via OTel sink.
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_RESOLUTION_NONE_TARGET_PORTBooleantrueIf enabled, targetPort will be supported for resolution=NONE ServiceEntry
ENABLE_SELECTOR_BASED_K8S_GATEWAY_POLICYBooleantrueIf disabled, Gateway API gateways will ignore workloadSelector policies, onlyapplying policies that select the gateway with a targetRef.
ENABLE_TLS_ON_SIDECAR_INGRESSBooleanfalseIf enabled, the TLS configuration on Sidecar.ingress will take effect
ENABLE_VTPROTOBUFBooleantrueIf true, will use optimized vtprotobuf based marshaling. Requires a build with -tags=vtprotobuf.
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.
GRPC_KEEPALIVE_INTERVALTime Duration30sgRPC Keepalive Interval
GRPC_KEEPALIVE_TIMEOUTTime Duration10sgRPC Keepalive Timeout
HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLEDBooleantrue
INBOUND_INTERCEPTION_MODEStringThe mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY"
INBOUND_TPROXY_MARKString
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_DELTA_XDSBooleantrueIf 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_DUAL_STACKBooleanfalseIf true, Istio will enable the Dual Stack feature.
ISTIO_ENABLE_CONTROLLER_QUEUE_METRICSBooleanfalseIf enabled, publishes metrics for queue depth, latency and processing times.
ISTIO_ENABLE_HTTP2_PROBINGBooleantrueIf enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes
ISTIO_ENABLE_IPV4_OUTBOUND_LISTENER_FOR_IPV6_CLUSTERSBooleanfalseIf true, pilot will configure an additional IPv4 listener for outbound traffic in IPv6 only clusters, e.g. AWS EKS IPv6 only clusters.
ISTIO_ENABLE_OPTIMIZED_SERVICE_PUSHBooleantrueIf enabled, Istiod will not push changes on arbitrary annotation change.
ISTIO_GPRC_MAXRECVMSGSIZEInteger4194304Sets the max receive buffer size of gRPC stream in bytes.
ISTIO_GPRC_MAXSTREAMSInteger100000Sets the maximum number of concurrent grpc streams.
ISTIO_KUBE_CLIENT_CONTENT_TYPEStringprotobufThe content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json]
ISTIO_MULTIROOT_MESHBooleanfalseIf enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS
ISTIO_OUTBOUND_IPV4_LOOPBACK_CIDRString127.0.0.1/32IPv4 CIDR range used to identify outbound traffic on loopback interface intended for application container
ISTIO_OUTBOUND_OWNER_GROUPSString*Comma separated list of groups whose outgoing traffic is to be redirected to Envoy. A group can be specified either by name or by a numeric GID. The wildcard character "*" can be used to configure redirection of traffic from all groups.
ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDEStringComma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy. A group can be specified either by name or by a numeric GID. Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy.
ISTIO_PROMETHEUS_ANNOTATIONSString
ISTIO_WATCH_NAMESPACEStringIf set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set.
ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITYBooleantrueIf enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases
JWKS_RESOLVER_INSECURE_SKIP_VERIFYBooleanfalseIf enabled, istiod will skip verifying the certificate of the JWKS server.
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.
LOCAL_CLUSTER_SECRET_WATCHERBooleanfalseIf enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster
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 Kubernetes Multi-Cluster Services (MCS) API.
METRIC_GRACEFUL_DELETION_INTERVALTime Duration5m0sMetric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled.
METRIC_ROTATION_INTERVALTime Duration0sMetric scope rotation interval, set to 0 to disable the metric scope rotation
MUTEX_PROFILE_FRACTIONInteger1000If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely.
PERSIST_OLDEST_FIRST_HEURISTIC_FOR_VIRTUAL_SERVICE_HOST_MATCHINGBooleanfalseIf enabled, istiod will persist the oldest first heuristic for subtly conflicting traffic policy selection(such as with overlapping wildcard hosts)
PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGEBooleanfalseIf set, it allows creating inbound listeners for service ports and sidecar ingress listeners
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_CONVERT_SIDECAR_SCOPE_CONCURRENCYInteger1Used to adjust the concurrency of SidecarScope conversions. When istiod is deployed on a multi-core CPU server, increasing this value will help to use the CPU to accelerate configuration push, but it also means that istiod will consume more CPU resources.
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_DISABLE_MX_ALPNBooleanfalseIf true, pilot will not put istio-peer-exchange ALPN into TLS handshake configuration.
PILOT_DISTRIBUTION_HISTORY_RETENTIONTime Duration1m0sIf enabled, Pilot will keep track of old versions of distributed config for this duration.
PILOT_DRAINING_LABELStringistio.io/drainingIf not empty, endpoints with the label value present will be sent with status DRAINING.
PILOT_ENABLE_ALPHA_GATEWAY_APIBooleanfalseIf this is set to true, support for alpha APIs in the 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_ALPN_FILTERBooleantrueIf true, pilot will add Istio ALPN filters, required for proper protocol sniffing.
PILOT_ENABLE_AMBIENT_CONTROLLERSBooleanfalseIf enabled, controllers required for ambient will run. This is required to run ambient mesh.
PILOT_ENABLE_AMBIENT_WAYPOINTSBooleanfalseIf enabled, controllers required for ambient will run. This is required to run ambient mesh.
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_TRACKINGBooleanfalseIf 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_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_GATEWAYCLASS_CONTROLLERBooleantrueIf this is set to true, istiod will create and manage its default GatewayClasses
PILOT_ENABLE_GATEWAY_API_STATUSBooleantrueIf this is set to true, gateway-api resources will have status written to them
PILOT_ENABLE_HBONEBooleanfalseIf enabled, HBONE support can be configured for proxies. Note: proxies must opt in on a per-proxy basis with ENABLE_HBONE to actually get HBONE config, in addition to this flag.
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIESBooleantrueIf enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature
PILOT_ENABLE_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_NODE_UNTAINT_CONTROLLERSBooleanfalseIf enabled, controller that untaints nodes with cni pods ready will run. This should be enabled if you disabled ambient init containers.
PILOT_ENABLE_PERSISTENT_SESSION_FILTERBooleanfalseIf enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set.
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_GATEWAY_API_CONTROLLER_NAMEStringistio.io/gateway-controllerGateway API controller name. istiod will only reconcile Gateway API resources referencing a GatewayClass with this controller name
PILOT_GATEWAY_API_DEFAULT_GATEWAYCLASS_NAMEStringistioName of the default GatewayClass
PILOT_HTTP10BooleanfalseEnables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.
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_JWKSStringfalseMode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy.
PILOT_JWT_PUB_KEY_REFRESH_INTERVALTime Duration20m0sThe interval for istiod to fetch the jwks_uri for the jwks public key.
PILOT_MAX_REQUESTS_PER_SECONDFloating-Point0Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. If set to 0 or unset, the max will be automatically determined based on the machine size
PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_APIBooleanfalseIf true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways.
PILOT_PERSISTENT_SESSION_HEADER_LABELStringistio.io/persistent-session-headerIf not empty, services with this label will use header based persistent sessions
PILOT_PERSISTENT_SESSION_LABELStringistio.io/persistent-sessionIf not empty, services with this label will use cookie based persistent sessions
PILOT_PUSH_THROTTLEInteger0Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes. If set to 0 or unset, the max will be automatically determined based on the machine size
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 sidecar 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_QPSInteger100If 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_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_INDEX_CLEAR_INTERVALTime Duration5sThe interval for xds cache index clearing.
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.
PLATFORMStringPlatform where Istio is deployed. Possible values are "openshift" and "gcp"
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.
SHARED_MESH_CONFIGStringAdditional config map to load for shared MeshConfig settings. The standard mesh config will take precedence.
STACKDRIVER_AUDIT_LOGBooleanfalseIf enabled, StackDriver audit logging will be enabled.
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
TRUSTED_GATEWAY_CIDRStringIf set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network
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.
USE_CACERTS_FOR_SELF_SIGNED_CABooleanfalseIf enabled, istiod will use a secret named cacerts to store its self-signed istio-generated root certificate.
VALIDATION_WEBHOOK_CONFIG_NAMEStringistio-istio-systemIf not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment.
VERIFY_CERTIFICATE_AT_CLIENTBooleantrueIf 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 running on a secure/trusted network

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.
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_tcp_over_current_tcpLastValueNumber of conflicting tcp listeners with current tcp listener.
pilot_debounce_timeDistributionDelay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue.
pilot_destrule_subsetsLastValueDuplicate subsets across destination rules for same host
pilot_dns_cluster_without_endpointsLastValueDNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint
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_envoy_filter_statusLastValueStatus of Envoy filters whether it was applied or errored.
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_pushcontext_init_secondsDistributionTotal time in seconds Pilot takes to init pushContext.
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_worker_queue_depthLastValueDepth of the controller queues
pilot_worker_queue_durationDistributionTime taken to process an item
pilot_worker_queue_latencyDistributionLatency before the item is processed
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_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.
provider_lookup_cluster_failuresSumNumber of times a cluster lookup failed
reconcile_request_totalSumNumber of times requesting Reconcile
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.
sidecar_injection_time_secondsDistributionTotal time taken for injection in seconds.
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_dependent_config_sizeLastValueCurrent size of dependent configs
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!