mirror of https://github.com/istio/istio.io.git
292 lines
196 KiB
HTML
292 lines
196 KiB
HTML
<!doctype html><html lang=en itemscope itemtype=https://schema.org/WebPage><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name=theme-color content=#466BB0><meta name=title content=istioctl><meta name=description content="Istio control interface."><meta name=keywords content=microservices,services,mesh><meta property=og:title content=istioctl><meta property=og:type content=website><meta property=og:description content="Istio control interface."><meta property=og:url content=/v1.3/docs/reference/commands/istioctl/><meta property=og:image content=/v1.3/img/istio-whitelogo-bluebackground-framed.svg><meta property=og:image:alt content="Istio Logo"><meta property=og:image:width content=112><meta property=og:image:height content=150><meta property=og:site_name content=Istio><meta name=twitter:card content=summary><meta name=twitter:site content=@IstioMesh><title>Istioldie 1.3 / istioctl</title><script async src="https://www.googletagmanager.com/gtag/js?id=UA-98480406-2"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}
|
|
gtag('js',new Date());gtag('config','UA-98480406-2');</script><link rel=alternate type=application/rss+xml title="Istio Blog" href=/v1.3/blog/feed.xml><link rel=alternate type=application/rss+xml title="Istio News" href=/v1.3/news/feed.xml><link rel=alternate type=application/rss+xml title="Istio Blog and News" href=/v1.3/feed.xml><link rel="shortcut icon" href=/v1.3/favicons/favicon.ico><link rel=apple-touch-icon href=/v1.3/favicons/apple-touch-icon-180x180.png sizes=180x180><link rel=icon type=image/png href=/v1.3/favicons/favicon-16x16.png sizes=16x16><link rel=icon type=image/png href=/v1.3/favicons/favicon-32x32.png sizes=32x32><link rel=icon type=image/png href=/v1.3/favicons/android-36x36.png sizes=36x36><link rel=icon type=image/png href=/v1.3/favicons/android-48x48.png sizes=48x48><link rel=icon type=image/png href=/v1.3/favicons/android-72x72.png sizes=72x72><link rel=icon type=image/png href=/v1.3/favicons/android-96x96.png sizes=96xW96><link rel=icon type=image/png href=/v1.3/favicons/android-144x144.png sizes=144x144><link rel=icon type=image/png href=/v1.3/favicons/android-192x192.png sizes=192x192><link rel=manifest href=/v1.3/manifest.json><meta name=apple-mobile-web-app-title content=Istio><meta name=application-name content=Istio><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Work+Sans:400|Chivo:400|Work+Sans:500,300,600,300italic,400italic,500italic,600italic|Chivo:500,300,600,300italic,400italic,500italic,600italic"><link rel=stylesheet href=/v1.3/css/all.css><script src=/v1.3/js/themes_init.min.js></script></head><body class="language-unknown archive-site"><script>const branchName="release-1.3";const docTitle="istioctl";const iconFile="\/v1.3/img/icons.svg";const buttonCopy='Copy to clipboard';const buttonPrint='Print';const buttonDownload='Download';</script><script src="https://www.google.com/cse/brand?form=search-form" defer></script><script src=/v1.3/js/all.min.js data-manual defer></script><header><nav><a id=brand href=/v1.3/><span class=logo><svg viewBox="0 0 300 300"><circle cx="150" cy="150" r="146" stroke-width="2" /><path d="M65 240H225L125 270z"/><path d="M65 230l60-10V110z"/><path d="M135 220l90 10L135 30z"/></svg></span><span class=name>Istioldie 1.3</span></a><div id=hamburger><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#hamburger"/></svg></div><div id=header-links><span title="Learn how to deploy, use, and operate Istio.">Docs</span>
|
|
<a title="Posts about using Istio." href=/v1.3/blog/2019/proxy/>Blog</a>
|
|
<a title="Timely news about the Istio project." href=/v1.3/news/2019/announcing-1.2-eol/>News</a>
|
|
<a title="Frequently Asked Questions about Istio." href=/v1.3/faq/>FAQ</a>
|
|
<a title="Get a bit more in-depth info about the Istio project." href=/v1.3/about/>About</a><div class=menu><button id=gearDropdownButton class=menu-trigger title="Options and settings" aria-label="Options and Settings" aria-controls=gearDropdownContent><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#gear"/></svg></button><div id=gearDropdownContent class=menu-content aria-labelledby=gearDropdownButton role=menu><a tabindex=-1 role=menuitem class=active id=light-theme-item>Light Theme</a>
|
|
<a tabindex=-1 role=menuitem id=dark-theme-item>Dark Theme</a><div role=separator></div><a tabindex=-1 role=menuitem id=syntax-coloring-item>Color Examples</a><div role=separator></div><h6>Other versions of this site</h6><a tabindex=-1 role=menuitem onclick="navigateToUrlOrRoot('https://istio.io/docs\/reference\/commands\/istioctl\/');return false;">Current Release</a>
|
|
<a tabindex=-1 role=menuitem onclick="navigateToUrlOrRoot('https://preliminary.istio.io/docs\/reference\/commands\/istioctl\/');return false;">Next Release</a>
|
|
<a tabindex=-1 role=menuitem href=https://archive.istio.io>Older Releases</a></div></div><button id=search-show title="Search this site" aria-label=Search><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#magnifier"/></svg></button></div><form id=search-form name=cse role=search><input type=hidden name=cx value=013699703217164175118:iwwf17ikgf4>
|
|
<input type=hidden name=ie value=utf-8>
|
|
<input type=hidden name=hl value=en>
|
|
<input type=hidden id=search-page-url value=/v1.3/search>
|
|
<input id=search-textbox class=form-control name=q type=search aria-label="Search this site">
|
|
<button id=search-close title="Cancel search" type=reset aria-label="Cancel search"><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#cancel-x"/></svg></button></form></nav></header><main class=primary><div id=sidebar-container class="sidebar-container sidebar-offcanvas"><nav id=sidebar aria-label="Section Navigation"><div class=directory><div class=card><button class="header dynamic" id=card32 title="Learn about the different parts of the Istio system and the abstractions it uses." aria-controls=card32-body><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#concepts"/></svg>Concepts</button><div class=body aria-labelledby=card32 role=region id=card32-body><ul role=tree aria-expanded=true class=leaf-section aria-labelledby=card32><li role=none><a role=treeitem title="Introduces Istio, the problems it solves, its high-level architecture and design goals." href=/v1.3/docs/concepts/what-is-istio/>What is Istio?</a></li><li role=none><a role=treeitem title="Describes the various Istio features focused on traffic routing and control." href=/v1.3/docs/concepts/traffic-management/>Traffic Management</a></li><li role=none><a role=treeitem title="Describes Istio's authorization and authentication functionality." href=/v1.3/docs/concepts/security/>Policies and Security</a></li><li role=none><a role=treeitem title="Describes the telemetry and monitoring features provided by Istio." href=/v1.3/docs/concepts/observability/>Observability</a></li><li role=none><a role=treeitem title="Introduces performance and scalability for Istio." href=/v1.3/docs/concepts/performance-and-scalability/>Performance and Scalability</a></li><li role=none><a role=treeitem title="Describes the system models that impact your overall Istio depolyment." href=/v1.3/docs/concepts/deployment-models/>Deployment Models</a></li></ul></div></div><div class=card><button class="header dynamic" id=card49 title="Instructions for installing the Istio control plane on Kubernetes and adding virtual machines into the mesh." aria-controls=card49-body><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#setup"/></svg>Setup</button><div class=body aria-labelledby=card49 role=region id=card49-body><ul role=tree aria-expanded=true aria-labelledby=card49><li role=none><a role=treeitem title="Download, install, and try out Istio." href=/v1.3/docs/setup/getting-started/>Getting Started</a></li><li role=treeitem aria-label="Platform Setup"><button aria-hidden=true></button><a title="How to prepare various Kubernetes platforms before installing Istio." href=/v1.3/docs/setup/platform-setup/>Platform Setup</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Instructions to setup an Alibaba Cloud Kubernetes cluster for Istio." href=/v1.3/docs/setup/platform-setup/alicloud/>Alibaba Cloud</a></li><li role=none><a role=treeitem title="Instructions to setup an Azure cluster for Istio." href=/v1.3/docs/setup/platform-setup/azure/>Azure</a></li><li role=none><a role=treeitem title="Instructions to setup Docker Desktop for Istio." href=/v1.3/docs/setup/platform-setup/docker/>Docker Desktop</a></li><li role=none><a role=treeitem title="Instructions to setup a Google Kubernetes Engine cluster for Istio." href=/v1.3/docs/setup/platform-setup/gke/>Google Kubernetes Engine</a></li><li role=none><a role=treeitem title="Instructions to setup an IBM Cloud cluster for Istio." href=/v1.3/docs/setup/platform-setup/ibm/>IBM Cloud</a></li><li role=none><a role=treeitem title="Instructions to setup a Gardener cluster for Istio." href=/v1.3/docs/setup/platform-setup/gardener/>Kubernetes Gardener</a></li><li role=none><a role=treeitem title="Instructions to setup MicroK8s for use with Istio." href=/v1.3/docs/setup/platform-setup/microk8s/>MicroK8s</a></li><li role=none><a role=treeitem title="Instructions to setup minikube for Istio." href=/v1.3/docs/setup/platform-setup/minikube/>Minikube</a></li><li role=none><a role=treeitem title="Instructions to setup an OpenShift cluster for Istio." href=/v1.3/docs/setup/platform-setup/openshift/>OpenShift</a></li><li role=none><a role=treeitem title="Instructions to setup an OKE cluster for Istio." href=/v1.3/docs/setup/platform-setup/oci/>Oracle Cloud Infrastructure</a></li></ul></li><li role=treeitem aria-label=Install><button aria-hidden=true></button><a title="Choose the guide that best suits your needs and platform." href=/v1.3/docs/setup/install/>Install</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Instructions to install Istio in a Kubernetes cluster for evaluation." href=/v1.3/docs/setup/install/kubernetes/>Quick Start Evaluation Install</a></li><li role=none><a role=treeitem title="Install and configure Istio for in-depth evaluation or production use." href=/v1.3/docs/setup/install/helm/>Customizable Install with Helm</a></li><li role=none><a role=treeitem title="Install and configure Istio using the Istio Operator CLI." href=/v1.3/docs/setup/install/operator/>Operator CLI-based Installation [Experimental]</a></li><li role=treeitem aria-label="Multi-cluster Installation"><button aria-hidden=true></button><a title="Configure an Istio mesh spanning multiple Kubernetes clusters." href=/v1.3/docs/setup/install/multicluster/>Multi-cluster Installation</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Install an Istio mesh across multiple Kubernetes clusters with replicated control plane instances." href=/v1.3/docs/setup/install/multicluster/gateways/>Replicated control planes</a></li><li role=none><a role=treeitem title="Install an Istio mesh across multiple Kubernetes clusters with a shared control plane and VPN connectivity between clusters." href=/v1.3/docs/setup/install/multicluster/shared-vpn/>Shared control plane (single-network)</a></li><li role=none><a role=treeitem title="Install an Istio mesh across multiple Kubernetes clusters using a shared control plane for disconnected cluster networks." href=/v1.3/docs/setup/install/multicluster/shared-gateways/>Shared control plane (multi-network)</a></li></ul></li></ul></li><li role=treeitem aria-label=Upgrade><button aria-hidden=true></button><a title="Information on upgrading Istio." href=/v1.3/docs/setup/upgrade/>Upgrade</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Important changes to consider when upgrading to Istio 1.3." href=/v1.3/docs/setup/upgrade/notice/>1.3 Upgrade Notice</a></li><li role=none><a role=treeitem title="Upgrade the Istio control plane and data plane independently." href=/v1.3/docs/setup/upgrade/steps/>Upgrade Steps</a></li></ul></li><li role=treeitem aria-label="More Guides"><button aria-hidden=true></button><a title="More information on additional setup tasks." href=/v1.3/docs/setup/additional-setup/>More Guides</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Prepare your Kubernetes pods and services to run in an Istio-enabled cluster." href=/v1.3/docs/setup/additional-setup/requirements/>Pods and Services</a></li><li role=none><a role=treeitem title="Describes the built-in Istio installation configuration profiles." href=/v1.3/docs/setup/additional-setup/config-profiles/>Installation Configuration Profiles</a></li><li role=none><a role=treeitem title="Install the Istio sidecar in application pods automatically using the sidecar injector webhook or manually using istioctl CLI." href=/v1.3/docs/setup/additional-setup/sidecar-injection/>Installing the Sidecar</a></li><li role=none><a role=treeitem title="Install and use Istio with the Istio CNI plugin, allowing operators to deploy services with lower privilege." href=/v1.3/docs/setup/additional-setup/cni/>Install Istio with the Istio CNI plugin</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card72 title="How to do single specific targeted activities with the Istio system." aria-controls=card72-body><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#tasks"/></svg>Tasks</button><div class=body aria-labelledby=card72 role=region id=card72-body><ul role=tree aria-expanded=true aria-labelledby=card72><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true></button><a title="Tasks that demonstrate Istio's traffic routing features." href=/v1.3/docs/tasks/traffic-management/>Traffic Management</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="This task shows you how to configure dynamic request routing to multiple versions of a microservice." href=/v1.3/docs/tasks/traffic-management/request-routing/>Request Routing</a></li><li role=none><a role=treeitem title="This task shows you how to inject faults to test the resiliency of your application." href=/v1.3/docs/tasks/traffic-management/fault-injection/>Fault Injection</a></li><li role=none><a role=treeitem title="Shows you how to migrate traffic from an old to new version of a service." href=/v1.3/docs/tasks/traffic-management/traffic-shifting/>Traffic Shifting</a></li><li role=none><a role=treeitem title="Shows you how to migrate TCP traffic from an old to new version of a TCP service." href=/v1.3/docs/tasks/traffic-management/tcp-traffic-shifting/>TCP Traffic Shifting</a></li><li role=none><a role=treeitem title="This task shows you how to setup request timeouts in Envoy using Istio." href=/v1.3/docs/tasks/traffic-management/request-timeouts/>Request Timeouts</a></li><li role=none><a role=treeitem title="This task shows you how to configure circuit breaking for connections, requests, and outlier detection." href=/v1.3/docs/tasks/traffic-management/circuit-breaking/>Circuit Breaking</a></li><li role=none><a role=treeitem title="This task demonstrates the traffic mirroring/shadowing capabilities of Istio." href=/v1.3/docs/tasks/traffic-management/mirroring/>Mirroring</a></li><li role=treeitem aria-label=Ingress><button aria-hidden=true></button><a title="Controlling ingress traffic for an Istio service mesh." href=/v1.3/docs/tasks/traffic-management/ingress/>Ingress</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes how to configure an Istio gateway to expose a service outside of the service mesh." href=/v1.3/docs/tasks/traffic-management/ingress/ingress-control/>Ingress Gateways</a></li><li role=none><a role=treeitem title="Expose a service outside of the service mesh over TLS or mTLS using file-mounted certificates." href=/v1.3/docs/tasks/traffic-management/ingress/secure-ingress-mount/>Secure Gateways (File Mount)</a></li><li role=none><a role=treeitem title="Expose a service outside of the service mesh over TLS or mTLS using the secret discovery service (SDS)." href=/v1.3/docs/tasks/traffic-management/ingress/secure-ingress-sds/>Secure Gateways (SDS)</a></li><li role=none><a role=treeitem title="Describes how to configure SNI passthrough for an ingress gateway." href=/v1.3/docs/tasks/traffic-management/ingress/ingress-sni-passthrough/>Ingress Gateway without TLS Termination</a></li><li role=none><a role=treeitem title="Demonstrates how to obtain Let's Encrypt TLS certificates for Kubernetes Ingress automatically using Cert-Manager." href=/v1.3/docs/tasks/traffic-management/ingress/ingress-certmgr/>Kubernetes Ingress with Cert-Manager</a></li></ul></li><li role=treeitem aria-label=Egress><button aria-hidden=true></button><a title="Controlling egress traffic for an Istio service mesh." href=/v1.3/docs/tasks/traffic-management/egress/>Egress</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes how to configure Istio to route traffic from services in the mesh to external services." href=/v1.3/docs/tasks/traffic-management/egress/egress-control/>Accessing External Services</a></li><li role=none><a role=treeitem title="Describes how to configure Istio to perform TLS origination for traffic to external services." href=/v1.3/docs/tasks/traffic-management/egress/egress-tls-origination/>Egress TLS Origination</a></li><li role=none><a role=treeitem title="Describes how to configure Istio to direct traffic to external services through a dedicated gateway." href=/v1.3/docs/tasks/traffic-management/egress/egress-gateway/>Egress Gateways</a></li><li role=none><a role=treeitem title="Describes how to configure an Egress Gateway to perform TLS origination to external services." href=/v1.3/docs/tasks/traffic-management/egress/egress-gateway-tls-origination/>Egress Gateways with TLS Origination</a></li><li role=none><a role=treeitem title="Describes how to enable egress traffic for a set of hosts in a common domain, instead of configuring each and every host separately." href=/v1.3/docs/tasks/traffic-management/egress/wildcard-egress-hosts/>Egress using Wildcard Hosts</a></li><li role=none><a role=treeitem title="Describes how to configure SNI monitoring and apply policies on TLS egress traffic." href=/v1.3/docs/tasks/traffic-management/egress/egress_sni_monitoring_and_policies/>Monitoring and Policies for TLS Egress</a></li><li role=none><a role=treeitem title="Describes how to configure Istio to let applications use an external HTTPS proxy." href=/v1.3/docs/tasks/traffic-management/egress/http-proxy/>Using an External HTTPS Proxy</a></li></ul></li></ul></li><li role=treeitem aria-label=Security><button aria-hidden=true></button><a title="Demonstrates how to secure the mesh." href=/v1.3/docs/tasks/security/>Security</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Shows you how to use Istio authentication policy to setup mutual TLS and basic end-user authentication." href=/v1.3/docs/tasks/security/authn-policy/>Authentication Policy</a></li><li role=none><a role=treeitem title="Shows how to set up role-based access control for HTTP services." href=/v1.3/docs/tasks/security/authz-http/>Authorization for HTTP Services</a></li><li role=none><a role=treeitem title="Shows how to set up role-based access control for TCP services." href=/v1.3/docs/tasks/security/authz-tcp/>Authorization for TCP Services</a></li><li role=none><a role=treeitem title="Tutorial on how to configure the groups-base authorization and configure the authorization of list-typed claims in Istio." href=/v1.3/docs/tasks/security/rbac-groups/>Authorization for groups and list claims</a></li><li role=none><a role=treeitem title="Shows how to use Authorization permissive mode." href=/v1.3/docs/tasks/security/authz-permissive/>Authorization permissive mode</a></li><li role=none><a role=treeitem title="Shows you how to verify and test Istio's automatic mutual TLS authentication." href=/v1.3/docs/tasks/security/mutual-tls/>Mutual TLS Deep-Dive</a></li><li role=none><a role=treeitem title="Shows how operators can configure Citadel with existing root certificate, signing certificate and key." href=/v1.3/docs/tasks/security/plugin-ca-cert/>Plugging in External CA Key and Certificate</a></li><li role=none><a role=treeitem title="Shows how to enable Citadel health checking with Kubernetes." href=/v1.3/docs/tasks/security/health-check/>Citadel Health Checking</a></li><li role=none><a role=treeitem title="Shows how to enable SDS (secret discovery service) for Istio identity provisioning." href=/v1.3/docs/tasks/security/auth-sds/>Provisioning Identity through SDS</a></li><li role=none><a role=treeitem title="Configure which namespaces Citadel should generate service account secrets for." href=/v1.3/docs/tasks/security/ca-namespace-targeting/>Configure Citadel Service Account Secret Generation</a></li><li role=none><a role=treeitem title="Shows you how to incrementally migrate your Istio services to mutual TLS." href=/v1.3/docs/tasks/security/mtls-migration/>Mutual TLS Migration</a></li><li role=none><a role=treeitem title="Shows how to enable mutual TLS on HTTPS services." href=/v1.3/docs/tasks/security/https-overlay/>Mutual TLS over HTTPS</a></li></ul></li><li role=treeitem aria-label=Policies><button aria-hidden=true></button><a title="Demonstrates policy enforcement features." href=/v1.3/docs/tasks/policy-enforcement/>Policies</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="This task shows you how to enable Istio policy enforcement." href=/v1.3/docs/tasks/policy-enforcement/enabling-policy/>Enabling Policy Enforcement</a></li><li role=none><a role=treeitem title="This task shows you how to use Istio to dynamically limit the traffic to a service." href=/v1.3/docs/tasks/policy-enforcement/rate-limiting/>Enabling Rate Limits</a></li><li role=none><a role=treeitem title="Shows how to modify request headers and routing using policy adapters." href=/v1.3/docs/tasks/policy-enforcement/control-headers/>Control Headers and Routing</a></li><li role=none><a role=treeitem title="Shows how to control access to a service using simple denials or white/black listing." href=/v1.3/docs/tasks/policy-enforcement/denial-and-list/>Denials and White/Black Listing</a></li></ul></li><li role=treeitem aria-label=Telemetry><button aria-hidden=true></button><a title="Demonstrates how to collect telemetry information from the mesh." href=/v1.3/docs/tasks/telemetry/>Telemetry</a><ul role=group aria-expanded=false><li role=treeitem aria-label=Metrics><button aria-hidden=true></button><a title="Demonstrates the configuration, collection, and processing of Istio mesh metrics." href=/v1.3/docs/tasks/telemetry/metrics/>Metrics</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="This task shows you how to configure Istio to collect and customize metrics." href=/v1.3/docs/tasks/telemetry/metrics/collecting-metrics/>Collecting Metrics</a></li><li role=none><a role=treeitem title="This task shows you how to configure Istio to collect metrics for TCP services." href=/v1.3/docs/tasks/telemetry/metrics/tcp-metrics/>Collecting Metrics for TCP services</a></li><li role=none><a role=treeitem title="This task shows you how to query for Istio Metrics using Prometheus." href=/v1.3/docs/tasks/telemetry/metrics/querying-metrics/>Querying Metrics from Prometheus</a></li><li role=none><a role=treeitem title="This task shows you how to setup and use the Istio Dashboard to monitor mesh traffic." href=/v1.3/docs/tasks/telemetry/metrics/using-istio-dashboard/>Visualizing Metrics with Grafana</a></li></ul></li><li role=treeitem aria-label=Logs><button aria-hidden=true></button><a title="Demonstrates the configuration, collection, and processing of Istio mesh logs." href=/v1.3/docs/tasks/telemetry/logs/>Logs</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="This task shows you how to configure Istio to collect and customize logs." href=/v1.3/docs/tasks/telemetry/logs/collecting-logs/>Collecting Logs</a></li><li role=none><a role=treeitem title="This task shows you how to configure Envoy proxies to print access log to their standard output." href=/v1.3/docs/tasks/telemetry/logs/access-log/>Getting Envoy's Access Logs</a></li><li role=none><a role=treeitem title="This task shows you how to configure Istio to log to a Fluentd daemon." href=/v1.3/docs/tasks/telemetry/logs/fluentd/>Logging with Fluentd</a></li></ul></li><li role=treeitem aria-label="Distributed Tracing"><button aria-hidden=true></button><a title="This task shows you how to configure Istio-enabled applications to collect trace spans." href=/v1.3/docs/tasks/telemetry/distributed-tracing/>Distributed Tracing</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Overview of distributed tracing in Istio." href=/v1.3/docs/tasks/telemetry/distributed-tracing/overview/>Overview</a></li><li role=none><a role=treeitem title="Learn how to configure the proxies to send tracing requests to Jaeger." href=/v1.3/docs/tasks/telemetry/distributed-tracing/jaeger/>Jaeger</a></li><li role=none><a role=treeitem title="Learn how to configure the proxies to send tracing requests to Zipkin." href=/v1.3/docs/tasks/telemetry/distributed-tracing/zipkin/>Zipkin</a></li><li role=none><a role=treeitem title="How to configure the proxies to send tracing requests to LightStep." href=/v1.3/docs/tasks/telemetry/distributed-tracing/lightstep/>LightStep</a></li></ul></li><li role=none><a role=treeitem title="This task shows you how to visualize your services within an Istio mesh." href=/v1.3/docs/tasks/telemetry/kiali/>Visualizing Your Mesh</a></li><li role=none><a role=treeitem title="This task shows you how to configure external access to the set of Istio telemetry addons." href=/v1.3/docs/tasks/telemetry/gateways/>Remotely Accessing Telemetry Addons</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card90 title="A variety of fully working example uses for Istio that you can experiment with." aria-controls=card90-body><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#examples"/></svg>Examples</button><div class=body aria-labelledby=card90 role=region id=card90-body><ul role=tree aria-expanded=true aria-labelledby=card90><li role=none><a role=treeitem title="Deploys a sample application composed of four separate microservices used to demonstrate various Istio features." href=/v1.3/docs/examples/bookinfo/>Bookinfo Application</a></li><li role=none><a role=treeitem title="Explains how to manually integrate Google Cloud Endpoints services with Istio." href=/v1.3/docs/examples/endpoints/>Install Istio for Google Cloud Endpoints Services</a></li><li role=treeitem aria-label="Mesh Expansion"><button aria-hidden=true></button><a title="Configure an Istio mesh spanning Kubernetes clusters, VMs and bare metals." href=/v1.3/docs/examples/mesh-expansion/>Mesh Expansion</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Integrate VMs and bare metal hosts into an Istio mesh deployed on Kubernetes." href=/v1.3/docs/examples/mesh-expansion/single-network/>Single-network Mesh Expansion</a></li><li role=none><a role=treeitem title="Integrate VMs and bare metal hosts into an Istio mesh deployed on Kubernetes with gateways." href=/v1.3/docs/examples/mesh-expansion/multi-network/>Multi-network Mesh Expansion</a></li><li role=none><a role=treeitem title="Illustrates how to expand the Bookinfo application's mesh with a raw VM service." href=/v1.3/docs/examples/mesh-expansion/bookinfo-expanded/>Bookinfo with Mesh Expansion</a></li></ul></li><li role=treeitem aria-label="Multicluster Service Mesh"><button aria-hidden=true></button><a title="Multicluster service mesh examples for Istio that you can experiment with." href=/v1.3/docs/examples/multicluster/>Multicluster Service Mesh</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Set up a multicluster mesh over two GKE clusters." href=/v1.3/docs/examples/multicluster/gke/>Google Kubernetes Engine</a></li><li role=none><a role=treeitem title="Example multicluster mesh over two IBM Cloud Private clusters." href=/v1.3/docs/examples/multicluster/icp/>IBM Cloud Private</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card104 title="Hints, tips, tricks about running an Istio mesh." aria-controls=card104-body><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#guide"/></svg>Operations</button><div class=body aria-labelledby=card104 role=region id=card104-body><ul role=tree aria-expanded=true aria-labelledby=card104><li role=none><a role=treeitem title="Shows how to do health checking for Istio services." href=/v1.3/docs/ops/app-health-check/>Health Checking of Istio Services</a></li><li role=treeitem aria-label="Installation and Configuration"><button aria-hidden=true></button><a title="Describes important requirements, concepts, and considerations for installing and configuring Istio." href=/v1.3/docs/ops/setup/>Installation and Configuration</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes Istio's use of Kubernetes webhooks for automatic sidecar injection." href=/v1.3/docs/ops/setup/injection-concepts/>Automatic Sidecar Injection</a></li><li role=none><a role=treeitem title="Describes how to check which capabilities are allowed for your pods." href=/v1.3/docs/ops/setup/required-pod-capabilities/>Required Pod Capabilities</a></li><li role=none><a role=treeitem title="Provides a general overview of Istio's use of Kubernetes webhooks and the related issues that can arise." href=/v1.3/docs/ops/setup/webhook/>Dynamic Admission Webhooks Overview</a></li><li role=none><a role=treeitem title="Describes Istio's use of Kubernetes webhooks for server-side configuration validation." href=/v1.3/docs/ops/setup/validation/>Configuration Validation Webhook</a></li></ul></li><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true></button><a title="Helps you manage the networking aspects of a running mesh." href=/v1.3/docs/ops/traffic-management/>Traffic Management</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="An introduction to Istio networking operational aspects." href=/v1.3/docs/ops/traffic-management/introduction/>Introduction to Network Operations</a></li><li role=none><a role=treeitem title="Provides specific deployment or configuration guidelines to avoid networking or traffic management issues." href=/v1.3/docs/ops/traffic-management/deploy-guidelines/>Avoiding Traffic Management Issues</a></li><li role=none><a role=treeitem title="Information on how to enable and understand Locality Load Balancing." href=/v1.3/docs/ops/traffic-management/locality-load-balancing/>Locality Load Balancing</a></li><li role=none><a role=treeitem title="Information on how to specify protocols." href=/v1.3/docs/ops/traffic-management/protocol-selection/>Protocol Selection</a></li></ul></li><li role=treeitem aria-label=Security><button aria-hidden=true></button><a title="Helps you manage the security aspects of a running mesh." href=/v1.3/docs/ops/security/>Security</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Use hardened container images to reduce Istio's attack surface." href=/v1.3/docs/ops/security/harden-docker-images/>Harden Docker Container Images</a></li><li role=none><a role=treeitem title="Learn how to extend the lifetime of the Istio self-signed root certificate." href=/v1.3/docs/ops/security/root-transition/>Extending Self-Signed Certificate Lifetime</a></li></ul></li><li role=treeitem aria-label=Telemetry><button aria-hidden=true></button><a title="Helps you manage telemetry collection and visualization in a running mesh." href=/v1.3/docs/ops/telemetry/>Telemetry</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="How to enable in-proxy generation of HTTP service-level metrics." href=/v1.3/docs/ops/telemetry/in-proxy-service-telemetry/>Generate Istio Metrics Without Mixer [Experimental]</a></li><li role=none><a role=treeitem title="Fine-grained control of Envoy statistics." href=/v1.3/docs/ops/telemetry/envoy-stats/>Envoy Statistics</a></li></ul></li><li role=treeitem aria-label=Troubleshooting><button aria-hidden=true></button><a title="Describes how to identify and resolve common problems in Istio." href=/v1.3/docs/ops/troubleshooting/>Troubleshooting</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Istio includes a supplemental tool that provides debugging and diagnosis for Istio service mesh deployments." href=/v1.3/docs/ops/troubleshooting/istioctl/>Using the istioctl command-line tool</a></li><li role=none><a role=treeitem title="Tools and techniques to address common Istio traffic management and network problems." href=/v1.3/docs/ops/troubleshooting/network-issues/>Network Problems</a></li><li role=none><a role=treeitem title="Tools and techniques to address common Istio authentication, authorization, and general security-related problems." href=/v1.3/docs/ops/troubleshooting/security-issues/>Security Problems</a></li><li role=none><a role=treeitem title="Resolve common problems with Istio's use of Kubernetes webhooks for automatic sidecar injection." href=/v1.3/docs/ops/troubleshooting/injection/>Sidecar Injection Problems</a></li><li role=none><a role=treeitem title="What to do if Citadel is not behaving properly." href=/v1.3/docs/ops/troubleshooting/repairing-citadel/>Repairing Citadel</a></li><li role=none><a role=treeitem title="Describes tools and techniques to diagnose Envoy configuration issues related to traffic management." href=/v1.3/docs/ops/troubleshooting/proxy-cmd/>Debugging Envoy and Pilot</a></li><li role=none><a role=treeitem title="Describes how to resolve Galley configuration problems." href=/v1.3/docs/ops/troubleshooting/validation/>Galley Configuration Problems</a></li><li role=none><a role=treeitem title="Diagnose problems where metrics are not being collected." href=/v1.3/docs/ops/troubleshooting/missing-metrics/>Missing Metrics</a></li><li role=none><a role=treeitem title="Dealing with Grafana issues." href=/v1.3/docs/ops/troubleshooting/grafana/>Missing Grafana Output</a></li><li role=none><a role=treeitem title="Fix missing traces in Zipkin." href=/v1.3/docs/ops/troubleshooting/missing-traces/>Missing Zipkin Traces</a></li><li role=none><a role=treeitem title="Shows you how to use istioctl describe to verify the configurations of a pod in your mesh." href=/v1.3/docs/ops/troubleshooting/istioctl-describe/>Understand your Mesh with istioctl describe</a></li><li role=none><a role=treeitem title="Describes how to use component-level logging to get insights into a running component's behavior." href=/v1.3/docs/ops/troubleshooting/component-logging/>Component Logging</a></li><li role=none><a role=treeitem title="Describes how to use ControlZ to get insight into individual running components." href=/v1.3/docs/ops/troubleshooting/controlz/>Component Introspection</a></li><li role=none><a role=treeitem title="Limitations for using Tcpdump in pods." href=/v1.3/docs/ops/troubleshooting/tcpdump-notes/>Tcpdump Limitations</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card126 title="Detailed authoritative reference material such as command-line options, configuration options, and API calling parameters." aria-controls=card126-body><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#reference"/></svg>Reference</button><div class="body default" aria-labelledby=card126 role=region id=card126-body><ul role=tree aria-expanded=true aria-labelledby=card126><li role=treeitem aria-label=Configuration><button aria-hidden=true></button><a title="Detailed information on configuration options." href=/v1.3/docs/reference/config/>Configuration</a><ul role=group aria-expanded=false><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true></button><a title="Describes how to configure HTTP/TCP routing features." href=/v1.3/docs/reference/config/networking/>Traffic Management</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Configuration affecting load balancing, outlier detection, etc." href=/v1.3/docs/reference/config/networking/v1alpha3/destination-rule/>Destination Rule</a></li><li role=none><a role=treeitem title="Customizing Envoy configuration generated by Istio." href=/v1.3/docs/reference/config/networking/v1alpha3/envoy-filter/>Envoy Filter</a></li><li role=none><a role=treeitem title="Configuration affecting edge load balancer." href=/v1.3/docs/reference/config/networking/v1alpha3/gateway/>Gateway</a></li><li role=none><a role=treeitem title="Configuration affecting service registry." href=/v1.3/docs/reference/config/networking/v1alpha3/service-entry/>Service Entry</a></li><li role=none><a role=treeitem title="Configuration affecting network reachability of a sidecar." href=/v1.3/docs/reference/config/networking/v1alpha3/sidecar/>Sidecar</a></li><li role=none><a role=treeitem title="Configuration affecting label/content routing, sni routing, etc." href=/v1.3/docs/reference/config/networking/v1alpha3/virtual-service/>Virtual Service</a></li></ul></li><li role=none><a role=treeitem title="Authentication policy for Istio services." href=/v1.3/docs/reference/config/istio.authentication.v1alpha1/>Authentication Policy</a></li><li role=none><a role=treeitem title="Resource annotations used by Istio." href=/v1.3/docs/reference/config/annotations/>Resource Annotations</a></li><li role=treeitem aria-label=Authorization><button aria-hidden=true></button><a title="Describes how to configure Istio's authorization features." href=/v1.3/docs/reference/config/authorization/>Authorization</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes the supported constraints and properties." href=/v1.3/docs/reference/config/authorization/constraints-and-properties/>Constraints and Properties</a></li><li role=none><a role=treeitem title="Configuration for Role Based Access Control." href=/v1.3/docs/reference/config/authorization/istio.rbac.v1alpha1/>RBAC</a></li></ul></li><li role=none><a role=treeitem title="Describes the options available when installing Istio using the included Helm chart." href=/v1.3/docs/reference/config/installation-options/>Installation Options</a></li><li role=none><a role=treeitem title="Details the Helm chart installation options differences between release-1.2 and release-1.3." href=/v1.3/docs/reference/config/installation-options-changes/>Installation Options Changes</a></li><li role=treeitem aria-label="Policies and Telemetry"><button aria-hidden=true></button><a title="Describes how to configure Istio's policy and telemetry features." href=/v1.3/docs/reference/config/policy-and-telemetry/>Policies and Telemetry</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Describes the configuration model for Istio's policy enforcement and telemetry mechanisms." href=/v1.3/docs/reference/config/policy-and-telemetry/mixer-overview/>Mixer Configuration Model</a></li><li role=none><a role=treeitem title="Describes the base attribute vocabulary used for policy and control." href=/v1.3/docs/reference/config/policy-and-telemetry/attribute-vocabulary/>Attribute Vocabulary</a></li><li role=none><a role=treeitem title="Mixer configuration expression language reference." href=/v1.3/docs/reference/config/policy-and-telemetry/expression-language/>Expression Language</a></li><li role=treeitem aria-label=Adapters><button aria-hidden=true></button><a title="Mixer adapters allow Istio to interface to a variety of infrastructure backends for such things as metrics and logs." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/>Adapters</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Adapter to deliver metrics to Apache SkyWalking." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/apache-skywalking/>Apache SkyWalking</a></li><li role=none><a role=treeitem title="Adapter for Apigee's distributed policy checks and analytics." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/apigee/>Apigee</a></li><li role=none><a role=treeitem title="Adapter to enforce authentication and authorization policies for web apps and APIs." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/app-identity-access-adapter/>App Identity and Access</a></li><li role=none><a role=treeitem title="Adapter for circonus.com's monitoring solution." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/circonus/>Circonus</a></li><li role=none><a role=treeitem title="Adapter for cloudmonitor metrics." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/cloudmonitor/>CloudMonitor</a></li><li role=none><a role=treeitem title="Adapter for cloudwatch metrics." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/cloudwatch/>CloudWatch</a></li><li role=none><a role=treeitem title="Adapter to deliver metrics to a dogstatsd agent for delivery to DataDog." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/datadog/>Datadog</a></li><li role=none><a role=treeitem title="Adapter that always returns a precondition denial." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/denier/>Denier</a></li><li role=none><a role=treeitem title="Adapter that delivers logs to a Fluentd daemon." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/fluentd/>Fluentd</a></li><li role=none><a role=treeitem title="Adapter that extracts information from a Kubernetes environment." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv/>Kubernetes Env</a></li><li role=none><a role=treeitem title="Adapter that performs whitelist or blacklist checks." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/list/>List</a></li><li role=none><a role=treeitem title="Adapter for a simple in-memory quota management system." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/memquota/>Memory quota</a></li><li role=none><a role=treeitem title="Adapter that implements an Open Policy Agent engine." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/opa/>OPA</a></li><li role=none><a role=treeitem title="Adapter that exposes Istio metrics for ingestion by a Prometheus harvester." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/prometheus/>Prometheus</a></li><li role=none><a role=treeitem title="Adapter for a Redis-based quota management system." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/redisquota/>Redis Quota</a></li><li role=none><a role=treeitem title="Adapter that sends metrics to SignalFx." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/signalfx/>SignalFx</a></li><li role=none><a role=treeitem title="Adapter to deliver logs and metrics to Papertrail and AppOptics backends." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/solarwinds/>SolarWinds</a></li><li role=none><a role=treeitem title="Adapter to deliver logs, metrics, and traces to Stackdriver." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/stackdriver/>Stackdriver</a></li><li role=none><a role=treeitem title="Adapter to deliver metrics to a StatsD backend." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/statsd/>StatsD</a></li><li role=none><a role=treeitem title="Adapter to locally output logs and metrics." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/stdio/>Stdio</a></li><li role=none><a role=treeitem title="Adapter to deliver metrics to Wavefront by VMware." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/wavefront/>Wavefront by VMware</a></li><li role=none><a role=treeitem title="Adapter to deliver tracing data to Zipkin." href=/v1.3/docs/reference/config/policy-and-telemetry/adapters/zipkin/>Zipkin</a></li></ul></li><li role=none><a role=treeitem title="Default Metrics exported from Istio through Mixer." href=/v1.3/docs/reference/config/policy-and-telemetry/metrics/>Default Metrics</a></li><li role=treeitem aria-label=Templates><button aria-hidden=true></button><a title="Mixer templates are used to send data to individual adapters." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/>Templates</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="A template that represents a single API key." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/apikey/>API Key</a></li><li role=none><a role=treeitem title="The Analytics template is used to dispatch runtime telemetry to Apigee." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/analytics/>Analytics</a></li><li role=none><a role=treeitem title="A template used to represent an access control query." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/authorization/>Authorization</a></li><li role=none><a role=treeitem title="A template that carries no data, useful for testing." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/checknothing/>Check Nothing</a></li><li role=none><a role=treeitem title="A template designed to report observed communication edges between workloads." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/edge/>Edge</a></li><li role=none><a role=treeitem title="A template that is used to control the production of Kubernetes-specific attributes." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/kubernetes/>Kubernetes</a></li><li role=none><a role=treeitem title="A template designed to let you perform list checking operations." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/listentry/>List Entry</a></li><li role=none><a role=treeitem title="A template that represents a single runtime log entry." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/logentry/>Log Entry</a></li><li role=none><a role=treeitem title="A template that represents a single runtime metric." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/metric/>Metric</a></li><li role=none><a role=treeitem title="A template that represents a quota allocation request." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/quota/>Quota</a></li><li role=none><a role=treeitem title="A template that carries no data, useful for testing." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/reportnothing/>Report Nothing</a></li><li role=none><a role=treeitem title="A template that represents an individual span within a distributed trace." href=/v1.3/docs/reference/config/policy-and-telemetry/templates/tracespan/>Trace Span</a></li></ul></li><li role=none><a role=treeitem title="Configuration state for the Mixer client library." href=/v1.3/docs/reference/config/policy-and-telemetry/istio.mixer.v1.config.client/>Mixer Client</a></li><li role=none><a role=treeitem title="Describes the rules used to configure Mixer's policy and telemetry features." href=/v1.3/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/>Rules</a></li></ul></li><li role=none><a role=treeitem title="Configuration for Istio control plane installation through the Operator." href=/v1.3/docs/reference/config/istio.operator.v1alpha12.pb/>Operator Installation</a></li><li role=none><a role=treeitem title="Configuration affecting the service mesh as a whole." href=/v1.3/docs/reference/config/istio.mesh.v1alpha1/>Service Mesh</a></li></ul></li><li role=treeitem aria-label=Commands><button class=show aria-hidden=true></button><a title="Describes usage and options of the Istio commands and utilities." href=/v1.3/docs/reference/commands/>Commands</a><ul role=group aria-expanded=true class=leaf-section><li role=none><a role=treeitem title="Galley provides configuration management services for Istio." href=/v1.3/docs/reference/commands/galley/>galley</a></li><li role=none><a role=treeitem title="Istio Certificate Authority (CA)." href=/v1.3/docs/reference/commands/istio_ca/>istio_ca</a></li><li role=none><span role=treeitem class=current title="Istio control interface.">istioctl</span></li><li role=none><a role=treeitem title="Mixer is Istio's abstraction on top of infrastructure backends." href=/v1.3/docs/reference/commands/mixs/>mixs</a></li><li role=none><a role=treeitem title="Istio security per-node agent." href=/v1.3/docs/reference/commands/node_agent/>node_agent</a></li><li role=none><a role=treeitem title="The Istio operator." href=/v1.3/docs/reference/commands/operator/>operator</a></li><li role=none><a role=treeitem title="Istio Pilot agent." href=/v1.3/docs/reference/commands/pilot-agent/>pilot-agent</a></li><li role=none><a role=treeitem title="Istio Pilot." href=/v1.3/docs/reference/commands/pilot-discovery/>pilot-discovery</a></li><li role=none><a role=treeitem title="Kubernetes webhook for automatic Istio sidecar injection." href=/v1.3/docs/reference/commands/sidecar-injector/>sidecar-injector</a></li></ul></li><li role=none><a role=treeitem title="A glossary of common Istio terms." href=/v1.3/docs/reference/glossary/>Glossary</a></li></ul></div></div></div></nav></div><div class=article-container><button tabindex=-1 id=sidebar-toggler title="Toggle the navigation bar"><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#pull"/></svg></button><nav aria-label=Breadcrumb><ol><li><a href=/v1.3/ title="Connect, secure, control, and observe services.">Istio</a></li><li><a href=/v1.3/docs/ title="Learn how to deploy, use, and operate Istio.">Docs</a></li><li><a href=/v1.3/docs/reference/ title="Detailed authoritative reference material such as command-line options, configuration options, and API calling parameters.">Reference</a></li><li><a href=/v1.3/docs/reference/commands/ title="Describes usage and options of the Istio commands and utilities.">Commands</a></li><li>istioctl</li></ol></nav><article aria-labelledby=title><div class=title-area><div><h1 id=title>istioctl</h1><p class=byline><span title="9973 words"><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#clock"/></svg><span> </span>47 minute read</span></p></div></div><nav class=toc-inlined aria-label="Table of Contents"><div><hr><ol><li role=none aria-label="istioctl auth"><a href=#istioctl-auth>istioctl auth</a><li role=none aria-label="istioctl authn"><a href=#istioctl-authn>istioctl authn</a><ol><li role=none aria-label=Examples><a href=#istioctl-authn%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl authn tls-check"><a href=#istioctl-authn-tls-check>istioctl authn tls-check</a><ol><li role=none aria-label=Examples><a href=#istioctl-authn-tls-check%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl convert-ingress"><a href=#istioctl-convert-ingress>istioctl convert-ingress</a><ol><li role=none aria-label=Examples><a href=#istioctl-convert-ingress%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard"><a href=#istioctl-dashboard>istioctl dashboard</a><li role=none aria-label="istioctl dashboard controlz"><a href=#istioctl-dashboard-controlz>istioctl dashboard controlz</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-controlz%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard envoy"><a href=#istioctl-dashboard-envoy>istioctl dashboard envoy</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-envoy%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard grafana"><a href=#istioctl-dashboard-grafana>istioctl dashboard grafana</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-grafana%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard jaeger"><a href=#istioctl-dashboard-jaeger>istioctl dashboard jaeger</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-jaeger%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard kiali"><a href=#istioctl-dashboard-kiali>istioctl dashboard kiali</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-kiali%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard prometheus"><a href=#istioctl-dashboard-prometheus>istioctl dashboard prometheus</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-prometheus%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard zipkin"><a href=#istioctl-dashboard-zipkin>istioctl dashboard zipkin</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-zipkin%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl deregister"><a href=#istioctl-deregister>istioctl deregister</a><ol><li role=none aria-label=Examples><a href=#istioctl-deregister%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental"><a href=#istioctl-experimental>istioctl experimental</a><li role=none aria-label="istioctl experimental add-to-mesh"><a href=#istioctl-experimental-add-to-mesh>istioctl experimental add-to-mesh</a><li role=none aria-label="istioctl experimental add-to-mesh external-service"><a href=#istioctl-experimental-add-to-mesh-external-service>istioctl experimental add-to-mesh external-service</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-add-to-mesh-external-service%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental add-to-mesh service"><a href=#istioctl-experimental-add-to-mesh-service>istioctl experimental add-to-mesh service</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-add-to-mesh-service%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental analyze"><a href=#istioctl-experimental-analyze>istioctl experimental analyze</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-analyze%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental auth"><a href=#istioctl-experimental-auth>istioctl experimental auth</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-auth%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental auth check"><a href=#istioctl-experimental-auth-check>istioctl experimental auth check</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-auth-check%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental auth validate"><a href=#istioctl-experimental-auth-validate>istioctl experimental auth validate</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-auth-validate%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental convert-ingress"><a href=#istioctl-experimental-convert-ingress>istioctl experimental convert-ingress</a><li role=none aria-label="istioctl experimental dashboard"><a href=#istioctl-experimental-dashboard>istioctl experimental dashboard</a><li role=none aria-label="istioctl experimental describe"><a href=#istioctl-experimental-describe>istioctl experimental describe</a><li role=none aria-label="istioctl experimental describe pod"><a href=#istioctl-experimental-describe-pod>istioctl experimental describe pod</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-describe-pod%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental kube-uninject"><a href=#istioctl-experimental-kube-uninject>istioctl experimental kube-uninject</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-kube-uninject%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental manifest"><a href=#istioctl-experimental-manifest>istioctl experimental manifest</a><li role=none aria-label="istioctl experimental manifest apply"><a href=#istioctl-experimental-manifest-apply>istioctl experimental manifest apply</a><li role=none aria-label="istioctl experimental manifest diff"><a href=#istioctl-experimental-manifest-diff>istioctl experimental manifest diff</a><li role=none aria-label="istioctl experimental manifest generate"><a href=#istioctl-experimental-manifest-generate>istioctl experimental manifest generate</a><li role=none aria-label="istioctl experimental manifest migrate"><a href=#istioctl-experimental-manifest-migrate>istioctl experimental manifest migrate</a><li role=none aria-label="istioctl experimental manifest versions"><a href=#istioctl-experimental-manifest-versions>istioctl experimental manifest versions</a><li role=none aria-label="istioctl experimental metrics"><a href=#istioctl-experimental-metrics>istioctl experimental metrics</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-metrics%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental profile"><a href=#istioctl-experimental-profile>istioctl experimental profile</a><li role=none aria-label="istioctl experimental profile diff"><a href=#istioctl-experimental-profile-diff>istioctl experimental profile diff</a><li role=none aria-label="istioctl experimental profile dump"><a href=#istioctl-experimental-profile-dump>istioctl experimental profile dump</a><li role=none aria-label="istioctl experimental profile list"><a href=#istioctl-experimental-profile-list>istioctl experimental profile list</a><li role=none aria-label="istioctl experimental remove-from-mesh"><a href=#istioctl-experimental-remove-from-mesh>istioctl experimental remove-from-mesh</a><li role=none aria-label="istioctl experimental remove-from-mesh external-service"><a href=#istioctl-experimental-remove-from-mesh-external-service>istioctl experimental remove-from-mesh external-service</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-remove-from-mesh-external-service%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental remove-from-mesh service"><a href=#istioctl-experimental-remove-from-mesh-service>istioctl experimental remove-from-mesh service</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-remove-from-mesh-service%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl kube-inject"><a href=#istioctl-kube-inject>istioctl kube-inject</a><ol><li role=none aria-label=Examples><a href=#istioctl-kube-inject%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config"><a href=#istioctl-proxy-config>istioctl proxy-config</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config bootstrap"><a href=#istioctl-proxy-config-bootstrap>istioctl proxy-config bootstrap</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-bootstrap%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config cluster"><a href=#istioctl-proxy-config-cluster>istioctl proxy-config cluster</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-cluster%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config endpoint"><a href=#istioctl-proxy-config-endpoint>istioctl proxy-config endpoint</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-endpoint%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config listener"><a href=#istioctl-proxy-config-listener>istioctl proxy-config listener</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-listener%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config route"><a href=#istioctl-proxy-config-route>istioctl proxy-config route</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-route%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-status"><a href=#istioctl-proxy-status>istioctl proxy-status</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-status%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl register"><a href=#istioctl-register>istioctl register</a><li role=none aria-label="istioctl validate"><a href=#istioctl-validate>istioctl validate</a><ol><li role=none aria-label=Examples><a href=#istioctl-validate%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl verify-install"><a href=#istioctl-verify-install>istioctl verify-install</a><ol><li role=none aria-label=Examples><a href=#istioctl-verify-install%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl version"><a href=#istioctl-version>istioctl version</a><li role=none aria-label="Environment variables"><a href=#envvars>Environment variables</a><li role=none aria-label="Exported metrics"><a href=#metrics>Exported metrics</a></ol><hr></div></nav><p>Istio configuration command line utility for service operators to
|
|
debug and diagnose their Istio mesh.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-auth>istioctl auth</h2><p>(auth is experimental. Use `istioctl experimental auth`)</p><pre class=language-bash><code>istioctl auth [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-authn>istioctl authn</h2><p>A group of commands used to interact with Istio authentication policies.
|
|
tls-check</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-authn Examples">Examples</h3><pre class=language-bash><code># Check whether TLS setting are matching between authentication policy and destination rules:
|
|
istioctl authn tls-check
|
|
</code></pre><h2 id=istioctl-authn-tls-check>istioctl authn tls-check</h2><p>Check what authentication policies and destination rules pilot uses to config a proxy instance,
|
|
and check if TLS settings are compatible between them.</p><pre class=language-bash><code>istioctl authn tls-check <pod-name[.namespace]> [<service>] [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-authn-tls-check Examples">Examples</h3><pre class=language-bash><code>
|
|
# 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 destination
|
|
service "bar" :
|
|
istioctl authn tls-check foo-656bd7df7c-5zp4s.default bar
|
|
|
|
</code></pre><h2 id=istioctl-convert-ingress>istioctl convert-ingress</h2><p>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.</p><pre class=language-bash><code>istioctl convert-ingress [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filenames <stringSlice></code></td><td><code>-f</code></td><td>Input filenames (default `[]`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output filename (default `-`)</td></tr></tbody></table><h3 id="istioctl-convert-ingress Examples">Examples</h3><pre class=language-bash><code>istioctl experimental convert-ingress -f samples/bookinfo/platform/kube/bookinfo-ingress.yaml
|
|
</code></pre><h2 id=istioctl-dashboard>istioctl dashboard</h2><p>Access to Istio web UIs</p><pre class=language-bash><code>istioctl dashboard [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl dash [flags]
|
|
istioctl d [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-dashboard-controlz>istioctl dashboard controlz</h2><p>Open the ControlZ web UI for a pod in the Istio control plane</p><pre class=language-bash><code>istioctl dashboard controlz <pod-name[.namespace]> [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--ctrlz_port <int></code></td><td></td><td>ControlZ port (default `9876`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-controlz Examples">Examples</h3><pre class=language-bash><code>istioctl experimental dashboard controlz pilot-123-456.istio-system
|
|
</code></pre><h2 id=istioctl-dashboard-envoy>istioctl dashboard envoy</h2><p>Open the Envoy admin dashboard for a sidecar</p><pre class=language-bash><code>istioctl dashboard envoy <pod-name[.namespace]> [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-envoy Examples">Examples</h3><pre class=language-bash><code>istioctl experimental dashboard envoy productpage-123-456.default
|
|
</code></pre><h2 id=istioctl-dashboard-grafana>istioctl dashboard grafana</h2><p>Open Istio's Grafana dashboard</p><pre class=language-bash><code>istioctl dashboard grafana [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-grafana Examples">Examples</h3><pre class=language-bash><code>istioctl experimental dashboard grafana
|
|
</code></pre><h2 id=istioctl-dashboard-jaeger>istioctl dashboard jaeger</h2><p>Open Istio's Jaeger dashboard</p><pre class=language-bash><code>istioctl dashboard jaeger [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-jaeger Examples">Examples</h3><pre class=language-bash><code>istioctl experimental dashboard jaeger
|
|
</code></pre><h2 id=istioctl-dashboard-kiali>istioctl dashboard kiali</h2><p>Open Istio's Kiali dashboard</p><pre class=language-bash><code>istioctl dashboard kiali [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-kiali Examples">Examples</h3><pre class=language-bash><code>istioctl experimental dashboard kiali
|
|
</code></pre><h2 id=istioctl-dashboard-prometheus>istioctl dashboard prometheus</h2><p>Open Istio's Prometheus dashboard</p><pre class=language-bash><code>istioctl dashboard prometheus [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-prometheus Examples">Examples</h3><pre class=language-bash><code>istioctl experimental dashboard prometheus
|
|
</code></pre><h2 id=istioctl-dashboard-zipkin>istioctl dashboard zipkin</h2><p>Open Istio's Zipkin dashboard</p><pre class=language-bash><code>istioctl dashboard zipkin [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-zipkin Examples">Examples</h3><pre class=language-bash><code>istioctl experimental dashboard zipkin
|
|
</code></pre><h2 id=istioctl-deregister>istioctl deregister</h2><p>De-registers a service instance</p><pre class=language-bash><code>istioctl deregister <svcname> <ip> [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-deregister Examples">Examples</h3><pre class=language-bash><code># de-register an endpoint 172.17.0.2 from service my-svc:
|
|
istioctl deregister my-svc 172.17.0.2
|
|
</code></pre><h2 id=istioctl-experimental>istioctl experimental</h2><p>Experimental commands that may be modified or deprecated</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-add-to-mesh>istioctl experimental add-to-mesh</h2><p>Add workloads into Istio service mesh</p><pre class=language-bash><code>istioctl experimental add-to-mesh [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental add [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-add-to-mesh-external-service>istioctl experimental add-to-mesh external-service</h2><p>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.
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental add-to-mesh external-service <svcname> <ip>... [name1:]port1 [name2:]port2 ... [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--annotations <stringSlice></code></td><td><code>-a</code></td><td>List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,x=y (default `[]`)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--labels <stringSlice></code></td><td><code>-l</code></td><td>List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--serviceaccount <string></code></td><td><code>-s</code></td><td>Service account to link to the service (default `default`)</td></tr></tbody></table><h3 id="istioctl-experimental-add-to-mesh-external-service Examples">Examples</h3><pre class=language-bash><code>istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126\
|
|
http:9080 tcp:8888 -l app=test,version=v1 -a env=stage -s stageAdmin
|
|
</code></pre><h2 id=istioctl-experimental-add-to-mesh-service>istioctl experimental add-to-mesh service</h2><p>istioctl experimental add-to-mesh service restarts pods with the Istio sidecar. Use 'add-to-mesh'
|
|
to test deployments for compatibility with Istio. 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/
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental add-to-mesh service [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--injectConfigFile <string></code></td><td></td><td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--injectConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--meshConfigFile <string></code></td><td></td><td>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--valuesFile <string></code></td><td></td><td>injection values configuration filename. (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-add-to-mesh-service Examples">Examples</h3><pre class=language-bash><code>istioctl experimental add-to-mesh service productpage
|
|
</code></pre><h2 id=istioctl-experimental-analyze>istioctl experimental analyze</h2><p>Analyze Istio configuration and print validation messages</p><pre class=language-bash><code>istioctl experimental analyze <file>... [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--use-kube</code></td><td><code>-k</code></td><td>Use live kubernetes cluster for analysis</td></tr></tbody></table><h3 id="istioctl-experimental-analyze Examples">Examples</h3><pre class=language-bash><code>
|
|
# Analyze yaml files
|
|
istioctl experimental analyze a.yaml b.yaml
|
|
|
|
# Analyze the current live cluster
|
|
istioctl experimental analyze -k
|
|
|
|
# Analyze the current live cluster, simulating the effect of applying additional yaml files
|
|
istioctl experimental analyze -k a.yaml b.yaml
|
|
|
|
</code></pre><h2 id=istioctl-experimental-auth>istioctl experimental auth</h2><p>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
|
|
validate - check for potential incorrect usage in authorization policy files.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-auth Examples">Examples</h3><pre class=language-bash><code> # Check the TLS/JWT/RBAC settings for pod httpbin-88ddbcfdd-nt5jb:
|
|
istioctl experimental auth check httpbin-88ddbcfdd-nt5jb
|
|
</code></pre><h2 id=istioctl-experimental-auth-check>istioctl experimental auth check</h2><p>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).</p><p>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.</p><p>- clusters on outbound direction generally tell how should the Envoy instance talk to other pods which
|
|
include the client side TLS settings.</p><p>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.</p><p>To check the JWT/RBAC setting, you could run 'check' only on your server pods and check the listener results.</p><p>THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental auth check <pod-name>[.<pod-namespace>] [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--all</code></td><td><code>-a</code></td><td>Show additional information (e.g. SNI and ALPN)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Check the TLS/JWT/RBAC setting from the config dump file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-auth-check Examples">Examples</h3><pre class=language-bash><code> # 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
|
|
</code></pre><h2 id=istioctl-experimental-auth-validate>istioctl experimental auth validate</h2><p>This command goes through all authorization policy files and finds potential issues such as:
|
|
* ServiceRoleBinding refers to a non existing ServiceRole.
|
|
* ServiceRole not used.
|
|
It does not require access to the cluster as the validation is against local files.</p><pre class=language-bash><code>istioctl experimental auth validate <policy-file1,policy-file2,...> [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file <stringSlice></code></td><td><code>-f</code></td><td>Authorization policy file (default `[]`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-auth-validate Examples">Examples</h3><pre class=language-bash><code>istioctl experimental auth validate -f policy1.yaml,policy2.yaml
|
|
</code></pre><h2 id=istioctl-experimental-convert-ingress>istioctl experimental convert-ingress</h2><p>(convert-ingress has graduated. Use `istioctl convert-ingress`)</p><pre class=language-bash><code>istioctl experimental convert-ingress [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-dashboard>istioctl experimental dashboard</h2><p>(dashboard has graduated. Use `istioctl dashboard`)</p><pre class=language-bash><code>istioctl experimental dashboard [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-describe>istioctl experimental describe</h2><p>Describe resource and related Istio configuration</p><pre class=language-bash><code>istioctl experimental describe [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental des [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-describe-pod>istioctl experimental describe pod</h2><p>Analyzes pod, its Services, DestinationRules, and VirtualServices and reports
|
|
the configuration objects that affect that pod.</p><p>THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental describe pod <pod> [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--ignoreUnmeshed</code></td><td></td><td>Suppress warnings for unmeshed pods</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-describe-pod Examples">Examples</h3><pre class=language-bash><code>istioctl experimental describe pod productpage-v1-c7765c886-7zzd4
|
|
</code></pre><h2 id=istioctl-experimental-kube-uninject>istioctl experimental kube-uninject</h2><p></p><p>kube-uninject is used to prevent Istio from adding a sidecar and
|
|
also provides the inverse of "istioctl kube-inject -f".</p><p></p><pre class=language-bash><code>istioctl experimental kube-uninject [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Input Kubernetes resource filename (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Modified output Kubernetes resource filename (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-kube-uninject Examples">Examples</h3><pre class=language-bash><code>
|
|
# 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 -
|
|
|
|
</code></pre><h2 id=istioctl-experimental-manifest>istioctl experimental manifest</h2><p>The manifest subcommand generates, applies, diffs or migrates Istio manifests.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-experimental-manifest-apply>istioctl experimental manifest apply</h2><p>The apply subcommand generates an Istio install manifest and applies it to a cluster.</p><pre class=language-bash><code>istioctl experimental manifest apply [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Path to file containing IstioControlPlane CustomResource (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--readiness-timeout <duration></code></td><td></td><td>Maximum seconds to wait for all Istio resources to be ready. The --wait flag must be set for this flag to apply (default `5m0s`)</td></tr><tr><td><code>--set <stringSlice></code></td><td><code>-s</code></td><td>Set a value in IstioControlPlane CustomResource. e.g. --set policy.enabled=true.
|
|
Overrides the corresponding path value in the selected profile or passed through IstioControlPlane CR
|
|
customization file (default `[]`)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr><tr><td><code>--wait</code></td><td><code>-w</code></td><td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds</td></tr><tr><td><code>--yes</code></td><td><code>-y</code></td><td>Do not ask for confirmation</td></tr></tbody></table><h2 id=istioctl-experimental-manifest-diff>istioctl experimental manifest diff</h2><p>The diff subcommand compares manifests from two files or directories.</p><pre class=language-bash><code>istioctl experimental manifest diff <file|dir> <file|dir> [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--directory</code></td><td><code>-r</code></td><td>compare directory</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--ignore <string></code></td><td></td><td>ignoreResources ignores all listed items during comparison. It uses the same list format as selectResources (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--select <string></code></td><td></td><td>selectResources constrains 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:*:istio-pilot - compare Services called "istio-pilot" in all namespaces (default `::`)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-experimental-manifest-generate>istioctl experimental manifest generate</h2><p>The generate subcommand generates an Istio install manifest and outputs to the console by default.</p><pre class=language-bash><code>istioctl experimental manifest generate [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Path to file containing IstioControlPlane CustomResource (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Manifest output directory path (default ``)</td></tr><tr><td><code>--set <stringSlice></code></td><td><code>-s</code></td><td>Set a value in IstioControlPlane CustomResource. e.g. --set policy.enabled=true.
|
|
Overrides the corresponding path value in the selected profile or passed through IstioControlPlane CR
|
|
customization file (default `[]`)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-experimental-manifest-migrate>istioctl experimental manifest migrate</h2><p>The migrate subcommand migrates a configuration from Helm values format to IstioControlPlane format.</p><pre class=language-bash><code>istioctl experimental manifest migrate [<filepath>] [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-experimental-manifest-versions>istioctl experimental manifest versions</h2><p>List the versions of Istio recommended for and supported by this version of the operator binary.</p><pre class=language-bash><code>istioctl experimental manifest versions [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr><tr><td><code>--versionsURI <string></code></td><td><code>-u</code></td><td>URI for operator versions to Istio versions map (default `https://raw.githubusercontent.com/istio/operator/master/version/versions.yaml`)</td></tr></tbody></table><h2 id=istioctl-experimental-metrics>istioctl experimental metrics</h2><p>Prints the metrics for the specified service(s) when running in Kubernetes.</p><p>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.</p><p>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.</p><pre class=language-bash><code>istioctl experimental metrics <workload name>...
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental m <workload name>...
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-metrics Examples">Examples</h3><pre class=language-bash><code>
|
|
# 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
|
|
|
|
</code></pre><h2 id=istioctl-experimental-profile>istioctl experimental profile</h2><p>The profile subcommand lists, dumps or diffs Istio configuration profiles.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-experimental-profile-diff>istioctl experimental profile diff</h2><p>The diff subcommand displays the differences between two Istio configuration profiles.</p><pre class=language-bash><code>istioctl experimental profile diff <file1.yaml> <file2.yaml> [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-experimental-profile-dump>istioctl experimental profile dump</h2><p>The dump subcommand dumps the values in an Istio configuration profile.</p><pre class=language-bash><code>istioctl experimental profile dump [<profile>] [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--config-path <string></code></td><td><code>-p</code></td><td>The path the root of the configuration subtree to dump e.g. trafficManagement.components.pilot. By default, dump whole tree (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Path to file containing IstioControlPlane CustomResource (default ``)</td></tr><tr><td><code>--helm-values</code></td><td></td><td>If set, dumps the Helm values that IstioControlPlaceSpec is translated to before manifests are rendered</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-experimental-profile-list>istioctl experimental profile list</h2><p>The list subcommand lists the available Istio configuration profiles.</p><pre class=language-bash><code>istioctl experimental profile list [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-experimental-remove-from-mesh>istioctl experimental remove-from-mesh</h2><p>Remove workloads from Istio service mesh</p><pre class=language-bash><code>istioctl experimental remove-from-mesh [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental remove [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-remove-from-mesh-external-service>istioctl experimental remove-from-mesh external-service</h2><p>istioctl experimental remove-from-mesh external-service remove the ServiceEntry and\
|
|
the kubernetes Service for the specified external service(eg:services running on VM) from Istio service mesh.
|
|
The typical usage scenario is Mesh Expansion on VMs.
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental remove-from-mesh external-service <svcname> [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-remove-from-mesh-external-service Examples">Examples</h3><pre class=language-bash><code>istioctl experimental remove-from-mesh external-service vmhttp
|
|
</code></pre><h2 id=istioctl-experimental-remove-from-mesh-service>istioctl experimental remove-from-mesh service</h2><p>istioctl experimental remove-from-mesh service restarts pods with the Istio sidecar un-injected.
|
|
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental remove-from-mesh service [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-remove-from-mesh-service Examples">Examples</h3><pre class=language-bash><code>istioctl experimental remove-from-mesh service productpage
|
|
</code></pre><h2 id=istioctl-kube-inject>istioctl kube-inject</h2><p></p><p>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.</p><p>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.</p><p>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.</p><pre class=language-bash><code>istioctl kube-inject [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Input Kubernetes resource filename (default ``)</td></tr><tr><td><code>--injectConfigFile <string></code></td><td></td><td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--injectConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--meshConfigFile <string></code></td><td></td><td>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Modified output Kubernetes resource filename (default ``)</td></tr><tr><td><code>--valuesFile <string></code></td><td></td><td>injection values configuration filename. (default ``)</td></tr></tbody></table><h3 id="istioctl-kube-inject Examples">Examples</h3><pre class=language-bash><code>
|
|
# 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
|
|
|
|
</code></pre><h2 id=istioctl-proxy-config>istioctl proxy-config</h2><p>A group of commands used to retrieve information about proxy configuration from the Envoy config dump</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr></tbody></table><h3 id="istioctl-proxy-config Examples">Examples</h3><pre class=language-bash><code> # Retrieve information about proxy configuration from an Envoy instance.
|
|
istioctl proxy-config <clusters|listeners|routes|endpoints|bootstrap> <pod-name[.namespace]>
|
|
</code></pre><h2 id=istioctl-proxy-config-bootstrap>istioctl proxy-config bootstrap</h2><p>Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config bootstrap <pod-name[.namespace]> [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config b <pod-name[.namespace]> [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr></tbody></table><h3 id="istioctl-proxy-config-bootstrap Examples">Examples</h3><pre class=language-bash><code> # Retrieve full bootstrap configuration for a given pod from Envoy.
|
|
istioctl proxy-config bootstrap <pod-name[.namespace]>
|
|
|
|
</code></pre><h2 id=istioctl-proxy-config-cluster>istioctl proxy-config cluster</h2><p>Retrieve information about cluster configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config cluster <pod-name[.namespace]> [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config clusters <pod-name[.namespace]> [flags]
|
|
istioctl proxy-config c <pod-name[.namespace]> [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--direction <string></code></td><td></td><td>Filter clusters by Direction field (default ``)</td></tr><tr><td><code>--fqdn <string></code></td><td></td><td>Filter clusters by substring of Service FQDN field (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter clusters by Port field (default `0`)</td></tr><tr><td><code>--subset <string></code></td><td></td><td>Filter clusters by substring of Subset field (default ``)</td></tr></tbody></table><h3 id="istioctl-proxy-config-cluster Examples">Examples</h3><pre class=language-bash><code> # 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
|
|
|
|
</code></pre><h2 id=istioctl-proxy-config-endpoint>istioctl proxy-config endpoint</h2><p>Retrieve information about endpoint configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config endpoint <pod-name[.namespace]> [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config endpoints <pod-name[.namespace]> [flags]
|
|
istioctl proxy-config ep <pod-name[.namespace]> [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <string></code></td><td></td><td>Filter endpoints by address field (default ``)</td></tr><tr><td><code>--cluster <string></code></td><td></td><td>Filter endpoints by cluster name field (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter endpoints by Port field (default `0`)</td></tr><tr><td><code>--status <string></code></td><td></td><td>Filter endpoints by status field (default ``)</td></tr></tbody></table><h3 id="istioctl-proxy-config-endpoint Examples">Examples</h3><pre class=language-bash><code> # 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
|
|
|
|
</code></pre><h2 id=istioctl-proxy-config-listener>istioctl proxy-config listener</h2><p>Retrieve information about listener configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config listener <pod-name[.namespace]> [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config listeners <pod-name[.namespace]> [flags]
|
|
istioctl proxy-config l <pod-name[.namespace]> [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <string></code></td><td></td><td>Filter listeners by address field (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter listeners by Port field (default `0`)</td></tr><tr><td><code>--type <string></code></td><td></td><td>Filter listeners by type field (default ``)</td></tr></tbody></table><h3 id="istioctl-proxy-config-listener Examples">Examples</h3><pre class=language-bash><code> # 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
|
|
|
|
</code></pre><h2 id=istioctl-proxy-config-route>istioctl proxy-config route</h2><p>Retrieve information about route configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config route <pod-name[.namespace]> [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config routes <pod-name[.namespace]> [flags]
|
|
istioctl proxy-config r <pod-name[.namespace]> [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--name <string></code></td><td></td><td>Filter listeners by route name field (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr></tbody></table><h3 id="istioctl-proxy-config-route Examples">Examples</h3><pre class=language-bash><code> # 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
|
|
|
|
</code></pre><h2 id=istioctl-proxy-status>istioctl proxy-status</h2><p>Retrieves last sent and last acknowledged xDS sync from Pilot to each Envoy in the mesh</p><p></p><pre class=language-bash><code>istioctl proxy-status [<pod-name[.namespace]>] [flags]
|
|
</code></pre><div class=aliases><pre class=language-bash><code>istioctl ps [<pod-name[.namespace]>] [flags]
|
|
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-proxy-status Examples">Examples</h3><pre class=language-bash><code># 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
|
|
|
|
</code></pre><h2 id=istioctl-register>istioctl register</h2><p>Registers a service instance (e.g. VM) joining the mesh</p><pre class=language-bash><code>istioctl register <svcname> <ip> [name1:]port1 [name2:]port2 ... [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--annotations <stringSlice></code></td><td><code>-a</code></td><td>List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,test,x=y (default `[]`)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--labels <stringSlice></code></td><td><code>-l</code></td><td>List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--serviceaccount <string></code></td><td><code>-s</code></td><td>Service account to link to the service (default `default`)</td></tr></tbody></table><h2 id=istioctl-validate>istioctl validate</h2><p>Validate Istio policy and rules</p><pre class=language-bash><code>istioctl validate -f FILENAME [options] [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename <stringSlice></code></td><td><code>-f</code></td><td>Names of files to validate (default `[]`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--referential</code></td><td><code>-x</code></td><td>Enable structural validation for policy and telemetry</td></tr></tbody></table><h3 id="istioctl-validate Examples">Examples</h3><pre class=language-bash><code>
|
|
# 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 -
|
|
|
|
</code></pre><h2 id=istioctl-verify-install>istioctl verify-install</h2><p>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.</p><p>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.</p><pre class=language-bash><code>istioctl verify-install [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--enableVerbose</code></td><td></td><td>Enable verbose output</td></tr><tr><td><code>--filename <stringSlice></code></td><td><code>-f</code></td><td>Istio YAML installation file. (default `[]`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--recursive</code></td><td><code>-R</code></td><td>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</td></tr></tbody></table><h3 id="istioctl-verify-install Examples">Examples</h3><pre class=language-bash><code>
|
|
# 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
|
|
|
|
</code></pre><h2 id=istioctl-version>istioctl version</h2><p>Prints out build version information</p><pre class=language-bash><code>istioctl version [flags]
|
|
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>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, all, analysis, attributes, authn, default, grpcAdapter, kube-converter, mcp, meshconfig, model, name, patch, processing, rbac, resource, runtime, source, tpath, translator, util, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>One of 'yaml' or 'json'. (default ``)</td></tr><tr><td><code>--remote</code></td><td></td><td>Use --remote=false to suppress control plane check</td></tr><tr><td><code>--short</code></td><td><code>-s</code></td><td>Use --short=false to generate full version information</td></tr></tbody></table><h2 id=envvars>Environment variables</h2>These environment variables affect the behavior of the <code>istioctl</code> command.<table class=envvars><thead><tr><th>Variable Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td><code>BYPASS_OOP_MTLS_SAN_VERIFICATION</code></td><td>Boolean</td><td><code>false</code></td><td>Whether or not to validate SANs for out-of-process adapters auth.</td></tr><tr><td><code>ISTIO_GPRC_MAXSTREAMS</code></td><td>Integer</td><td><code>100000</code></td><td>Sets the maximum number of concurrent grpc streams.</td></tr><tr><td><code>ISTIO_LANG</code></td><td>String</td><td><code></code></td><td>Selects the attribute expression langauge runtime for Mixer.</td></tr><tr><td><code>K8S_INGRESS_NS</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>PILOT_CERT_DIR</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>PILOT_DEBOUNCE_AFTER</code></td><td>Time Duration</td><td><code>100ms</code></td><td>The delay added to config/registry events for debouncing. This will delay the push by at least this internal. 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.</td></tr><tr><td><code>PILOT_DEBOUNCE_MAX</code></td><td>Time Duration</td><td><code>10s</code></td><td>The 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.</td></tr><tr><td><code>PILOT_DEBUG_ADSZ_CONFIG</code></td><td>Boolean</td><td><code>false</code></td><td></td></tr><tr><td><code>PILOT_DISABLE_XDS_MARSHALING_TO_ANY</code></td><td>Boolean</td><td><code>false</code></td><td></td></tr><tr><td><code>PILOT_ENABLE_EDS_DEBOUNCE</code></td><td>Boolean</td><td><code>true</code></td><td>If 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</td></tr><tr><td><code>PILOT_ENABLE_FALLTHROUGH_ROUTE</code></td><td>Boolean</td><td><code>true</code></td><td>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.</td></tr><tr><td><code>PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.</td></tr><tr><td><code>PILOT_ENABLE_MYSQL_FILTER</code></td><td>Boolean</td><td><code>false</code></td><td>EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain.</td></tr><tr><td><code>PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUND</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, protocol sniffing will be used for inbound listeners whose port protocol is not specified or unsupported</td></tr><tr><td><code>PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_OUTBOUND</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, protocol sniffing will be used for outbound listeners whose port protocol is not specified or unsupported</td></tr><tr><td><code>PILOT_ENABLE_REDIS_FILTER</code></td><td>Boolean</td><td><code>false</code></td><td>EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain.</td></tr><tr><td><code>PILOT_HTTP10</code></td><td>Boolean</td><td><code>false</code></td><td>Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.</td></tr><tr><td><code>PILOT_INBOUND_PROTOCOL_DETECTION_TIMEOUT</code></td><td>Time Duration</td><td><code>1s</code></td><td>Protocol detection timeout for inbound listener</td></tr><tr><td><code>PILOT_INITIAL_FETCH_TIMEOUT</code></td><td>Time Duration</td><td><code>0s</code></td><td>Specifies the initial_fetch_timeout for config. If this time is reached without a response to the config requested by Envoy, the Envoy will move on with the init phase. This prevents envoy from getting stuck waiting on config during startup.</td></tr><tr><td><code>PILOT_PUSH_THROTTLE</code></td><td>Integer</td><td><code>100</code></td><td>Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes</td></tr><tr><td><code>PILOT_RESPECT_DNS_TTL</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, DNS based clusters will respect the TTL of the DNS, rather than polling at a fixed rate. This option is only provided for backward compatibility purposes and will be removed in the near future.</td></tr><tr><td><code>PILOT_RESTRICT_POD_UP_TRAFFIC_LOOP</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, this will block inbound traffic from matching outbound listeners, which could result in an infinite loop of traffic. This option is only provided for backward compatibility purposes and will be removed in the near future.</td></tr><tr><td><code>PILOT_SCOPE_GATEWAY_TO_NAMESPACE</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, a gateway workload can only select gateway resources in the same namespace. Gateways with same selectors in different namespaces will not be applicable.</td></tr><tr><td><code>PILOT_SCOPE_PUSHES</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, pilot will attempt to limit unnecessary pushes by determining what proxies a config or endpoint update will impact.</td></tr><tr><td><code>PILOT_SIDECAR_USE_REMOTE_ADDRESS</code></td><td>Boolean</td><td><code>false</code></td><td>UseRemoteAddress sets useRemoteAddress to true for side car outbound listeners.</td></tr><tr><td><code>PILOT_SKIP_VALIDATE_TRUST_DOMAIN</code></td><td>Boolean</td><td><code>false</code></td><td>Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy</td></tr><tr><td><code>PILOT_TRACE_SAMPLING</code></td><td>Floating-Point</td><td><code>100</code></td><td>Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 100, not recommended for production use.</td></tr><tr><td><code>POD_NAME</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>TERMINATION_DRAIN_DURATION_SECONDS</code></td><td>Integer</td><td><code>5</code></td><td>The amount of time allowed for connections to complete on pilot-agent shutdown. On receiving SIGTERM or SIGINT, pilot-agent tells the active Envoy to start draining, preventing any new connections and allowing existing connections to complete. It then sleeps for the TerminationDrainDuration and then kills any remaining active Envoy processes.</td></tr><tr><td><code>USE_ISTIO_JWT_FILTER</code></td><td>Boolean</td><td><code>false</code></td><td>Use the Istio JWT filter for JWT token verification.</td></tr><tr><td><code>V2_REFRESH</code></td><td>Time Duration</td><td><code>0s</code></td><td></td></tr></tbody></table><h2 id=metrics>Exported metrics</h2><table class=metrics><thead><tr><th>Metric Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>endpoint_no_pod</code></td><td><code>LastValue</code></td><td>Endpoints without an associated pod.</td></tr><tr><td><code>galley_runtime_processor_event_span_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration between each incoming event</td></tr><tr><td><code>galley_runtime_processor_events_processed_total</code></td><td><code>Count</code></td><td>The number of events that have been processed</td></tr><tr><td><code>galley_runtime_processor_snapshot_events_total</code></td><td><code>Distribution</code></td><td>The number of events per snapshot</td></tr><tr><td><code>galley_runtime_processor_snapshot_lifetime_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration of each snapshot</td></tr><tr><td><code>galley_runtime_processor_snapshots_published_total</code></td><td><code>Count</code></td><td>The number of snapshots that have been published</td></tr><tr><td><code>galley_runtime_state_type_instances_total</code></td><td><code>LastValue</code></td><td>The number of type instances per type URL</td></tr><tr><td><code>galley_runtime_strategy_on_change_total</code></td><td><code>Count</code></td><td>The number of times the strategy's onChange has been called</td></tr><tr><td><code>galley_runtime_strategy_timer_max_time_reached_total</code></td><td><code>Count</code></td><td>The number of times the max time has been reached</td></tr><tr><td><code>galley_runtime_strategy_timer_quiesce_reached_total</code></td><td><code>Count</code></td><td>The number of times a quiesce has been reached</td></tr><tr><td><code>galley_runtime_strategy_timer_resets_total</code></td><td><code>Count</code></td><td>The number of times the timer has been reset</td></tr><tr><td><code>galley_source_kube_dynamic_converter_failure_total</code></td><td><code>Count</code></td><td>The number of times a dynamnic kubernetes source failed converting a resources</td></tr><tr><td><code>galley_source_kube_dynamic_converter_success_total</code></td><td><code>Count</code></td><td>The number of times a dynamic kubernetes source successfully converted a resource</td></tr><tr><td><code>galley_source_kube_event_error_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source encountered errored while handling an event</td></tr><tr><td><code>galley_source_kube_event_success_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source successfully handled an event</td></tr><tr><td><code>istio_build</code></td><td><code>LastValue</code></td><td>Istio component build info</td></tr><tr><td><code>istio_mcp_clients_total</code></td><td><code>LastValue</code></td><td>The number of streams currently connected.</td></tr><tr><td><code>istio_mcp_message_sizes_bytes</code></td><td><code>Distribution</code></td><td>Size of messages received from clients.</td></tr><tr><td><code>istio_mcp_reconnections</code></td><td><code>Sum</code></td><td>The number of times the sink has reconnected.</td></tr><tr><td><code>istio_mcp_recv_failures_total</code></td><td><code>Sum</code></td><td>The number of recv failures in the source.</td></tr><tr><td><code>istio_mcp_request_acks_total</code></td><td><code>Sum</code></td><td>The number of request acks received by the source.</td></tr><tr><td><code>istio_mcp_request_nacks_total</code></td><td><code>Sum</code></td><td>The number of request nacks received by the source.</td></tr><tr><td><code>istio_mcp_send_failures_total</code></td><td><code>Sum</code></td><td>The number of send failures in the source.</td></tr><tr><td><code>mixer_config_adapter_info_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the adapter info configuration.</td></tr><tr><td><code>mixer_config_adapter_info_configs_total</code></td><td><code>LastValue</code></td><td>The number of known adapters in the current config.</td></tr><tr><td><code>mixer_config_attributes_total</code></td><td><code>LastValue</code></td><td>The number of known attributes in the current config.</td></tr><tr><td><code>mixer_config_handler_configs_total</code></td><td><code>LastValue</code></td><td>The number of known handlers in the current config.</td></tr><tr><td><code>mixer_config_handler_validation_error_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered because handler validation returned error.</td></tr><tr><td><code>mixer_config_instance_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the instance configuration.</td></tr><tr><td><code>mixer_config_instance_configs_total</code></td><td><code>LastValue</code></td><td>The number of known instances in the current config.</td></tr><tr><td><code>mixer_config_rule_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the rule configuration.</td></tr><tr><td><code>mixer_config_rule_config_match_error_total</code></td><td><code>LastValue</code></td><td>The number of rule conditions that was not parseable.</td></tr><tr><td><code>mixer_config_rule_configs_total</code></td><td><code>LastValue</code></td><td>The number of known rules in the current config.</td></tr><tr><td><code>mixer_config_template_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the template configuration.</td></tr><tr><td><code>mixer_config_template_configs_total</code></td><td><code>LastValue</code></td><td>The number of known templates in the current config.</td></tr><tr><td><code>mixer_config_unsatisfied_action_handler_total</code></td><td><code>LastValue</code></td><td>The number of actions that failed due to handlers being unavailable.</td></tr><tr><td><code>mixer_dispatcher_destinations_per_request</code></td><td><code>Distribution</code></td><td>Number of handlers dispatched per request by Mixer</td></tr><tr><td><code>mixer_dispatcher_destinations_per_variety_total</code></td><td><code>LastValue</code></td><td>Number of Mixer adapter destinations by template variety type</td></tr><tr><td><code>mixer_dispatcher_instances_per_request</code></td><td><code>Distribution</code></td><td>Number of instances created per request by Mixer</td></tr><tr><td><code>mixer_handler_closed_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were closed during config transition.</td></tr><tr><td><code>mixer_handler_daemons_total</code></td><td><code>LastValue</code></td><td>The current number of active daemon routines in a given adapter environment.</td></tr><tr><td><code>mixer_handler_handler_build_failures_total</code></td><td><code>LastValue</code></td><td>The number of handlers that failed creation during config transition.</td></tr><tr><td><code>mixer_handler_handler_close_failures_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered while closing handlers during config transition.</td></tr><tr><td><code>mixer_handler_new_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were newly created during config transition.</td></tr><tr><td><code>mixer_handler_reused_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were re-used during config transition.</td></tr><tr><td><code>mixer_handler_workers_total</code></td><td><code>LastValue</code></td><td>The current number of active worker routines in a given adapter environment.</td></tr><tr><td><code>mixer_runtime_dispatch_duration_seconds</code></td><td><code>Distribution</code></td><td>Duration in seconds for adapter dispatches handled by Mixer.</td></tr><tr><td><code>mixer_runtime_dispatches_total</code></td><td><code>Count</code></td><td>Total number of adapter dispatches handled by Mixer.</td></tr><tr><td><code>pilot_conflict_inbound_listener</code></td><td><code>LastValue</code></td><td>Number of conflicting inbound listeners.</td></tr><tr><td><code>pilot_conflict_outbound_listener_http_over_current_tcp</code></td><td><code>LastValue</code></td><td>Number of conflicting wildcard http listeners with current wildcard tcp listener.</td></tr><tr><td><code>pilot_conflict_outbound_listener_tcp_over_current_http</code></td><td><code>LastValue</code></td><td>Number of conflicting wildcard tcp listeners with current wildcard http listener.</td></tr><tr><td><code>pilot_conflict_outbound_listener_tcp_over_current_tcp</code></td><td><code>LastValue</code></td><td>Number of conflicting tcp listeners with current tcp listener.</td></tr><tr><td><code>pilot_destrule_subsets</code></td><td><code>LastValue</code></td><td>Duplicate subsets across destination rules for same host</td></tr><tr><td><code>pilot_duplicate_envoy_clusters</code></td><td><code>LastValue</code></td><td>Duplicate envoy clusters caused by service entries with same hostname</td></tr><tr><td><code>pilot_eds_no_instances</code></td><td><code>LastValue</code></td><td>Number of clusters without instances.</td></tr><tr><td><code>pilot_endpoint_not_ready</code></td><td><code>LastValue</code></td><td>Endpoint found in unready state.</td></tr><tr><td><code>pilot_inbound_updates</code></td><td><code>Sum</code></td><td>Total number of updates received by pilot.</td></tr><tr><td><code>pilot_invalid_out_listeners</code></td><td><code>LastValue</code></td><td>Number of invalid outbound listeners.</td></tr><tr><td><code>pilot_jwks_resolver_network_fetch_fail_total</code></td><td><code>Sum</code></td><td>Total number of failed network fetch by pilot jwks resolver</td></tr><tr><td><code>pilot_jwks_resolver_network_fetch_success_total</code></td><td><code>Sum</code></td><td>Total number of successfully network fetch by pilot jwks resolver</td></tr><tr><td><code>pilot_k8s_cfg_events</code></td><td><code>Sum</code></td><td>Events from k8s config.</td></tr><tr><td><code>pilot_k8s_object_errors</code></td><td><code>LastValue</code></td><td>Errors converting k8s CRDs</td></tr><tr><td><code>pilot_k8s_reg_events</code></td><td><code>Sum</code></td><td>Events from k8s registry.</td></tr><tr><td><code>pilot_no_ip</code></td><td><code>LastValue</code></td><td>Pods not found in the endpoint table, possibly invalid.</td></tr><tr><td><code>pilot_proxy_convergence_time</code></td><td><code>Distribution</code></td><td>Delay between config change and all proxies converging.</td></tr><tr><td><code>pilot_proxy_queue_time</code></td><td><code>Distribution</code></td><td>Time a proxy is in the push queue before being dequeued.</td></tr><tr><td><code>pilot_rds_expired_nonce</code></td><td><code>Sum</code></td><td>Total number of RDS messages with an expired nonce.</td></tr><tr><td><code>pilot_services</code></td><td><code>LastValue</code></td><td>Total services known to pilot.</td></tr><tr><td><code>pilot_total_rejected_configs</code></td><td><code>Sum</code></td><td>Total number of configs that Pilot had to reject or ignore.</td></tr><tr><td><code>pilot_total_xds_internal_errors</code></td><td><code>Sum</code></td><td>Total number of internal XDS errors in pilot.</td></tr><tr><td><code>pilot_total_xds_rejects</code></td><td><code>Sum</code></td><td>Total number of XDS responses from pilot rejected by proxy.</td></tr><tr><td><code>pilot_virt_services</code></td><td><code>LastValue</code></td><td>Total virtual services known to pilot.</td></tr><tr><td><code>pilot_vservice_dup_domain</code></td><td><code>LastValue</code></td><td>Virtual services with dup domains.</td></tr><tr><td><code>pilot_xds</code></td><td><code>LastValue</code></td><td>Number of endpoints connected to this pilot using XDS.</td></tr><tr><td><code>pilot_xds_cds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected CSD configs.</td></tr><tr><td><code>pilot_xds_eds_instances</code></td><td><code>LastValue</code></td><td>Instances for each cluster, as of last push. Zero instances is an error.</td></tr><tr><td><code>pilot_xds_eds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected EDS.</td></tr><tr><td><code>pilot_xds_lds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected LDS.</td></tr><tr><td><code>pilot_xds_push_context_errors</code></td><td><code>Sum</code></td><td>Number of errors (timeouts) initiating push context.</td></tr><tr><td><code>pilot_xds_push_time</code></td><td><code>Distribution</code></td><td>Total time in second Pilot takes to push lds, rds, cds and eds.</td></tr><tr><td><code>pilot_xds_pushes</code></td><td><code>Sum</code></td><td>Pilot build and send errors for lds, rds, cds and eds.</td></tr><tr><td><code>pilot_xds_rds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected RDS.</td></tr><tr><td><code>pilot_xds_write_timeout</code></td><td><code>Sum</code></td><td>Pilot XDS response write timeouts.</td></tr><tr><td><code>sidecar_injection_failure_total</code></td><td><code>Sum</code></td><td>Total number of failed Side car injection requests.</td></tr><tr><td><code>sidecar_injection_requests_total</code></td><td><code>Sum</code></td><td>Total number of Side car injection requests.</td></tr><tr><td><code>sidecar_injection_skip_total</code></td><td><code>Sum</code></td><td>Total number of skipped injection requests.</td></tr><tr><td><code>sidecar_injection_success_total</code></td><td><code>Sum</code></td><td>Total number of successful Side car injection requests.</td></tr></tbody></table></article><nav class=pagenav><div class=left><a title="Istio Certificate Authority (CA)." href=/v1.3/docs/reference/commands/istio_ca/><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#left-arrow"/></svg>istio_ca</a></div><div class=right><a title="Mixer is Istio's abstraction on top of infrastructure backends." href=/v1.3/docs/reference/commands/mixs/>mixs<svg class="icon"><use xlink:href="/v1.3/img/icons.svg#right-arrow"/></svg></a></div></nav><div id=endnotes-container aria-hidden=true><h2>Links</h2><ol id=endnotes></ol></div></div><div class=toc-container><nav class=toc aria-label="Table of Contents"><div id=toc><ol><li role=none aria-label="istioctl auth"><a href=#istioctl-auth>istioctl auth</a><li role=none aria-label="istioctl authn"><a href=#istioctl-authn>istioctl authn</a><ol><li role=none aria-label=Examples><a href=#istioctl-authn%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl authn tls-check"><a href=#istioctl-authn-tls-check>istioctl authn tls-check</a><ol><li role=none aria-label=Examples><a href=#istioctl-authn-tls-check%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl convert-ingress"><a href=#istioctl-convert-ingress>istioctl convert-ingress</a><ol><li role=none aria-label=Examples><a href=#istioctl-convert-ingress%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard"><a href=#istioctl-dashboard>istioctl dashboard</a><li role=none aria-label="istioctl dashboard controlz"><a href=#istioctl-dashboard-controlz>istioctl dashboard controlz</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-controlz%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard envoy"><a href=#istioctl-dashboard-envoy>istioctl dashboard envoy</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-envoy%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard grafana"><a href=#istioctl-dashboard-grafana>istioctl dashboard grafana</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-grafana%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard jaeger"><a href=#istioctl-dashboard-jaeger>istioctl dashboard jaeger</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-jaeger%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard kiali"><a href=#istioctl-dashboard-kiali>istioctl dashboard kiali</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-kiali%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard prometheus"><a href=#istioctl-dashboard-prometheus>istioctl dashboard prometheus</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-prometheus%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl dashboard zipkin"><a href=#istioctl-dashboard-zipkin>istioctl dashboard zipkin</a><ol><li role=none aria-label=Examples><a href=#istioctl-dashboard-zipkin%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl deregister"><a href=#istioctl-deregister>istioctl deregister</a><ol><li role=none aria-label=Examples><a href=#istioctl-deregister%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental"><a href=#istioctl-experimental>istioctl experimental</a><li role=none aria-label="istioctl experimental add-to-mesh"><a href=#istioctl-experimental-add-to-mesh>istioctl experimental add-to-mesh</a><li role=none aria-label="istioctl experimental add-to-mesh external-service"><a href=#istioctl-experimental-add-to-mesh-external-service>istioctl experimental add-to-mesh external-service</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-add-to-mesh-external-service%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental add-to-mesh service"><a href=#istioctl-experimental-add-to-mesh-service>istioctl experimental add-to-mesh service</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-add-to-mesh-service%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental analyze"><a href=#istioctl-experimental-analyze>istioctl experimental analyze</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-analyze%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental auth"><a href=#istioctl-experimental-auth>istioctl experimental auth</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-auth%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental auth check"><a href=#istioctl-experimental-auth-check>istioctl experimental auth check</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-auth-check%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental auth validate"><a href=#istioctl-experimental-auth-validate>istioctl experimental auth validate</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-auth-validate%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental convert-ingress"><a href=#istioctl-experimental-convert-ingress>istioctl experimental convert-ingress</a><li role=none aria-label="istioctl experimental dashboard"><a href=#istioctl-experimental-dashboard>istioctl experimental dashboard</a><li role=none aria-label="istioctl experimental describe"><a href=#istioctl-experimental-describe>istioctl experimental describe</a><li role=none aria-label="istioctl experimental describe pod"><a href=#istioctl-experimental-describe-pod>istioctl experimental describe pod</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-describe-pod%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental kube-uninject"><a href=#istioctl-experimental-kube-uninject>istioctl experimental kube-uninject</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-kube-uninject%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental manifest"><a href=#istioctl-experimental-manifest>istioctl experimental manifest</a><li role=none aria-label="istioctl experimental manifest apply"><a href=#istioctl-experimental-manifest-apply>istioctl experimental manifest apply</a><li role=none aria-label="istioctl experimental manifest diff"><a href=#istioctl-experimental-manifest-diff>istioctl experimental manifest diff</a><li role=none aria-label="istioctl experimental manifest generate"><a href=#istioctl-experimental-manifest-generate>istioctl experimental manifest generate</a><li role=none aria-label="istioctl experimental manifest migrate"><a href=#istioctl-experimental-manifest-migrate>istioctl experimental manifest migrate</a><li role=none aria-label="istioctl experimental manifest versions"><a href=#istioctl-experimental-manifest-versions>istioctl experimental manifest versions</a><li role=none aria-label="istioctl experimental metrics"><a href=#istioctl-experimental-metrics>istioctl experimental metrics</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-metrics%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental profile"><a href=#istioctl-experimental-profile>istioctl experimental profile</a><li role=none aria-label="istioctl experimental profile diff"><a href=#istioctl-experimental-profile-diff>istioctl experimental profile diff</a><li role=none aria-label="istioctl experimental profile dump"><a href=#istioctl-experimental-profile-dump>istioctl experimental profile dump</a><li role=none aria-label="istioctl experimental profile list"><a href=#istioctl-experimental-profile-list>istioctl experimental profile list</a><li role=none aria-label="istioctl experimental remove-from-mesh"><a href=#istioctl-experimental-remove-from-mesh>istioctl experimental remove-from-mesh</a><li role=none aria-label="istioctl experimental remove-from-mesh external-service"><a href=#istioctl-experimental-remove-from-mesh-external-service>istioctl experimental remove-from-mesh external-service</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-remove-from-mesh-external-service%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl experimental remove-from-mesh service"><a href=#istioctl-experimental-remove-from-mesh-service>istioctl experimental remove-from-mesh service</a><ol><li role=none aria-label=Examples><a href=#istioctl-experimental-remove-from-mesh-service%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl kube-inject"><a href=#istioctl-kube-inject>istioctl kube-inject</a><ol><li role=none aria-label=Examples><a href=#istioctl-kube-inject%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config"><a href=#istioctl-proxy-config>istioctl proxy-config</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config bootstrap"><a href=#istioctl-proxy-config-bootstrap>istioctl proxy-config bootstrap</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-bootstrap%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config cluster"><a href=#istioctl-proxy-config-cluster>istioctl proxy-config cluster</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-cluster%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config endpoint"><a href=#istioctl-proxy-config-endpoint>istioctl proxy-config endpoint</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-endpoint%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config listener"><a href=#istioctl-proxy-config-listener>istioctl proxy-config listener</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-listener%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-config route"><a href=#istioctl-proxy-config-route>istioctl proxy-config route</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-config-route%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl proxy-status"><a href=#istioctl-proxy-status>istioctl proxy-status</a><ol><li role=none aria-label=Examples><a href=#istioctl-proxy-status%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl register"><a href=#istioctl-register>istioctl register</a><li role=none aria-label="istioctl validate"><a href=#istioctl-validate>istioctl validate</a><ol><li role=none aria-label=Examples><a href=#istioctl-validate%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl verify-install"><a href=#istioctl-verify-install>istioctl verify-install</a><ol><li role=none aria-label=Examples><a href=#istioctl-verify-install%20Examples>Examples</a></ol></li><li role=none aria-label="istioctl version"><a href=#istioctl-version>istioctl version</a><li role=none aria-label="Environment variables"><a href=#envvars>Environment variables</a><li role=none aria-label="Exported metrics"><a href=#metrics>Exported metrics</a></ol></div></nav></div></main><footer><div class=user-links><a class=channel title="Go download Istio 1.3.5 now" href=/v1.3/docs/setup#downloading-the-release aria-label="Download Istio"><span>download</span><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#download"/></svg>
|
|
</a><a class=channel title="Join the Istio discussion board to participate in discussions and get help troubleshooting problems" href=https://discuss.istio.io aria-label="Istio discussion board"><span>discuss</span><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#discourse"/></svg></a>
|
|
<a class=channel title="Stack Overflow is where you can ask questions and find curated answers on deploying, configuring, and using Istio" href=https://stackoverflow.com/questions/tagged/istio aria-label="Stack Overflow"><span>stack overflow</span><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#stackoverflow"/></svg></a>
|
|
<a class=channel title="Interactively discuss issues with the Istio community on Slack" href=https://istio.slack.com aria-label=slack><span>slack</span><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#slack"/></svg></a>
|
|
<a class=channel title="Follow us on Twitter to get the latest news" href=https://twitter.com/IstioMesh aria-label=Twitter><span>twitter</span><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#twitter"/></svg></a><div class=tag>for everyone</div></div><div class=info><p class=copyright>Istio Archive
|
|
1.3.5<br>© 2019 Istio Authors, <a href=https://policies.google.com/privacy>Privacy Policy</a><br>Archived on November 14, 2019</p></div><div class=dev-links><a class=channel title="GitHub is where development takes place on Istio code" href=https://github.com/istio/community aria-label=GitHub><span>github</span><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#github"/></svg></a>
|
|
<a class=channel title="Access our team drive if you'd like to take a look at the Istio technical design documents" href=https://groups.google.com/forum/#!forum/istio-team-drive-access aria-label="team drive"><span>drive</span><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#drive"/></svg></a>
|
|
<a class=channel title="If you'd like to contribute to the Istio project, consider participating in our working groups" href=https://github.com/istio/community/blob/master/WORKING-GROUPS.md aria-label="working groups"><span>working groups</span><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#working-groups"/></svg></a><div class=tag>for developers</div></div></footer><div id=scroll-to-top-container aria-hidden=true><button id=scroll-to-top title="Back to top"><svg class="icon"><use xlink:href="/v1.3/img/icons.svg#top"/></svg></button></div></body></html> |