istioctl

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

istioctl analyze

Analyze Istio configuration and print validation messages

istioctl analyze <file>... [flags]

Examples

# Analyze the current live cluster
istioctl analyze
# Analyze the current live cluster, simulating the effect of applying additional yaml files
istioctl analyze a.yaml b.yaml my-app-config/
# Analyze the current live cluster, simulating the effect of applying a directory of config recursively
istioctl analyze --recursive my-istio-config/
# Analyze yaml files without connecting to a live cluster
istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/
# Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
istioctl analyze -S "IST0103=Pod mypod.testing"
# Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
# and suppress MisplacedAnnotation on deployment foobar in namespace default.
istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"
# List available analyzers
istioctl analyze -L

istioctl authz

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

istioctl authz [flags]

istioctl convert-ingress

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

istioctl convert-ingress [flags]

Examples

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

istioctl dashboard

Access to Istio web UIs

istioctl dashboard [flags]

istioctl dash [flags]
istioctl d [flags]

istioctl dashboard controlz

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

istioctl dashboard controlz <pod-name[.namespace]> [flags]

Examples

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

istioctl dashboard envoy

Open the Envoy admin dashboard for a sidecar

istioctl dashboard envoy <pod-name[.namespace]> [flags]

Examples

istioctl dashboard envoy productpage-123-456.default

istioctl dashboard grafana

Open Istio’s Grafana dashboard

istioctl dashboard grafana [flags]

Examples

istioctl dashboard grafana

istioctl dashboard jaeger

Open Istio’s Jaeger dashboard

istioctl dashboard jaeger [flags]

Examples

istioctl dashboard jaeger

istioctl dashboard kiali

Open Istio’s Kiali dashboard

istioctl dashboard kiali [flags]

Examples

istioctl dashboard kiali

istioctl dashboard prometheus

Open Istio’s Prometheus dashboard

istioctl dashboard prometheus [flags]

Examples

istioctl dashboard prometheus

istioctl dashboard zipkin

Open Istio’s Zipkin dashboard

istioctl dashboard zipkin [flags]

Examples

istioctl dashboard zipkin

istioctl deregister

De-registers a service instance

istioctl deregister <svcname> <ip> [flags]

Examples

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

istioctl experimental

Experimental commands that may be modified or deprecated

istioctl experimental add-to-mesh

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

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

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

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

istioctl experimental add-to-mesh [flags]

istioctl experimental add [flags]

Examples

# Restart all productpage pods with an Istio sidecar
istioctl experimental add-to-mesh service productpage
# Restart just pods from the productpage-v1 deployment
istioctl experimental add-to-mesh deployment productpage-v1
# Control how meshed pods see an external service
istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126 \
   http:9080 tcp:8888 --labels app=test,version=v1 --annotations env=stage --serviceaccount stageAdmin

istioctl experimental add-to-mesh deployment

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

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

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

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

istioctl experimental add-to-mesh deployment <deployment> [flags]

Examples

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

istioctl experimental add-to-mesh external-service

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

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

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

istioctl experimental add-to-mesh external-service <svcname> <ip> [name1:]port1 [[name2:]port2] ... [flags]

Examples

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

istioctl experimental add-to-mesh service

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

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

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

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

istioctl experimental add-to-mesh service <service> [flags]

Examples

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

istioctl experimental analyze

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

istioctl experimental analyze <file>... [flags]

Examples

# Analyze the current live cluster
istioctl analyze
# Analyze the current live cluster, simulating the effect of applying additional yaml files
istioctl analyze a.yaml b.yaml my-app-config/
# Analyze the current live cluster, simulating the effect of applying a directory of config recursively
istioctl analyze --recursive my-istio-config/
# Analyze yaml files without connecting to a live cluster
istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/
# Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
istioctl analyze -S "IST0103=Pod mypod.testing"
# Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
# and suppress MisplacedAnnotation on deployment foobar in namespace default.
istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"
# List available analyzers
istioctl analyze -L

