istioctl

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

istioctl authn

A group of commands used to interact with Istio authentication policies. tls-check

Examples

# Check whether TLS setting are matching between authentication policy and destination rules:
istioctl authn tls-check

istioctl authn tls-check

Check what authentication policies and destination rules pilot uses to config a proxy instance, and check if TLS settings are compatible between them.

istioctl authn tls-check <pod-name[.namespace]> [<service>] [flags]

Examples

# Check settings for pod "foo-656bd7df7c-5zp4s" in namespace default:
istioctl authn tls-check foo-656bd7df7c-5zp4s.default

# Check settings for pod "foo-656bd7df7c-5zp4s" in namespace default, filtered on destintation
service "bar" :
istioctl authn tls-check foo-656bd7df7c-5zp4s.default bar

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 auth

Commands to inspect and interact with the authentication (TLS, JWT) and authorization (RBAC) policies in the mesh check - check the TLS/JWT/RBAC settings based on the Envoy config upgrade - upgrade the authorization policy from version v1 to v2

Examples

  # Check the TLS/JWT/RBAC settings for pod httpbin-88ddbcfdd-nt5jb:
  istioctl experimental auth check httpbin-88ddbcfdd-nt5jb

istioctl experimental auth check

Check analyzes the TLS/JWT/RBAC settings directly based on the Envoy config. The Envoy config 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).

Currently only the listeners with node IP and clusters on outbound direction are analyzed: - listeners with node IP generally tell how should other pods talk to the Envoy instance which include the server side TLS/JWT/RBAC settings.

- clusters on outbound direction generally tell how should the Envoy instance talk to other pods which include the client side TLS settings.

To check the TLS setting, you could run 'check' on both of the client and server pods and compare the cluster results of the client pod and the listener results of the server pod.

To check the JWT/RBAC setting, you could run 'check' only on your server pods and check the listener results.

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

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

Examples

  # Check the TLS/JWT/RBAC policy status for pod httpbin-88ddbcfdd-nt5jb in namespace foo:
  istioctl experimental auth check httpbin-88ddbcfdd-nt5jb.foo

  # Check the TLS/JWT/RBAC policy status from a config dump file:
  istioctl experimental auth check -f httpbin_config_dump.txt

istioctl experimental 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 experimental convert-ingress [flags]

Examples

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

istioctl experimental dashboard

Access to Istio web UIs

istioctl experimental dashboard [flags]

istioctl experimental dash [flags]
istioctl experimental d [flags]

istioctl experimental dashboard controlz

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

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

Examples

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

istioctl experimental dashboard envoy

Open the Envoy admin dashboard for a sidecar

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

Examples

istioctl experimental dashboard envoy productpage-123-456.default

istioctl experimental dashboard grafana

Open Istio's Grafana dashboard

istioctl experimental dashboard grafana [flags]

Examples

istioctl experimental dashboard grafana

istioctl experimental dashboard jaeger

Open Istio's Jaeger dashboard

istioctl experimental dashboard jaeger [flags]

Examples

istioctl experimental dashboard jaeger

istioctl experimental dashboard kiali

Open Istio's Kiali dashboard

istioctl experimental dashboard kiali [flags]

Examples

istioctl experimental dashboard kiali

istioctl experimental dashboard prometheus

Open Istio's Prometheus dashboard

istioctl experimental dashboard prometheus [flags]

Examples

istioctl experimental dashboard prometheus

istioctl experimental dashboard zipkin

Open Istio's Zipkin dashboard

istioctl experimental dashboard zipkin [flags]

Examples

istioctl experimental dashboard zipkin

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 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. Its 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.

To override the sidecar injection template from kubernetes configmap 'istio-inject', the parameters --injectConfigFile or --injectConfigMapName can be used. Either of options would typically be used with the file/configmap created with a new Istio release.

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 -

# Create a persistent version of the deployment with Envoy sidecar
# injected configuration from Kubernetes configmap 'istio-inject'
istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml --injectConfigMapName istio-inject

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]>

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

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

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

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

istioctl proxy-status

Retrieves last sent and last acknowledged xDS sync from Pilot 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 Pilot
	istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system

istioctl register

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

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

istioctl validate

Validate Istio policy and rules

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 -

istioctl verify-install

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

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

istioctl verify-install [flags]

Examples

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

		# Verify that the deployment matches the istio-demo profile
		istioctl verify-install -f istio-demo.yaml

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

istioctl version

Prints out build version information

istioctl version [flags]

Environment variables

Annotations