istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
istio.io/archive/v1.12/docs/reference/commands/istioctl/index.html

915 lines
342 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.12/docs/reference/commands/istioctl/"><meta property="og:image" content="https://raw.githubusercontent.com/istio/istio.io/master/static/img/istio-whitelogo-bluebackground-framed.svg"><meta property="og:image:alt" content="Istio Logo"><meta property="og:image:width" content="1024"><meta property="og:image:height" content="1024"><meta property="og:site_name" content="Istio"><meta name=twitter:card content="summary"><meta name=twitter:site content="@IstioMesh"><title>Istioldie 1.12 / 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.12/blog/feed.xml><link rel=alternate type=application/rss+xml title="Istio News" href=/v1.12/news/feed.xml><link rel=alternate type=application/rss+xml title="Istio Blog and News" href=/v1.12/feed.xml><link rel="shortcut icon" href=/v1.12/favicons/favicon.ico><link rel=apple-touch-icon href=/v1.12/favicons/apple-touch-icon-180x180.png sizes=180x180><link rel=icon type=image/png href=/v1.12/favicons/favicon-16x16.png sizes=16x16><link rel=icon type=image/png href=/v1.12/favicons/favicon-32x32.png sizes=32x32><link rel=icon type=image/png href=/v1.12/favicons/android-36x36.png sizes=36x36><link rel=icon type=image/png href=/v1.12/favicons/android-48x48.png sizes=48x48><link rel=icon type=image/png href=/v1.12/favicons/android-72x72.png sizes=72x72><link rel=icon type=image/png href=/v1.12/favicons/android-96x96.png sizes=96xW96><link rel=icon type=image/png href=/v1.12/favicons/android-144x144.png sizes=144x144><link rel=icon type=image/png href=/v1.12/favicons/android-192x192.png sizes=192x192><link rel=mask-icon href=/v1.12/favicons/safari-pinned-tab.svg color=#466bb0><link rel=manifest href=/v1.12/manifest.json><meta name=apple-mobile-web-app-title content="Istio"><meta name=application-name content="Istio"><meta name=msapplication-config content="/browserconfig.xml"><meta name=msapplication-TileColor content="#466BB0"><meta name=theme-color content="#466BB0"><link rel=stylesheet href=/v1.12/css/all.css><link rel=preconnect href=https://fonts.gstatic.com><link rel=stylesheet href="https://fonts.googleapis.com/css2?family=Barlow:ital,wght@0,400;0,500;0,600;0,700;1,400;1,600&display=swap"><script src=/v1.12/js/themes_init.min.js></script></head><body class="language-unknown archive-site"><script>const branchName="release-1.12";const docTitle="istioctl";const iconFile="\/v1.12/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.12/js/all.min.js data-manual defer></script><header class=main-navigation><nav class="main-navigation-wrapper container-l"><div class=main-navigation-header><a id=brand href=/v1.12/><span class=logo><svg xmlns="http://www.w3.org/2000/svg" width="128" height="60" viewBox="0 0 128 60"><path d="M58.434 48.823A.441.441.0 0158.3 48.497V22.583a.444.444.0 01.134-.326.446.446.0 01.327-.134h3.527a.447.447.0 01.325.134.447.447.0 01.134.326v25.914a.443.443.0 01-.134.326.444.444.0 01-.325.134h-3.527a.444.444.0 01-.327-.134z"/><path d="m70.969 48.477a6.556 6.556.0 01-2.818-1.955 4.338 4.338.0 01-1-2.78v-.345a.443.443.0 01.134-.326.444.444.0 01.326-.135h3.374a.444.444.0 01.326.135.445.445.0 01.134.326v.077a2.014 2.014.0 001.054 1.667 4.672 4.672.0 002.664.709 4.446 4.446.0 002.492-.633 1.862 1.862.0 00.958-1.591 1.426 1.426.0 00-.786-1.322 12.7 12.7.0 00-2.549-.939l-1.457-.46a21.526 21.526.0 01-3.3-1.227 6.57 6.57.0 01-2.262-1.783 4.435 4.435.0 01-.92-2.894 5.081 5.081.0 012.109-4.275 8.993 8.993.0 015.558-1.591 10.445 10.445.0 014.1.748 6.3 6.3.0 012.722 2.07 5 5 0 01.958 3.009.441.441.0 01-.134.326.441.441.0 01-.325.134h-3.258a.441.441.0 01-.326-.134.443.443.0 01-.134-.326 1.974 1.974.0 00-.978-1.667 4.647 4.647.0 00-2.665-.671 4.741 4.741.0 00-2.435.556 1.724 1.724.0 00-.938 1.553 1.512 1.512.0 00.9 1.4 15.875 15.875.0 003.01 1.055l.843.229a27.368 27.368.0 013.412 1.246 6.67 6.67.0 012.338 1.763 4.387 4.387.0 01.958 2.933 4.988 4.988.0 01-2.146 4.275 9.543 9.543.0 01-5.712 1.552 11.626 11.626.0 01-4.227-.709z"/><path d="m97.039 32.837a.443.443.0 01-.326.135h-3.911a.169.169.0 00-.191.192v9.239a2.951 2.951.0 00.632 2.108 2.7 2.7.0 002.013.652h1.15a.444.444.0 01.325.134.441.441.0 01.134.326v2.875a.471.471.0 01-.459.5l-1.994.039a8 8 0 01-4.524-1.035q-1.495-1.035-1.533-3.91V33.166A.17.17.0 0088.164 32.974H85.978A.441.441.0 0185.652 32.839.441.441.0 0185.518 32.513V29.83a.441.441.0 01.134-.326.444.444.0 01.326-.135h2.186a.169.169.0 00.191-.192v-4.485a.438.438.0 01.134-.326.44.44.0 01.325-.134h3.336a.443.443.0 01.325.134.442.442.0 01.135.326v4.485a.169.169.0 00.191.192h3.911a.446.446.0 01.326.135.446.446.0 01.134.326v2.683a.446.446.0 01-.133.324z"/><path d="m101.694 25.917a2.645 2.645.0 01-.767-1.955 2.65 2.65.0 01.767-1.955 2.65 2.65.0 011.955-.767 2.65 2.65.0 011.955.767 2.652 2.652.0 01.767 1.955 2.647 2.647.0 01-.767 1.955 2.646 2.646.0 01-1.955.767 2.645 2.645.0 01-1.955-.767zm-.211 22.906a.441.441.0 01-.134-.326V29.79a.444.444.0 01.134-.326.446.446.0 01.326-.134h3.527a.446.446.0 01.326.134.445.445.0 01.134.326v18.707a.443.443.0 01-.134.326.443.443.0 01-.326.134h-3.527a.443.443.0 01-.326-.134z"/><path d="m114.019 47.734a8.1 8.1.0 01-3.047-4.255 14.439 14.439.0 01-.652-4.37 14.3 14.3.0 01.614-4.371 7.869 7.869.0 013.066-4.178 9.072 9.072.0 015.252-1.5 8.543 8.543.0 015.041 1.5 7.985 7.985.0 013.009 4.14 12.439 12.439.0 01.69 4.37 13.793 13.793.0 01-.651 4.37 8.255 8.255.0 01-3.028 4.275 8.475 8.475.0 01-5.1 1.553 8.754 8.754.0 01-5.194-1.534zm7.629-3.1a4.536 4.536.0 001.476-2.262 11.335 11.335.0 00.383-3.221 10.618 10.618.0 00-.383-3.22 4.169 4.169.0 00-1.457-2.243 4.066 4.066.0 00-2.531-.785 3.942 3.942.0 00-2.453.785 4.376 4.376.0 00-1.5 2.243 11.839 11.839.0 00-.383 3.22 11.84 11.84.0 00.383 3.221 4.222 4.222.0 001.476 2.262 4.075 4.075.0 002.549.8 3.8 3.8.0 002.44-.809z"/><path d="m15.105 32.057v15.565a.059.059.0 01-.049.059L.069 50.25A.06.06.0 01.005 50.167l14.987-33.47a.06.06.0 01.114.025z"/><path d="m17.631 23.087v24.6a.06.06.0 00.053.059l22.449 2.507a.06.06.0 00.061-.084L17.745.032a.06.06.0 00-.114.024z"/><path d="m39.961 52.548-24.833 7.45a.062.062.0 01-.043.0L.079 52.548a.059.059.0 01.026-.113h39.839a.06.06.0 01.017.113z"/></svg></span></a><button id=hamburger class=main-navigation-toggle aria-label="Open navigation"><svg class="icon menu-hamburger"><use xlink:href="/v1.12/img/icons.svg#menu-hamburger"/></svg></button>
<button id=menu-close class=main-navigation-toggle aria-label="Close navigation"><svg class="icon menu-close"><use xlink:href="/v1.12/img/icons.svg#menu-close"/></svg></button></div><div id=header-links class=main-navigation-links-wrapper><ul class=main-navigation-links><li class=main-navigation-links-item><a class="main-navigation-links-link has-dropdown"><span>About</span><svg class="icon dropdown-arrow"><use xlink:href="/v1.12/img/icons.svg#dropdown-arrow"/></svg></a><ul class=main-navigation-links-dropdown><li class=main-navigation-links-dropdown-item><a href=/v1.12/about/service-mesh class=main-navigation-links-link>Service mesh</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.12/about/solutions class=main-navigation-links-link>Solutions</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.12/about/case-studies class=main-navigation-links-link>Case studies</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.12/about/ecosystem class=main-navigation-links-link>Ecosystem</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.12/about/deployment class=main-navigation-links-link>Deployment</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.12/about/faq class=main-navigation-links-link>FAQ</a></li></ul></li><li class=main-navigation-links-item><a href=/v1.12/blog/ class=main-navigation-links-link><span>Blog</span></a></li><li class=main-navigation-links-item><a href=/v1.12/news/ class=main-navigation-links-link><span>News</span></a></li><li class=main-navigation-links-item><a href=/v1.12/get-involved/ class=main-navigation-links-link><span>Get involved</span></a></li><li class=main-navigation-links-item><a href=/v1.12/docs/ class=main-navigation-links-link><span>Documentation</span></a></li></ul><div class=main-navigation-footer><button id=search-show class=search-show title="Search this site" aria-label=Search><svg class="icon magnifier"><use xlink:href="/v1.12/img/icons.svg#magnifier"/></svg></button>
<a href=/v1.12/docs/setup/getting-started class="btn btn--primary" id=try-istio>Try Istio</a></div></div><form id=search-form class=search name=cse role=search><input type=hidden name=cx value=002184991200833970123:iwwf17ikgf4>
<input type=hidden name=ie value=utf-8>
<input type=hidden name=hl value=en>
<input type=hidden id=search-page-url value=/search>
<input id=search-textbox class="search-textbox form-control" name=q type=search aria-label="Search this site" placeholder=Search>
<button id=search-close title="Cancel search" type=reset aria-label="Cancel search"><svg class="icon menu-close"><use xlink:href="/v1.12/img/icons.svg#menu-close"/></svg></button></form></nav></header><div class=banner-container><a href=/v1.12/news/releases/1.12.x/announcing-1.12.3/ class=banner data-title="Latest Release-2022-02-11 00:00:00 +0000 UTC" data-period-start=1644537600000 data-period-end=1645142400000 data-max-impressions=3 data-timeout><div class=content><p>Istio 1.12.3 is now available! Click here to learn more</p></div><div class=frame></div></a></div><main class="primary container has-sidebar has-toc docs"><div id=sidebar-container class=sidebar-container><nav id=sidebar aria-label="Section Navigation"><button id=sidebar-close class="main-navigation-toggle sidebar-close" aria-label="Close sidebar"><svg class="icon menu-close"><use xlink:href="/v1.12/img/icons.svg#menu-close"/></svg></button><div class=sidebar-nav><div class=search><form id=search-docs-form name=cse role=search><input type=hidden name=ie value=utf-8>
<input type=hidden name=hl value=en>
<input type=hidden id=search-docs-url value=/v1.12/search>
<input id=search-docs-textbox class=form-control name=docs-search type=search aria-label="Search this site" placeholder=Search>
<button id=search-show2 class=search-show title="Search this site" aria-label=Search><svg class="icon magnifier"><use xlink:href="/v1.12/img/icons.svg#magnifier"/></svg></button></form></div><div class=card><div class="body default" aria-labelledby=header0><ul role=tree aria-expanded=true aria-labelledby=header0><li role=treeitem aria-label=Concepts><a class=main title="Learn about the different parts of the Istio system and the abstractions it uses." href=/v1.12/docs/concepts/>Concepts</a><ul role=group aria-expanded=true class=leaf-section><li role=none><a role=treeitem title="Describes the various Istio features focused on traffic routing and control." href=/v1.12/docs/concepts/traffic-management/>Traffic Management</a></li><li role=none><a role=treeitem title="Describes Istio's authorization and authentication functionality." href=/v1.12/docs/concepts/security/>Security</a></li><li role=none><a role=treeitem title="Describes the telemetry and monitoring features provided by Istio." href=/v1.12/docs/concepts/observability/>Observability</a></li><li role=none><a role=treeitem title="Describes Istio's WebAssembly Plugin system." href=/v1.12/docs/concepts/wasm/>Extensibility</a></li></ul></li><li role=treeitem aria-label=Setup><a class=main title="Instructions for installing the Istio control plane on Kubernetes." href=/v1.12/docs/setup/>Setup</a><ul role=group aria-expanded=true><li role=none><a role=treeitem title="Try Istio’s features quickly and easily." href=/v1.12/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.12/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.12/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.12/docs/setup/platform-setup/azure/>Azure</a></li><li role=none><a role=treeitem title="Instructions to setup Docker Desktop for Istio." href=/v1.12/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.12/docs/setup/platform-setup/gke/>Google Kubernetes Engine</a></li><li role=none><a role=treeitem title="Instructions to setup an Huawei Cloud kubernetes cluster for Istio." href=/v1.12/docs/setup/platform-setup/huaweicloud/>Huawei Cloud</a></li><li role=none><a role=treeitem title="Instructions to setup an IBM Cloud cluster for Istio." href=/v1.12/docs/setup/platform-setup/ibm/>IBM Cloud</a></li><li role=none><a role=treeitem title="Instructions to setup kind for Istio." href=/v1.12/docs/setup/platform-setup/kind/>kind</a></li><li role=none><a role=treeitem title="Instructions to setup Kops for use with Istio." href=/v1.12/docs/setup/platform-setup/kops/>Kops</a></li><li role=none><a role=treeitem title="Instructions to setup a Gardener cluster for Istio." href=/v1.12/docs/setup/platform-setup/gardener/>Kubernetes Gardener</a></li><li role=none><a role=treeitem title="Instructions to setup a KubeSphere Container Platform for Istio." href=/v1.12/docs/setup/platform-setup/kubesphere/>KubeSphere Container Platform</a></li><li role=none><a role=treeitem title="Instructions to setup MicroK8s for use with Istio." href=/v1.12/docs/setup/platform-setup/microk8s/>MicroK8s</a></li><li role=none><a role=treeitem title="Instructions to setup minikube for Istio." href=/v1.12/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.12/docs/setup/platform-setup/openshift/>OpenShift</a></li><li role=none><a role=treeitem title="Instructions to prepare a cluster for Istio using Oracle Container Engine for Kubernetes (OKE)." href=/v1.12/docs/setup/platform-setup/oci/>Oracle Cloud Infrastructure</a></li><li role=none><a role=treeitem title="Instructions to setup Istio quickly in Tencent Cloud." href=/v1.12/docs/setup/platform-setup/tencent-cloud-mesh/>Tencent Cloud</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.12/docs/setup/install/>Install</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Install and customize any Istio configuration profile for in-depth evaluation or production use." href=/v1.12/docs/setup/install/istioctl/>Install with Istioctl</a></li><li role=none><a role=treeitem title="Install and configure Istio for in-depth evaluation." href=/v1.12/docs/setup/install/helm/>Install with Helm</a></li><li role=treeitem aria-label="Install Multicluster"><button aria-hidden=true></button><a title="Install an Istio mesh across multiple Kubernetes clusters." href=/v1.12/docs/setup/install/multicluster/>Install Multicluster</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Initial steps before installing Istio on multiple clusters." href=/v1.12/docs/setup/install/multicluster/before-you-begin/>Before you begin</a></li><li role=none><a role=treeitem title="Install an Istio mesh across multiple primary clusters." href=/v1.12/docs/setup/install/multicluster/multi-primary/>Install Multi-Primary</a></li><li role=none><a role=treeitem title="Install an Istio mesh across primary and remote clusters." href=/v1.12/docs/setup/install/multicluster/primary-remote/>Install Primary-Remote</a></li><li role=none><a role=treeitem title="Install an Istio mesh across multiple primary clusters on different networks." href=/v1.12/docs/setup/install/multicluster/multi-primary_multi-network/>Install Multi-Primary on different networks</a></li><li role=none><a role=treeitem title="Install an Istio mesh across primary and remote clusters on different networks." href=/v1.12/docs/setup/install/multicluster/primary-remote_multi-network/>Install Primary-Remote on different networks</a></li><li role=none><a role=treeitem title="Verify that Istio has been installed properly on multiple clusters." href=/v1.12/docs/setup/install/multicluster/verify/>Verify the installation</a></li></ul></li><li role=none><a role=treeitem title="Install Istio with an external control plane and a remote cluster data plane." href=/v1.12/docs/setup/install/external-controlplane/>Install Istio with an External Control Plane</a></li><li role=none><a role=treeitem title="Deploy Istio and connect a workload running within a virtual machine to it." href=/v1.12/docs/setup/install/virtual-machine/>Virtual Machine Installation</a></li><li role=none><a role=treeitem title="Instructions to install Istio in a Kubernetes cluster using the Istio operator (Beta)" href=/v1.12/docs/setup/install/operator/>Istio Operator Install *</a></li></ul></li><li role=treeitem aria-label=Upgrade><button aria-hidden=true></button><a title="Upgrade, downgrade, and manage Istio accross multiple control plane revisions." href=/v1.12/docs/setup/upgrade/>Upgrade</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Upgrade Istio by first running a canary deployment of a new control plane." href=/v1.12/docs/setup/upgrade/canary/>Canary Upgrades</a></li><li role=none><a role=treeitem title="Upgrade or downgrade Istio in place." href=/v1.12/docs/setup/upgrade/in-place/>In-place Upgrades</a></li><li role=none><a role=treeitem title="Upgrade and configure Istio for in-depth evaluation." href=/v1.12/docs/setup/upgrade/helm/>Upgrade with Helm</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.12/docs/setup/additional-setup/>More Guides</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes the built-in Istio installation configuration profiles." href=/v1.12/docs/setup/additional-setup/config-profiles/>Installation Configuration Profiles</a></li><li role=none><a role=treeitem title="Install and customize Istio Gateways." href=/v1.12/docs/setup/additional-setup/gateway/>Installing Gateways</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.12/docs/setup/additional-setup/sidecar-injection/>Installing the Sidecar</a></li><li role=none><a role=treeitem title="Describes how to customize installation configuration options." href=/v1.12/docs/setup/additional-setup/customize-installation/>Customizing the installation configuration</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.12/docs/setup/additional-setup/cni/>Install Istio with the Istio CNI plugin</a></li></ul></li></ul></li><li role=treeitem aria-label=Tasks><a class=main title="How to do single specific targeted activities with the Istio system." href=/v1.12/docs/tasks/>Tasks</a><ul role=group aria-expanded=true><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true></button><a title="Tasks that demonstrate Istio's traffic routing features." href=/v1.12/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.12/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.12/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.12/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.12/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.12/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.12/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.12/docs/tasks/traffic-management/mirroring/>Mirroring</a></li><li role=treeitem aria-label="Locality Load Balancing"><button aria-hidden=true></button><a title="This series of tasks demonstrate how to configure locality load balancing in Istio." href=/v1.12/docs/tasks/traffic-management/locality-load-balancing/>Locality Load Balancing</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Initial steps before configuring locality load balancing." href=/v1.12/docs/tasks/traffic-management/locality-load-balancing/before-you-begin/>Before you begin</a></li><li role=none><a role=treeitem title="This task demonstrates how to configure your mesh for locality failover." href=/v1.12/docs/tasks/traffic-management/locality-load-balancing/failover/>Locality failover</a></li><li role=none><a role=treeitem title="This guide demonstrates how to configure locality distribution." href=/v1.12/docs/tasks/traffic-management/locality-load-balancing/distribute/>Locality weighted distribution</a></li><li role=none><a role=treeitem title="Cleanup steps for locality load balancing." href=/v1.12/docs/tasks/traffic-management/locality-load-balancing/cleanup/>Cleanup</a></li></ul></li><li role=treeitem aria-label=Ingress><button aria-hidden=true></button><a title="Controlling ingress traffic for an Istio service mesh." href=/v1.12/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.12/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." href=/v1.12/docs/tasks/traffic-management/ingress/secure-ingress/>Secure Gateways</a></li><li role=none><a role=treeitem title="Describes how to configure SNI passthrough for an ingress gateway." href=/v1.12/docs/tasks/traffic-management/ingress/ingress-sni-passthrough/>Ingress Gateway without TLS Termination</a></li><li role=none><a role=treeitem title="Describes how to configure a Kubernetes Ingress object to expose a service outside of the service mesh." href=/v1.12/docs/tasks/traffic-management/ingress/kubernetes-ingress/>Kubernetes Ingress</a></li><li role=none><a role=treeitem title="Describes how to configure the Kubernetes Gateway API with Istio." href=/v1.12/docs/tasks/traffic-management/ingress/gateway-api/>Kubernetes Gateway API</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.12/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.12/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.12/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.12/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.12/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.12/docs/tasks/traffic-management/egress/wildcard-egress-hosts/>Egress using Wildcard Hosts</a></li><li role=none><a role=treeitem title="Shows how to configure Istio for Kubernetes External Services." href=/v1.12/docs/tasks/traffic-management/egress/egress-kubernetes-services/>Kubernetes Services for Egress Traffic</a></li><li role=none><a role=treeitem title="Describes how to configure Istio to let applications use an external HTTPS proxy." href=/v1.12/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.12/docs/tasks/security/>Security</a><ul role=group aria-expanded=false><li role=treeitem aria-label="Certificate Management"><button aria-hidden=true></button><a title="Management of the certificates in Istio." href=/v1.12/docs/tasks/security/cert-management/>Certificate Management</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Shows how system administrators can configure Istio's CA with a root certificate, signing certificate and key." href=/v1.12/docs/tasks/security/cert-management/plugin-ca-cert/>Plug in CA Certificates</a></li><li role=none><a role=treeitem title="Shows how to provision and manage DNS certificates in Istio." href=/v1.12/docs/tasks/security/cert-management/dns-cert/>Istio DNS Certificate Management</a></li><li role=none><a role=treeitem title="Shows how to use a Custom Certificate Authority (that integrates with the Kubernetes CSR API) to provision Istio workload certificates (Experimental)" href=/v1.12/docs/tasks/security/cert-management/custom-ca-k8s/>Custom CA Integration using Kubernetes CSR *</a></li></ul></li><li role=treeitem aria-label=Authentication><button aria-hidden=true></button><a title="Controlling mutual TLS and end-user authentication for mesh services." href=/v1.12/docs/tasks/security/authentication/>Authentication</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.12/docs/tasks/security/authentication/authn-policy/>Authentication Policy</a></li><li role=none><a role=treeitem title="Shows you how to use Istio authentication policy to route requests based on JWT claims (Experimental)" href=/v1.12/docs/tasks/security/authentication/jwt-route/>JWT claim based routing *</a></li><li role=none><a role=treeitem title="Shows you how to incrementally migrate your Istio services to mutual TLS." href=/v1.12/docs/tasks/security/authentication/mtls-migration/>Mutual TLS Migration</a></li></ul></li><li role=treeitem aria-label=Authorization><button aria-hidden=true></button><a title="Shows how to control access to Istio services." href=/v1.12/docs/tasks/security/authorization/>Authorization</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Shows how to set up access control for HTTP traffic." href=/v1.12/docs/tasks/security/authorization/authz-http/>HTTP Traffic</a></li><li role=none><a role=treeitem title="Shows how to set up access control for TCP traffic." href=/v1.12/docs/tasks/security/authorization/authz-tcp/>TCP Traffic</a></li><li role=none><a role=treeitem title="Shows how to set up access control for JWT token." href=/v1.12/docs/tasks/security/authorization/authz-jwt/>JWT Token</a></li><li role=none><a role=treeitem title="Shows how to integrate and delegate access control to an external authorization system." href=/v1.12/docs/tasks/security/authorization/authz-custom/>External Authorization</a></li><li role=none><a role=treeitem title="Shows how to set up access control to deny traffic explicitly." href=/v1.12/docs/tasks/security/authorization/authz-deny/>Explicit Deny</a></li><li role=none><a role=treeitem title="Shows how to set up access control on an ingress gateway." href=/v1.12/docs/tasks/security/authorization/authz-ingress/>Ingress Gateway</a></li><li role=none><a role=treeitem title="Shows how to migrate from one trust domain to another without changing authorization policy." href=/v1.12/docs/tasks/security/authorization/authz-td-migration/>Trust Domain Migration</a></li><li role=none><a role=treeitem title="Shows how to dry-run an authorization policy without enforcing it (Experimental)" href=/v1.12/docs/tasks/security/authorization/authz-dry-run/>Dry Run *</a></li></ul></li></ul></li><li role=treeitem aria-label="Policy Enforcement"><button aria-hidden=true></button><a title="Demonstrates policy enforcement features." href=/v1.12/docs/tasks/policy-enforcement/>Policy Enforcement</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 dynamically limit the traffic to a service." href=/v1.12/docs/tasks/policy-enforcement/rate-limit/>Enabling Rate Limits using Envoy</a></li></ul></li><li role=treeitem aria-label=Observability><button aria-hidden=true></button><a title="Demonstrates how to collect telemetry information from the mesh." href=/v1.12/docs/tasks/observability/>Observability</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="This task shows you how to configure the Telemetry API." href=/v1.12/docs/tasks/observability/telemetry/>Telemetry API</a></li><li role=treeitem aria-label=Metrics><button aria-hidden=true></button><a title="Demonstrates the collection and querying of metrics within Istio." href=/v1.12/docs/tasks/observability/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 metrics for TCP services." href=/v1.12/docs/tasks/observability/metrics/tcp-metrics/>Collecting Metrics for TCP Services</a></li><li role=none><a role=treeitem title="This task shows you how to customize the Istio metrics." href=/v1.12/docs/tasks/observability/metrics/customize-metrics/>Customizing Istio Metrics</a></li><li role=none><a role=treeitem title="This task shows you how to improve telemetry by grouping requests and responses by their type." href=/v1.12/docs/tasks/observability/metrics/classify-metrics/>Classifying Metrics Based on Request or Response</a></li><li role=none><a role=treeitem title="This task shows you how to query for Istio Metrics using Prometheus." href=/v1.12/docs/tasks/observability/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.12/docs/tasks/observability/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 collection of logs within Istio." href=/v1.12/docs/tasks/observability/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 Envoy proxies to print access logs to their standard output." href=/v1.12/docs/tasks/observability/logs/access-log/>Envoy Access Logs</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.12/docs/tasks/observability/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.12/docs/tasks/observability/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.12/docs/tasks/observability/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.12/docs/tasks/observability/distributed-tracing/zipkin/>Zipkin</a></li><li role=none><a role=treeitem title="How to configure tracing options using MeshConfig and pod annotations (Beta/Experimental)" href=/v1.12/docs/tasks/observability/distributed-tracing/mesh-and-proxy-config/>Configure tracing using MeshConfig and Pod annotations *</a></li><li role=none><a role=treeitem title="How to configure the proxies to send tracing requests to Lightstep." href=/v1.12/docs/tasks/observability/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.12/docs/tasks/observability/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.12/docs/tasks/observability/gateways/>Remotely Accessing Telemetry Addons</a></li></ul></li></ul></li><li role=treeitem aria-label=Examples><a class=main title="A variety of fully working example uses for Istio that you can experiment with." href=/v1.12/docs/examples/>Examples</a><ul role=group aria-expanded=true><li role=none><a role=treeitem title="Deploys a sample application composed of four separate microservices used to demonstrate various Istio features." href=/v1.12/docs/examples/bookinfo/>Bookinfo Application</a></li><li role=none><a role=treeitem title="Run the Bookinfo application with a MySQL service running on a virtual machine within your mesh." href=/v1.12/docs/examples/virtual-machines/>Bookinfo with a Virtual Machine</a></li><li role=treeitem aria-label="Learn Microservices using Kubernetes and Istio"><button aria-hidden=true></button><a title="This modular tutorial provides new users with hands-on experience using Istio for common microservices scenarios, one step at a time." href=/v1.12/docs/examples/microservices-istio/>Learn Microservices using Kubernetes and Istio</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/prereq/>Prerequisites</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/setup-kubernetes-cluster/>Setup a Kubernetes Cluster</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/setup-local-computer/>Setup a Local Computer</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/single/>Run a Microservice Locally</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/package-service/>Run ratings in Docker</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/bookinfo-kubernetes/>Run Bookinfo with Kubernetes</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/production-testing/>Test in production</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/add-new-microservice-version/>Add a new version of reviews</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/add-istio/>Enable Istio on productpage</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/enable-istio-all-microservices/>Enable Istio on all the microservices</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/istio-ingress-gateway/>Configure Istio Ingress Gateway</a></li><li role=none><a role=treeitem href=/v1.12/docs/examples/microservices-istio/logs-istio/>Monitoring with Istio</a></li></ul></li></ul></li><li role=treeitem aria-label=Operations><a class=main title="Concepts, tools, and techniques to deploy and manage an Istio mesh." href=/v1.12/docs/ops/>Operations</a><ul role=group aria-expanded=true><li role=treeitem aria-label=Deployment><button aria-hidden=true></button><a title="Requirements, concepts, and considerations for setting up an Istio deployment." href=/v1.12/docs/ops/deployment/>Deployment</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes Istio's high-level architecture and design goals." href=/v1.12/docs/ops/deployment/architecture/>Architecture</a></li><li role=none><a role=treeitem title="Describes the options and considerations when configuring your Istio deployment." href=/v1.12/docs/ops/deployment/deployment-models/>Deployment Models</a></li><li role=none><a role=treeitem title="Describes Istio's high-level architecture for virtual machines." href=/v1.12/docs/ops/deployment/vm-architecture/>Virtual Machine Architecture</a></li><li role=none><a role=treeitem title="Istio performance and scalability summary." href=/v1.12/docs/ops/deployment/performance-and-scalability/>Performance and Scalability</a></li><li role=none><a role=treeitem title="Requirements of applications deployed in an Istio-enabled cluster." href=/v1.12/docs/ops/deployment/requirements/>Application Requirements</a></li></ul></li><li role=treeitem aria-label=Configuration><button aria-hidden=true></button><a title="Advanced concepts and features for configuring a running Istio mesh." href=/v1.12/docs/ops/configuration/>Configuration</a><ul role=group aria-expanded=false><li role=treeitem aria-label="Mesh Configuration"><button aria-hidden=true></button><a title="Helps you manage the global mesh configuration." href=/v1.12/docs/ops/configuration/mesh/>Mesh Configuration</a><ul role=group aria-expanded=false class=leaf-section><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.12/docs/ops/configuration/mesh/webhook/>Dynamic Admission Webhooks Overview</a></li><li role=none><a role=treeitem title="Describes how to wait until a resource reaches a given status of readiness." href=/v1.12/docs/ops/configuration/mesh/config-resource-ready/>Wait on Resource Status for Applied Configuration</a></li><li role=none><a role=treeitem title="Describes Istio's use of Kubernetes webhooks for automatic sidecar injection." href=/v1.12/docs/ops/configuration/mesh/injection-concepts/>Automatic Sidecar Injection</a></li><li role=none><a role=treeitem title="Shows how to do health checking for Istio services." href=/v1.12/docs/ops/configuration/mesh/app-health-check/>Health Checking of Istio Services</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.12/docs/ops/configuration/traffic-management/>Traffic Management</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Information on how to specify protocols." href=/v1.12/docs/ops/configuration/traffic-management/protocol-selection/>Protocol Selection</a></li><li role=none><a role=treeitem title="How to configure TLS settings to secure network traffic." href=/v1.12/docs/ops/configuration/traffic-management/tls-configuration/>TLS Configuration</a></li><li role=none><a role=treeitem title="How Istio routes traffic through the mesh." href=/v1.12/docs/ops/configuration/traffic-management/traffic-routing/>Traffic Routing</a></li><li role=none><a role=treeitem title="How to configure gateway network topology (Alpha)" href=/v1.12/docs/ops/configuration/traffic-management/network-topologies/>Configuring Gateway Network Topology *</a></li><li role=none><a role=treeitem title="How to configure DNS proxying." href=/v1.12/docs/ops/configuration/traffic-management/dns-proxy/>DNS Proxying</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.12/docs/ops/configuration/security/>Security</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Shows common examples of using Istio security policy." href=/v1.12/docs/ops/configuration/security/security-policy-examples/>Security policy examples</a></li><li role=none><a role=treeitem title="Use hardened container images to reduce Istio's attack surface." href=/v1.12/docs/ops/configuration/security/harden-docker-images/>Harden Docker Container Images</a></li></ul></li><li role=treeitem aria-label=Observability><button aria-hidden=true></button><a title="Helps you manage telemetry collection and visualization in a running mesh." href=/v1.12/docs/ops/configuration/telemetry/>Observability</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Fine-grained control of Envoy statistics." href=/v1.12/docs/ops/configuration/telemetry/envoy-stats/>Envoy Statistics</a></li><li role=none><a role=treeitem title="Configure Prometheus to monitor multicluster Istio." href=/v1.12/docs/ops/configuration/telemetry/monitoring-multicluster-prometheus/>Monitoring Multicluster Istio with Prometheus</a></li></ul></li><li role=treeitem aria-label=Extensibility><button aria-hidden=true></button><a title="Helps you manage extensions to the service mesh." href=/v1.12/docs/ops/configuration/extensibility/>Extensibility</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes how to make remote WebAssembly modules available in the mesh (Alpha)" href=/v1.12/docs/ops/configuration/extensibility/wasm-module-distribution/>Distributing WebAssembly Modules *</a></li></ul></li></ul></li><li role=treeitem aria-label="Best Practices"><button aria-hidden=true></button><a title="Best practices for setting up and managing an Istio service mesh." href=/v1.12/docs/ops/best-practices/>Best Practices</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="General best practices when setting up an Istio service mesh." href=/v1.12/docs/ops/best-practices/deployment/>Deployment Best Practices</a></li><li role=none><a role=treeitem title="Configuration best practices to avoid networking or traffic management issues." href=/v1.12/docs/ops/best-practices/traffic-management/>Traffic Management Best Practices</a></li><li role=none><a role=treeitem title="Best practices for securing applications using Istio." href=/v1.12/docs/ops/best-practices/security/>Security Best Practices</a></li><li role=none><a role=treeitem title="Best practices for observing applications using Istio." href=/v1.12/docs/ops/best-practices/observability/>Observability Best Practices</a></li></ul></li><li role=treeitem aria-label="Common Problems"><button aria-hidden=true></button><a title="Describes how to identify and resolve common problems in Istio." href=/v1.12/docs/ops/common-problems/>Common Problems</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Techniques to address common Istio traffic management and network problems." href=/v1.12/docs/ops/common-problems/network-issues/>Traffic Management Problems</a></li><li role=none><a role=treeitem title="Techniques to address common Istio authentication, authorization, and general security-related problems." href=/v1.12/docs/ops/common-problems/security-issues/>Security Problems</a></li><li role=none><a role=treeitem title="Dealing with telemetry collection issues." href=/v1.12/docs/ops/common-problems/observability-issues/>Observability 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.12/docs/ops/common-problems/injection/>Sidecar Injection Problems</a></li><li role=none><a role=treeitem title="Describes how to resolve configuration validation problems." href=/v1.12/docs/ops/common-problems/validation/>Configuration Validation Problems</a></li></ul></li><li role=treeitem aria-label="Diagnostic Tools"><button aria-hidden=true></button><a title="Tools and techniques to help troubleshoot an Istio mesh." href=/v1.12/docs/ops/diagnostic-tools/>Diagnostic Tools</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.12/docs/ops/diagnostic-tools/istioctl/>Using the Istioctl Command-line Tool</a></li><li role=none><a role=treeitem title="Describes tools and techniques to diagnose Envoy configuration issues related to traffic management." href=/v1.12/docs/ops/diagnostic-tools/proxy-cmd/>Debugging Envoy and Istiod</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.12/docs/ops/diagnostic-tools/istioctl-describe/>Understand your Mesh with Istioctl Describe</a></li><li role=none><a role=treeitem title="Shows you how to use istioctl analyze to identify potential issues with your configuration." href=/v1.12/docs/ops/diagnostic-tools/istioctl-analyze/>Diagnose your Configuration with Istioctl Analyze</a></li><li role=none><a role=treeitem title="Describes how to use ControlZ to get insight into a running istiod component." href=/v1.12/docs/ops/diagnostic-tools/controlz/>Istiod Introspection</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.12/docs/ops/diagnostic-tools/component-logging/>Component Logging</a></li><li role=none><a role=treeitem title="Describes tools and techniques to diagnose issues with Virtual Machines." href=/v1.12/docs/ops/diagnostic-tools/virtual-machines/>Debugging Virtual Machines</a></li><li role=none><a role=treeitem title="Describes tools and techniques to diagnose issues with multicluster and multi-network installations." href=/v1.12/docs/ops/diagnostic-tools/multicluster/>Troubleshooting Multicluster</a></li><li role=none><a role=treeitem title="Describes tools and techniques to diagnose issues using Istio with the CNI plugin." href=/v1.12/docs/ops/diagnostic-tools/cni/>Troubleshooting the Istio CNI plugin</a></li></ul></li><li role=treeitem aria-label=Integrations><button aria-hidden=true></button><a title="Other software that Istio can integrate with to provide additional functionality." href=/v1.12/docs/ops/integrations/>Integrations</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Information on how to integrate with cert-manager." href=/v1.12/docs/ops/integrations/certmanager/>cert-manager</a></li><li role=none><a role=treeitem title="Information on how to integrate with Grafana to set up Istio dashboards." href=/v1.12/docs/ops/integrations/grafana/>Grafana</a></li><li role=none><a role=treeitem title="How to integrate with Jaeger." href=/v1.12/docs/ops/integrations/jaeger/>Jaeger</a></li><li role=none><a role=treeitem title="Information on how to integrate with Kiali." href=/v1.12/docs/ops/integrations/kiali/>Kiali</a></li><li role=none><a role=treeitem title="How to integrate with Prometheus." href=/v1.12/docs/ops/integrations/prometheus/>Prometheus</a></li><li role=none><a role=treeitem title="How to integrate with Zipkin." href=/v1.12/docs/ops/integrations/zipkin/>Zipkin</a></li></ul></li></ul></li><li role=treeitem aria-label=Releases><a class=main title="Information relating to Istio releases." href=/v1.12/docs/releases/>Releases</a><ul role=group aria-expanded=true><li role=none><a role=treeitem title="List of features and their release stages." href=/v1.12/docs/releases/feature-stages/>Feature Status</a></li><li role=none><a role=treeitem title="What to do if you find a bug." href=/v1.12/docs/releases/bugs/>Reporting Bugs</a></li><li role=none><a role=treeitem title="How we handle security vulnerabilities." href=/v1.12/docs/releases/security-vulnerabilities/>Security Vulnerabilities</a></li><li role=none><a role=treeitem title="The currently supported Istio releases." href=/v1.12/docs/releases/supported-releases/>Supported Releases</a></li><li role=treeitem aria-label="Contribute Documentation"><button aria-hidden=true></button><a title="Details how to create and maintain Istio documentation pages." href=/v1.12/docs/releases/contribute/>Contribute Documentation</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Shows you how to use GitHub to contribute to the Istio documentation." href=/v1.12/docs/releases/contribute/github/>Work with GitHub</a></li><li role=none><a role=treeitem title="Details how to contribute new documentation to Istio." href=/v1.12/docs/releases/contribute/add-content/>Add New Documentation</a></li><li role=none><a role=treeitem title="Details how to contribute retired documentation to Istio." href=/v1.12/docs/releases/contribute/remove-content/>Remove Retired Documentation</a></li><li role=none><a role=treeitem title="Explains how to locally build, test, serve, and preview the website." href=/v1.12/docs/releases/contribute/build/>Build and serve the website locally</a></li><li role=none><a role=treeitem title="Explains the front matter used in our documentation and the fields available." href=/v1.12/docs/releases/contribute/front-matter/>Front matter</a></li><li role=none><a role=treeitem title="Shows you how changes to the Istio documentation and website are reviewed and approved." href=/v1.12/docs/releases/contribute/review/>Documentation Review Process</a></li><li role=none><a role=treeitem title="Explains how to include code in your documentation." href=/v1.12/docs/releases/contribute/code-blocks/>Add Code Blocks</a></li><li role=none><a role=treeitem title="Explains the shortcodes available and how to use them." href=/v1.12/docs/releases/contribute/shortcodes/>Use Shortcodes</a></li><li role=none><a role=treeitem title="Explains the standard markup used to format Istio documentation." href=/v1.12/docs/releases/contribute/formatting/>Follow Formatting Standards</a></li><li role=none><a role=treeitem title="Explains the style conventions used in the Istio documentation." href=/v1.12/docs/releases/contribute/style-guide/>Style Guide</a></li><li role=none><a role=treeitem title="Explains the terminology standards used in the Istio documentation." href=/v1.12/docs/releases/contribute/terminology/>Terminology Standards</a></li><li role=none><a role=treeitem title="Provides assets and instructions to create diagrams for the Istio documentation." href=/v1.12/docs/releases/contribute/diagrams/>Diagram Creation Guidelines</a></li></ul></li><li role=none><a role=treeitem title="List of recent changes to this website." href=/v1.12/docs/releases/log/>Website Content Changes</a></li></ul></li><li role=treeitem aria-label=Reference><a class=main title="Detailed authoritative reference material such as command-line options, configuration options, and API calling parameters." href=/v1.12/docs/reference/>Reference</a><ul role=group aria-expanded=true><li role=treeitem aria-label=Configuration><button aria-hidden=true></button><a title="Detailed information on configuration options." href=/v1.12/docs/reference/config/>Configuration</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Telemetry configuration for workloads." href=/v1.12/docs/reference/config/telemetry/>Telemetry</a></li><li role=none><a role=treeitem title="Configuration affecting Istio control plane installation version and shape." href=/v1.12/docs/reference/config/istio.operator.v1alpha1/>IstioOperator Options</a></li><li role=none><a role=treeitem title="Configuration affecting the service mesh as a whole." href=/v1.12/docs/reference/config/istio.mesh.v1alpha1/>Global Mesh Options</a></li><li role=none><a role=treeitem title="Describes the structure of messages generated by Istio analyzers." href=/v1.12/docs/reference/config/istio.analysis.v1alpha1/>Analysis Messages</a></li><li role=none><a role=treeitem title="Describes the role of the `status` field in configuration workflow." href=/v1.12/docs/reference/config/config-status/>Configuration Status Field</a></li><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true></button><a title="Describes how to configure HTTP/TCP routing features." href=/v1.12/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.12/docs/reference/config/networking/destination-rule/>Destination Rule</a></li><li role=none><a role=treeitem title="Customizing Envoy configuration generated by Istio." href=/v1.12/docs/reference/config/networking/envoy-filter/>Envoy Filter</a></li><li role=none><a role=treeitem title="Configuration affecting edge load balancer." href=/v1.12/docs/reference/config/networking/gateway/>Gateway</a></li><li role=none><a role=treeitem title="Configuration affecting VMs onboarded into the mesh." href=/v1.12/docs/reference/config/networking/workload-entry/>Workload Entry</a></li><li role=none><a role=treeitem title="Configuration affecting service registry." href=/v1.12/docs/reference/config/networking/service-entry/>Service Entry</a></li><li role=none><a role=treeitem title="Configuration affecting network reachability of a sidecar." href=/v1.12/docs/reference/config/networking/sidecar/>Sidecar</a></li><li role=none><a role=treeitem title="Configuration affecting label/content routing, sni routing, etc." href=/v1.12/docs/reference/config/networking/virtual-service/>Virtual Service</a></li><li role=none><a role=treeitem title="Describes a collection of workload instances." href=/v1.12/docs/reference/config/networking/workload-group/>Workload Group</a></li></ul></li><li role=treeitem aria-label="Proxy Extensions"><button aria-hidden=true></button><a title="Describes how to configure Istio proxy extensions." href=/v1.12/docs/reference/config/proxy_extensions/>Proxy Extensions</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Extend the functionality provided by the Istio proxy through WebAssembly filters." href=/v1.12/docs/reference/config/proxy_extensions/wasm-plugin/>Wasm Plugin</a></li><li role=none><a role=treeitem title="Configuration for Metadata Exchange Filter." href=/v1.12/docs/reference/config/proxy_extensions/metadata_exchange/>Metadata Exchange Config</a></li><li role=none><a role=treeitem title="Configuration for Stackdriver filter." href=/v1.12/docs/reference/config/proxy_extensions/stackdriver/>Stackdriver Config</a></li><li role=none><a role=treeitem title="Configuration for Stats Filter." href=/v1.12/docs/reference/config/proxy_extensions/stats/>Stats Config</a></li><li role=none><a role=treeitem title="Configuration for AccessLogPolicy Filter." href=/v1.12/docs/reference/config/proxy_extensions/accesslogpolicy/>AccessLogPolicy Config</a></li><li role=none><a role=treeitem title="Configuration for Attribute Generation plugin." href=/v1.12/docs/reference/config/proxy_extensions/attributegen/>AttributeGen Config</a></li><li role=none><a role=treeitem title="How to enable telemetry generation with the Wasm runtime (Experimental)" href=/v1.12/docs/reference/config/proxy_extensions/wasm_telemetry/>Wasm-based Telemetry *</a></li></ul></li><li role=treeitem aria-label=Security><button aria-hidden=true></button><a title="Describes how to configure Istio's security features." href=/v1.12/docs/reference/config/security/>Security</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Configuration to validate JWT." href=/v1.12/docs/reference/config/security/jwt/>JWTRule</a></li><li role=none><a role=treeitem title="Peer authentication configuration for workloads." href=/v1.12/docs/reference/config/security/peer_authentication/>PeerAuthentication</a></li><li role=none><a role=treeitem title="Request authentication configuration for workloads." href=/v1.12/docs/reference/config/security/request_authentication/>RequestAuthentication</a></li><li role=none><a role=treeitem title="Configuration for access control on workloads." href=/v1.12/docs/reference/config/security/authorization-policy/>Authorization Policy</a></li><li role=none><a role=treeitem title="Describes the supported conditions in authorization policies." href=/v1.12/docs/reference/config/security/conditions/>Authorization Policy Conditions</a></li><li role=none><a role=treeitem title="Describes the supported normalizations in authorization policies." href=/v1.12/docs/reference/config/security/normalization/>Authorization Policy Normalization</a></li></ul></li><li role=none><a role=treeitem title="Istio standard metrics exported by Istio telemetry." href=/v1.12/docs/reference/config/metrics/>Istio Standard Metrics</a></li><li role=treeitem aria-label="Common Types"><button aria-hidden=true></button><a title="Describes common types in Istio API." href=/v1.12/docs/reference/config/type/>Common Types</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Definition of a workload selector." href=/v1.12/docs/reference/config/type/workload-selector/>Workload Selector</a></li></ul></li><li role=none><a role=treeitem title="Resource annotations used by Istio." href=/v1.12/docs/reference/config/annotations/>Resource Annotations</a></li><li role=none><a role=treeitem title="Resource labels used by Istio." href=/v1.12/docs/reference/config/labels/>Resource Labels</a></li><li role=treeitem aria-label="Configuration Analysis Messages"><button aria-hidden=true></button><a title="Documents the individual error and warning messages produced during configuration analysis." href=/v1.12/docs/reference/config/analysis/>Configuration Analysis Messages</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/message-format/>Analyzer Message Format</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0109/>ConflictingMeshGatewayVirtualServiceHosts</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0110/>ConflictingSidecarWorkloadSelectors</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0116/>DeploymentAssociatedToMultipleServices</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0137/>DeploymentConflictingPorts</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0117/>DeploymentRequiresServiceAssociated</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0002/>Deprecated</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0135/>DeprecatedAnnotation</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0104/>GatewayPortNotOnWorkload</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0001/>InternalError</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0125/>InvalidAnnotation</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0144/>InvalidApplicationUID</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0122/>InvalidRegexp</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0105/>IstioProxyImageMismatch</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0119/>JwtFailureDueToInvalidServicePortPrefix</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0143/>LocalhostListener</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0107/>MisplacedAnnotation</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0136/>AlphaAnnotation</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0111/>MultipleSidecarsWithoutWorkloadSelectors</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0123/>NamespaceMultipleInjectionLabels</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0102/>NamespaceNotInjected</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0127/>NoMatchingWorkloadsFound</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0128/>NoServerCertificateVerificationDestinationLevel</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0129/>NoServerCertificateVerificationPortLevel</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0113/>MTLSPolicyConflict</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0103/>PodMissingProxy</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0118/>PortNameIsNotUnderNamingConvention</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0101/>ReferencedResourceNotFound</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0134/>ServiceEntryAddressesRequired</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0108/>UnknownAnnotation</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0112/>VirtualServiceDestinationPortSelectorRequired</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0132/>VirtualServiceHostNotFoundInGateway</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0131/>VirtualServiceIneffectiveMatch</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0106/>SchemaValidationError</a></li><li role=none><a role=treeitem href=/v1.12/docs/reference/config/analysis/ist0130/>VirtualServiceUnreachableRule</a></li></ul></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.12/docs/reference/commands/>Commands</a><ul role=group aria-expanded=true class=leaf-section><li role=none><a role=treeitem title="Install and configure Istio CNI plugin on a node, detect and repair pod which is broken by race condition." href=/v1.12/docs/reference/commands/install-cni/>install-cni</a></li><li role=none><a role=treeitem title="Istio control interface." href=/v1.12/docs/reference/commands/istioctl/>istioctl</a></li><li role=none><a role=treeitem title="The Istio operator." href=/v1.12/docs/reference/commands/operator/>operator</a></li><li role=none><a role=treeitem title="Istio Pilot agent." href=/v1.12/docs/reference/commands/pilot-agent/>pilot-agent</a></li><li role=none><a role=treeitem title="Istio Pilot." href=/v1.12/docs/reference/commands/pilot-discovery/>pilot-discovery</a></li></ul></li><li role=none><a role=treeitem title="A glossary of common Istio terms." href=/v1.12/docs/reference/glossary/>Glossary</a></li></ul></li></ul></div></div></div></nav></div><div class=article-container><button id=sidebar-toggle class=main-navigation-toggle aria-label="Open sidebar"><svg class="icon hamburger-sidebar"><use xlink:href="/v1.12/img/icons.svg#hamburger-sidebar"/></svg>
Contents</button><article aria-labelledby=title><nav aria-label=Breadcrumb><ol><li><a href=/v1.12/docs/ title="Learn how to deploy, use, and operate Istio.">Documentation</a><svg class="icon breadcrumb-arrow"><use xlink:href="/v1.12/img/icons.svg#breadcrumb-arrow"/></svg></li><li><a href=/v1.12/docs/reference/ title="Detailed authoritative reference material such as command-line options, configuration options, and API calling parameters.">Reference</a><svg class="icon breadcrumb-arrow"><use xlink:href="/v1.12/img/icons.svg#breadcrumb-arrow"/></svg></li><li><a href=/v1.12/docs/reference/commands/ title="Describes usage and options of the Istio commands and utilities.">Commands</a><svg class="icon breadcrumb-arrow"><use xlink:href="/v1.12/img/icons.svg#breadcrumb-arrow"/></svg></li><li>istioctl</li></ol></nav><div class=title-area><div style=width:100%><h1 id=title>istioctl</h1><p class=byline><span class=reading-time title="20759 words"><svg class="icon clock"><use xlink:href="/v1.12/img/icons.svg#clock"/></svg><span>&nbsp;</span>98 minute read</span>
<span>&nbsp;</span>
<span></span></p></div></div><nav class=toc-inlined aria-label="Table of Contents"><div><hr><ol><li role=none aria-label="istioctl admin"><a href=#istioctl-admin>admin</a><li role=none aria-label="istioctl admin log"><a href=#istioctl-admin-log>admin log</a><li role=none aria-label="istioctl analyze"><a href=#istioctl-analyze>analyze</a><li role=none aria-label="istioctl authz"><a href=#istioctl-authz>authz</a><li role=none aria-label="istioctl bug-report"><a href=#istioctl-bug-report>bug-report</a><li role=none aria-label="istioctl bug-report version"><a href=#istioctl-bug-report-version>bug-report version</a><li role=none aria-label="istioctl completion"><a href=#istioctl-completion>completion</a><li role=none aria-label="istioctl completion bash"><a href=#istioctl-completion-bash>completion bash</a><li role=none aria-label="istioctl completion fish"><a href=#istioctl-completion-fish>completion fish</a><li role=none aria-label="istioctl completion powershell"><a href=#istioctl-completion-powershell>completion powershell</a><li role=none aria-label="istioctl completion zsh"><a href=#istioctl-completion-zsh>completion zsh</a><li role=none aria-label="istioctl dashboard"><a href=#istioctl-dashboard>dashboard</a><li role=none aria-label="istioctl dashboard controlz"><a href=#istioctl-dashboard-controlz>dashboard controlz</a><li role=none aria-label="istioctl dashboard envoy"><a href=#istioctl-dashboard-envoy>dashboard envoy</a><li role=none aria-label="istioctl dashboard grafana"><a href=#istioctl-dashboard-grafana>dashboard grafana</a><li role=none aria-label="istioctl dashboard jaeger"><a href=#istioctl-dashboard-jaeger>dashboard jaeger</a><li role=none aria-label="istioctl dashboard kiali"><a href=#istioctl-dashboard-kiali>dashboard kiali</a><li role=none aria-label="istioctl dashboard prometheus"><a href=#istioctl-dashboard-prometheus>dashboard prometheus</a><li role=none aria-label="istioctl dashboard skywalking"><a href=#istioctl-dashboard-skywalking>dashboard skywalking</a><li role=none aria-label="istioctl dashboard zipkin"><a href=#istioctl-dashboard-zipkin>dashboard zipkin</a><li role=none aria-label="istioctl experimental"><a href=#istioctl-experimental>experimental</a><li role=none aria-label="istioctl experimental add-to-mesh"><a href=#istioctl-experimental-add-to-mesh>experimental add-to-mesh</a><li role=none aria-label="istioctl experimental add-to-mesh deployment"><a href=#istioctl-experimental-add-to-mesh-deployment>experimental add-to-mesh deployment</a><li role=none aria-label="istioctl experimental add-to-mesh external-service"><a href=#istioctl-experimental-add-to-mesh-external-service>experimental add-to-mesh external-service</a><li role=none aria-label="istioctl experimental add-to-mesh service"><a href=#istioctl-experimental-add-to-mesh-service>experimental add-to-mesh service</a><li role=none aria-label="istioctl experimental authz"><a href=#istioctl-experimental-authz>experimental authz</a><li role=none aria-label="istioctl experimental authz check"><a href=#istioctl-experimental-authz-check>experimental authz check</a><li role=none aria-label="istioctl experimental config"><a href=#istioctl-experimental-config>experimental config</a><li role=none aria-label="istioctl experimental config list"><a href=#istioctl-experimental-config-list>experimental config list</a><li role=none aria-label="istioctl experimental create-remote-secret"><a href=#istioctl-experimental-create-remote-secret>experimental create-remote-secret</a><li role=none aria-label="istioctl experimental describe"><a href=#istioctl-experimental-describe>experimental describe</a><li role=none aria-label="istioctl experimental describe pod"><a href=#istioctl-experimental-describe-pod>experimental describe pod</a><li role=none aria-label="istioctl experimental describe service"><a href=#istioctl-experimental-describe-service>experimental describe service</a><li role=none aria-label="istioctl experimental injector"><a href=#istioctl-experimental-injector>experimental injector</a><li role=none aria-label="istioctl experimental injector list"><a href=#istioctl-experimental-injector-list>experimental injector list</a><li role=none aria-label="istioctl experimental internal-debug"><a href=#istioctl-experimental-internal-debug>experimental internal-debug</a><li role=none aria-label="istioctl experimental kube-uninject"><a href=#istioctl-experimental-kube-uninject>experimental kube-uninject</a><li role=none aria-label="istioctl experimental metrics"><a href=#istioctl-experimental-metrics>experimental metrics</a><li role=none aria-label="istioctl experimental precheck"><a href=#istioctl-experimental-precheck>experimental precheck</a><li role=none aria-label="istioctl experimental proxy-status"><a href=#istioctl-experimental-proxy-status>experimental proxy-status</a><li role=none aria-label="istioctl experimental remote-clusters"><a href=#istioctl-experimental-remote-clusters>experimental remote-clusters</a><li role=none aria-label="istioctl experimental remove-from-mesh"><a href=#istioctl-experimental-remove-from-mesh>experimental remove-from-mesh</a><li role=none aria-label="istioctl experimental remove-from-mesh deployment"><a href=#istioctl-experimental-remove-from-mesh-deployment>experimental remove-from-mesh deployment</a><li role=none aria-label="istioctl experimental remove-from-mesh external-service"><a href=#istioctl-experimental-remove-from-mesh-external-service>experimental remove-from-mesh external-service</a><li role=none aria-label="istioctl experimental remove-from-mesh service"><a href=#istioctl-experimental-remove-from-mesh-service>experimental remove-from-mesh service</a><li role=none aria-label="istioctl experimental revision"><a href=#istioctl-experimental-revision>experimental revision</a><li role=none aria-label="istioctl experimental revision describe"><a href=#istioctl-experimental-revision-describe>experimental revision describe</a><li role=none aria-label="istioctl experimental revision list"><a href=#istioctl-experimental-revision-list>experimental revision list</a><li role=none aria-label="istioctl experimental revision tag"><a href=#istioctl-experimental-revision-tag>experimental revision tag</a><li role=none aria-label="istioctl experimental revision tag generate"><a href=#istioctl-experimental-revision-tag-generate>experimental revision tag generate</a><li role=none aria-label="istioctl experimental revision tag list"><a href=#istioctl-experimental-revision-tag-list>experimental revision tag list</a><li role=none aria-label="istioctl experimental revision tag remove"><a href=#istioctl-experimental-revision-tag-remove>experimental revision tag remove</a><li role=none aria-label="istioctl experimental revision tag set"><a href=#istioctl-experimental-revision-tag-set>experimental revision tag set</a><li role=none aria-label="istioctl experimental uninstall"><a href=#istioctl-experimental-uninstall>experimental uninstall</a><li role=none aria-label="istioctl experimental version"><a href=#istioctl-experimental-version>experimental version</a><li role=none aria-label="istioctl experimental wait"><a href=#istioctl-experimental-wait>experimental wait</a><li role=none aria-label="istioctl experimental workload"><a href=#istioctl-experimental-workload>experimental workload</a><li role=none aria-label="istioctl experimental workload entry"><a href=#istioctl-experimental-workload-entry>experimental workload entry</a><li role=none aria-label="istioctl experimental workload entry configure"><a href=#istioctl-experimental-workload-entry-configure>experimental workload entry configure</a><li role=none aria-label="istioctl experimental workload group"><a href=#istioctl-experimental-workload-group>experimental workload group</a><li role=none aria-label="istioctl experimental workload group create"><a href=#istioctl-experimental-workload-group-create>experimental workload group create</a><li role=none aria-label="istioctl install"><a href=#istioctl-install>install</a><li role=none aria-label="istioctl kube-inject"><a href=#istioctl-kube-inject>kube-inject</a><li role=none aria-label="istioctl manifest"><a href=#istioctl-manifest>manifest</a><li role=none aria-label="istioctl manifest diff"><a href=#istioctl-manifest-diff>manifest diff</a><li role=none aria-label="istioctl manifest generate"><a href=#istioctl-manifest-generate>manifest generate</a><li role=none aria-label="istioctl manifest install"><a href=#istioctl-manifest-install>manifest install</a><li role=none aria-label="istioctl operator"><a href=#istioctl-operator>operator</a><li role=none aria-label="istioctl operator dump"><a href=#istioctl-operator-dump>operator dump</a><li role=none aria-label="istioctl operator init"><a href=#istioctl-operator-init>operator init</a><li role=none aria-label="istioctl operator remove"><a href=#istioctl-operator-remove>operator remove</a><li role=none aria-label="istioctl options"><a href=#istioctl-options>options</a><li role=none aria-label="istioctl profile"><a href=#istioctl-profile>profile</a><li role=none aria-label="istioctl profile diff"><a href=#istioctl-profile-diff>profile diff</a><li role=none aria-label="istioctl profile dump"><a href=#istioctl-profile-dump>profile dump</a><li role=none aria-label="istioctl profile list"><a href=#istioctl-profile-list>profile list</a><li role=none aria-label="istioctl proxy-config"><a href=#istioctl-proxy-config>proxy-config</a><li role=none aria-label="istioctl proxy-config all"><a href=#istioctl-proxy-config-all>proxy-config all</a><li role=none aria-label="istioctl proxy-config bootstrap"><a href=#istioctl-proxy-config-bootstrap>proxy-config bootstrap</a><li role=none aria-label="istioctl proxy-config cluster"><a href=#istioctl-proxy-config-cluster>proxy-config cluster</a><li role=none aria-label="istioctl proxy-config endpoint"><a href=#istioctl-proxy-config-endpoint>proxy-config endpoint</a><li role=none aria-label="istioctl proxy-config listener"><a href=#istioctl-proxy-config-listener>proxy-config listener</a><li role=none aria-label="istioctl proxy-config log"><a href=#istioctl-proxy-config-log>proxy-config log</a><li role=none aria-label="istioctl proxy-config rootca-compare"><a href=#istioctl-proxy-config-rootca-compare>proxy-config rootca-compare</a><li role=none aria-label="istioctl proxy-config route"><a href=#istioctl-proxy-config-route>proxy-config route</a><li role=none aria-label="istioctl proxy-config secret"><a href=#istioctl-proxy-config-secret>proxy-config secret</a><li role=none aria-label="istioctl proxy-status"><a href=#istioctl-proxy-status>proxy-status</a><li role=none aria-label="istioctl tag"><a href=#istioctl-tag>tag</a><li role=none aria-label="istioctl tag generate"><a href=#istioctl-tag-generate>tag generate</a><li role=none aria-label="istioctl tag list"><a href=#istioctl-tag-list>tag list</a><li role=none aria-label="istioctl tag remove"><a href=#istioctl-tag-remove>tag remove</a><li role=none aria-label="istioctl tag set"><a href=#istioctl-tag-set>tag set</a><li role=none aria-label="istioctl upgrade"><a href=#istioctl-upgrade>upgrade</a><li role=none aria-label="istioctl validate"><a href=#istioctl-validate>validate</a><li role=none aria-label="istioctl verify-install"><a href=#istioctl-verify-install>verify-install</a><li role=none aria-label="istioctl version"><a href=#istioctl-version>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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-admin>istioctl admin</h2><p>A group of commands used to manage istiod configuration</p><pre class=language-bash><code>istioctl admin [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl istiod [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--selector &lt;string></code></td><td><code>-l</code></td><td>label selector (default `app=istiod`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-admin Examples">Examples</h3><pre class=language-bash><code> # Retrieve information about istiod configuration.
istioctl admin log
</code></pre><h2 id=istioctl-admin-log>istioctl admin log</h2><p>Retrieve or update logging levels of istiod components.</p><pre class=language-bash><code>istioctl admin log [&lt;pod-name&gt;] [--level &lt;scope&gt;:&lt;level&gt;][--stack-trace-level &lt;scope&gt;:&lt;level&gt;]|[-r|--reset]|[--output|-o short|yaml] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl admin l [&lt;pod-name&gt;] [--level &lt;scope&gt;:&lt;level&gt;][--stack-trace-level &lt;scope&gt;:&lt;level&gt;]|[-r|--reset]|[--output|-o short|yaml] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--ctrlz_port &lt;int></code></td><td></td><td>ControlZ port (default `9876`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--level &lt;string></code></td><td></td><td>Comma-separated list of output logging level for scopes in format &lt;scope>:&lt;level>[,&lt;scope>:&lt;level>,...]Possible values for &lt;level>: none, error, warn, info, debug (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr><tr><td><code>--reset</code></td><td><code>-r</code></td><td>Reset levels to default value. (info)</td></tr><tr><td><code>--selector &lt;string></code></td><td><code>-l</code></td><td>label selector (default `app=istiod`)</td></tr><tr><td><code>--stack-trace-level &lt;string></code></td><td></td><td>Comma-separated list of stack trace level for scopes in format &lt;scope>:&lt;stack-trace-level>[,&lt;scope>:&lt;stack-trace-level>,...] Possible values for &lt;stack-trace-level>: none, error, warn, info, debug (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-admin-log Examples">Examples</h3><pre class=language-bash><code> # Retrieve information about istiod logging levels.
istioctl admin log
# Retrieve information about istiod logging levels on a specific control plane pod.
istioctl admin l istiod-5c868d8bdd-pmvgg
# Update levels of the specified loggers.
istioctl admin log --level ads:debug,authorization:debug
# Reset levels of all the loggers to default value (info).
istioctl admin log -r
</code></pre><h2 id=istioctl-analyze>istioctl analyze</h2><p>Analyze Istio configuration and print validation messages</p><pre class=language-bash><code>istioctl analyze &lt;file&gt;... [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-namespaces</code></td><td><code>-A</code></td><td>Analyze all namespaces</td></tr><tr><td><code>--color</code></td><td></td><td>Default true. Disable with '=false' or set $TERM to dumb</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--failure-threshold &lt;Level></code></td><td></td><td>The severity level of analysis at which to set a non-zero exit code. Valid values: [Info Warning Error] (default `Error`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--list-analyzers</code></td><td><code>-L</code></td><td>List the analyzers available to run. Suppresses normal execution.</td></tr><tr><td><code>--meshConfigFile &lt;string></code></td><td></td><td>Overrides the mesh config values to use for analysis. (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of [log json yaml] (default `log`)</td></tr><tr><td><code>--output-threshold &lt;Level></code></td><td></td><td>The severity level of analysis at which to display messages. Valid values: [Info Warning Error] (default `Info`)</td></tr><tr><td><code>--recursive</code></td><td><code>-R</code></td><td>Process directory arguments recursively. Useful when you want to analyze related manifests organized within the same directory.</td></tr><tr><td><code>--suppress &lt;stringArray></code></td><td><code>-S</code></td><td>Suppress reporting a message code on a specific resource. Values are supplied in the form &lt;code>=&lt;resource> (e.g. '--suppress "IST0102=DestinationRule primary-dr.default"'). Can be repeated. You can include the wildcard character '*' to support a partial match (e.g. '--suppress "IST0102=DestinationRule *.default" ). (default `[]`)</td></tr><tr><td><code>--timeout &lt;duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--use-kube</code></td><td><code>-k</code></td><td>Use live Kubernetes cluster for analysis. Set --use-kube=false to analyze files only.</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-analyze Examples">Examples</h3><pre class=language-bash><code> # Analyze the current live cluster
istioctl analyze
# Analyze the current live cluster, simulating the effect of applying additional yaml files
istioctl analyze a.yaml b.yaml my-app-config/
# Analyze the current live cluster, simulating the effect of applying a directory of config recursively
istioctl analyze --recursive my-istio-config/
# Analyze yaml files without connecting to a live cluster
istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/
# Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace &#39;testing&#39;.
istioctl analyze -S &#34;IST0103=Pod mypod.testing&#34;
# Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace &#39;testing&#39;,
# and suppress MisplacedAnnotation on deployment foobar in namespace default.
istioctl analyze -S &#34;IST0103=Pod *.testing&#34; -S &#34;IST0107=Deployment foobar.default&#34;
# List available analyzers
istioctl analyze -L
</code></pre><h2 id=istioctl-authz>istioctl authz</h2><p>(authz is experimental. Use `istioctl experimental authz`)</p><pre class=language-bash><code>istioctl authz [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-bug-report>istioctl bug-report</h2><p>bug-report selectively captures cluster information and logs into an archive to help diagnose problems.
Proxy logs can be filtered using:
--include|--exclude ns1,ns2.../dep1,dep2.../pod1,pod2.../cntr1,cntr.../lbl1=val1,lbl2=val2.../ann1=val1,ann2=val2...
where ns=namespace, dep=deployment, cntr=container, lbl=label, ann=annotation</p><p>The filter spec is interpreted as 'must be in (ns1 OR ns2) AND (dep1 OR dep2) AND (cntr1 OR cntr2)...'
The log will be included only if the container matches at least one include filter and does not match any exclude filters.
All parts of the filter are optional and can be omitted e.g. ns1//pod1 filters only for namespace ns1 and pod1.
All names except label and annotation keys support '*' glob matching pattern.</p><p>e.g.
--include ns1,ns2 (only namespaces ns1 and ns2)
--include n*//p*/l=v* (pods with name beginning with 'p' in namespaces beginning with 'n' and having label 'l' with value beginning with 'v'.)</p><pre class=language-bash><code>istioctl bug-report [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--critical-errs &lt;stringSlice></code></td><td></td><td>List of comma separated glob patterns to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`)</td></tr><tr><td><code>--dir &lt;string></code></td><td></td><td>Set a specific directory for temporary artifact storage. (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Only log commands that would be run, don't fetch or write.</td></tr><tr><td><code>--duration &lt;duration></code></td><td></td><td>How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, --start-time must be unset. (default `0s`)</td></tr><tr><td><code>--end-time &lt;string></code></td><td></td><td>End time for the range of log entries to include in the archive. Default is now. (default ``)</td></tr><tr><td><code>--exclude &lt;stringSlice></code></td><td></td><td>Spec for which pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-system,kube-public,kube-node-lease,local-path-storage"]`)</td></tr><tr><td><code>--filename &lt;string></code></td><td><code>-f</code></td><td>Path to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``)</td></tr><tr><td><code>--full-secrets</code></td><td></td><td>If set, secret contents are included in output.</td></tr><tr><td><code>--ignore-errs &lt;stringSlice></code></td><td></td><td>List of comma separated glob patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`)</td></tr><tr><td><code>--include &lt;stringSlice></code></td><td></td><td>Spec for which pod's proxy logs to include in the archive. See above for format and examples. (default `[]`)</td></tr><tr><td><code>--istio-namespace &lt;string></code></td><td></td><td>Namespace where Istio control plane is installed. (default `istio-system`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--start-time &lt;string></code></td><td></td><td>Start time for the range of log entries to include in the archive. Default is the infinite past. If set, --duration must be unset. (default ``)</td></tr><tr><td><code>--timeout &lt;duration></code></td><td></td><td>Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-bug-report-version>istioctl bug-report version</h2><p>Prints out build version information</p><pre class=language-bash><code>istioctl bug-report 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 &lt;string></code></td><td></td><td>Name of the kubeconfig Context to use. (default ``)</td></tr><tr><td><code>--critical-errs &lt;stringSlice></code></td><td></td><td>List of comma separated glob patterns to match against log error strings. If any pattern matches an error in the log, the logs is given the highest priority for archive inclusion. (default `[]`)</td></tr><tr><td><code>--dir &lt;string></code></td><td></td><td>Set a specific directory for temporary artifact storage. (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Only log commands that would be run, don't fetch or write.</td></tr><tr><td><code>--duration &lt;duration></code></td><td></td><td>How far to go back in time from end-time for log entries to include in the archive. Default is infinity. If set, --start-time must be unset. (default `0s`)</td></tr><tr><td><code>--end-time &lt;string></code></td><td></td><td>End time for the range of log entries to include in the archive. Default is now. (default ``)</td></tr><tr><td><code>--exclude &lt;stringSlice></code></td><td></td><td>Spec for which pod's proxy logs to exclude from the archive, after the include spec is processed. See above for format and examples. (default `["kube-system,kube-public,kube-node-lease,local-path-storage"]`)</td></tr><tr><td><code>--filename &lt;string></code></td><td><code>-f</code></td><td>Path to a file containing configuration in YAML format. The file contents are applied over the default values and flag settings, with lists being replaced per JSON merge semantics. (default ``)</td></tr><tr><td><code>--full-secrets</code></td><td></td><td>If set, secret contents are included in output.</td></tr><tr><td><code>--ignore-errs &lt;stringSlice></code></td><td></td><td>List of comma separated glob patterns to match against log error strings. Any error matching these patterns is ignored when calculating the log importance heuristic. (default `[]`)</td></tr><tr><td><code>--include &lt;stringSlice></code></td><td></td><td>Spec for which pod's proxy logs to include in the archive. See above for format and examples. (default `[]`)</td></tr><tr><td><code>--istio-namespace &lt;string></code></td><td></td><td>Namespace where Istio control plane is installed. (default `istio-system`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Path to kube config. (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>One of 'yaml' or 'json'. (default ``)</td></tr><tr><td><code>--short</code></td><td><code>-s</code></td><td>Use --short=false to generate full version information</td></tr><tr><td><code>--start-time &lt;string></code></td><td></td><td>Start time for the range of log entries to include in the archive. Default is the infinite past. If set, --duration must be unset. (default ``)</td></tr><tr><td><code>--timeout &lt;duration></code></td><td></td><td>Maximum amount of time to spend fetching logs. When timeout is reached only the logs captured so far are saved to the archive. (default `30m0s`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-completion>istioctl completion</h2><p>Generate the autocompletion script for istioctl for the specified shell.
See each sub-command's help for details on how to use the generated script.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-completion-bash>istioctl completion bash</h2><p>Generate the autocompletion script for the bash shell.</p><p>This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.</p><p>To load completions in your current shell session:
$ source &lt;(istioctl completion bash)</p><p>To load completions for every new session, execute once:
Linux:
$ istioctl completion bash > /etc/bash_completion.d/istioctl
MacOS:
$ istioctl completion bash > /usr/local/etc/bash_completion.d/istioctl</p><p>You will need to start a new shell for this setup to take effect.</p><pre class=language-bash><code>istioctl completion bash
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--no-descriptions</code></td><td></td><td>disable completion descriptions</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-completion-fish>istioctl completion fish</h2><p>Generate the autocompletion script for the fish shell.</p><p>To load completions in your current shell session:
$ istioctl completion fish | source</p><p>To load completions for every new session, execute once:
$ istioctl completion fish > ~/.config/fish/completions/istioctl.fish</p><p>You will need to start a new shell for this setup to take effect.</p><pre class=language-bash><code>istioctl completion fish [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--no-descriptions</code></td><td></td><td>disable completion descriptions</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-completion-powershell>istioctl completion powershell</h2><p>Generate the autocompletion script for powershell.</p><p>To load completions in your current shell session:
PS C:\> istioctl completion powershell | Out-String | Invoke-Expression</p><p>To load completions for every new session, add the output of the above command
to your powershell profile.</p><pre class=language-bash><code>istioctl completion powershell [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--no-descriptions</code></td><td></td><td>disable completion descriptions</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-completion-zsh>istioctl completion zsh</h2><p>Generate the autocompletion script for the zsh shell.</p><p>If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:</p><p>$ echo "autoload -U compinit; compinit" >> ~/.zshrc</p><p>To load completions for every new session, execute once:
# Linux:
$ istioctl completion zsh > "${fpath[1]}/_istioctl"
# macOS:
$ istioctl completion zsh > /usr/local/share/zsh/site-functions/_istioctl</p><p>You will need to start a new shell for this setup to take effect.</p><pre class=language-bash><code>istioctl completion zsh [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--no-descriptions</code></td><td></td><td>disable completion descriptions</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><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>--address &lt;string></code></td><td></td><td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td></tr><tr><td><code>--browser</code></td><td></td><td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--port &lt;int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address &lt;string></code></td><td></td><td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td></tr><tr><td><code>--browser</code></td><td></td><td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--ctrlz_port &lt;int></code></td><td></td><td>ControlZ port (default `9876`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td></tr><tr><td><code>--port &lt;int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--selector &lt;string></code></td><td><code>-l</code></td><td>Label selector (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-dashboard-controlz Examples">Examples</h3><pre class=language-bash><code> # Open ControlZ web UI for the istiod-123-456.istio-system pod
istioctl dashboard controlz istiod-123-456.istio-system
# Open ControlZ web UI for the istiod-56dd66799-jfdvs pod in a custom namespace
istioctl dashboard controlz istiod-123-456 -n custom-ns
# Open ControlZ web UI for any Istiod pod
istioctl dashboard controlz deployment/istiod.istio-system
# with short syntax
istioctl dash controlz pilot-123-456.istio-system
istioctl d controlz pilot-123-456.istio-system
</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 [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address &lt;string></code></td><td></td><td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td></tr><tr><td><code>--browser</code></td><td></td><td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td></tr><tr><td><code>--port &lt;int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--selector &lt;string></code></td><td><code>-l</code></td><td>Label selector (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-dashboard-envoy Examples">Examples</h3><pre class=language-bash><code> # Open Envoy dashboard for the productpage-123-456.default pod
istioctl dashboard envoy productpage-123-456.default
# Open Envoy dashboard for one pod under a deployment
istioctl dashboard envoy deployment/productpage-v1
# with short syntax
istioctl dash envoy productpage-123-456.default
istioctl d envoy productpage-123-456.default
</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>--address &lt;string></code></td><td></td><td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td></tr><tr><td><code>--browser</code></td><td></td><td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td></tr><tr><td><code>--port &lt;int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-dashboard-grafana Examples">Examples</h3><pre class=language-bash><code> istioctl dashboard grafana
# with short syntax
istioctl dash grafana
istioctl d 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>--address &lt;string></code></td><td></td><td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td></tr><tr><td><code>--browser</code></td><td></td><td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td></tr><tr><td><code>--port &lt;int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-dashboard-jaeger Examples">Examples</h3><pre class=language-bash><code> istioctl dashboard jaeger
# with short syntax
istioctl dash jaeger
istioctl d 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>--address &lt;string></code></td><td></td><td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td></tr><tr><td><code>--browser</code></td><td></td><td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td></tr><tr><td><code>--port &lt;int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-dashboard-kiali Examples">Examples</h3><pre class=language-bash><code> istioctl dashboard kiali
# with short syntax
istioctl dash kiali
istioctl d 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>--address &lt;string></code></td><td></td><td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td></tr><tr><td><code>--browser</code></td><td></td><td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td></tr><tr><td><code>--port &lt;int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-dashboard-prometheus Examples">Examples</h3><pre class=language-bash><code> istioctl dashboard prometheus
# with short syntax
istioctl dash prometheus
istioctl d prometheus
</code></pre><h2 id=istioctl-dashboard-skywalking>istioctl dashboard skywalking</h2><p>Open the Istio dashboard in the SkyWalking UI</p><pre class=language-bash><code>istioctl dashboard skywalking [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address &lt;string></code></td><td></td><td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td></tr><tr><td><code>--browser</code></td><td></td><td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td></tr><tr><td><code>--port &lt;int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-dashboard-skywalking Examples">Examples</h3><pre class=language-bash><code> istioctl dashboard skywalking
# with short syntax
istioctl dash skywalking
istioctl d skywalking
</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>--address &lt;string></code></td><td></td><td>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td></tr><tr><td><code>--browser</code></td><td></td><td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard.</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td></tr><tr><td><code>--port &lt;int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-dashboard-zipkin Examples">Examples</h3><pre class=language-bash><code> istioctl dashboard zipkin
# with short syntax
istioctl dash zipkin
istioctl d zipkin
</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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-experimental-add-to-mesh>istioctl experimental add-to-mesh</h2><p>'istioctl experimental add-to-mesh' restarts pods with an Istio sidecar or configures meshed pod access to external services.
Use 'add-to-mesh' as an alternate to namespace-wide auto injection for troubleshooting compatibility.</p><p>The 'remove-from-mesh' command can be used to restart with the sidecar removed.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--injectConfigFile &lt;string></code></td><td></td><td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--injectConfigMapName &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--meshConfigFile &lt;string></code></td><td></td><td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName &lt;string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--valuesFile &lt;string></code></td><td></td><td>Injection values configuration filename. (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-add-to-mesh Examples">Examples</h3><pre class=language-bash><code> # Restart all productpage pods with an Istio sidecar
istioctl experimental add-to-mesh service productpage
# Restart just pods from the productpage-v1 deployment
istioctl experimental add-to-mesh deployment productpage-v1
# Restart just pods from the details-v1 deployment
istioctl x add deployment details-v1
# Control how meshed pods see an external service
istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126 \
http:9080 tcp:8888 --labels app=test,version=v1 --annotations env=stage --serviceaccount stageAdmin
</code></pre><h2 id=istioctl-experimental-add-to-mesh-deployment>istioctl experimental add-to-mesh deployment</h2><p>'istioctl experimental add-to-mesh deployment' restarts pods with the Istio sidecar. Use 'add-to-mesh'
to test deployments for compatibility with Istio. It can be used instead of namespace-wide auto-injection of sidecars and is especially helpful for compatibility testing.</p><p>If your deployment does not function after using 'add-to-mesh' you must re-deploy it and troubleshoot it for Istio compatibility.
See https://istio.io/v1.12/docs/ops/deployment/requirements/</p><p>See also 'istioctl experimental remove-from-mesh deployment' which does the reverse.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental add-to-mesh deployment &lt;deployment&gt; [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental add-to-mesh deploy &lt;deployment&gt; [flags]
istioctl experimental add-to-mesh dep &lt;deployment&gt; [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--injectConfigFile &lt;string></code></td><td></td><td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--injectConfigMapName &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--meshConfigFile &lt;string></code></td><td></td><td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName &lt;string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--valuesFile &lt;string></code></td><td></td><td>Injection values configuration filename. (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-add-to-mesh-deployment Examples">Examples</h3><pre class=language-bash><code> # Restart pods from the productpage-v1 deployment with Istio sidecar
istioctl experimental add-to-mesh deployment productpage-v1
# Restart pods from the details-v1 deployment with Istio sidecar
istioctl x add-to-mesh deploy details-v1
# Restart pods from the ratings-v1 deployment with Istio sidecar
istioctl x add dep ratings-v1
</code></pre><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.</p><p>See also 'istioctl experimental remove-from-mesh external-service' which does the reverse.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental add-to-mesh external-service &lt;svcname&gt; &lt;ip&gt; [name1:]port1 [[name2:]port2] ... [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental add-to-mesh es &lt;svcname&gt; &lt;ip&gt; [name1:]port1 [[name2:]port2] ... [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>--annotations &lt;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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--injectConfigFile &lt;string></code></td><td></td><td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--injectConfigMapName &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--labels &lt;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>--meshConfigFile &lt;string></code></td><td></td><td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName &lt;string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--serviceaccount &lt;string></code></td><td><code>-s</code></td><td>Service account to link to the service (default `default`)</td></tr><tr><td><code>--valuesFile &lt;string></code></td><td></td><td>Injection values configuration filename. (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-add-to-mesh-external-service Examples">Examples</h3><pre class=language-bash><code> # Control how meshed pods contact 172.12.23.125 and .126
istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126 \
http:9080 tcp:8888 --labels app=test,version=v1 --annotations env=stage --serviceaccount stageAdmin
</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. It can be used instead of namespace-wide auto-injection of sidecars and is especially helpful for compatibility testing.</p><p>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/v1.12/docs/ops/deployment/requirements/</p><p>See also 'istioctl experimental remove-from-mesh service' which does the reverse.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental add-to-mesh service &lt;service&gt; [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental add-to-mesh svc &lt;service&gt; [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--injectConfigFile &lt;string></code></td><td></td><td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--injectConfigMapName &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--meshConfigFile &lt;string></code></td><td></td><td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName &lt;string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--valuesFile &lt;string></code></td><td></td><td>Injection values configuration filename. (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-add-to-mesh-service Examples">Examples</h3><pre class=language-bash><code> # Restart all productpage pods with an Istio sidecar
istioctl experimental add-to-mesh service productpage
# Restart all details-v1 pods with an Istio sidecar
istioctl x add-to-mesh svc details-v1
# Restart all ratings-v1 pods with an Istio sidecar
istioctl x add svc ratings-v1
</code></pre><h2 id=istioctl-experimental-authz>istioctl experimental authz</h2><p></p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-experimental-authz-check>istioctl experimental authz check</h2><p>Check prints the AuthorizationPolicy applied to a pod by directly checking
the Envoy configuration of the pod. The command is especially useful for inspecting
the policy propagation from Istiod to Envoy and the final AuthorizationPolicy list merged
from multiple sources (mesh-level, namespace-level and workload-level).</p><p>The command also supports reading from a standalone config dump file with flag -f.</p><pre class=language-bash><code>istioctl experimental authz check [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>The json file with Envoy config dump to be checked (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-authz-check Examples">Examples</h3><pre class=language-bash><code> # Check AuthorizationPolicy applied to pod httpbin-88ddbcfdd-nt5jb:
istioctl x authz check httpbin-88ddbcfdd-nt5jb
# Check AuthorizationPolicy applied to one pod under a deployment
istioctl proxy-status deployment/productpage-v1
# Check AuthorizationPolicy from Envoy config dump file:
istioctl x authz check -f httpbin_config_dump.json
</code></pre><h2 id=istioctl-experimental-config>istioctl experimental config</h2><p>Configure istioctl defaults</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-config Examples">Examples</h3><pre class=language-bash><code> # list configuration parameters
istioctl config list
</code></pre><h2 id=istioctl-experimental-config-list>istioctl experimental config list</h2><p>List istio configurable defaults</p><pre class=language-bash><code>istioctl experimental config 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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-experimental-create-remote-secret>istioctl experimental create-remote-secret</h2><p>Create a secret with credentials to allow Istio to access remote Kubernetes apiservers</p><pre class=language-bash><code>istioctl experimental create-remote-secret [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--auth-plugin-config &lt;stringToString></code></td><td></td><td>Authenticator plug-in configuration. --auth-type=plugin must be set with this option (default `[]`)</td></tr><tr><td><code>--auth-plugin-name &lt;string></code></td><td></td><td>Authenticator plug-in name. --auth-type=plugin must be set with this option (default ``)</td></tr><tr><td><code>--auth-type &lt;RemoteSecretAuthType></code></td><td></td><td>Type of authentication to use. supported values = [bearer-token plugin] (default `bearer-token`)</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--create-service-account</code></td><td></td><td>If true, the service account needed for creating the remote secret will be created if it doesn't exist.</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--name &lt;string></code></td><td></td><td>Name of the local cluster whose credentials are stored in the secret. If a name is not specified the kube-system namespace's UUID of the local cluster will be used. (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--secret-name &lt;string></code></td><td></td><td>The name of the specific secret to use from the service-account. Needed when there are multiple secrets in the service account. (default ``)</td></tr><tr><td><code>--server &lt;string></code></td><td></td><td>The address and port of the Kubernetes API server. (default ``)</td></tr><tr><td><code>--service-account &lt;string></code></td><td></td><td>Create a secret with this service account's credentials. Default value is "istio-reader-service-account" if --type is "remote", "istiod" if --type is "config". (default ``)</td></tr><tr><td><code>--type &lt;SecretType></code></td><td></td><td>Type of the generated secret. supported values = [remote config] (default `remote`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-create-remote-secret Examples">Examples</h3><pre class=language-bash><code> # Create a secret to access cluster c0&#39;s apiserver and install it in cluster c1.
istioctl --kubeconfig=c0.yaml x create-remote-secret --name c0 \
| kubectl --kubeconfig=c1.yaml apply -f -
# Delete a secret that was previously installed in c1
istioctl --kubeconfig=c0.yaml x create-remote-secret --name c0 \
| kubectl --kubeconfig=c1.yaml delete -f -
# Create a secret access a remote cluster with an auth plugin
istioctl --kubeconfig=c0.yaml x create-remote-secret --name c0 --auth-type=plugin --auth-plugin-name=gcp \
| kubectl --kubeconfig=c1.yaml apply -f -
</code></pre><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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental describe pod &lt;pod&gt; [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental describe po &lt;pod&gt; [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 &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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-describe-service>istioctl experimental describe service</h2><p>Analyzes service, pods, DestinationRules, and VirtualServices and reports
the configuration objects that affect that service.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental describe service &lt;svc&gt; [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental describe svc &lt;svc&gt; [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 &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-describe-service Examples">Examples</h3><pre class=language-bash><code> istioctl experimental describe service productpage
</code></pre><h2 id=istioctl-experimental-injector>istioctl experimental injector</h2><p>List sidecar injector and sidecar versions</p><pre class=language-bash><code>istioctl experimental injector [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-injector Examples">Examples</h3><pre class=language-bash><code> istioctl experimental injector list
</code></pre><h2 id=istioctl-experimental-injector-list>istioctl experimental injector list</h2><p>List sidecar injector and sidecar versions</p><pre class=language-bash><code>istioctl experimental injector 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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-injector-list Examples">Examples</h3><pre class=language-bash><code> istioctl experimental injector list
</code></pre><h2 id=istioctl-experimental-internal-debug>istioctl experimental internal-debug</h2><p>Retrieves the debug information from Istiod or Pods in the mesh using the service account from the pod if --cert-dir is empty.
By default it will use the default serviceAccount from (istio-system) namespace if the pod is not specified.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental internal-debug [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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></td><td>Send the same request to all instances of Istiod. Only applicable for in-cluster deployment.</td></tr><tr><td><code>--authority &lt;string></code></td><td></td><td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td></tr><tr><td><code>--cert-dir &lt;string></code></td><td></td><td>XDS Endpoint certificate directory (default ``)</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--insecure</code></td><td></td><td>Skip server certificate and domain verification. (NOT SECURE!)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--plaintext</code></td><td></td><td>Use plain-text HTTP/2 when connecting to server (no TLS).</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--timeout &lt;duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--xds-address &lt;string></code></td><td></td><td>XDS Endpoint (default ``)</td></tr><tr><td><code>--xds-label &lt;string></code></td><td></td><td>Istiod pod label selector (default ``)</td></tr><tr><td><code>--xds-port &lt;int></code></td><td></td><td>Istiod pod port (default `15012`)</td></tr></tbody></table><h3 id="istioctl-experimental-internal-debug Examples">Examples</h3><pre class=language-bash><code> # Retrieve sync status for all Envoys in a mesh
istioctl x internal-debug syncz
# Retrieve sync diff for a single Envoy and Istiod
istioctl x internal-debug syncz istio-egressgateway-59585c5b9c-ndc59.istio-system
# SECURITY OPTIONS
# Retrieve syncz debug information directly from the control plane, using token security
# (This is the usual way to get the debug information with an out-of-cluster control plane.)
istioctl x internal-debug syncz --xds-address istio.cloudprovider.example.com:15012
# Retrieve syncz debug information via Kubernetes config, using token security
# (This is the usual way to get the debug information with an in-cluster control plane.)
istioctl x internal-debug syncz
# Retrieve syncz debug information directly from the control plane, using RSA certificate security
# (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
istioctl x internal-debug syncz --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
# Retrieve syncz information via XDS from specific control plane in multi-control plane in-cluster configuration
# (Select a specific control plane in an in-cluster canary Istio configuration.)
istioctl x internal-debug syncz --xds-label istio.io/rev=default
</code></pre><h2 id=istioctl-experimental-kube-uninject>istioctl experimental kube-uninject</h2><p>kube-uninject is used to prevent Istio from adding a sidecar and
also provides the inverse of "istioctl kube-inject -f".</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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename &lt;string></code></td><td><code>-f</code></td><td>Input Kubernetes resource filename (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Modified output Kubernetes resource filename (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 &lt;(istioctl experimental kube-uninject -f &lt;resource.yaml&gt;)
# 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-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 &lt;workload name&gt;...
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental m &lt;workload name&gt;...
</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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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-precheck>istioctl experimental precheck</h2><p>precheck inspects a Kubernetes cluster for Istio install and upgrade requirements.</p><pre class=language-bash><code>istioctl experimental precheck [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--skip-controlplane</code></td><td></td><td>skip checking the control plane</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-precheck Examples">Examples</h3><pre class=language-bash><code> # Verify that Istio can be installed or upgraded
istioctl x precheck
# Check only a single namespace
istioctl x precheck --namespace default
</code></pre><h2 id=istioctl-experimental-proxy-status>istioctl experimental proxy-status</h2><p>Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh</p><pre class=language-bash><code>istioctl experimental proxy-status [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental ps [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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>--authority &lt;string></code></td><td></td><td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td></tr><tr><td><code>--cert-dir &lt;string></code></td><td></td><td>XDS Endpoint certificate directory (default ``)</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--insecure</code></td><td></td><td>Skip server certificate and domain verification. (NOT SECURE!)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--plaintext</code></td><td></td><td>Use plain-text HTTP/2 when connecting to server (no TLS).</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--timeout &lt;duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--xds-address &lt;string></code></td><td></td><td>XDS Endpoint (default ``)</td></tr><tr><td><code>--xds-label &lt;string></code></td><td></td><td>Istiod pod label selector (default ``)</td></tr><tr><td><code>--xds-port &lt;int></code></td><td></td><td>Istiod pod port (default `15012`)</td></tr></tbody></table><h3 id="istioctl-experimental-proxy-status Examples">Examples</h3><pre class=language-bash><code> # Retrieve sync status for all Envoys in a mesh
istioctl x proxy-status
# Retrieve sync diff for a single Envoy and Istiod
istioctl x proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
# SECURITY OPTIONS
# Retrieve proxy status information directly from the control plane, using token security
# (This is the usual way to get the proxy-status with an out-of-cluster control plane.)
istioctl x ps --xds-address istio.cloudprovider.example.com:15012
# Retrieve proxy status information via Kubernetes config, using token security
# (This is the usual way to get the proxy-status with an in-cluster control plane.)
istioctl x proxy-status
# Retrieve proxy status information directly from the control plane, using RSA certificate security
# (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
istioctl x ps --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
# Retrieve proxy status information via XDS from specific control plane in multi-control plane in-cluster configuration
# (Select a specific control plane in an in-cluster canary Istio configuration.)
istioctl x ps --xds-label istio.io/rev=default
</code></pre><h2 id=istioctl-experimental-remote-clusters>istioctl experimental remote-clusters</h2><p>Lists the remote clusters each istiod instance is connected to.</p><pre class=language-bash><code>istioctl experimental remote-clusters [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-experimental-remove-from-mesh>istioctl experimental remove-from-mesh</h2><p>'istioctl experimental remove-from-mesh' restarts pods without an Istio sidecar or removes external service access configuration.
Use 'remove-from-mesh' to quickly test uninjected behavior as part of compatibility troubleshooting.
The 'add-to-mesh' command can be used to add or restore the sidecar.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental remove-from-mesh [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental rm [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-remove-from-mesh Examples">Examples</h3><pre class=language-bash><code> # Restart all productpage pods without an Istio sidecar
istioctl experimental remove-from-mesh service productpage
# Restart all details-v1 pods without an Istio sidecar
istioctl x rm service details-v1
# Restart all ratings-v1 pods without an Istio sidecar
istioctl x rm deploy ratings-v1
</code></pre><h2 id=istioctl-experimental-remove-from-mesh-deployment>istioctl experimental remove-from-mesh deployment</h2><p>'istioctl experimental remove-from-mesh deployment' restarts pods with the Istio sidecar un-injected.
'remove-from-mesh' is a compatibility troubleshooting tool.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental remove-from-mesh deployment &lt;deployment&gt; [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental remove-from-mesh deploy &lt;deployment&gt; [flags]
istioctl experimental remove-from-mesh dep &lt;deployment&gt; [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-remove-from-mesh-deployment Examples">Examples</h3><pre class=language-bash><code> # Restart all productpage-v1 pods without an Istio sidecar
istioctl experimental remove-from-mesh deployment productpage-v1
# Restart all details-v1 pods without an Istio sidecar
istioctl x remove-from-mesh deploy details-v1
# Restart all ratings-v1 pods without an Istio sidecar
istioctl x rm dep ratings-v1
</code></pre><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' removes the ServiceEntry and
the Kubernetes Service for the specified external service (e.g. services running on a VM) from Istio service mesh.
The typical usage scenario is Mesh Expansion on VMs.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental remove-from-mesh external-service &lt;svcname&gt; [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental remove-from-mesh es &lt;svcname&gt; [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-remove-from-mesh-external-service Examples">Examples</h3><pre class=language-bash><code> # Remove &#34;vmhttp&#34; service entry rules
istioctl experimental remove-from-mesh external-service vmhttp
# Remove &#34;vmhttp&#34; service entry rules
istioctl x remove-from-mesh es vmhttp
# Remove &#34;vmhttp&#34; service entry rules
istioctl x rm es 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.
'remove-from-mesh' is a compatibility troubleshooting tool.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental remove-from-mesh service &lt;service&gt; [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental remove-from-mesh svc &lt;service&gt; [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-remove-from-mesh-service Examples">Examples</h3><pre class=language-bash><code> # Restart all productpage pods without an Istio sidecar
istioctl experimental remove-from-mesh service productpage
# Restart all details-v1 pods without an Istio sidecar
istioctl x remove-from-mesh svc details-v1
# Restart all ratings-v1 pods without an Istio sidecar
istioctl x rm svc ratings-v1
</code></pre><h2 id=istioctl-experimental-revision>istioctl experimental revision</h2><p>The revision command provides a revision centric view of istio deployments. It provides insight into IstioOperator CRs defining the revision, istiod and gateway pods which are part of deployment of a particular revision.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format for revision description (available formats: table,json) (default `table`)</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-experimental-revision-describe>istioctl experimental revision describe</h2><p>Show information about a revision, including customizations, istiod version and which pods/gateways are using it.</p><pre class=language-bash><code>istioctl experimental revision describe [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format for revision description (available formats: table,json) (default `table`)</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-revision-describe Examples">Examples</h3><pre class=language-bash><code> # View the details of a revision named &#39;canary&#39;
istioctl x revision describe canary
# View the details of a revision named &#39;canary&#39; and also the pods
# under that particular revision
istioctl x revision describe canary -v
# Get details about a revision in json format (default format is human-friendly table format)
istioctl x revision describe canary -v -o json
</code></pre><h2 id=istioctl-experimental-revision-list>istioctl experimental revision list</h2><p>Show list of control plane and gateway revisions that are currently installed in cluster</p><pre class=language-bash><code>istioctl experimental revision 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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format for revision description (available formats: table,json) (default `table`)</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-revision-list Examples">Examples</h3><pre class=language-bash><code> # View summary of revisions installed in the current cluster
# which can be overridden with --context parameter.
istioctl x revision list
# View list of revisions including customizations, istiod and gateway pods
istioctl x revision list -v
</code></pre><h2 id=istioctl-experimental-revision-tag>istioctl experimental revision tag</h2><p>Command group used to interact with revision tags. Revision tags allow for the creation of mutable aliases
referring to control plane revisions for sidecar injection.</p><p>With revision tags, rather than relabeling a namespace from "istio.io/rev=revision-a" to "istio.io/rev=revision-b" to
change which control plane revision handles injection, it's possible to create a revision tag "prod" and label our
namespace "istio.io/rev=prod". The "prod" revision tag could point to "1-7-6" initially and then be changed to point to "1-8-1"
at some later point.</p><p>This allows operators to change which Istio control plane revision should handle injection for a namespace or set of namespaces
without manual relabeling of the "istio.io/rev" tag.</p><pre class=language-bash><code>istioctl experimental revision tag [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format for revision description (available formats: table,json) (default `table`)</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-experimental-revision-tag-generate>istioctl experimental revision tag generate</h2><p>Create a revision tag and output to the command's stdout. Tag an Istio control plane revision for use with namespace istio.io/rev
injection labels.</p><pre class=language-bash><code>istioctl experimental revision tag generate &lt;revision-tag&gt; [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--auto-inject-namespaces</code></td><td></td><td>If set to true, the sidecars should be automatically injected into all namespaces by default</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format for revision description (available formats: table,json) (default `table`)</td></tr><tr><td><code>--overwrite</code></td><td></td><td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
overwrite existing revision tags.</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision to reference from a given revision tag (default ``)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>The skipConfirmation determines whether the user is prompted for confirmation.
If set to true, the user is not prompted and a Yes response is assumed in all cases.</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--webhook-name &lt;string></code></td><td></td><td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-revision-tag-generate Examples">Examples</h3><pre class=language-bash><code> # Create a revision tag from the &#34;1-8-0&#34; revision
istioctl tag generate prod --revision 1-8-0 &gt; tag.yaml
# Apply the tag to cluster
kubectl apply -f tag.yaml
# Point namespace &#34;test-ns&#34; at the revision pointed to by the &#34;prod&#34; revision tag
kubectl label ns test-ns istio.io/rev=prod
# Rollout namespace &#34;test-ns&#34; to update workloads to the &#34;1-8-0&#34; revision
kubectl rollout restart deployments -n test-ns
</code></pre><h2 id=istioctl-experimental-revision-tag-list>istioctl experimental revision tag list</h2><p>List existing revision tags</p><pre class=language-bash><code>istioctl experimental revision tag list [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental revision tag show [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format for revision description (available formats: table,json) (default `table`)</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-revision-tag-list Examples">Examples</h3><pre class=language-bash><code>istioctl tag list
</code></pre><h2 id=istioctl-experimental-revision-tag-remove>istioctl experimental revision tag remove</h2><p>Remove Istio control plane revision tag.</p><p>Removing a revision tag should be done with care. Removing a revision tag will disrupt sidecar injection in namespaces
that reference the tag in an "istio.io/rev" label. Verify that there are no remaining namespaces referencing a
revision tag before removing using the "istioctl tag list" command.</p><pre class=language-bash><code>istioctl experimental revision tag remove &lt;revision-tag&gt; [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental revision tag delete &lt;revision-tag&gt; [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format for revision description (available formats: table,json) (default `table`)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>The skipConfirmation determines whether the user is prompted for confirmation.
If set to true, the user is not prompted and a Yes response is assumed in all cases.</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-revision-tag-remove Examples">Examples</h3><pre class=language-bash><code> # Remove the revision tag &#34;prod&#34;
istioctl tag remove prod
</code></pre><h2 id=istioctl-experimental-revision-tag-set>istioctl experimental revision tag set</h2><p>Create or modify revision tags. Tag an Istio control plane revision for use with namespace istio.io/rev
injection labels.</p><pre class=language-bash><code>istioctl experimental revision tag set &lt;revision-tag&gt; [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--auto-inject-namespaces</code></td><td></td><td>If set to true, the sidecars should be automatically injected into all namespaces by default</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format for revision description (available formats: table,json) (default `table`)</td></tr><tr><td><code>--overwrite</code></td><td></td><td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
overwrite existing revision tags.</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision to reference from a given revision tag (default ``)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>The skipConfirmation determines whether the user is prompted for confirmation.
If set to true, the user is not prompted and a Yes response is assumed in all cases.</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--webhook-name &lt;string></code></td><td></td><td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-revision-tag-set Examples">Examples</h3><pre class=language-bash><code> # Create a revision tag from the &#34;1-8-0&#34; revision
istioctl tag set prod --revision 1-8-0
# Point namespace &#34;test-ns&#34; at the revision pointed to by the &#34;prod&#34; revision tag
kubectl label ns test-ns istio.io/rev=prod
# Change the revision tag to reference the &#34;1-8-1&#34; revision
istioctl tag set prod --revision 1-8-1 --overwrite
# Make revision &#34;1-8-1&#34; the default revision, both resulting in that revision handling injection for &#34;istio-injection=enabled&#34;
# and validating resources cluster-wide
istioctl tag set default --revision 1-8-1
# Rollout namespace &#34;test-ns&#34; to update workloads to the &#34;1-8-1&#34; revision
kubectl rollout restart deployments -n test-ns
</code></pre><h2 id=istioctl-experimental-uninstall>istioctl experimental uninstall</h2><p>The uninstall command uninstalls Istio from a cluster</p><pre class=language-bash><code>istioctl experimental uninstall [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 &lt;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 &lt;string></code></td><td><code>-f</code></td><td>The filename of the IstioOperator CR. (default ``)</td></tr><tr><td><code>--force</code></td><td></td><td>Proceed even with validation errors.</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--purge</code></td><td></td><td>Delete all Istio related sources for all versions</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set &lt;stringArray></code></td><td><code>-s</code></td><td>Override an IstioOperator value, e.g. to choose a profile
(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.12/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>The skipConfirmation determines whether the user is prompted for confirmation.
If set to true, the user is not prompted and a Yes response is assumed in all cases.</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Verbose output.</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-uninstall Examples">Examples</h3><pre class=language-bash><code> # Uninstall a single control plane by revision
istioctl x uninstall --revision foo
# Uninstall a single control plane by iop file
istioctl x uninstall -f iop.yaml
# Uninstall all control planes and shared resources
istioctl x uninstall --purge
</code></pre><h2 id=istioctl-experimental-version>istioctl experimental version</h2><p>Prints out build version information</p><pre class=language-bash><code>istioctl experimental 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>--authority &lt;string></code></td><td></td><td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td></tr><tr><td><code>--cert-dir &lt;string></code></td><td></td><td>XDS Endpoint certificate directory (default ``)</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--insecure</code></td><td></td><td>Skip server certificate and domain verification. (NOT SECURE!)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>One of 'yaml' or 'json'. (default ``)</td></tr><tr><td><code>--plaintext</code></td><td></td><td>Use plain-text HTTP/2 when connecting to server (no TLS).</td></tr><tr><td><code>--remote</code></td><td></td><td>Use --remote=false to suppress control plane check</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--short</code></td><td><code>-s</code></td><td>Use --short=false to generate full version information</td></tr><tr><td><code>--timeout &lt;duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--xds-address &lt;string></code></td><td></td><td>XDS Endpoint (default ``)</td></tr><tr><td><code>--xds-label &lt;string></code></td><td></td><td>Istiod pod label selector (default ``)</td></tr><tr><td><code>--xds-port &lt;int></code></td><td></td><td>Istiod pod port (default `15012`)</td></tr></tbody></table><h3 id="istioctl-experimental-version Examples">Examples</h3><pre class=language-bash><code># Retrieve version information directly from the control plane, using token security
# (This is the usual way to get the control plane version with an out-of-cluster control plane.)
istioctl x version --xds-address istio.cloudprovider.example.com:15012
# Retrieve version information via Kubernetes config, using token security
# (This is the usual way to get the control plane version with an in-cluster control plane.)
istioctl x version
# Retrieve version information directly from the control plane, using RSA certificate security
# (Certificates must be obtained before this step. The --cert-dir flag lets istioctl bypass the Kubernetes API server.)
istioctl x version --xds-address istio.example.com:15012 --cert-dir ~/.istio-certs
# Retrieve version information via XDS from specific control plane in multi-control plane in-cluster configuration
# (Select a specific control plane in an in-cluster canary Istio configuration.)
istioctl x version --xds-label istio.io/rev=default
</code></pre><h2 id=istioctl-experimental-wait>istioctl experimental wait</h2><p>Waits for the specified condition to be true of an Istio resource.</p><pre class=language-bash><code>istioctl experimental wait [flags] &lt;type&gt; &lt;name&gt;[.&lt;namespace&gt;]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--for &lt;string></code></td><td></td><td>Wait condition, must be 'distribution' or 'delete' (default `distribution`)</td></tr><tr><td><code>--generation &lt;string></code></td><td></td><td>Wait for a specific generation of config to become current, rather than using whatever is latest in Kubernetes (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--threshold &lt;float32></code></td><td></td><td>The ratio of distribution required for success (default `1`)</td></tr><tr><td><code>--timeout &lt;duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-wait Examples">Examples</h3><pre class=language-bash><code> # Wait until the bookinfo virtual service has been distributed to all proxies in the mesh
istioctl experimental wait --for=distribution virtualservice bookinfo.default
# Wait until 99% of the proxies receive the distribution, timing out after 5 minutes
istioctl experimental wait --for=distribution --threshold=.99 --timeout=300 virtualservice bookinfo.default
</code></pre><h2 id=istioctl-experimental-workload>istioctl experimental workload</h2><p>Commands to assist in configuring and deploying workloads running on VMs and other non-Kubernetes environments</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-workload Examples">Examples</h3><pre class=language-bash><code> # workload group yaml generation
workload group create
# workload entry configuration generation
workload entry configure
</code></pre><h2 id=istioctl-experimental-workload-entry>istioctl experimental workload entry</h2><p>Commands dealing with WorkloadEntry resources</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-workload-entry Examples">Examples</h3><pre class=language-bash><code>entry configure -f workloadgroup.yaml -o outputDir
</code></pre><h2 id=istioctl-experimental-workload-entry-configure>istioctl experimental workload entry configure</h2><p>Generates all the required configuration files for workload instance on a VM or non-Kubernetes environment from a WorkloadGroup artifact.
This includes a MeshConfig resource, the cluster.env file, and necessary certificates and security tokens.
Configure requires either the WorkloadGroup artifact path or its location on the API server.</p><pre class=language-bash><code>istioctl experimental workload entry configure [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--autoregister</code></td><td></td><td>Creates a WorkloadEntry upon connection to istiod (if enabled in pilot).</td></tr><tr><td><code>--capture-dns</code></td><td></td><td>Enables the capture of outgoing DNS packets on port 53, redirecting to istio-agent</td></tr><tr><td><code>--clusterID &lt;string></code></td><td></td><td>The ID used to identify the cluster (default ``)</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--externalIP &lt;string></code></td><td></td><td>External IP address of the workload (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>filename of the WorkloadGroup artifact. Leave this field empty if using the API server (default ``)</td></tr><tr><td><code>--ingressIP &lt;string></code></td><td></td><td>IP address of the ingress gateway (default ``)</td></tr><tr><td><code>--ingressService &lt;string></code></td><td></td><td>Name of the Service to be used as the ingress gateway, in the format &lt;service>.&lt;namespace>. If no namespace is provided, the default istio-system namespace will be used. (default `istio-eastwestgateway`)</td></tr><tr><td><code>--internalIP &lt;string></code></td><td></td><td>Internal IP address of the workload (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name &lt;string></code></td><td></td><td>The name of the workload group (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output directory for generated files (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--tokenDuration &lt;int></code></td><td></td><td>The token duration in seconds (default: 1 hour) (default `3600`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-workload-entry-configure Examples">Examples</h3><pre class=language-bash><code> # configure example using a local WorkloadGroup artifact
configure -f workloadgroup.yaml -o config
# configure example using the API server
configure --name foo --namespace bar -o config
</code></pre><h2 id=istioctl-experimental-workload-group>istioctl experimental workload group</h2><p>Commands dealing with WorkloadGroup resources</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-workload-group Examples">Examples</h3><pre class=language-bash><code>group create --name foo --namespace bar --labels app=foobar
</code></pre><h2 id=istioctl-experimental-workload-group-create>istioctl experimental workload group create</h2><p>Creates a WorkloadGroup resource that provides a template for associated WorkloadEntries.
The default output is serialized YAML, which can be piped into 'kubectl apply -f -' to send the artifact to the API Server.</p><pre class=language-bash><code>istioctl experimental workload group create [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 &lt;stringSlice></code></td><td><code>-a</code></td><td>The annotations to apply to the workload instances (default `[]`)</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--labels &lt;stringSlice></code></td><td><code>-l</code></td><td>The labels to apply to the workload instances; e.g. -l env=prod,vers=2 (default `[]`)</td></tr><tr><td><code>--name &lt;string></code></td><td></td><td>The name of the workload group (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--ports &lt;stringSlice></code></td><td><code>-p</code></td><td>The incoming ports exposed by the workload instance (default `[]`)</td></tr><tr><td><code>--serviceAccount &lt;string></code></td><td><code>-s</code></td><td>The service identity to associate with the workload instances (default `default`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-experimental-workload-group-create Examples">Examples</h3><pre class=language-bash><code>create --name foo --namespace bar --labels app=foo,bar=baz --ports grpc=3550,http=8080 --annotations annotation=foobar --serviceAccount sa
</code></pre><h2 id=istioctl-install>istioctl install</h2><p>The install command generates an Istio install manifest and applies it to a cluster.</p><pre class=language-bash><code>istioctl install [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl apply [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>--charts &lt;string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context &lt;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 &lt;stringSlice></code></td><td><code>-f</code></td><td>Path to file containing IstioOperator custom resource
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td></tr><tr><td><code>--force</code></td><td></td><td>Proceed even with validation errors.</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--readiness-timeout &lt;duration></code></td><td></td><td>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set &lt;stringArray></code></td><td><code>-s</code></td><td>Override an IstioOperator value, e.g. to choose a profile
(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.12/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>The skipConfirmation determines whether the user is prompted for confirmation.
If set to true, the user is not prompted and a Yes response is assumed in all cases.</td></tr><tr><td><code>--verify</code></td><td></td><td>Verify the Istio control plane after installation/in-place upgrade</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-install Examples">Examples</h3><pre class=language-bash><code> # Apply a default Istio installation
istioctl install
# Enable Tracing
istioctl install --set meshConfig.enableTracing=true
# Generate the demo profile and don&#39;t wait for confirmation
istioctl install --set profile=demo --skip-confirmation
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
istioctl install --set &#34;values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default&#34;
# For setting boolean-string option, it should be enclosed quotes and escaped with a backslash (\).
istioctl install --set meshConfig.defaultConfig.proxyMetadata.PROXY_XDS_VIA_AGENT=\&#34;false\&#34;
</code></pre><h2 id=istioctl-kube-inject>istioctl kube-inject</h2><p>kube-inject manually injects the Istio sidecar into Kubernetes
workloads. Unsupported resources are left unmodified so it is safe to
run kube-inject over a single file that contains multiple Service,
ConfigMap, Deployment, etc. definitions for a complex application. When in
doubt re-run istioctl kube-inject on deployments to get the most up-to-date changes.</p><p>It's best to do kube-inject when the resource is initially created.</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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename &lt;string></code></td><td><code>-f</code></td><td>Input Kubernetes resource filename (default ``)</td></tr><tr><td><code>--injectConfigFile &lt;string></code></td><td></td><td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--meshConfigFile &lt;string></code></td><td></td><td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName &lt;string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Modified output Kubernetes resource filename (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--valuesFile &lt;string></code></td><td></td><td>Injection values configuration filename. (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--webhookConfig &lt;string></code></td><td></td><td>MutatingWebhookConfiguration name for Istio (default `istio-sidecar-injector`)</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 &lt;(istioctl kube-inject -f &lt;resource.yaml&gt;)
# Create a persistent version of the deployment with Istio sidecar injected.
istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml
# Update an existing deployment.
kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -
# Capture cluster configuration for later use with kube-inject
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath=&#34;{.data.config}&#34; &gt; /tmp/inj-template.tmpl
kubectl -n istio-system get cm istio -o jsonpath=&#34;{.data.mesh}&#34; &gt; /tmp/mesh.yaml
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath=&#34;{.data.values}&#34; &gt; /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-manifest>istioctl manifest</h2><p>The manifest command generates and diffs 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 &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-manifest-diff>istioctl manifest diff</h2><p>The diff subcommand compares manifests from two files or directories. The output is a list of
changed paths with the value changes shown as OLD-VALUE -> NEW-VALUE.
List order changes are shown as [OLD-INDEX->NEW-INDEX], with ? used where a list item is added or
removed.</p><pre class=language-bash><code>istioctl manifest diff &lt;file|dir&gt; &lt;file|dir&gt; [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 &lt;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 &lt;string></code></td><td></td><td>Ignore all listed items during comparison, using the same list format as selectResources. (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--rename &lt;string></code></td><td></td><td>Rename resources before comparison.
The format of each renaming pair is A->B, all renaming pairs are comma separated.
e.g. Service:*:istiod->Service:*:istio-control - rename istiod service into istio-control (default ``)</td></tr><tr><td><code>--select &lt;string></code></td><td></td><td>Constrain the list of resources to compare to only the ones in this list, ignoring all others.
The format of each list item is "::" and the items are comma separated. The "*" character represents wildcard selection.
e.g.
Deployment:istio-system:* - compare all deployments in istio-system namespace
Service:*:istiod - compare Services called "istiod" in all namespaces (default `::`)</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Verbose output.</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-manifest-generate>istioctl 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 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>--charts &lt;string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--component &lt;stringSlice></code></td><td></td><td>Specify which component to generate manifests for. (default `[]`)</td></tr><tr><td><code>--context &lt;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 &lt;stringSlice></code></td><td><code>-f</code></td><td>Path to file containing IstioOperator custom resource
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td></tr><tr><td><code>--force</code></td><td></td><td>Proceed even with validation errors.</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Manifest output directory path. (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set &lt;stringArray></code></td><td><code>-s</code></td><td>Override an IstioOperator value, e.g. to choose a profile
(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.12/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-manifest-generate Examples">Examples</h3><pre class=language-bash><code> # Generate a default Istio installation
istioctl manifest generate
# Enable Tracing
istioctl manifest generate --set meshConfig.enableTracing=true
# Generate the demo profile
istioctl manifest generate --set profile=demo
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
istioctl manifest generate --set &#34;values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default&#34;
# For setting boolean-string option, it should be enclosed quotes and escaped with a backslash (\).
istioctl manifest generate --set meshConfig.defaultConfig.proxyMetadata.PROXY_XDS_VIA_AGENT=\&#34;false\&#34;
</code></pre><h2 id=istioctl-manifest-install>istioctl manifest install</h2><p>The install command generates an Istio install manifest and applies it to a cluster.</p><pre class=language-bash><code>istioctl manifest install [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl manifest apply [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>--charts &lt;string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context &lt;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 &lt;stringSlice></code></td><td><code>-f</code></td><td>Path to file containing IstioOperator custom resource
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td></tr><tr><td><code>--force</code></td><td></td><td>Proceed even with validation errors.</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--readiness-timeout &lt;duration></code></td><td></td><td>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set &lt;stringArray></code></td><td><code>-s</code></td><td>Override an IstioOperator value, e.g. to choose a profile
(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.12/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>The skipConfirmation determines whether the user is prompted for confirmation.
If set to true, the user is not prompted and a Yes response is assumed in all cases.</td></tr><tr><td><code>--verify</code></td><td></td><td>Verify the Istio control plane after installation/in-place upgrade</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-manifest-install Examples">Examples</h3><pre class=language-bash><code> # Apply a default Istio installation
istioctl install
# Enable Tracing
istioctl install --set meshConfig.enableTracing=true
# Generate the demo profile and don&#39;t wait for confirmation
istioctl install --set profile=demo --skip-confirmation
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
istioctl install --set &#34;values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default&#34;
# For setting boolean-string option, it should be enclosed quotes and escaped with a backslash (\).
istioctl install --set meshConfig.defaultConfig.proxyMetadata.PROXY_XDS_VIA_AGENT=\&#34;false\&#34;
</code></pre><h2 id=istioctl-operator>istioctl operator</h2><p>The operator command installs, dumps, removes and shows the status of the operator controller.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-operator-dump>istioctl operator dump</h2><p>The dump subcommand dumps the Istio operator controller manifest.</p><pre class=language-bash><code>istioctl operator dump [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--charts &lt;string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context &lt;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>--hub &lt;string></code></td><td></td><td>The hub for the operator controller image. (default `unknown`)</td></tr><tr><td><code>--imagePullSecrets &lt;stringSlice></code></td><td></td><td>The imagePullSecrets are used to pull the operator image from the private registry,
could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (default `[]`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--operatorNamespace &lt;string></code></td><td></td><td>The namespace the operator controller is installed into. (default `istio-operator`)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Target revision for the operator. (default ``)</td></tr><tr><td><code>--tag &lt;string></code></td><td></td><td>The tag for the operator controller image. (default `unknown`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--watchedNamespaces &lt;string></code></td><td></td><td>The namespaces the operator controller watches, could be namespace list separated by comma, eg. 'ns1,ns2' (default `istio-system`)</td></tr></tbody></table><h2 id=istioctl-operator-init>istioctl operator init</h2><p>The init subcommand installs the Istio operator controller in the cluster.</p><pre class=language-bash><code>istioctl operator init [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--charts &lt;string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context &lt;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 &lt;string></code></td><td><code>-f</code></td><td>Path to file containing IstioOperator custom resource
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default ``)</td></tr><tr><td><code>--hub &lt;string></code></td><td></td><td>The hub for the operator controller image. (default `unknown`)</td></tr><tr><td><code>--imagePullSecrets &lt;stringSlice></code></td><td></td><td>The imagePullSecrets are used to pull the operator image from the private registry,
could be secret list separated by comma, eg. '--imagePullSecrets imagePullSecret1,imagePullSecret2' (default `[]`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--operatorNamespace &lt;string></code></td><td></td><td>The namespace the operator controller is installed into. (default `istio-operator`)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Target revision for the operator. (default ``)</td></tr><tr><td><code>--tag &lt;string></code></td><td></td><td>The tag for the operator controller image. (default `unknown`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--watchedNamespaces &lt;string></code></td><td></td><td>The namespaces the operator controller watches, could be namespace list separated by comma, eg. 'ns1,ns2' (default `istio-system`)</td></tr></tbody></table><h2 id=istioctl-operator-remove>istioctl operator remove</h2><p>The remove subcommand removes the Istio operator controller from the cluster.</p><pre class=language-bash><code>istioctl operator remove [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 &lt;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>--force</code></td><td></td><td>Proceed even with validation errors.</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--operatorNamespace &lt;string></code></td><td></td><td>The namespace the operator controller is installed into. (default `istio-operator`)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Target revision for the operator. (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-options>istioctl options</h2><p>Displays istioctl global options</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-profile>istioctl profile</h2><p>The profile command 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 &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-profile Examples">Examples</h3><pre class=language-bash><code>istioctl profile list
istioctl install --set profile=demo # Use a profile from the list
</code></pre><h2 id=istioctl-profile-diff>istioctl profile diff</h2><p>The diff subcommand displays the differences between two Istio configuration profiles.</p><pre class=language-bash><code>istioctl profile diff &lt;profile|file1.yaml&gt; &lt;profile|file2.yaml&gt; [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--charts &lt;string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-profile-diff Examples">Examples</h3><pre class=language-bash><code> # Profile diff by providing yaml files
istioctl profile diff manifests/profiles/default.yaml manifests/profiles/demo.yaml
# Profile diff by providing a profile name
istioctl profile diff default demo
</code></pre><h2 id=istioctl-profile-dump>istioctl profile dump</h2><p>The dump subcommand dumps the values in an Istio configuration profile.</p><pre class=language-bash><code>istioctl profile dump [&lt;profile&gt;] [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--charts &lt;string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--config-path &lt;string></code></td><td><code>-p</code></td><td>The path the root of the configuration subtree to dump e.g. components.pilot. By default, dump whole tree (default ``)</td></tr><tr><td><code>--context &lt;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 &lt;stringSlice></code></td><td><code>-f</code></td><td>Path to file containing IstioOperator custom resource
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|flags (default `yaml`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-profile-list>istioctl profile list</h2><p>The list subcommand lists the available Istio configuration profiles.</p><pre class=language-bash><code>istioctl 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>--charts &lt;string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context &lt;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 &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 &lt;clusters|listeners|routes|endpoints|bootstrap|log|secret&gt; &lt;pod-name[.namespace]&gt;
</code></pre><h2 id=istioctl-proxy-config-all>istioctl proxy-config all</h2><p>Retrieve information about all configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config all [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config a [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>Filter listeners by address field (default ``)</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--direction &lt;string></code></td><td></td><td>Filter clusters by Direction field (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>Envoy config dump file (default ``)</td></tr><tr><td><code>--fqdn &lt;string></code></td><td></td><td>Filter clusters by substring of Service FQDN field (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name &lt;string></code></td><td></td><td>Filter listeners by route name field (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--port &lt;int></code></td><td></td><td>Filter clusters and listeners by Port field (default `0`)</td></tr><tr><td><code>--subset &lt;string></code></td><td></td><td>Filter clusters by substring of Subset field (default ``)</td></tr><tr><td><code>--type &lt;string></code></td><td></td><td>Filter listeners by type field (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Output more information</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-proxy-config-all Examples">Examples</h3><pre class=language-bash><code> # Retrieve summary about all configuration for a given pod from Envoy.
istioctl proxy-config all &lt;pod-name[.namespace]&gt;
# Retrieve full cluster dump as JSON
istioctl proxy-config all &lt;pod-name[.namespace]&gt; -o json
# Retrieve full cluster dump with short syntax
istioctl pc a &lt;pod-name[.namespace]&gt;
# Retrieve cluster summary without using Kubernetes API
ssh &lt;user@hostname&gt; &#39;curl localhost:15000/config_dump&#39; &gt; envoy-config.json
istioctl proxy-config all --file envoy-config.json
</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 [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config b [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 &lt;pod-name[.namespace]&gt;
# Retrieve full bootstrap without using Kubernetes API
ssh &lt;user@hostname&gt; &#39;curl localhost:15000/config_dump&#39; &gt; envoy-config.json
istioctl proxy-config bootstrap --file envoy-config.json
# Show a human-readable Istio and Envoy version summary
istioctl proxy-config bootstrap -o short
</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 [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config clusters [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
istioctl proxy-config c [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--direction &lt;string></code></td><td></td><td>Filter clusters by Direction field (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--fqdn &lt;string></code></td><td></td><td>Filter clusters by substring of Service FQDN field (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--port &lt;int></code></td><td></td><td>Filter clusters by Port field (default `0`)</td></tr><tr><td><code>--subset &lt;string></code></td><td></td><td>Filter clusters by substring of Subset field (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 &lt;pod-name[.namespace]&gt;
# Retrieve cluster summary for clusters with port 9080.
istioctl proxy-config clusters &lt;pod-name[.namespace]&gt; --port 9080
# Retrieve full cluster dump for clusters that are inbound with a FQDN of details.default.svc.cluster.local.
istioctl proxy-config clusters &lt;pod-name[.namespace]&gt; --fqdn details.default.svc.cluster.local --direction inbound -o json
# Retrieve cluster summary without using Kubernetes API
ssh &lt;user@hostname&gt; &#39;curl localhost:15000/config_dump&#39; &gt; envoy-config.json
istioctl proxy-config clusters --file envoy-config.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 [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config endpoints [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
istioctl proxy-config ep [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>Filter endpoints by address field (default ``)</td></tr><tr><td><code>--cluster &lt;string></code></td><td></td><td>Filter endpoints by cluster name field (default ``)</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--port &lt;int></code></td><td></td><td>Filter endpoints by Port field (default `0`)</td></tr><tr><td><code>--status &lt;string></code></td><td></td><td>Filter endpoints by status field (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 &lt;pod-name[.namespace]&gt;
# Retrieve endpoint summary for endpoint with port 9080.
istioctl proxy-config endpoint &lt;pod-name[.namespace]&gt; --port 9080
# Retrieve full endpoint with a address (172.17.0.2).
istioctl proxy-config endpoint &lt;pod-name[.namespace]&gt; --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 &lt;pod-name[.namespace]&gt; --cluster &#34;outbound|9411||zipkin.istio-system.svc.cluster.local&#34; -o json
# Retrieve full endpoint with the status (healthy).
istioctl proxy-config endpoint &lt;pod-name[.namespace]&gt; --status healthy -ojson
# Retrieve endpoint summary without using Kubernetes API
ssh &lt;user@hostname&gt; &#39;curl localhost:15000/clusters?format=json&#39; &gt; envoy-clusters.json
istioctl proxy-config endpoints --file envoy-clusters.json
</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 [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config listeners [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
istioctl proxy-config l [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>Filter listeners by address field (default ``)</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--port &lt;int></code></td><td></td><td>Filter listeners by Port field (default `0`)</td></tr><tr><td><code>--type &lt;string></code></td><td></td><td>Filter listeners by type field (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Output more information</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 &lt;pod-name[.namespace]&gt;
# Retrieve listener summary for listeners with port 9080.
istioctl proxy-config listeners &lt;pod-name[.namespace]&gt; --port 9080
# Retrieve full listener dump for HTTP listeners with a wildcard address (0.0.0.0).
istioctl proxy-config listeners &lt;pod-name[.namespace]&gt; --type HTTP --address 0.0.0.0 -o json
# Retrieve listener summary without using Kubernetes API
ssh &lt;user@hostname&gt; &#39;curl localhost:15000/config_dump&#39; &gt; envoy-config.json
istioctl proxy-config listeners --file envoy-config.json
</code></pre><h2 id=istioctl-proxy-config-log>istioctl proxy-config log</h2><p>(experimental) Retrieve information about logging levels of the Envoy instance in the specified pod, and update optionally</p><pre class=language-bash><code>istioctl proxy-config log [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config o [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--level &lt;string></code></td><td></td><td>Comma-separated minimum per-logger level of messages to output, in the form of [&lt;logger>:]&lt;level>,[&lt;logger>:]&lt;level>,... where logger can be one of admin, aws, assert, backtrace, client, config, connection, conn_handler, dubbo, file, filter, forward_proxy, grpc, hc, health_checker, http, http2, hystrix, init, io, jwt, kafka, lua, main, misc, mongo, quic, pool, rbac, redis, router, runtime, stats, secret, tap, testing, thrift, tracing, upstream, udp, wasm and level can be one of [trace, debug, info, warning, error, critical, off] (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--reset</code></td><td><code>-r</code></td><td>Reset levels to default value (warning).</td></tr><tr><td><code>--selector &lt;string></code></td><td><code>-l</code></td><td>Label selector (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-proxy-config-log Examples">Examples</h3><pre class=language-bash><code> # Retrieve information about logging levels for a given pod from Envoy.
istioctl proxy-config log &lt;pod-name[.namespace]&gt;
# Update levels of the all loggers
istioctl proxy-config log &lt;pod-name[.namespace]&gt; --level none
# Update levels of the specified loggers.
istioctl proxy-config log &lt;pod-name[.namespace]&gt; --level http:debug,redis:debug
# Reset levels of all the loggers to default value (warning).
istioctl proxy-config log &lt;pod-name[.namespace]&gt; -r
</code></pre><h2 id=istioctl-proxy-config-rootca-compare>istioctl proxy-config rootca-compare</h2><p>Compare ROOTCA values for given 2 pods to check the connectivity between them.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl proxy-config rootca-compare [pod/]&lt;name-1&gt;[.&lt;namespace-1&gt;] [pod/]&lt;name-2&gt;[.&lt;namespace-2&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config rootca-compare [pod/]&lt;name-1&gt;[.&lt;namespace-1&gt;] [pod/]&lt;name-2&gt;[.&lt;namespace-2&gt;] [flags]
istioctl proxy-config rc [pod/]&lt;name-1&gt;[.&lt;namespace-1&gt;] [pod/]&lt;name-2&gt;[.&lt;namespace-2&gt;] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-proxy-config-rootca-compare Examples">Examples</h3><pre class=language-bash><code> # Compare ROOTCA values for given 2 pods to check the connectivity between them.
istioctl proxy-config rootca-compare &lt;pod-name-1[.namespace]&gt; &lt;pod-name-2[.namespace]&gt;
</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 [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config routes [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
istioctl proxy-config r [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name &lt;string></code></td><td></td><td>Filter listeners by route name field (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Output more information</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 &lt;pod-name[.namespace]&gt;
# Retrieve route summary for route 9080.
istioctl proxy-config route &lt;pod-name[.namespace]&gt; --name 9080
# Retrieve full route dump for route 9080
istioctl proxy-config route &lt;pod-name[.namespace]&gt; --name 9080 -o json
# Retrieve route summary without using Kubernetes API
ssh &lt;user@hostname&gt; &#39;curl localhost:15000/config_dump&#39; &gt; envoy-config.json
istioctl proxy-config routes --file envoy-config.json
</code></pre><h2 id=istioctl-proxy-config-secret>istioctl proxy-config secret</h2><p>Retrieve information about secret configuration for the Envoy instance in the specified pod.</p><p>THIS COMMAND IS UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl proxy-config secret [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config secrets [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
istioctl proxy-config s [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-proxy-config-secret Examples">Examples</h3><pre class=language-bash><code> # Retrieve full secret configuration for a given pod from Envoy.
istioctl proxy-config secret &lt;pod-name[.namespace]&gt;
# Retrieve full bootstrap without using Kubernetes API
ssh &lt;user@hostname&gt; &#39;curl localhost:15000/config_dump&#39; &gt; envoy-config.json
istioctl proxy-config secret --file envoy-config.json
</code></pre><h2 id=istioctl-proxy-status>istioctl proxy-status</h2><p>Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh</p><p></p><pre class=language-bash><code>istioctl proxy-status [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl ps [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file &lt;string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</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 Istiod
istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
# Retrieve sync diff between Istiod and one pod under a deployment
istioctl proxy-status deployment/productpage-v1
# Write proxy config-dump to file, and compare to Istio control plane
kubectl port-forward -n istio-system istio-egressgateway-59585c5b9c-ndc59 15000 &amp;
curl localhost:15000/config_dump &gt; cd.json
istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system --file cd.json
</code></pre><h2 id=istioctl-tag>istioctl tag</h2><p>Command group used to interact with revision tags. Revision tags allow for the creation of mutable aliases
referring to control plane revisions for sidecar injection.</p><p>With revision tags, rather than relabeling a namespace from "istio.io/rev=revision-a" to "istio.io/rev=revision-b" to
change which control plane revision handles injection, it's possible to create a revision tag "prod" and label our
namespace "istio.io/rev=prod". The "prod" revision tag could point to "1-7-6" initially and then be changed to point to "1-8-1"
at some later point.</p><p>This allows operators to change which Istio control plane revision should handle injection for a namespace or set of namespaces
without manual relabeling of the "istio.io/rev" tag.</p><pre class=language-bash><code>istioctl tag [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-tag-generate>istioctl tag generate</h2><p>Create a revision tag and output to the command's stdout. Tag an Istio control plane revision for use with namespace istio.io/rev
injection labels.</p><pre class=language-bash><code>istioctl tag generate &lt;revision-tag&gt; [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--auto-inject-namespaces</code></td><td></td><td>If set to true, the sidecars should be automatically injected into all namespaces by default</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--overwrite</code></td><td></td><td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
overwrite existing revision tags.</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision to reference from a given revision tag (default ``)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>The skipConfirmation determines whether the user is prompted for confirmation.
If set to true, the user is not prompted and a Yes response is assumed in all cases.</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--webhook-name &lt;string></code></td><td></td><td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td></tr></tbody></table><h3 id="istioctl-tag-generate Examples">Examples</h3><pre class=language-bash><code> # Create a revision tag from the &#34;1-8-0&#34; revision
istioctl tag generate prod --revision 1-8-0 &gt; tag.yaml
# Apply the tag to cluster
kubectl apply -f tag.yaml
# Point namespace &#34;test-ns&#34; at the revision pointed to by the &#34;prod&#34; revision tag
kubectl label ns test-ns istio.io/rev=prod
# Rollout namespace &#34;test-ns&#34; to update workloads to the &#34;1-8-0&#34; revision
kubectl rollout restart deployments -n test-ns
</code></pre><h2 id=istioctl-tag-list>istioctl tag list</h2><p>List existing revision tags</p><pre class=language-bash><code>istioctl tag list [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl tag show [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-tag-list Examples">Examples</h3><pre class=language-bash><code>istioctl tag list
</code></pre><h2 id=istioctl-tag-remove>istioctl tag remove</h2><p>Remove Istio control plane revision tag.</p><p>Removing a revision tag should be done with care. Removing a revision tag will disrupt sidecar injection in namespaces
that reference the tag in an "istio.io/rev" label. Verify that there are no remaining namespaces referencing a
revision tag before removing using the "istioctl tag list" command.</p><pre class=language-bash><code>istioctl tag remove &lt;revision-tag&gt; [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl tag delete &lt;revision-tag&gt; [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>The skipConfirmation determines whether the user is prompted for confirmation.
If set to true, the user is not prompted and a Yes response is assumed in all cases.</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-tag-remove Examples">Examples</h3><pre class=language-bash><code> # Remove the revision tag &#34;prod&#34;
istioctl tag remove prod
</code></pre><h2 id=istioctl-tag-set>istioctl tag set</h2><p>Create or modify revision tags. Tag an Istio control plane revision for use with namespace istio.io/rev
injection labels.</p><pre class=language-bash><code>istioctl tag set &lt;revision-tag&gt; [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--auto-inject-namespaces</code></td><td></td><td>If set to true, the sidecars should be automatically injected into all namespaces by default</td></tr><tr><td><code>--context &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--overwrite</code></td><td></td><td>If true, allow revision tags to be overwritten, otherwise reject revision tag updates that
overwrite existing revision tags.</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision to reference from a given revision tag (default ``)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>The skipConfirmation determines whether the user is prompted for confirmation.
If set to true, the user is not prompted and a Yes response is assumed in all cases.</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr><tr><td><code>--webhook-name &lt;string></code></td><td></td><td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td></tr></tbody></table><h3 id="istioctl-tag-set Examples">Examples</h3><pre class=language-bash><code> # Create a revision tag from the &#34;1-8-0&#34; revision
istioctl tag set prod --revision 1-8-0
# Point namespace &#34;test-ns&#34; at the revision pointed to by the &#34;prod&#34; revision tag
kubectl label ns test-ns istio.io/rev=prod
# Change the revision tag to reference the &#34;1-8-1&#34; revision
istioctl tag set prod --revision 1-8-1 --overwrite
# Make revision &#34;1-8-1&#34; the default revision, both resulting in that revision handling injection for &#34;istio-injection=enabled&#34;
# and validating resources cluster-wide
istioctl tag set default --revision 1-8-1
# Rollout namespace &#34;test-ns&#34; to update workloads to the &#34;1-8-1&#34; revision
kubectl rollout restart deployments -n test-ns
</code></pre><h2 id=istioctl-upgrade>istioctl upgrade</h2><p>The upgrade command checks for upgrade version eligibility and, if eligible, upgrades the Istio control plane components in-place. Warning: traffic may be disrupted during upgrade. Please ensure PodDisruptionBudgets are defined to maintain service continuity.</p><pre class=language-bash><code>istioctl upgrade [flags]
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--charts &lt;string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context &lt;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 &lt;stringSlice></code></td><td><code>-f</code></td><td>Path to file containing IstioOperator custom resource
This flag can be specified multiple times to overlay multiple files. Multiple files are overlaid in left to right order. (default `[]`)</td></tr><tr><td><code>--force</code></td><td></td><td>Apply the upgrade without eligibility checks</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--readiness-timeout &lt;duration></code></td><td></td><td>Maximum time to wait for Istio resources in each component to be ready. (default `5m0s`)</td></tr><tr><td><code>--set &lt;stringArray></code></td><td><code>-s</code></td><td>Override an IstioOperator value, e.g. to choose a profile
(--set profile=demo), enable or disable components (--set components.cni.enabled=true), or override Istio
settings (--set meshConfig.enableTracing=true). See documentation for more info:https://istio.io/v1.12/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td></tr><tr><td><code>--skip-confirmation</code></td><td><code>-y</code></td><td>If skip-confirmation is set, skips the prompting confirmation for value changes in this upgrade</td></tr><tr><td><code>--verify</code></td><td></td><td>Verify the Istio control plane after installation/in-place upgrade</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=istioctl-validate>istioctl validate</h2><p>Validate Istio policy and rules files</p><pre class=language-bash><code>istioctl validate -f FILENAME [options] [flags]
</code></pre><div class=aliases><pre class=language-bash><code>istioctl v -f FILENAME [options] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename &lt;stringSlice></code></td><td><code>-f</code></td><td>Names of files to validate (default `[]`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;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><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-validate Examples">Examples</h3><pre class=language-bash><code> # Validate bookinfo-gateway.yaml
istioctl validate -f samples/bookinfo/networking/bookinfo-gateway.yaml
# Validate bookinfo-gateway.yaml with shorthand syntax
istioctl v -f samples/bookinfo/networking/bookinfo-gateway.yaml
# Validate current deployments under &#39;default&#39; namespace within the cluster
kubectl get deployments -o yaml | istioctl validate -f -
# Validate current services under &#39;default&#39; namespace within the cluster
kubectl get services -o yaml | istioctl validate -f -
# Also see the related command &#39;istioctl analyze&#39;
istioctl analyze samples/bookinfo/networking/bookinfo-gateway.yaml
</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 an installation it will check for an IstioOperator resource
and will verify if pods and services defined in it are present.</p><p>Note: For verifying whether your cluster is ready for Istio installation, see
istioctl experimental precheck.</p><pre class=language-bash><code>istioctl verify-install [-f &lt;deployment or istio operator file&gt;] [--revision &lt;revision&gt;] [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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename &lt;stringSlice></code></td><td><code>-f</code></td><td>Istio YAML installation file. (default `[]`)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests &lt;string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.12.0/manifests)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.12.0/istio-1.12.0-linux-amd64.tar.gz).
(default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h3 id="istioctl-verify-install Examples">Examples</h3><pre class=language-bash><code> # Verify that Istio is installed correctly via Istio Operator
istioctl verify-install
# Verify the deployment matches a custom Istio deployment configuration
istioctl verify-install -f $HOME/istio.yaml
# Verify the deployment matches the Istio Operator deployment definition
istioctl verify-install --revision &lt;canary&gt;
# Verify the installation of specific revision
istioctl verify-install -r 1-9-0
</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 &lt;string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace &lt;string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig &lt;string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace &lt;string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output &lt;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>--revision &lt;string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--short</code></td><td><code>-s</code></td><td>Use --short=false to generate full version information</td></tr><tr><td><code>--vklog &lt;Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h2 id=envvars>Environment variables</h2>These environment variables affect the behavior of the <code>istioctl</code> command. Please use with caution as these environment variables are experimental and can change anytime.<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>AUTO_RELOAD_PLUGIN_CERTS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, if user introduces new intermediate plug-in CA, user need not to restart istiod to pick up certs.Istiod picks newly added intermediate plug-in CA certs and updates it. Plug-in new Root-CA not supported.</td></tr><tr><td><code>CERT_SIGNER_DOMAIN</code></td><td>String</td><td><code></code></td><td>The cert signer domain info</td></tr><tr><td><code>CLUSTER_ID</code></td><td>String</td><td><code>Kubernetes</code></td><td>Defines the cluster and service registry that this Istiod instance is belongs to</td></tr><tr><td><code>ENABLE_AUTO_MTLS_CHECK_POLICIES</code></td><td>Boolean</td><td><code>true</code></td><td>Enable the auto mTLS EDS output to consult the PeerAuthentication Policy, only set the {tlsMode: istio} when server side policy enables mTLS PERMISSIVE or STRICT.</td></tr><tr><td><code>ENABLE_CA_SERVER</code></td><td>Boolean</td><td><code>true</code></td><td>If this is set to false, will not create CA server in istiod.</td></tr><tr><td><code>ENABLE_DEBUG_ON_HTTP</code></td><td>Boolean</td><td><code>true</code></td><td>If this is set to false, the debug interface will not be ebabled on Http, recommended for production</td></tr><tr><td><code>ENABLE_LEGACY_FSGROUP_INJECTION</code></td><td>Boolean</td><td><code>true</code></td><td>If true, Istiod will set the pod fsGroup to 1337 on injection. This is required for Kubernetes 1.18 and older (see https://github.com/kubernetes/kubernetes/issues/57923 for details) unless JWT_POLICY is "first-party-jwt".</td></tr><tr><td><code>ENABLE_MCS_AUTO_EXPORT</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, istiod will automatically generate Kubernetes Multi-Cluster Services (MCS) ServiceExport resources for every service in the mesh. Services defined to be cluster-local in MeshConfig are excluded.</td></tr><tr><td><code>ENABLE_MCS_CLUSTER_LOCAL</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, istiod will treat the host `&lt;svc>.&lt;namespace>.svc.cluster.local` as defined by the Kubernetes Multi-Cluster Services (MCS) spec. In this mode, requests to `cluster.local` will be routed to only those endpoints residing within the same cluster as the client. Requires that both ENABLE_MCS_SERVICE_DISCOVERY and ENABLE_MCS_HOST also be enabled.</td></tr><tr><td><code>ENABLE_MCS_HOST</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, istiod will configure a Kubernetes Multi-Cluster Services (MCS) host (&lt;svc>.&lt;namespace>.svc.clusterset.local) for each service exported (via ServiceExport) in at least one cluster. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used. Requires that ENABLE_MCS_SERVICE_DISCOVERY also be enabled.</td></tr><tr><td><code>ENABLE_MCS_SERVICE_DISCOVERY</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, istiod will enable Kubernetes Multi-Cluster Services (MCS) service discovery mode. In this mode, service endpoints in a cluster will only be discoverable within the same cluster unless explicitly exported via ServiceExport.</td></tr><tr><td><code>ENABLE_MULTICLUSTER_HEADLESS</code></td><td>Boolean</td><td><code>true</code></td><td>If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster.</td></tr><tr><td><code>ENABLE_WASM_TELEMETRY</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, Wasm-based telemetry will be enabled.</td></tr><tr><td><code>EXTERNAL_ISTIOD</code></td><td>Boolean</td><td><code>false</code></td><td>If this is set to true, one Istiod will control remote clusters including CA.</td></tr><tr><td><code>GCP_METADATA</code></td><td>String</td><td><code></code></td><td>Pipe separated GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE</td></tr><tr><td><code>GCP_QUOTA_PROJECT</code></td><td>String</td><td><code></code></td><td>Allows specification of a quota project to be used in requests to GCP APIs.</td></tr><tr><td><code>INJECTION_WEBHOOK_CONFIG_NAME</code></td><td>String</td><td><code>istio-sidecar-injector</code></td><td>Name of the mutatingwebhookconfiguration to patch, if istioctl is not used.</td></tr><tr><td><code>ISTIOCONFIG</code></td><td>String</td><td><code>$HOME/.istioctl/config.yaml</code></td><td>Default values for istioctl flags</td></tr><tr><td><code>ISTIOCTL_AUTHORITY</code></td><td>String</td><td><code></code></td><td>The istioctl --authority override</td></tr><tr><td><code>ISTIOCTL_CERT_DIR</code></td><td>String</td><td><code></code></td><td>The istioctl --cert-dir override</td></tr><tr><td><code>ISTIOCTL_INSECURE</code></td><td>Boolean</td><td><code>false</code></td><td>The istioctl --insecure override</td></tr><tr><td><code>ISTIOCTL_ISTIONAMESPACE</code></td><td>String</td><td><code>istio-system</code></td><td>The istioctl --istioNamespace override</td></tr><tr><td><code>ISTIOCTL_PLAINTEXT</code></td><td>Boolean</td><td><code>false</code></td><td>The istioctl --plaintext override</td></tr><tr><td><code>ISTIOCTL_PREFER_EXPERIMENTAL</code></td><td>Boolean</td><td><code>false</code></td><td>The istioctl should use experimental subcommand variants</td></tr><tr><td><code>ISTIOCTL_XDS_ADDRESS</code></td><td>String</td><td><code></code></td><td>The istioctl --xds-address override</td></tr><tr><td><code>ISTIOCTL_XDS_PORT</code></td><td>Integer</td><td><code>15012</code></td><td>The istioctl --xds-port override</td></tr><tr><td><code>ISTIOD_CUSTOM_HOST</code></td><td>String</td><td><code></code></td><td>Custom host name of istiod that istiod signs the server cert.</td></tr><tr><td><code>ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file.</td></tr><tr><td><code>ISTIO_BOOTSTRAP</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>ISTIO_DEFAULT_REQUEST_TIMEOUT</code></td><td>Time Duration</td><td><code>0s</code></td><td>Default Http and gRPC Request timeout</td></tr><tr><td><code>ISTIO_DELTA_XDS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas.</td></tr><tr><td><code>ISTIO_GATEWAY_STRIP_HOST_PORT</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, Gateway will remove any port from host/authority header before any processing of request by HTTP filters or routing.</td></tr><tr><td><code>ISTIO_GPRC_MAXRECVMSGSIZE</code></td><td>Integer</td><td><code>4194304</code></td><td>Sets the max receive buffer size of gRPC stream in bytes.</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_MULTIROOT_MESH</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS</td></tr><tr><td><code>ISTIO_PROMETHEUS_ANNOTATIONS</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>JWT_POLICY</code></td><td>String</td><td><code>third-party-jwt</code></td><td>The JWT validation policy.</td></tr><tr><td><code>K8S_INGRESS_NS</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>K_REVISION</code></td><td>String</td><td><code></code></td><td>KNative revision, set if running in knative</td></tr><tr><td><code>PILOT_CERT_PROVIDER</code></td><td>String</td><td><code>istiod</code></td><td>The provider of Pilot DNS certificate.</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 interval. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX.</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_DISTRIBUTION_HISTORY_RETENTION</code></td><td>Time Duration</td><td><code>1m0s</code></td><td>If enabled, Pilot will keep track of old versions of distributed config for this duration.</td></tr><tr><td><code>PILOT_ENABLE_ANALYSIS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources</td></tr><tr><td><code>PILOT_ENABLE_CDS_CACHE</code></td><td>Boolean</td><td><code>true</code></td><td>If true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE.</td></tr><tr><td><code>PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, Pilot will assign meaningful nonces to each Envoy configuration message, and allow users to interrogate which envoy has which config from the debug interface.</td></tr><tr><td><code>PILOT_ENABLE_CROSS_CLUSTER_WORKLOAD_ENTRY</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster.</td></tr><tr><td><code>PILOT_ENABLE_DESTINATION_RULE_INHERITANCE</code></td><td>Boolean</td><td><code>false</code></td><td>If set, workload specific DestinationRules will inherit configurations settings from mesh and namespace level rules</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_EDS_FOR_HEADLESS_SERVICES</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, for headless service in Kubernetes, pilot will send endpoints over EDS, allowing the sidecar to load balance among pods in the headless service. This feature should be enabled if applications access all services explicitly via a HTTP proxy port in the sidecar.</td></tr><tr><td><code>PILOT_ENABLE_FLOW_CONTROL</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, pilot will wait for the completion of a receive operation beforeexecuting a push operation. This is a form of flow control and is useful inenvironments with high rates of push requests to each gateway. By default,this is false.</td></tr><tr><td><code>PILOT_ENABLE_GATEWAY_API</code></td><td>Boolean</td><td><code>true</code></td><td>If this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed.</td></tr><tr><td><code>PILOT_ENABLE_GATEWAY_API_DEPLOYMENT_CONTROLLER</code></td><td>Boolean</td><td><code>true</code></td><td>If this is set to true, gateway-api resources will automatically provision in cluster deployment, services, etc</td></tr><tr><td><code>PILOT_ENABLE_GATEWAY_API_STATUS</code></td><td>Boolean</td><td><code>true</code></td><td>If this is set to true, gateway-api resources will have status written to them</td></tr><tr><td><code>PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS</code></td><td>Boolean</td><td><code>true</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_INBOUND_PASSTHROUGH</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration.</td></tr><tr><td><code>PILOT_ENABLE_ISTIO_TAGS</code></td><td>Boolean</td><td><code>true</code></td><td>Determines whether or not trace spans generated by Envoy will include Istio-specific tags.</td></tr><tr><td><code>PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don't need this feature</td></tr><tr><td><code>PILOT_ENABLE_LEGACY_AUTO_PASSTHROUGH</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, pilot will allow any upstream cluster to be used with AUTO_PASSTHROUGH. This option is intended for backwards compatibility only and is not secure with untrusted downstreams; it will be removed in the future.</td></tr><tr><td><code>PILOT_ENABLE_METADATA_EXCHANGE</code></td><td>Boolean</td><td><code>true</code></td><td>If true, pilot will add metadata exchange filters, which will be consumed by telemetry filter.</td></tr><tr><td><code>PILOT_ENABLE_MONGO_FILTER</code></td><td>Boolean</td><td><code>true</code></td><td>EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain.</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>true</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_QUIC_LISTENERS</code></td><td>Boolean</td><td><code>false</code></td><td>If true, QUIC listeners will be generated wherever there are listeners terminating TLS on gateways if the gateway service exposes a UDP port with the same number (for example 443/TCP and 443/UDP)</td></tr><tr><td><code>PILOT_ENABLE_RDS_CACHE</code></td><td>Boolean</td><td><code>true</code></td><td>If true, Pilot will cache RDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE.</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_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION</code></td><td>Boolean</td><td><code>true</code></td><td>If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization.</td></tr><tr><td><code>PILOT_ENABLE_SERVICEENTRY_SELECT_PODS</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don't need this feature</td></tr><tr><td><code>PILOT_ENABLE_STATUS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status.</td></tr><tr><td><code>PILOT_ENABLE_TELEMETRY_LABEL</code></td><td>Boolean</td><td><code>true</code></td><td>If true, pilot will add telemetry related metadata to cluster and endpoint resources, which will be consumed by telemetry filter.</td></tr><tr><td><code>PILOT_ENABLE_VIRTUAL_SERVICE_DELEGATE</code></td><td>Boolean</td><td><code>true</code></td><td>If set to false, virtualService delegate will not be supported.</td></tr><tr><td><code>PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION</code></td><td>Boolean</td><td><code>true</code></td><td>Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload.</td></tr><tr><td><code>PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS</code></td><td>Boolean</td><td><code>true</code></td><td>Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup</td></tr><tr><td><code>PILOT_ENABLE_XDS_CACHE</code></td><td>Boolean</td><td><code>true</code></td><td>If true, Pilot will cache XDS responses.</td></tr><tr><td><code>PILOT_ENABLE_XDS_IDENTITY_CHECK</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for.</td></tr><tr><td><code>PILOT_ENDPOINT_TELEMETRY_LABEL</code></td><td>Boolean</td><td><code>true</code></td><td>If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter.</td></tr><tr><td><code>PILOT_ENVOY_FILTER_STATS</code></td><td>Boolean</td><td><code>false</code></td><td>If true, Pilot will collect metrics for envoy filter operations.</td></tr><tr><td><code>PILOT_FILTER_GATEWAY_CLUSTER_CONFIG</code></td><td>Boolean</td><td><code>false</code></td><td></td></tr><tr><td><code>PILOT_FLOW_CONTROL_TIMEOUT</code></td><td>Time Duration</td><td><code>15s</code></td><td>If set, the max amount of time to delay a push by. Depends on PILOT_ENABLE_FLOW_CONTROL.</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_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS</code></td><td>String</td><td><code>gcp,azure,exec,openstack,clientkey,clientCertificate,tokenFile</code></td><td>Comma separated list of potentially insecure kubeconfig authentication options that are allowed for multicluster authentication.Support values: all authProviders (`gcp`, `azure`, `exec`, `openstack`), `clientKey`, `clientCertificate`, `tokenFile`, and `exec`.</td></tr><tr><td><code>PILOT_JWT_ENABLE_REMOTE_JWKS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, checks to see if the configured JwksUri in RequestAuthentication is a mesh cluster URL and configures remote Jwks to let Envoy fetch the Jwks instead of Istiod.</td></tr><tr><td><code>PILOT_JWT_PUB_KEY_REFRESH_INTERVAL</code></td><td>Time Duration</td><td><code>20m0s</code></td><td>The interval for istiod to fetch the jwks_uri for the jwks public key.</td></tr><tr><td><code>PILOT_MAX_REQUESTS_PER_SECOND</code></td><td>Floating-Point</td><td><code>100</code></td><td>Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently.</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_REMOTE_CLUSTER_TIMEOUT</code></td><td>Time Duration</td><td><code>30s</code></td><td>After this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior.</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_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_STATUS_BURST</code></td><td>Integer</td><td><code>500</code></td><td>If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst</td></tr><tr><td><code>PILOT_STATUS_MAX_WORKERS</code></td><td>Integer</td><td><code>100</code></td><td>The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments.</td></tr><tr><td><code>PILOT_STATUS_QPS</code></td><td>Floating-Point</td><td><code>100</code></td><td>If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS</td></tr><tr><td><code>PILOT_STATUS_UPDATE_INTERVAL</code></td><td>Time Duration</td><td><code>500ms</code></td><td>Interval to update the XDS distribution status.</td></tr><tr><td><code>PILOT_TRACE_SAMPLING</code></td><td>Floating-Point</td><td><code>1</code></td><td>Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0.</td></tr><tr><td><code>PILOT_USE_ENDPOINT_SLICE</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used</td></tr><tr><td><code>PILOT_WORKLOAD_ENTRY_GRACE_PERIOD</code></td><td>Time Duration</td><td><code>10s</code></td><td>The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up.</td></tr><tr><td><code>PILOT_XDS_CACHE_SIZE</code></td><td>Integer</td><td><code>60000</code></td><td>The maximum number of cache entries for the XDS cache.</td></tr><tr><td><code>PILOT_XDS_CACHE_STATS</code></td><td>Boolean</td><td><code>false</code></td><td>If true, Pilot will collect metrics for XDS cache efficiency.</td></tr><tr><td><code>PILOT_XDS_SEND_TIMEOUT</code></td><td>Time Duration</td><td><code>0s</code></td><td>The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push.</td></tr><tr><td><code>POD_NAME</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>PRIORITIZED_LEADER_ELECTION</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, the default revision will steal leader locks from non-default revisions</td></tr><tr><td><code>REQUIRE_3P_TOKEN</code></td><td>Boolean</td><td><code>false</code></td><td>Reject k8s default tokens, without audience. If false, default K8S token will be accepted</td></tr><tr><td><code>REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior.</td></tr><tr><td><code>REWRITE_TCP_PROBES</code></td><td>Boolean</td><td><code>true</code></td><td>If false, TCP probes will not be rewritten and therefor always succeed when a sidecar is used.</td></tr><tr><td><code>SHARED_MESH_CONFIG</code></td><td>String</td><td><code></code></td><td>Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence.</td></tr><tr><td><code>SPIFFE_BUNDLE_ENDPOINTS</code></td><td>String</td><td><code></code></td><td>The SPIFFE bundle trust domain to endpoint mappings. Istiod retrieves the root certificate from each SPIFFE bundle endpoint and uses it to verify client certifiates from that trust domain. The endpoint must be compliant to the SPIFFE Bundle Endpoint standard. For details, please refer to https://github.com/spiffe/spiffe/blob/master/standards/SPIFFE_Trust_Domain_and_Bundle.md . No need to configure this for root certificates issued via Istiod or web-PKI based root certificates. Use || between &lt;trustdomain, endpoint> tuples. Use | as delimiter between trust domain and endpoint in each tuple. For example: foo|https://url/for/foo||bar|https://url/for/bar</td></tr><tr><td><code>TERM</code></td><td>String</td><td><code></code></td><td>Specifies terminal type. Use 'dumb' to suppress color output</td></tr><tr><td><code>TOKEN_AUDIENCES</code></td><td>String</td><td><code>istio-ca</code></td><td>A list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences</td></tr><tr><td><code>UNSAFE_ENABLE_ADMIN_ENDPOINTS</code></td><td>Boolean</td><td><code>false</code></td><td>If this is set to true, dangerous admin endpoints will be exposed on the debug interface. Not recommended for production.</td></tr><tr><td><code>UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing.</td></tr><tr><td><code>VALIDATION_WEBHOOK_CONFIG_NAME</code></td><td>String</td><td><code>istio-istio-system</code></td><td>Name of the validatingwebhookconfiguration to patch. Empty will skip using cluster admin to patch.</td></tr><tr><td><code>VERIFY_CERTIFICATE_AT_CLIENT</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, certificates received by the proxy will be verified against the OS CA certificate bundle.</td></tr><tr><td><code>XDS_AUTH</code></td><td>Boolean</td><td><code>true</code></td><td>If true, will authenticate XDS clients.</td></tr><tr><td><code>XDS_AUTH_PLAINTEXT</code></td><td>Boolean</td><td><code>false</code></td><td>Authenticate plain text requests - used if Istiod is behind a gateway handling TLS</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>auto_registration_deletes_total</code></td><td><code>Sum</code></td><td>Total number of auto registration cleaned up by periodic timer.</td></tr><tr><td><code>auto_registration_errors_total</code></td><td><code>Sum</code></td><td>Total number of auto registration errors.</td></tr><tr><td><code>auto_registration_success_total</code></td><td><code>Sum</code></td><td>Total number of successful auto registrations.</td></tr><tr><td><code>auto_registration_unregister_total</code></td><td><code>Sum</code></td><td>Total number of unregistrations.</td></tr><tr><td><code>auto_registration_updates_total</code></td><td><code>Sum</code></td><td>Total number of auto registration updates.</td></tr><tr><td><code>cache_flush_total</code></td><td><code>Sum</code></td><td>number of times operator cache was flushed</td></tr><tr><td><code>controller_sync_errors_total</code></td><td><code>Sum</code></td><td>Total number of errorMetric syncing controllers.</td></tr><tr><td><code>cr_deletion_total</code></td><td><code>Sum</code></td><td>Number of IstioOperator CR deleted</td></tr><tr><td><code>cr_merge_failure_total</code></td><td><code>Sum</code></td><td>Number of IstioOperator CR merge failures</td></tr><tr><td><code>cr_validation_error_total</code></td><td><code>Sum</code></td><td>Number of IstioOperator CR validation failures</td></tr><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>galley_validation_config_delete_error</code></td><td><code>Count</code></td><td>k8s webhook configuration delete error</td></tr><tr><td><code>galley_validation_config_load</code></td><td><code>Count</code></td><td>k8s webhook configuration (re)loads</td></tr><tr><td><code>galley_validation_config_load_error</code></td><td><code>Count</code></td><td>k8s webhook configuration (re)load error</td></tr><tr><td><code>galley_validation_config_update_error</code></td><td><code>Count</code></td><td>k8s webhook configuration update error</td></tr><tr><td><code>galley_validation_config_updates</code></td><td><code>Count</code></td><td>k8s webhook configuration updates</td></tr><tr><td><code>get_cr_error_total</code></td><td><code>Sum</code></td><td>Number of times fetching CR from apiserver failed</td></tr><tr><td><code>istio_build</code></td><td><code>LastValue</code></td><td>Istio component build info</td></tr><tr><td><code>istiod_managed_clusters</code></td><td><code>LastValue</code></td><td>Number of clusters managed by istiod</td></tr><tr><td><code>legacy_path_translation_total</code></td><td><code>Sum</code></td><td>Number of times a legacy API path is translated</td></tr><tr><td><code>manifest_patch_error_total</code></td><td><code>Sum</code></td><td>Number of times K8S patch overlays failed</td></tr><tr><td><code>manifest_render_error_total</code></td><td><code>Sum</code></td><td>Number of times error occurred during rendering output manifest</td></tr><tr><td><code>num_outgoing_retries</code></td><td><code>Sum</code></td><td>Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.)</td></tr><tr><td><code>owned_resource_total</code></td><td><code>LastValue</code></td><td>Number of resources currently owned by the operator</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_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_endpoints_pending_pod</code></td><td><code>LastValue</code></td><td>Number of endpoints that do not currently have any corresponding pods.</td></tr><tr><td><code>pilot_k8s_endpoints_with_no_pods</code></td><td><code>Sum</code></td><td>Endpoints that does not have any corresponding pods.</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 in seconds between config change and a proxy receiving all required configuration.</td></tr><tr><td><code>pilot_proxy_queue_time</code></td><td><code>Distribution</code></td><td>Time in seconds, a proxy is in the push queue before being dequeued.</td></tr><tr><td><code>pilot_push_triggers</code></td><td><code>Sum</code></td><td>Total number of times a push was triggered, labeled by reason for the push.</td></tr><tr><td><code>pilot_sds_certificate_errors_total</code></td><td><code>Sum</code></td><td>Total number of failures to fetch SDS key and certificate.</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 CDS configs.</td></tr><tr><td><code>pilot_xds_config_size_bytes</code></td><td><code>Distribution</code></td><td>Distribution of configuration sizes pushed to clients</td></tr><tr><td><code>pilot_xds_delayed_push_timeouts_total</code></td><td><code>Sum</code></td><td>Total number of XDS pushes that are delayed and timed out</td></tr><tr><td><code>pilot_xds_delayed_pushes_total</code></td><td><code>Sum</code></td><td>Total number of XDS pushes that are delayed.</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_expired_nonce</code></td><td><code>Sum</code></td><td>Total number of XDS requests with an expired nonce.</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 seconds 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_send_time</code></td><td><code>Distribution</code></td><td>Total time in seconds Pilot takes to send generated configuration.</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>remote_cluster_sync_timeouts_total</code></td><td><code>Sum</code></td><td>Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters.</td></tr><tr><td><code>render_manifest_total</code></td><td><code>Sum</code></td><td>Number of component manifests rendered</td></tr><tr><td><code>resource_creation_total</code></td><td><code>Sum</code></td><td>Number of resources created by the operator</td></tr><tr><td><code>resource_deletion_total</code></td><td><code>Sum</code></td><td>Number of resources deleted by the operator</td></tr><tr><td><code>resource_prune_total</code></td><td><code>Sum</code></td><td>Number of resources pruned by the operator</td></tr><tr><td><code>resource_update_total</code></td><td><code>Sum</code></td><td>Number of resources updated by the operator</td></tr><tr><td><code>scrape_failures_total</code></td><td><code>Sum</code></td><td>The total number of failed scrapes.</td></tr><tr><td><code>scrapes_total</code></td><td><code>Sum</code></td><td>The total number of scrapes.</td></tr><tr><td><code>sidecar_injection_failure_total</code></td><td><code>Sum</code></td><td>Total number of failed sidecar injection requests.</td></tr><tr><td><code>sidecar_injection_requests_total</code></td><td><code>Sum</code></td><td>Total number of sidecar injection requests.</td></tr><tr><td><code>sidecar_injection_skip_total</code></td><td><code>Sum</code></td><td>Total number of skipped sidecar injection requests.</td></tr><tr><td><code>sidecar_injection_success_total</code></td><td><code>Sum</code></td><td>Total number of successful sidecar injection requests.</td></tr><tr><td><code>startup_duration_seconds</code></td><td><code>LastValue</code></td><td>The time from the process starting to being marked ready.</td></tr><tr><td><code>version</code></td><td><code>LastValue</code></td><td>Version of operator binary</td></tr><tr><td><code>wasm_cache_entries</code></td><td><code>LastValue</code></td><td>number of Wasm remote fetch cache entries.</td></tr><tr><td><code>wasm_cache_lookup_count</code></td><td><code>Sum</code></td><td>number of Wasm remote fetch cache lookups.</td></tr><tr><td><code>wasm_config_conversion_count</code></td><td><code>Sum</code></td><td>number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint.</td></tr><tr><td><code>wasm_config_conversion_duration</code></td><td><code>Distribution</code></td><td>Total time in milliseconds istio-agent spends on converting remote load in Wasm config.</td></tr><tr><td><code>wasm_remote_fetch_count</code></td><td><code>Sum</code></td><td>number of Wasm remote fetches and results, including success, download failure, and checksum mismatch.</td></tr><tr><td><code>webhook_patch_attempts_total</code></td><td><code>Sum</code></td><td>Webhook patching attempts</td></tr><tr><td><code>webhook_patch_failures_total</code></td><td><code>Sum</code></td><td>Webhook patching total failures</td></tr><tr><td><code>webhook_patch_retries_total</code></td><td><code>Sum</code></td><td>Webhook patching retries</td></tr><tr><td><code>xds_cache_evictions</code></td><td><code>Sum</code></td><td>Total number of xds cache evictions.</td></tr><tr><td><code>xds_cache_reads</code></td><td><code>Sum</code></td><td>Total number of xds cache xdsCacheReads.</td></tr><tr><td><code>xds_cache_size</code></td><td><code>LastValue</code></td><td>Current size of xds cache</td></tr></tbody></table></article><nav class=pagenav><div class=left><a title="Install and configure Istio CNI plugin on a node, detect and repair pod which is broken by race condition." href=/v1.12/docs/reference/commands/install-cni/ class=next-link><svg class="icon left-arrow"><use xlink:href="/v1.12/img/icons.svg#left-arrow"/></svg>install-cni</a></div><div class=right><a title="The Istio operator." href=/v1.12/docs/reference/commands/operator/ class=next-link>operator<svg class="icon right-arrow"><use xlink:href="/v1.12/img/icons.svg#right-arrow"/></svg></a></div></nav><div id=feedback><div id=feedback-initial>Was this information useful?<br><button class="btn feedback" onclick="sendFeedback('en',1)">Yes</button>
<button class="btn feedback" onclick="sendFeedback('en',0)">No</button></div><div id=feedback-comment>Do you have any suggestions for improvement?<br><br><input id=feedback-textbox type=text placeholder="Help us improve..." data-lang=en></div><div id=feedback-thankyou>Thanks for your feedback!</div></div><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 admin"><a href=#istioctl-admin>admin</a><li role=none aria-label="istioctl admin log"><a href=#istioctl-admin-log>admin log</a><li role=none aria-label="istioctl analyze"><a href=#istioctl-analyze>analyze</a><li role=none aria-label="istioctl authz"><a href=#istioctl-authz>authz</a><li role=none aria-label="istioctl bug-report"><a href=#istioctl-bug-report>bug-report</a><li role=none aria-label="istioctl bug-report version"><a href=#istioctl-bug-report-version>bug-report version</a><li role=none aria-label="istioctl completion"><a href=#istioctl-completion>completion</a><li role=none aria-label="istioctl completion bash"><a href=#istioctl-completion-bash>completion bash</a><li role=none aria-label="istioctl completion fish"><a href=#istioctl-completion-fish>completion fish</a><li role=none aria-label="istioctl completion powershell"><a href=#istioctl-completion-powershell>completion powershell</a><li role=none aria-label="istioctl completion zsh"><a href=#istioctl-completion-zsh>completion zsh</a><li role=none aria-label="istioctl dashboard"><a href=#istioctl-dashboard>dashboard</a><li role=none aria-label="istioctl dashboard controlz"><a href=#istioctl-dashboard-controlz>dashboard controlz</a><li role=none aria-label="istioctl dashboard envoy"><a href=#istioctl-dashboard-envoy>dashboard envoy</a><li role=none aria-label="istioctl dashboard grafana"><a href=#istioctl-dashboard-grafana>dashboard grafana</a><li role=none aria-label="istioctl dashboard jaeger"><a href=#istioctl-dashboard-jaeger>dashboard jaeger</a><li role=none aria-label="istioctl dashboard kiali"><a href=#istioctl-dashboard-kiali>dashboard kiali</a><li role=none aria-label="istioctl dashboard prometheus"><a href=#istioctl-dashboard-prometheus>dashboard prometheus</a><li role=none aria-label="istioctl dashboard skywalking"><a href=#istioctl-dashboard-skywalking>dashboard skywalking</a><li role=none aria-label="istioctl dashboard zipkin"><a href=#istioctl-dashboard-zipkin>dashboard zipkin</a><li role=none aria-label="istioctl experimental"><a href=#istioctl-experimental>experimental</a><li role=none aria-label="istioctl experimental add-to-mesh"><a href=#istioctl-experimental-add-to-mesh>experimental add-to-mesh</a><li role=none aria-label="istioctl experimental add-to-mesh deployment"><a href=#istioctl-experimental-add-to-mesh-deployment>experimental add-to-mesh deployment</a><li role=none aria-label="istioctl experimental add-to-mesh external-service"><a href=#istioctl-experimental-add-to-mesh-external-service>experimental add-to-mesh external-service</a><li role=none aria-label="istioctl experimental add-to-mesh service"><a href=#istioctl-experimental-add-to-mesh-service>experimental add-to-mesh service</a><li role=none aria-label="istioctl experimental authz"><a href=#istioctl-experimental-authz>experimental authz</a><li role=none aria-label="istioctl experimental authz check"><a href=#istioctl-experimental-authz-check>experimental authz check</a><li role=none aria-label="istioctl experimental config"><a href=#istioctl-experimental-config>experimental config</a><li role=none aria-label="istioctl experimental config list"><a href=#istioctl-experimental-config-list>experimental config list</a><li role=none aria-label="istioctl experimental create-remote-secret"><a href=#istioctl-experimental-create-remote-secret>experimental create-remote-secret</a><li role=none aria-label="istioctl experimental describe"><a href=#istioctl-experimental-describe>experimental describe</a><li role=none aria-label="istioctl experimental describe pod"><a href=#istioctl-experimental-describe-pod>experimental describe pod</a><li role=none aria-label="istioctl experimental describe service"><a href=#istioctl-experimental-describe-service>experimental describe service</a><li role=none aria-label="istioctl experimental injector"><a href=#istioctl-experimental-injector>experimental injector</a><li role=none aria-label="istioctl experimental injector list"><a href=#istioctl-experimental-injector-list>experimental injector list</a><li role=none aria-label="istioctl experimental internal-debug"><a href=#istioctl-experimental-internal-debug>experimental internal-debug</a><li role=none aria-label="istioctl experimental kube-uninject"><a href=#istioctl-experimental-kube-uninject>experimental kube-uninject</a><li role=none aria-label="istioctl experimental metrics"><a href=#istioctl-experimental-metrics>experimental metrics</a><li role=none aria-label="istioctl experimental precheck"><a href=#istioctl-experimental-precheck>experimental precheck</a><li role=none aria-label="istioctl experimental proxy-status"><a href=#istioctl-experimental-proxy-status>experimental proxy-status</a><li role=none aria-label="istioctl experimental remote-clusters"><a href=#istioctl-experimental-remote-clusters>experimental remote-clusters</a><li role=none aria-label="istioctl experimental remove-from-mesh"><a href=#istioctl-experimental-remove-from-mesh>experimental remove-from-mesh</a><li role=none aria-label="istioctl experimental remove-from-mesh deployment"><a href=#istioctl-experimental-remove-from-mesh-deployment>experimental remove-from-mesh deployment</a><li role=none aria-label="istioctl experimental remove-from-mesh external-service"><a href=#istioctl-experimental-remove-from-mesh-external-service>experimental remove-from-mesh external-service</a><li role=none aria-label="istioctl experimental remove-from-mesh service"><a href=#istioctl-experimental-remove-from-mesh-service>experimental remove-from-mesh service</a><li role=none aria-label="istioctl experimental revision"><a href=#istioctl-experimental-revision>experimental revision</a><li role=none aria-label="istioctl experimental revision describe"><a href=#istioctl-experimental-revision-describe>experimental revision describe</a><li role=none aria-label="istioctl experimental revision list"><a href=#istioctl-experimental-revision-list>experimental revision list</a><li role=none aria-label="istioctl experimental revision tag"><a href=#istioctl-experimental-revision-tag>experimental revision tag</a><li role=none aria-label="istioctl experimental revision tag generate"><a href=#istioctl-experimental-revision-tag-generate>experimental revision tag generate</a><li role=none aria-label="istioctl experimental revision tag list"><a href=#istioctl-experimental-revision-tag-list>experimental revision tag list</a><li role=none aria-label="istioctl experimental revision tag remove"><a href=#istioctl-experimental-revision-tag-remove>experimental revision tag remove</a><li role=none aria-label="istioctl experimental revision tag set"><a href=#istioctl-experimental-revision-tag-set>experimental revision tag set</a><li role=none aria-label="istioctl experimental uninstall"><a href=#istioctl-experimental-uninstall>experimental uninstall</a><li role=none aria-label="istioctl experimental version"><a href=#istioctl-experimental-version>experimental version</a><li role=none aria-label="istioctl experimental wait"><a href=#istioctl-experimental-wait>experimental wait</a><li role=none aria-label="istioctl experimental workload"><a href=#istioctl-experimental-workload>experimental workload</a><li role=none aria-label="istioctl experimental workload entry"><a href=#istioctl-experimental-workload-entry>experimental workload entry</a><li role=none aria-label="istioctl experimental workload entry configure"><a href=#istioctl-experimental-workload-entry-configure>experimental workload entry configure</a><li role=none aria-label="istioctl experimental workload group"><a href=#istioctl-experimental-workload-group>experimental workload group</a><li role=none aria-label="istioctl experimental workload group create"><a href=#istioctl-experimental-workload-group-create>experimental workload group create</a><li role=none aria-label="istioctl install"><a href=#istioctl-install>install</a><li role=none aria-label="istioctl kube-inject"><a href=#istioctl-kube-inject>kube-inject</a><li role=none aria-label="istioctl manifest"><a href=#istioctl-manifest>manifest</a><li role=none aria-label="istioctl manifest diff"><a href=#istioctl-manifest-diff>manifest diff</a><li role=none aria-label="istioctl manifest generate"><a href=#istioctl-manifest-generate>manifest generate</a><li role=none aria-label="istioctl manifest install"><a href=#istioctl-manifest-install>manifest install</a><li role=none aria-label="istioctl operator"><a href=#istioctl-operator>operator</a><li role=none aria-label="istioctl operator dump"><a href=#istioctl-operator-dump>operator dump</a><li role=none aria-label="istioctl operator init"><a href=#istioctl-operator-init>operator init</a><li role=none aria-label="istioctl operator remove"><a href=#istioctl-operator-remove>operator remove</a><li role=none aria-label="istioctl options"><a href=#istioctl-options>options</a><li role=none aria-label="istioctl profile"><a href=#istioctl-profile>profile</a><li role=none aria-label="istioctl profile diff"><a href=#istioctl-profile-diff>profile diff</a><li role=none aria-label="istioctl profile dump"><a href=#istioctl-profile-dump>profile dump</a><li role=none aria-label="istioctl profile list"><a href=#istioctl-profile-list>profile list</a><li role=none aria-label="istioctl proxy-config"><a href=#istioctl-proxy-config>proxy-config</a><li role=none aria-label="istioctl proxy-config all"><a href=#istioctl-proxy-config-all>proxy-config all</a><li role=none aria-label="istioctl proxy-config bootstrap"><a href=#istioctl-proxy-config-bootstrap>proxy-config bootstrap</a><li role=none aria-label="istioctl proxy-config cluster"><a href=#istioctl-proxy-config-cluster>proxy-config cluster</a><li role=none aria-label="istioctl proxy-config endpoint"><a href=#istioctl-proxy-config-endpoint>proxy-config endpoint</a><li role=none aria-label="istioctl proxy-config listener"><a href=#istioctl-proxy-config-listener>proxy-config listener</a><li role=none aria-label="istioctl proxy-config log"><a href=#istioctl-proxy-config-log>proxy-config log</a><li role=none aria-label="istioctl proxy-config rootca-compare"><a href=#istioctl-proxy-config-rootca-compare>proxy-config rootca-compare</a><li role=none aria-label="istioctl proxy-config route"><a href=#istioctl-proxy-config-route>proxy-config route</a><li role=none aria-label="istioctl proxy-config secret"><a href=#istioctl-proxy-config-secret>proxy-config secret</a><li role=none aria-label="istioctl proxy-status"><a href=#istioctl-proxy-status>proxy-status</a><li role=none aria-label="istioctl tag"><a href=#istioctl-tag>tag</a><li role=none aria-label="istioctl tag generate"><a href=#istioctl-tag-generate>tag generate</a><li role=none aria-label="istioctl tag list"><a href=#istioctl-tag-list>tag list</a><li role=none aria-label="istioctl tag remove"><a href=#istioctl-tag-remove>tag remove</a><li role=none aria-label="istioctl tag set"><a href=#istioctl-tag-set>tag set</a><li role=none aria-label="istioctl upgrade"><a href=#istioctl-upgrade>upgrade</a><li role=none aria-label="istioctl validate"><a href=#istioctl-validate>validate</a><li role=none aria-label="istioctl verify-install"><a href=#istioctl-verify-install>verify-install</a><li role=none aria-label="istioctl version"><a href=#istioctl-version>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 class=footer><div class="footer-wrapper container-l"><div class="user-links footer-links"><a class=channel title="GitHub is where development takes place on Istio code" href=https://github.com/istio/community aria-label=GitHub><svg class="icon github"><use xlink:href="/v1.12/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"><svg class="icon drive"><use xlink:href="/v1.12/img/icons.svg#drive"/></svg></a><a class=channel title="Interactively discuss issues with the Istio community on Slack" href=https://slack.istio.io aria-label=slack><svg class="icon slack"><use xlink:href="/v1.12/img/icons.svg#slack"/></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"><svg class="icon stackoverflow"><use xlink:href="/v1.12/img/icons.svg#stackoverflow"/></svg></a><a class=channel title="Follow us on Twitter to get the latest news" href=https://twitter.com/IstioMesh aria-label=Twitter><svg class="icon twitter"><use xlink:href="/v1.12/img/icons.svg#twitter"/></svg></a></div><hr class=footer-separator role=separator><div class="info footer-info"><a class=logo href=/v1.12/><svg xmlns="http://www.w3.org/2000/svg" width="128" height="60" viewBox="0 0 128 60"><path d="M58.434 48.823A.441.441.0 0158.3 48.497V22.583a.444.444.0 01.134-.326.446.446.0 01.327-.134h3.527a.447.447.0 01.325.134.447.447.0 01.134.326v25.914a.443.443.0 01-.134.326.444.444.0 01-.325.134h-3.527a.444.444.0 01-.327-.134z"/><path d="m70.969 48.477a6.556 6.556.0 01-2.818-1.955 4.338 4.338.0 01-1-2.78v-.345a.443.443.0 01.134-.326.444.444.0 01.326-.135h3.374a.444.444.0 01.326.135.445.445.0 01.134.326v.077a2.014 2.014.0 001.054 1.667 4.672 4.672.0 002.664.709 4.446 4.446.0 002.492-.633 1.862 1.862.0 00.958-1.591 1.426 1.426.0 00-.786-1.322 12.7 12.7.0 00-2.549-.939l-1.457-.46a21.526 21.526.0 01-3.3-1.227 6.57 6.57.0 01-2.262-1.783 4.435 4.435.0 01-.92-2.894 5.081 5.081.0 012.109-4.275 8.993 8.993.0 015.558-1.591 10.445 10.445.0 014.1.748 6.3 6.3.0 012.722 2.07 5 5 0 01.958 3.009.441.441.0 01-.134.326.441.441.0 01-.325.134h-3.258a.441.441.0 01-.326-.134.443.443.0 01-.134-.326 1.974 1.974.0 00-.978-1.667 4.647 4.647.0 00-2.665-.671 4.741 4.741.0 00-2.435.556 1.724 1.724.0 00-.938 1.553 1.512 1.512.0 00.9 1.4 15.875 15.875.0 003.01 1.055l.843.229a27.368 27.368.0 013.412 1.246 6.67 6.67.0 012.338 1.763 4.387 4.387.0 01.958 2.933 4.988 4.988.0 01-2.146 4.275 9.543 9.543.0 01-5.712 1.552 11.626 11.626.0 01-4.227-.709z"/><path d="m97.039 32.837a.443.443.0 01-.326.135h-3.911a.169.169.0 00-.191.192v9.239a2.951 2.951.0 00.632 2.108 2.7 2.7.0 002.013.652h1.15a.444.444.0 01.325.134.441.441.0 01.134.326v2.875a.471.471.0 01-.459.5l-1.994.039a8 8 0 01-4.524-1.035q-1.495-1.035-1.533-3.91V33.166A.17.17.0 0088.164 32.974H85.978A.441.441.0 0185.652 32.839.441.441.0 0185.518 32.513V29.83a.441.441.0 01.134-.326.444.444.0 01.326-.135h2.186a.169.169.0 00.191-.192v-4.485a.438.438.0 01.134-.326.44.44.0 01.325-.134h3.336a.443.443.0 01.325.134.442.442.0 01.135.326v4.485a.169.169.0 00.191.192h3.911a.446.446.0 01.326.135.446.446.0 01.134.326v2.683a.446.446.0 01-.133.324z"/><path d="m101.694 25.917a2.645 2.645.0 01-.767-1.955 2.65 2.65.0 01.767-1.955 2.65 2.65.0 011.955-.767 2.65 2.65.0 011.955.767 2.652 2.652.0 01.767 1.955 2.647 2.647.0 01-.767 1.955 2.646 2.646.0 01-1.955.767 2.645 2.645.0 01-1.955-.767zm-.211 22.906a.441.441.0 01-.134-.326V29.79a.444.444.0 01.134-.326.446.446.0 01.326-.134h3.527a.446.446.0 01.326.134.445.445.0 01.134.326v18.707a.443.443.0 01-.134.326.443.443.0 01-.326.134h-3.527a.443.443.0 01-.326-.134z"/><path d="m114.019 47.734a8.1 8.1.0 01-3.047-4.255 14.439 14.439.0 01-.652-4.37 14.3 14.3.0 01.614-4.371 7.869 7.869.0 013.066-4.178 9.072 9.072.0 015.252-1.5 8.543 8.543.0 015.041 1.5 7.985 7.985.0 013.009 4.14 12.439 12.439.0 01.69 4.37 13.793 13.793.0 01-.651 4.37 8.255 8.255.0 01-3.028 4.275 8.475 8.475.0 01-5.1 1.553 8.754 8.754.0 01-5.194-1.534zm7.629-3.1a4.536 4.536.0 001.476-2.262 11.335 11.335.0 00.383-3.221 10.618 10.618.0 00-.383-3.22 4.169 4.169.0 00-1.457-2.243 4.066 4.066.0 00-2.531-.785 3.942 3.942.0 00-2.453.785 4.376 4.376.0 00-1.5 2.243 11.839 11.839.0 00-.383 3.22 11.84 11.84.0 00.383 3.221 4.222 4.222.0 001.476 2.262 4.075 4.075.0 002.549.8 3.8 3.8.0 002.44-.809z"/><path d="m15.105 32.057v15.565a.059.059.0 01-.049.059L.069 50.25A.06.06.0 01.005 50.167l14.987-33.47a.06.06.0 01.114.025z"/><path d="m17.631 23.087v24.6a.06.06.0 00.053.059l22.449 2.507a.06.06.0 00.061-.084L17.745.032a.06.06.0 00-.114.024z"/><path d="m39.961 52.548-24.833 7.45a.062.062.0 01-.043.0L.079 52.548a.059.059.0 01.026-.113h39.839a.06.06.0 01.017.113z"/></svg></a><div class=footer-languages><a tabindex=-1 role=menuitem lang=en id=switch-lang-en class="footer-languages-item active"><svg class="icon tick"><use xlink:href="/v1.12/img/icons.svg#tick"/></svg>English</a>
<a tabindex=-1 role=menuitem lang=zh id=switch-lang-zh class=footer-languages-item>中文</a></div></div><ul class=footer-policies><li class=footer-policies-item><a class=footer-policies-link href=https://policies.google.com/privacy>Privacy policy</a> |
<a class=disabled title="This is an auto-generated file, please edit the source in the https://github.com/istio/istio repo.">Edit this Page on GitHub</a></li></ul><div class=footer-base><span class=footer-base-copyright>&copy; 2021 Istio Authors.</span>
<span class=footer-base-version>Version
Archive
1.12.3</span><ul class=footer-base-releases><li class=footer-base-releases-item><a tabindex=-1 class=footer-base-releases-link role=menuitem onclick="navigateToUrlOrRoot('https://istio.io/docs\/reference\/commands\/istioctl\/');return false;">current release</a></li><li class=footer-base-releases-item><a tabindex=-1 class=footer-base-releases-link role=menuitem onclick="navigateToUrlOrRoot('https://preliminary.istio.io/docs\/reference\/commands\/istioctl\/');return false;">next release</a></li><li class=footer-base-releases-item><a tabindex=-1 class=footer-base-releases-link role=menuitem href=https://istio.io/archive>older releases</a></li></ul></div></div></footer><div id=scroll-to-top-container aria-hidden=true><button id=scroll-to-top title="Back to top"><svg class="icon top"><use xlink:href="/v1.12/img/icons.svg#top"/></svg></button></div></body></html>
Reference in New Issue View Git Blame Copy Permalink