istioctl experimental authz

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

Examples

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

istioctl experimental authz check

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

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

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

istioctl experimental authz check <pod-name>[.<pod-namespace>] [flags]

Examples

  # Check Envoy authorization configuration for pod httpbin-88ddbcfdd-nt5jb:
  istioctl x authz check httpbin-88ddbcfdd-nt5jb
  # Check Envoy authorization configuration from a config dump file:
  istioctl x authz check -f httpbin_config_dump.json

istioctl experimental config

Gonfigure istioctl defaults

Examples

# list configuration parameters
istioctl config list

istioctl experimental config list

List istio configurable defaults

istioctl experimental config list [flags]

istioctl experimental create-remote-secret

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

istioctl experimental create-remote-secret [flags]

Examples

# Create a secret to access cluster c0's apiserver and install it in cluster c1.
istioctl --Kubeconfig=c0.yaml x create-remote-secret --name c0 \
    | kubectl --Kubeconfig=c1.yaml apply -f -
# Delete a secret that was previously installed in c1
istioctl --Kubeconfig=c0.yaml x create-remote-secret --name c0 \
    | kubectl --Kubeconfig=c1.yaml delete -f -
# Create a secret access a remote cluster with an auth plugin
istioctl --Kubeconfig=c0.yaml x create-remote-secret --name c0 --auth-type=plugin --auth-plugin-name=gcp \
    | kubectl --Kubeconfig=c1.yaml apply -f -

istioctl experimental describe

Describe resource and related Istio configuration

istioctl experimental describe [flags]

istioctl experimental des [flags]

istioctl experimental describe pod

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

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

istioctl experimental describe pod <pod> [flags]

Examples

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

istioctl experimental describe service

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

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

istioctl experimental describe service <svc> [flags]

istioctl experimental describe svc <svc> [flags]

Examples

istioctl experimental describe service productpage

istioctl experimental kube-uninject

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

istioctl experimental kube-uninject [flags]

Examples

# Update resources before applying.
kubectl apply -f <(istioctl experimental kube-uninject -f <resource.yaml>)
# Create a persistent version of the deployment by removing Envoy sidecar.
istioctl experimental kube-uninject -f deployment.yaml -o deployment-uninjected.yaml
# Update an existing deployment.
kubectl get deployment -o yaml | istioctl experimental kube-uninject -f - | kubectl apply -f -

istioctl experimental metrics

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

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

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

istioctl experimental metrics <workload name>...

istioctl experimental m <workload name>...

Examples

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

istioctl experimental multicluster

Commands to assist in managing a multi-cluster mesh

istioctl experimental multicluster apply

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

istioctl experimental multicluster apply  -f <mesh.yaml> [flags]

istioctl experimental multicluster describe

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

istioctl experimental multicluster describe -f <mesh.yaml> [--all] [flags]

istioctl experimental multicluster generate

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

istioctl experimental multicluster generate -f <mesh.yaml> [flags]

istioctl experimental post-install

Commands related to post-install

istioctl experimental post-install webhook

webhook command to manage webhook configurations

istioctl experimental post-install webhook disable

Disable webhook configurations

istioctl experimental post-install webhook disable [flags]

Examples

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

istioctl experimental post-install webhook enable

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

istioctl experimental post-install webhook enable [flags]

Examples

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

istioctl experimental post-install webhook status

Get webhook configurations

istioctl experimental post-install webhook status [flags]

Examples

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

istioctl experimental precheck

precheck inspects a Kubernetes cluster for Istio install requirements.

istioctl experimental precheck [-f <deployment or istio operator file>] [flags]

Examples

        # Verify that Istio can be installed
        istioctl experimental precheck
        # Verify the deployment matches a custom Istio deployment configuration
        istioctl x precheck --set profile=demo
        # Verify the deployment matches the Istio Operator deployment definition
        istioctl x precheck -f iop.yaml

istioctl experimental proxy-status

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

