--- WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE https://github.com/istio/istio REPO source_repo: https://github.com/istio/istio title: istioctl description: Istio control interface. generator: pkg-collateral-docs number_of_entries: 36 ---
Istio configuration command line utility for service operators to debug and diagnose their Istio mesh.
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
A group of commands used to interact with Istio authentication policies. tls-check
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
# Check whether TLS setting are matching between authentication policy and destination rules:
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]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
# Check settings for pod "foo-656bd7df7c-5zp4s" in namespace default:
istioctl authn tls-check 656bd7df7c-5zp4s.default
# Check settings for pod "foo-656bd7df7c-5zp4s" in namespace default, filtered on destintation
service "bar" :
istioctl authn tls-check 656bd7df7c-5zp4s.default bar
De-registers a service instance
istioctl deregister <svcname> <ip> [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
# de-register an endpoint 172.17.0.2 from service my-svc:
istioctl deregister my-svc 172.17.0.2
Experimental commands that may be modified or deprecated
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
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]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--filenames <stringSlice> |
-f |
Input filenames (default `[]`) |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--output <string> |
-o |
Output filename (default `-`) |
istioctl experimental convert-ingress -f samples/bookinfo/platform/kube/bookinfo-ingress.yaml
Access to Istio web UIs
istioctl experimental dashboard [flags]
istioctl experimental dash [flags]
istioctl experimental d [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
Open the ControlZ web UI for a pod in the Istio control plane
istioctl experimental dashboard controlz <pod-name[.namespace]> [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--ctrlz_port <int> |
ControlZ port (default `9876`) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
istioctl experimental dashboard controlz pilot-123-456.istio-system
Open the Envoy admin dashboard for a sidecar
istioctl experimental dashboard envoy <pod-name[.namespace]> [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
istioctl experimental dashboard envoy productpage-123-456.default
Open Istio's Grafana dashboard
istioctl experimental dashboard grafana [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
istioctl experimental dashboard grafana
Open Istio's Jaeger dashboard
istioctl experimental dashboard jaeger [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
istioctl experimental dashboard jaeger
Open Istio's Kiali dashboard
istioctl experimental dashboard kiali [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
istioctl experimental dashboard kiali
Open Istio's Prometheus dashboard
istioctl experimental dashboard prometheus [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
istioctl experimental dashboard prometheus
Open Istio's Zipkin dashboard
istioctl experimental dashboard zipkin [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
istioctl experimental dashboard zipkin
Prints the metrics for the specified service(s) when running in Kubernetes.
This command finds a Prometheus pod running in the specified istio system namespace. It then executes a series of queries per requested workload to find the following top-level workload metrics: total requests per second, error rate, and request latency at p50, p90, and p99 percentiles. The query results are printed to the console, organized by workload name.
All metrics returned are from server-side reports. This means that latencies and error rates are from the perspective of the service itself and not of an individual client (or aggregate set of clients). Rates and latencies are calculated over a time interval of 1 minute.
istioctl experimental metrics <workload name>...
istioctl experimental m <workload name>...
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
# 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
A group of commands used to interact with Istio RBAC policies. For example, Query whether a specific request is allowed or denied under the current Istio RBAC policies.
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
# Query if user test is allowed to GET /v1/health of service rating.
istioctl experimental rbac can -u test GET rating /v1/health
This command lets you query whether a specific request will be allowed or denied under current Istio RBAC policies. It constructs a fake request with the custom subject and action specified in the command line to check if your Istio RBAC policies are working as expected. Note the fake request is only used locally to evaluate the effect of the Istio RBAC policies, no actual request will be issued.
METHOD is the HTTP method being taken, like GET, POST, etc. SERVICE is the short service name the action is being taken on. PATH is the HTTP path within the service.
istioctl experimental rbac can METHOD SERVICE PATH [flags]
Flags | Shorthand | Description |
---|---|---|
--action-properties <stringArray> |
-a |
[Action] Additional data about the action. Specified as name1=value1,name2=value2,... (default `[]`) |
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--subject-properties <stringArray> |
-s |
[Subject] Additional data about the subject. Specified as name1=value1,name2=value2,... (default `[]`) |
--user <string> |
-u |
[Subject] User name/ID that the subject represents. (default ``) |
# Query if user "cluster.local/ns/default/sa/productpage" is allowed to GET /v1/health of service rating.
istioctl experimental rbac can -u cluster.local/ns/default/sa/productpage GET rating /v1/health
# Query if namespace foo is allowed to POST to /data of service rating with label version=dev.
istioctl experimental rbac can -s source.namespace=foo POST rating /data -a destination.labels[version]=dev
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 experimental verify-install [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--enableVerbose |
Enable verbose output | |
--filename <stringSlice> |
-f |
Istio YAML installation file. (default `[]`) |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--recursive |
-R |
Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. |
# Verify that Istio can be freshly installed
istioctl experimental verify-install
# Verify that the deployment matches the istio-demo profile
istioctl experimental verify-install -f istio-demo.yaml
# Verify the deployment matches a custom Istio deployment configuration
istioctl experimental verify-install -f $HOME/istio.yaml
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]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--filename <string> |
-f |
Input Kubernetes resource filename (default ``) |
--injectConfigFile <string> |
injection configuration filename. Cannot be used with --injectConfigMapName (default ``) | |
--injectConfigMapName <string> |
ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--meshConfigFile <string> |
mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``) | |
--meshConfigMapName <string> |
ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--output <string> |
-o |
Modified output Kubernetes resource filename (default ``) |
--valuesFile <string> |
injection values configuration filename. (default ``) |
# 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
A group of commands used to retrieve information about proxy configuration from the Envoy config dump
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--output <string> |
-o |
Output format: one of json|short (default `short`) |
# Retrieve information about proxy configuration from an Envoy instance.
istioctl proxy-config <clusters|listeners|routes|endpoints|bootstrap> <pod-name[.namespace]>
Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.
istioctl proxy-config bootstrap <pod-name[.namespace]> [flags]
istioctl proxy-config b <pod-name[.namespace]> [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--output <string> |
-o |
Output format: one of json|short (default `short`) |
# Retrieve full bootstrap configuration for a given pod from Envoy.
istioctl proxy-config bootstrap <pod-name[.namespace]>
Retrieve information about cluster configuration for the Envoy instance in the specified pod.
istioctl proxy-config cluster <pod-name[.namespace]> [flags]
istioctl proxy-config clusters <pod-name[.namespace]> [flags]
istioctl proxy-config c <pod-name[.namespace]> [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--direction <string> |
Filter clusters by Direction field (default ``) | |
--fqdn <string> |
Filter clusters by substring of Service FQDN field (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--output <string> |
-o |
Output format: one of json|short (default `short`) |
--port <int> |
Filter clusters by Port field (default `0`) | |
--subset <string> |
Filter clusters by substring of Subset field (default ``) |
# 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 information about endpoint configuration for the Envoy instance in the specified pod.
istioctl proxy-config endpoint <pod-name[.namespace]> [flags]
istioctl proxy-config endpoints <pod-name[.namespace]> [flags]
istioctl proxy-config ep <pod-name[.namespace]> [flags]
Flags | Shorthand | Description |
---|---|---|
--address <string> |
Filter endpoints by address field (default ``) | |
--cluster <string> |
Filter endpoints by cluster name field (default ``) | |
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--output <string> |
-o |
Output format: one of json|short (default `short`) |
--port <int> |
Filter endpoints by Port field (default `0`) | |
--status <string> |
Filter endpoints by status field (default ``) |
# 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 information about listener configuration for the Envoy instance in the specified pod.
istioctl proxy-config listener <pod-name[.namespace]> [flags]
istioctl proxy-config listeners <pod-name[.namespace]> [flags]
istioctl proxy-config l <pod-name[.namespace]> [flags]
Flags | Shorthand | Description |
---|---|---|
--address <string> |
Filter listeners by address field (default ``) | |
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--output <string> |
-o |
Output format: one of json|short (default `short`) |
--port <int> |
Filter listeners by Port field (default `0`) | |
--type <string> |
Filter listeners by type field (default ``) |
# 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 information about route configuration for the Envoy instance in the specified pod.
istioctl proxy-config route <pod-name[.namespace]> [flags]
istioctl proxy-config routes <pod-name[.namespace]> [flags]
istioctl proxy-config r <pod-name[.namespace]> [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--name <string> |
Filter listeners by route name field (default ``) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--output <string> |
-o |
Output format: one of json|short (default `short`) |
# 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
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]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
# 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
Registers a service instance (e.g. VM) joining the mesh
istioctl register <svcname> <ip> [name1:]port1 [name2:]port2 ... [flags]
Flags | Shorthand | Description |
---|---|---|
--annotations <stringSlice> |
-a |
List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,test,x=y (default `[]`) |
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--labels <stringSlice> |
-l |
List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--serviceaccount <string> |
-s |
Service account to link to the service (default `default`) |
Validate Istio policy and rules
istioctl validate -f FILENAME [options] [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--filename <stringSlice> |
-f |
(default `[]`) |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--recursive |
-R |
Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. |
istioctl validate -f bookinfo-gateway.yaml
Prints out build version information
istioctl version [flags]
Flags | Shorthand | Description |
---|---|---|
--context <string> |
The name of the kubeconfig context to use (default ``) | |
--istioNamespace <string> |
-i |
Istio system namespace (default `istio-system`) |
--kubeconfig <string> |
-c |
Kubernetes configuration file (default ``) |
--log_output_level <string> |
Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, default, kube-converter, meshconfig, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`) | |
--namespace <string> |
-n |
Config namespace (default ``) |
--output <string> |
-o |
One of 'yaml' or 'json'. (default ``) |
--remote |
Prints remote version information, from the control plane | |
--short |
-s |
Displays a short form of the version information |
istioctl
command.
Variable Name | Type | Default Value | Description |
---|---|---|---|
ISTIO_GPRC_MAXSTREAMS |
Integer | 100000 |
|
K8S_INGRESS_NS |
String |
|
|
PILOT_CERT_DIR |
String |
|
|
PILOT_DEBOUNCE_AFTER |
Time Duration | 100ms |
|
PILOT_DEBOUNCE_MAX |
Time Duration | 10s |
|
PILOT_DEBUG_ADSZ_CONFIG |
Boolean | false |
|
PILOT_DISABLE_EDS_ISOLATION |
String |
|
|
PILOT_DISABLE_XDS_MARSHALING_TO_ANY |
String |
|
|
PILOT_ENABLE_CDS_PRECOMPUTATION |
String |
|
|
PILOT_ENABLE_FALLTHROUGH_ROUTE |
Boolean | false |
EnableFallthroughRoute provides an option to add a final wildcard match for routes. When ALLOW_ANY traffic policy is used, a Passthrough cluster is used. When REGISTRY_ONLY traffic policy is used, a 502 error is returned. |
PILOT_ENABLE_LOCALITY_LOAD_BALANCING |
String |
|
|
PILOT_ENABLE_WAIT_CACHE_SYNC |
String |
|
|
PILOT_HTTP10 |
Boolean | false |
|
PILOT_PUSH_BURST |
Integer | 100 |
|
PILOT_PUSH_THROTTLE |
Integer | 10 |
|
PILOT_TRACE_SAMPLING |
Floating-Point | 100 |
|
POD_NAME |
String |
|
|
TERMINATION_DRAIN_DURATION_SECONDS |
String |
|
|
V2_REFRESH |
Time Duration | 0s |
istioctl
command.
Annotation Name | Description |
---|---|
policy.istio.io/check |
Determines the policy for behavior when unable to connect to Mixer. If not set, FAIL_CLOSE is set, rejecting requests. |
policy.istio.io/checkBaseRetryWaitTime |
Base time to wait between retries, will be adjusted by backoff and jitter. In duration format. If not set, this will be 80ms. |
policy.istio.io/checkMaxRetryWaitTime |
Maximum time to wait between retries to Mixer. In duration format. If not set, this will be 1000ms. |
policy.istio.io/checkRetries |
The maximum number of retries on transport errors to Mixer. If not set, this will be 0, indicating no retries. |
readiness.status.sidecar.istio.io/applicationPorts |
|
readiness.status.sidecar.istio.io/failureThreshold |
|
readiness.status.sidecar.istio.io/initialDelaySeconds |
|
readiness.status.sidecar.istio.io/periodSeconds |
|
sidecar.istio.io/inject |
|
sidecar.istio.io/interceptionMode |
|
sidecar.istio.io/proxyImage |
|
sidecar.istio.io/rewriteAppHTTPProbers |
Rewrite HTTP readiness and liveness probes to be redirected to istio-proxy sidecar |
sidecar.istio.io/status |
|
status.sidecar.istio.io/port |
|
traffic.sidecar.istio.io/excludeInboundPorts |
|
traffic.sidecar.istio.io/excludeOutboundIPRanges |
|
traffic.sidecar.istio.io/includeInboundPorts |
|
traffic.sidecar.istio.io/includeOutboundIPRanges |
|
traffic.sidecar.istio.io/kubevirtInterfaces |