istioctl experimental proxy-status [<pod-name[.namespace]>] [flags]

istioctl experimental ps [<pod-name[.namespace]>] [flags]

Examples

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

istioctl experimental remove-from-mesh

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

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

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

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

istioctl experimental remove-from-mesh [flags]

istioctl experimental rm [flags]

Examples

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

istioctl experimental remove-from-mesh deployment

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

‘remove-from-mesh’ is a compatibility troubleshooting tool.

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

istioctl experimental remove-from-mesh deployment <deployment> [flags]

Examples

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

istioctl experimental remove-from-mesh external-service

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

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

istioctl experimental remove-from-mesh external-service <svcname> [flags]

Examples

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

istioctl experimental remove-from-mesh service

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

‘remove-from-mesh’ is a compatibility troubleshooting tool.

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

istioctl experimental remove-from-mesh service <service> [flags]

Examples

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

istioctl experimental sidecar-bootstrap

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

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

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

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

istioctl experimental sidecar-bootstrap <workloadEntry>.<namespace> [flags]

Examples

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

istioctl experimental uninstall

The uninstall command uninstalls Istio from a cluster

istioctl experimental uninstall [flags]

Examples

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

istioctl experimental upgrade

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

istioctl experimental upgrade [flags]

istioctl experimental version

Prints out build version information

istioctl experimental version [flags]

Examples

# Retrieve version information directly from XDS, without security
istioctl x version --xds-address localhost:15012
# Retrieve version information directly from XDS, with security
# (the certificates must be retrieved before this step)
istioctl x version --xds-address localhost:15010 --cert-dir ~/.istio-certs
# Retrieve version information via XDS from all Istio pods in a Kubernetes cluster
# (without security)
istioctl x version --xds-port 15010
# Retrieve version information via XDS from all Istio pods in a Kubernetes cluster
# (the certificates must be retrieved before this step)
istioctl x version --cert-dir ~/.istio-certs
# Retrieve version information via XDS from default control plane Istio pods
# in a Kubernetes cluster, without security
istioctl x version --xds-label istio.io/rev=default --xds-port 15010

istioctl experimental wait

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

istioctl experimental wait [flags] <type> <name>[.<namespace>]

Examples

# Wait until the bookinfo virtual service has been distributed to all proxies in the mesh
istioctl experimental wait --for=distribution virtualservice bookinfo.default
# Wait until 99% of the proxies receive the distribution, timing out after 5 minutes
istioctl experimental wait --for=distribution --threshold=.99 --timeout=300 virtualservice bookinfo.default

istioctl install

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

istioctl install [flags]

Examples

  # Apply a default Istio installation
  istioctl install
  # Enable grafana dashboard
  istioctl install --set values.grafana.enabled=true
  # Generate the demo profile and don't wait for confirmation
  istioctl install --set profile=demo --skip-confirmation
  # To override a setting that includes dots, escape them with a backslash (\).  Your shell may require enclosing quotes.
  istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"

istioctl kube-inject

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

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

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

istioctl kube-inject [flags]

Examples

# Update resources on the fly before applying.
kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)
# Create a persistent version of the deployment with Envoy sidecar
# injected.
istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml
# Update an existing deployment.
kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -
# Capture cluster configuration for later use with kube-inject
kubectl -n istio-system get cm istio-sidecar-injector  -o jsonpath="{.data.config}" > /tmp/inj-template.tmpl
kubectl -n istio-system get cm istio -o jsonpath="{.data.mesh}" > /tmp/mesh.yaml
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.values}" > /tmp/values.json
# Use kube-inject based on captured configuration
istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \
    --injectConfigFile /tmp/inj-template.tmpl \
    --meshConfigFile /tmp/mesh.yaml \
    --valuesFile /tmp/values.json

istioctl manifest

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

istioctl manifest diff

The diff subcommand compares manifests from two files or directories.

istioctl manifest diff <file|dir> <file|dir> [flags]

istioctl manifest generate

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

istioctl manifest generate [flags]

Examples

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

istioctl manifest install

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

istioctl manifest install [flags]

Examples

  # Apply a default Istio installation
  istioctl install
  # Enable grafana dashboard
  istioctl install --set values.grafana.enabled=true
  # Generate the demo profile and don't wait for confirmation
  istioctl install --set profile=demo --skip-confirmation
  # To override a setting that includes dots, escape them with a backslash (\).  Your shell may require enclosing quotes.
  istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"

istioctl operator

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

istioctl operator dump

The dump subcommand dumps the Istio operator controller manifest.

istioctl operator dump [flags]

istioctl operator init

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

istioctl operator init [flags]

istioctl operator remove

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

istioctl operator remove [flags]

istioctl options

Displays istioctl global options

istioctl profile

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

Examples

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

istioctl profile diff

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

istioctl profile diff <file1.yaml> <file2.yaml> [flags]

istioctl profile dump

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

istioctl profile dump [<profile>] [flags]

istioctl profile list

The list subcommand lists the available Istio configuration profiles.

istioctl profile list [flags]

istioctl proxy-config

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

Examples

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

istioctl proxy-config bootstrap

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

istioctl proxy-config bootstrap [<pod-name[.namespace]>] [flags]

istioctl proxy-config b [<pod-name[.namespace]>] [flags]

Examples

  # Retrieve full bootstrap configuration for a given pod from Envoy.
  istioctl proxy-config bootstrap <pod-name[.namespace]>
  # Retrieve full bootstrap without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config bootstrap --file envoy-config.json

istioctl proxy-config cluster

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

istioctl proxy-config cluster [<pod-name[.namespace]>] [flags]

istioctl proxy-config clusters [<pod-name[.namespace]>] [flags]
istioctl proxy-config c [<pod-name[.namespace]>] [flags]

Examples

  # Retrieve summary about cluster configuration for a given pod from Envoy.
  istioctl proxy-config clusters <pod-name[.namespace]>
  # Retrieve cluster summary for clusters with port 9080.
  istioctl proxy-config clusters <pod-name[.namespace]> --port 9080
  # Retrieve full cluster dump for clusters that are inbound with a FQDN of details.default.svc.cluster.local.
  istioctl proxy-config clusters <pod-name[.namespace]> --fqdn details.default.svc.cluster.local --direction inbound -o json
  # Retrieve cluster summary without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config clusters --file envoy-config.json

istioctl proxy-config endpoint

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

istioctl proxy-config endpoint [<pod-name[.namespace]>] [flags]

istioctl proxy-config endpoints [<pod-name[.namespace]>] [flags]
istioctl proxy-config ep [<pod-name[.namespace]>] [flags]

Examples

  # Retrieve full endpoint configuration for a given pod from Envoy.
  istioctl proxy-config endpoint <pod-name[.namespace]>
  # Retrieve endpoint summary for endpoint with port 9080.
  istioctl proxy-config endpoint <pod-name[.namespace]> --port 9080
  # Retrieve full endpoint with a address (172.17.0.2).
  istioctl proxy-config endpoint <pod-name[.namespace]> --address 172.17.0.2 -o json
  # Retrieve full endpoint with a cluster name (outbound|9411||zipkin.istio-system.svc.cluster.local).
  istioctl proxy-config endpoint <pod-name[.namespace]> --cluster "outbound|9411||zipkin.istio-system.svc.cluster.local" -o json
  # Retrieve full endpoint with the status (healthy).
  istioctl proxy-config endpoint <pod-name[.namespace]> --status healthy -ojson
  # Retrieve endpoint summary without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/clusters?format=json' > envoy-clusters.json
  istioctl proxy-config endpoints --file envoy-clusters.json

istioctl proxy-config listener

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

istioctl proxy-config listener [<pod-name[.namespace]>] [flags]

istioctl proxy-config listeners [<pod-name[.namespace]>] [flags]
istioctl proxy-config l [<pod-name[.namespace]>] [flags]

Examples

  # Retrieve summary about listener configuration for a given pod from Envoy.
  istioctl proxy-config listeners <pod-name[.namespace]>
  # Retrieve listener summary for listeners with port 9080.
  istioctl proxy-config listeners <pod-name[.namespace]> --port 9080
  # Retrieve full listener dump for HTTP listeners with a wildcard address (0.0.0.0).
  istioctl proxy-config listeners <pod-name[.namespace]> --type HTTP --address 0.0.0.0 -o json
  # Retrieve listener summary without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config listeners --file envoy-config.json

istioctl proxy-config log

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

istioctl proxy-config log <pod-name[.namespace]> [flags]

istioctl proxy-config o <pod-name[.namespace]> [flags]

Examples

  # Retrieve information about logging levels for a given pod from Envoy.
  istioctl proxy-config log <pod-name[.namespace]>
  # Update levels of the all loggers
  istioctl proxy-config log <pod-name[.namespace]> --level none
  # Update levels of the specified loggers.
  istioctl proxy-config log <pod-name[.namespace]> --level http:debug,redis:debug
  # Reset levels of all the loggers to default value (warning).
  istioctl proxy-config log <pod-name[.namespace]> -r

istioctl proxy-config route

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

istioctl proxy-config route [<pod-name[.namespace]>] [flags]

istioctl proxy-config routes [<pod-name[.namespace]>] [flags]
istioctl proxy-config r [<pod-name[.namespace]>] [flags]

Examples

  # Retrieve summary about route configuration for a given pod from Envoy.
  istioctl proxy-config routes <pod-name[.namespace]>
  # Retrieve route summary for route 9080.
  istioctl proxy-config route <pod-name[.namespace]> --name 9080
  # Retrieve full route dump for route 9080
  istioctl proxy-config route <pod-name[.namespace]> --name 9080 -o json
  # Retrieve route summary without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config routes --file envoy-config.json

istioctl proxy-config secret

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

istioctl proxy-config secret [<pod-name[.namespace]>] [flags]

istioctl proxy-config s [<pod-name[.namespace]>] [flags]

Examples

  # Retrieve full secret configuration for a given pod from Envoy.
  istioctl proxy-config secret <pod-name[.namespace]>
  # Retrieve full bootstrap without using Kubernetes API
  ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
  istioctl proxy-config secret --file envoy-config.json
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.

istioctl proxy-status

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

istioctl proxy-status [<pod-name[.namespace]>] [flags]

istioctl ps [<pod-name[.namespace]>] [flags]

Examples

# Retrieve sync status for all Envoys in a mesh
    istioctl proxy-status
# Retrieve sync diff for a single Envoy and Istiod
    istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
# Write proxy config-dump to file, and compare to Istio control plane
    kubectl port-forward -n istio-system istio-egressgateway-59585c5b9c-ndc59 15000 &
    curl localhost:15000/config_dump > cd.json
    istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system --file cd.json

istioctl register

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

istioctl register <svcname> <ip> [name1:]port1 [name2:]port2 ... [flags]

istioctl upgrade

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

istioctl upgrade [flags]

istioctl validate

Validate Istio policy and rules files

istioctl validate -f FILENAME [options] [flags]

Examples

        # Validate bookinfo-gateway.yaml
        istioctl validate -f bookinfo-gateway.yaml
        # Validate current deployments under 'default' namespace within the cluster
        kubectl get deployments -o yaml |istioctl validate -f -
        # Validate current services under 'default' namespace within the cluster
        kubectl get services -o yaml |istioctl validate -f -
        # Also see the related command 'istioctl analyze'
        istioctl analyze samples/bookinfo/networking/bookinfo-gateway.yaml

istioctl verify-install

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

If you do not specify 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]

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>

istioctl version

Prints out build version information

istioctl version [flags]

Environment variables

These environment variables affect the behavior of the istioctl command.

Exported metrics