mirror of https://github.com/istio/istio.io.git
907 lines
388 KiB
HTML
907 lines
388 KiB
HTML
<!doctype html><html lang=en itemscope itemtype=https://schema.org/WebPage><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name=theme-color content="#466BB0"><meta name=title content="istioctl"><meta name=description content="Istio control interface."><meta name=keywords content="microservices,services,mesh"><meta property="og:title" content="istioctl"><meta property="og:type" content="website"><meta property="og:description" content="Istio control interface."><meta property="og:url" content="/v1.24/docs/reference/commands/istioctl/"><meta property="og:image" content="https://raw.githubusercontent.com/istio/istio.io/master/static/img/istio-social.png"><meta property="og:image:alt" content="The Istio sailboat logo"><meta property="og:image:width" content="4096"><meta property="og:image:height" content="2048"><meta property="og:site_name" content="Istio"><meta name=twitter:card content="summary_large_image"><meta name=twitter:site content="@IstioMesh"><title>Istioldie 1.24 / istioctl</title>
|
||
<script async src="https://www.googletagmanager.com/gtag/js?id=G-5XBWY4YJ1E"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments)}gtag("js",new Date),gtag("config","G-5XBWY4YJ1E")</script><link rel=alternate type=application/rss+xml title="Istio Blog" href=/v1.24/blog/feed.xml><link rel=alternate type=application/rss+xml title="Istio News" href=/v1.24/news/feed.xml><link rel=alternate type=application/rss+xml title="Istio Blog and News" href=/v1.24/feed.xml><link rel="shortcut icon" href=/v1.24/favicons/favicon.ico><link rel=apple-touch-icon href=/v1.24/favicons/apple-touch-icon-180x180.png sizes=180x180><link rel=icon type=image/png href=/v1.24/favicons/favicon-16x16.png sizes=16x16><link rel=icon type=image/png href=/v1.24/favicons/favicon-32x32.png sizes=32x32><link rel=icon type=image/png href=/v1.24/favicons/android-36x36.png sizes=36x36><link rel=icon type=image/png href=/v1.24/favicons/android-48x48.png sizes=48x48><link rel=icon type=image/png href=/v1.24/favicons/android-72x72.png sizes=72x72><link rel=icon type=image/png href=/v1.24/favicons/android-96x96.png sizes=96xW96><link rel=icon type=image/png href=/v1.24/favicons/android-144x144.png sizes=144x144><link rel=icon type=image/png href=/v1.24/favicons/android-192x192.png sizes=192x192><link rel=icon type=image/svg+xml href=/v1.24/favicons/favicon.svg><link rel=icon type=image/png href=/v1.24/favicons/favicon.png><link rel=mask-icon href=/v1.24/favicons/safari-pinned-tab.svg color=#466BB0><link rel=manifest href=/v1.24/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.24/css/style.min.38f1afbdf6f8efdb4fe991ff2a53ca1c801b5c4602dea2963da44df7ceaacfb8.css integrity="sha256-OPGvvfb479tP6ZH/KlPKHIAbXEYC3qKWPaRN986qz7g=" crossorigin=anonymous><link rel=preconnect href=https://fonts.googleapis.com><link rel=preconnect href=https://fonts.gstatic.com crossorigin><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.24/js/themes_init.min.js></script></head><body class="language-unknown archive-site"><script>const branchName="release-1.24",docTitle="istioctl",iconFile="/v1.24//img/icons.svg",buttonCopy="Copy to clipboard",buttonPrint="Print",buttonDownload="Download"</script><script src="https://www.google.com/cse/brand?form=search-form" defer></script><script src=/v1.24/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.24/ aria-label=logotype><span class=logo><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.371A7.869 7.869.0 01114 30.56a9.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.24/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.24/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.24/img/icons.svg#dropdown-arrow"/></svg></a><ul class=main-navigation-links-dropdown><li class=main-navigation-links-dropdown-item><a href=/v1.24/about/service-mesh class=main-navigation-links-link>Service mesh</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.24/about/solutions class=main-navigation-links-link>Solutions</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.24/about/case-studies class=main-navigation-links-link>Case studies</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.24/about/ecosystem class=main-navigation-links-link>Ecosystem</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.24/about/deployment class=main-navigation-links-link>Deployment</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.24/about/training class=main-navigation-links-link>Training</a></li><li class=main-navigation-links-dropdown-item><a href=/v1.24/about/faq class=main-navigation-links-link>FAQ</a></li></ul></li><li class=main-navigation-links-item><a href=/v1.24/blog/ class=main-navigation-links-link><span>Blog</span></a></li><li class=main-navigation-links-item><a href=/v1.24/news/ class=main-navigation-links-link><span>News</span></a></li><li class=main-navigation-links-item><a href=/v1.24/get-involved/ class=main-navigation-links-link><span>Get involved</span></a></li><li class=main-navigation-links-item><a href=/v1.24/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.24/img/icons.svg#magnifier"/></svg></button>
|
||
<a href=/v1.24/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.24/img/icons.svg#menu-close"/></svg></button></form></nav></header><div class=banner-container><a href=https://events.linuxfoundation.org/kubecon-cloudnativecon-europe/co-located-events/istio-day/ class=banner data-title="Istio Day Europe-2025-01-31 00:00:00 +0000 UTC" data-period-start=1738281600000 data-period-end=1743465600000 data-max-impressions data-timeout><div class=content><p>Join us for Istio Day Europe, a KubeCon + CloudNativeCon Europe Co-located Event. 01 April 2025, London, England. Register now!</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.24/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.24//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.24/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=Overview><a class=main title="A high-level introduction to Istio and service mesh." href=/v1.24/docs/overview/>Overview</a><ul role=group aria-expanded=true class=leaf-section><li role=none><a role=treeitem title="Find out what Istio can do for you." href=/v1.24/docs/overview/what-is-istio/>What is Istio?</a></li><li role=none><a role=treeitem title="Compare Istio to other service mesh solutions." href=/v1.24/docs/overview/why-choose-istio/>Why choose Istio?</a></li><li role=none><a role=treeitem title="Learn about Istio's two dataplane modes and which you should use." href=/v1.24/docs/overview/dataplane-modes/>Sidecar or ambient?</a></li></ul></li><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.24/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.24/docs/concepts/traffic-management/>Traffic Management</a></li><li role=none><a role=treeitem title="Describes Istio's authorization and authentication functionality." href=/v1.24/docs/concepts/security/>Security</a></li><li role=none><a role=treeitem title="Describes the telemetry and monitoring features provided by Istio." href=/v1.24/docs/concepts/observability/>Observability</a></li><li role=none><a role=treeitem title="Describes Istio's WebAssembly Plugin system." href=/v1.24/docs/concepts/wasm/>Extensibility</a></li></ul></li><li role=treeitem aria-label="Sidecar Mode"><a class=main title="Information for setting up and operating Istio in sidecar mode." href=/v1.24/docs/setup/>Sidecar Mode</a><ul role=group aria-expanded=true><li role=none><a role=treeitem title="Try Istio’s features quickly and easily." href=/v1.24/docs/setup/getting-started/>Getting Started</a></li><li role=treeitem aria-label="Platform Setup"><button aria-hidden=true tabindex=-1></button><a title="How to prepare various Kubernetes platforms before installing Istio." href=/v1.24/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 set up an Alibaba Cloud Kubernetes cluster for Istio." href=/v1.24/docs/setup/platform-setup/alicloud/>Alibaba Cloud</a></li><li role=none><a role=treeitem title="Instructions to set up Istio on Amazon EKS in AWS cloud." href=/v1.24/docs/setup/platform-setup/amazon-eks/>Amazon EKS</a></li><li role=none><a role=treeitem title="Instructions to set up an Azure cluster for Istio." href=/v1.24/docs/setup/platform-setup/azure/>Azure</a></li><li role=none><a role=treeitem title="Instructions to set up Docker Desktop for Istio." href=/v1.24/docs/setup/platform-setup/docker/>Docker Desktop</a></li><li role=none><a role=treeitem title="Instructions to set up a Google Kubernetes Engine cluster for Istio." href=/v1.24/docs/setup/platform-setup/gke/>Google Kubernetes Engine</a></li><li role=none><a role=treeitem title="Instructions to set up an Huawei Cloud kubernetes cluster for Istio." href=/v1.24/docs/setup/platform-setup/huaweicloud/>Huawei Cloud</a></li><li role=none><a role=treeitem title="Instructions to set up an IBM Cloud cluster for Istio." href=/v1.24/docs/setup/platform-setup/ibm/>IBM Cloud</a></li><li role=none><a role=treeitem title="Instructions to set up k3d for Istio." href=/v1.24/docs/setup/platform-setup/k3d/>k3d</a></li><li role=none><a role=treeitem title="Instructions to set up kind for Istio." href=/v1.24/docs/setup/platform-setup/kind/>kind</a></li><li role=none><a role=treeitem title="Instructions to set up Kops for use with Istio." href=/v1.24/docs/setup/platform-setup/kops/>Kops</a></li><li role=none><a role=treeitem title="Instructions to set up a Gardener cluster for Istio." href=/v1.24/docs/setup/platform-setup/gardener/>Kubernetes Gardener</a></li><li role=none><a role=treeitem title="Instructions to set up a KubeSphere Container Platform for Istio." href=/v1.24/docs/setup/platform-setup/kubesphere/>KubeSphere Container Platform</a></li><li role=none><a role=treeitem title="Instructions to set up MicroK8s for use with Istio." href=/v1.24/docs/setup/platform-setup/microk8s/>MicroK8s</a></li><li role=none><a role=treeitem title="Instructions to set up minikube for Istio." href=/v1.24/docs/setup/platform-setup/minikube/>Minikube</a></li><li role=none><a role=treeitem title="Instructions to set up an OpenShift cluster for Istio." href=/v1.24/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.24/docs/setup/platform-setup/oci/>Oracle Cloud Infrastructure</a></li><li role=none><a role=treeitem title="Instructions to set up Istio quickly in Tencent Cloud." href=/v1.24/docs/setup/platform-setup/tencent-cloud-mesh/>Tencent Cloud</a></li></ul></li><li role=treeitem aria-label=Install><button aria-hidden=true tabindex=-1></button><a title="Choose the guide that best suits your needs and platform." href=/v1.24/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.24/docs/setup/install/istioctl/>Install with Istioctl</a></li><li role=none><a role=treeitem title="Instructions to install and configure Istio in a Kubernetes cluster using Helm." href=/v1.24/docs/setup/install/helm/>Install with Helm</a></li><li role=treeitem aria-label="Install Multicluster"><button aria-hidden=true tabindex=-1></button><a title="Install an Istio mesh across multiple Kubernetes clusters." href=/v1.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/docs/setup/install/external-controlplane/>Install Istio with an External Control Plane</a></li><li role=none><a role=treeitem title="Install multiple Istio control planes in a single cluster using revisions and discoverySelectors." href=/v1.24/docs/setup/install/multiple-controlplanes/>Install Multiple Istio Control Planes in a Single Cluster</a></li><li role=none><a role=treeitem title="Deploy Istio and connect a workload running within a virtual machine to it." href=/v1.24/docs/setup/install/virtual-machine/>Virtual Machine Installation</a></li></ul></li><li role=treeitem aria-label=Upgrade><button aria-hidden=true tabindex=-1></button><a title="Upgrade, downgrade, and manage Istio across multiple control plane revisions." href=/v1.24/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.24/docs/setup/upgrade/canary/>Canary Upgrades</a></li><li role=none><a role=treeitem title="Upgrade or downgrade Istio in place." href=/v1.24/docs/setup/upgrade/in-place/>In-place Upgrades</a></li><li role=none><a role=treeitem title="Instructions to upgrade Istio using Helm." href=/v1.24/docs/setup/upgrade/helm/>Upgrade with Helm</a></li></ul></li><li role=treeitem aria-label="More Guides"><button aria-hidden=true tabindex=-1></button><a title="More information on additional setup tasks." href=/v1.24/docs/setup/additional-setup/>More Guides</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Get the files required to install and explore Istio." href=/v1.24/docs/setup/additional-setup/download-istio-release/>Download the Istio release</a></li><li role=none><a role=treeitem title="Describes the built-in Istio installation configuration profiles." href=/v1.24/docs/setup/additional-setup/config-profiles/>Installation Configuration Profiles</a></li><li role=none><a role=treeitem title='How to configure "compatibility versions", to decouple behavioral changes from releases.' href=/v1.24/docs/setup/additional-setup/compatibility-versions/>Compatibility Versions</a></li><li role=none><a role=treeitem title="Install and customize Istio Gateways." href=/v1.24/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.24/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.24/docs/setup/additional-setup/customize-installation/>Customizing the installation configuration</a></li><li role=none><a role=treeitem title="Describes how to customize installation configuration options when installing with helm." href=/v1.24/docs/setup/additional-setup/customize-installation-helm/>Advanced Helm Chart Customization</a></li><li role=none><a role=treeitem title="Install and use Istio in Dual-Stack mode running on a Dual-Stack Kubernetes cluster." href=/v1.24/docs/setup/additional-setup/dual-stack/>Install Istio in Dual-Stack mode</a></li><li role=none><a role=treeitem title="Install and use Istio with the Pod Security admission controller." href=/v1.24/docs/setup/additional-setup/pod-security-admission/>Install Istio with Pod Security Admission</a></li><li role=none><a role=treeitem title="Install and use the Istio CNI node agent, allowing operators to deploy workloads with lower privilege." href=/v1.24/docs/setup/additional-setup/cni/>Install the Istio CNI node agent</a></li><li role=none><a role=treeitem title="Try Istio’s features with the legacy Istio APIs." href=/v1.24/docs/setup/additional-setup/getting-started-istio-apis/>Getting Started without the Gateway API</a></li></ul></li></ul></li><li role=treeitem aria-label="Ambient Mode"><a class=main title="Information for setting up and operating Istio with support for ambient mode." href=/v1.24/docs/ambient/>Ambient Mode</a><ul role=group aria-expanded=true><li role=none><a role=treeitem title="An overview of Istio's ambient data plane mode." href=/v1.24/docs/ambient/overview/>Overview</a></li><li role=treeitem aria-label="Getting Started"><button aria-hidden=true tabindex=-1></button><a title="How to deploy and install Istio in ambient mode." href=/v1.24/docs/ambient/getting-started/>Getting Started</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Deploy the Bookinfo sample application." href=/v1.24/docs/ambient/getting-started/deploy-sample-app/>Deploy a sample application</a></li><li role=none><a role=treeitem title="Enable ambient mode and secure the communication between applications." href=/v1.24/docs/ambient/getting-started/secure-and-visualize/>Secure and visualize the application</a></li><li role=none><a role=treeitem title="Enforce Layer 4 and Layer 7 authorization policies in an ambient mesh." href=/v1.24/docs/ambient/getting-started/enforce-auth-policies/>Enforce authorization policies</a></li><li role=none><a role=treeitem title="Manage traffic between services in the ambient mode." href=/v1.24/docs/ambient/getting-started/manage-traffic/>Manage traffic</a></li><li role=none><a role=treeitem title="Delete Istio and associated resources." href=/v1.24/docs/ambient/getting-started/cleanup/>Clean up</a></li></ul></li><li role=treeitem aria-label=Install><button aria-hidden=true tabindex=-1></button><a title="Installation guides for Istio in ambient mode." href=/v1.24/docs/ambient/install/>Install</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Platform-specific prerequisites for installing Istio in ambient mode." href=/v1.24/docs/ambient/install/platform-prerequisites/>Platform-Specific Prerequisites</a></li><li role=none><a role=treeitem title="Install Istio with support for ambient mode with Helm." href=/v1.24/docs/ambient/install/helm/>Install with Helm</a></li><li role=none><a role=treeitem title="Install Istio with support for ambient mode using the istioctl command line tool." href=/v1.24/docs/ambient/install/istioctl/>Install with istioctl</a></li></ul></li><li role=treeitem aria-label=Upgrade><button aria-hidden=true tabindex=-1></button><a title="Upgrade guides for Istio in ambient mode." href=/v1.24/docs/ambient/upgrade/>Upgrade</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Upgrading an ambient mode installation with Helm." href=/v1.24/docs/ambient/upgrade/helm/>Upgrade with Helm</a></li></ul></li><li role=treeitem aria-label="User Guides"><button aria-hidden=true tabindex=-1></button><a title="How to configure your mesh to take advantage of ambient mode." href=/v1.24/docs/ambient/usage/>User Guides</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Understand how to add workloads to an ambient mesh." href=/v1.24/docs/ambient/usage/add-workloads/>Add workloads to the mesh</a></li><li role=none><a role=treeitem title="Understand how to verify mTLS is enabled among workloads in an ambient mesh." href=/v1.24/docs/ambient/usage/verify-mtls-enabled/>Verify mutual TLS is enabled</a></li><li role=none><a role=treeitem title="Understanding how CNI-enforced L4 Kubernetes NetworkPolicy interacts with Istio's ambient mode." href=/v1.24/docs/ambient/usage/networkpolicy/>Ambient and Kubernetes NetworkPolicy</a></li><li role=none><a role=treeitem title="Supported security features when only using the secure L4 overlay." href=/v1.24/docs/ambient/usage/l4-policy/>Use Layer 4 security policy</a></li><li role=none><a role=treeitem title="Gain the full set of Istio features with optional Layer 7 proxies." href=/v1.24/docs/ambient/usage/waypoint/>Configure waypoint proxies</a></li><li role=none><a role=treeitem title="Supported features when using a L7 waypoint proxy." href=/v1.24/docs/ambient/usage/l7-features/>Use Layer 7 features</a></li><li role=none><a role=treeitem title="Describes how to make remote WebAssembly modules available for ambient mode (Alpha)" href=/v1.24/docs/ambient/usage/extend-waypoint-wasm/>Extend waypoints with WebAssembly plugins *</a></li><li role=none><a role=treeitem title="How to validate the node proxies have the correct configuration." href=/v1.24/docs/ambient/usage/troubleshoot-ztunnel/>Troubleshoot connectivity issues with ztunnel</a></li><li role=none><a role=treeitem title="How to investigate problems routing through waypoint proxies." href=/v1.24/docs/ambient/usage/troubleshoot-waypoint/>Troubleshoot issues with waypoints</a></li></ul></li><li role=treeitem aria-label=Architecture><button aria-hidden=true tabindex=-1></button><a title="A deep dive into the architecture of ambient mode." href=/v1.24/docs/ambient/architecture/>Architecture</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Understand how ambient interacts with the Istio control plane." href=/v1.24/docs/ambient/architecture/control-plane/>Ambient and the Istio control plane</a></li><li role=none><a role=treeitem title="Understand how the ambient data plane routes traffic between workloads in an ambient mesh." href=/v1.24/docs/ambient/architecture/data-plane/>Ambient data plane</a></li><li role=none><a role=treeitem title="Understanding Istio's secure tunneling protocol." href=/v1.24/docs/ambient/architecture/hbone/>HBONE</a></li><li role=none><a role=treeitem title="Understand how traffic is redirected between pods and the ztunnel node proxy." href=/v1.24/docs/ambient/architecture/traffic-redirection/>Ztunnel traffic redirection</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.24/docs/tasks/>Tasks</a><ul role=group aria-expanded=true><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true tabindex=-1></button><a title="Tasks that demonstrate Istio's traffic routing features." href=/v1.24/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.24/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.24/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.24/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.24/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 set up request timeouts in Envoy using Istio." href=/v1.24/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.24/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.24/docs/tasks/traffic-management/mirroring/>Mirroring</a></li><li role=treeitem aria-label="Locality Load Balancing"><button aria-hidden=true tabindex=-1></button><a title="This series of tasks demonstrate how to configure locality load balancing in Istio." href=/v1.24/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.24/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.24/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.24/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.24/docs/tasks/traffic-management/locality-load-balancing/cleanup/>Cleanup</a></li></ul></li><li role=treeitem aria-label=Ingress><button aria-hidden=true tabindex=-1></button><a title="Controlling ingress traffic for an Istio service mesh." href=/v1.24/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.24/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.24/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.24/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 terminate TLS traffic at a sidecar without using an Ingress Gateway." href=/v1.24/docs/tasks/traffic-management/ingress/ingress-sidecar-tls-termination/>Ingress Sidecar 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.24/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.24/docs/tasks/traffic-management/ingress/gateway-api/>Kubernetes Gateway API</a></li></ul></li><li role=treeitem aria-label=Egress><button aria-hidden=true tabindex=-1></button><a title="Controlling egress traffic for an Istio service mesh." href=/v1.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/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 tabindex=-1></button><a title="Demonstrates how to secure the mesh." href=/v1.24/docs/tasks/security/>Security</a><ul role=group aria-expanded=false><li role=treeitem aria-label="Certificate Management"><button aria-hidden=true tabindex=-1></button><a title="Management of the certificates in Istio." href=/v1.24/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.24/docs/tasks/security/cert-management/plugin-ca-cert/>Plug in CA Certificates</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.24/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 tabindex=-1></button><a title="Controlling mutual TLS and end-user authentication for mesh services." href=/v1.24/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 set up mutual TLS and basic end-user authentication." href=/v1.24/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 (Alpha)" href=/v1.24/docs/tasks/security/authentication/jwt-route/>JWT claim based routing *</a></li><li role=none><a role=treeitem title="Shows how users can copy their JWT claims to HTTP headers (Experimental)" href=/v1.24/docs/tasks/security/authentication/claim-to-header/>Copy JWT Claims to HTTP Headers *</a></li><li role=none><a role=treeitem title="Shows you how to incrementally migrate your Istio services to mutual TLS." href=/v1.24/docs/tasks/security/authentication/mtls-migration/>Mutual TLS Migration</a></li></ul></li><li role=treeitem aria-label=Authorization><button aria-hidden=true tabindex=-1></button><a title="Shows how to control access to Istio services." href=/v1.24/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.24/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.24/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.24/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.24/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.24/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.24/docs/tasks/security/authorization/authz-ingress/>Ingress Access Control</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.24/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 (Alpha)" href=/v1.24/docs/tasks/security/authorization/authz-dry-run/>Dry Run *</a></li></ul></li><li role=treeitem aria-label="TLS Configuration"><button aria-hidden=true tabindex=-1></button><a title="TLS configuration in Istio." href=/v1.24/docs/tasks/security/tls-configuration/>TLS Configuration</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Shows how to configure the minimum TLS version for Istio workloads." href=/v1.24/docs/tasks/security/tls-configuration/workload-min-tls-version/>Istio Workload Minimum TLS Version Configuration</a></li></ul></li></ul></li><li role=treeitem aria-label="Policy Enforcement"><button aria-hidden=true tabindex=-1></button><a title="Demonstrates policy enforcement features." href=/v1.24/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.24/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 tabindex=-1></button><a title="Demonstrates how to collect telemetry information from the mesh." href=/v1.24/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.24/docs/tasks/observability/telemetry/>Telemetry API</a></li><li role=treeitem aria-label=Metrics><button aria-hidden=true tabindex=-1></button><a title="Demonstrates the collection and querying of metrics within Istio." href=/v1.24/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 customize the Istio metrics with Telemetry API." href=/v1.24/docs/tasks/observability/metrics/telemetry-api/>Customizing Istio Metrics with Telemetry API</a></li><li role=none><a role=treeitem title="This task shows you how to configure Istio to collect metrics for TCP services." href=/v1.24/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.24/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.24/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.24/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 set up and use the Istio Dashboard to monitor mesh traffic." href=/v1.24/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 tabindex=-1></button><a title="Demonstrates the collection of logs within Istio." href=/v1.24/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 send access logs with Telemetry API." href=/v1.24/docs/tasks/observability/logs/telemetry-api/>Configure access logs with Telemetry API</a></li><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.24/docs/tasks/observability/logs/access-log/>Envoy Access Logs</a></li><li role=none><a role=treeitem title="This task shows you how to configure Envoy proxies to send access logs with OpenTelemetry collector." href=/v1.24/docs/tasks/observability/logs/otel-provider/>OpenTelemetry</a></li></ul></li><li role=treeitem aria-label="Distributed Tracing"><button aria-hidden=true tabindex=-1></button><a title="This task shows you how to configure Istio-enabled applications to collect trace spans." href=/v1.24/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.24/docs/tasks/observability/distributed-tracing/overview/>Overview</a></li><li role=none><a role=treeitem title="How to configure tracing options using Telemetry API." href=/v1.24/docs/tasks/observability/distributed-tracing/telemetry-api/>Configure tracing with Telemetry API</a></li><li role=none><a role=treeitem title="How to configure tracing options using MeshConfig and pod annotations." href=/v1.24/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="Learn the different approaches on how to configure trace sampling on the proxies." href=/v1.24/docs/tasks/observability/distributed-tracing/sampling/>Configure trace sampling</a></li><li role=none><a role=treeitem title="Learn how to configure the proxies to send traces in OpenTelemetry format." href=/v1.24/docs/tasks/observability/distributed-tracing/opentelemetry/>OpenTelemetry</a></li><li role=none><a role=treeitem title="Learn how to configure the proxies to send tracing requests to Jaeger." href=/v1.24/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.24/docs/tasks/observability/distributed-tracing/zipkin/>Zipkin</a></li><li role=none><a role=treeitem title="Learn how to configure the proxies to send tracing requests to Apache SkyWalking." href=/v1.24/docs/tasks/observability/distributed-tracing/skywalking/>Apache SkyWalking</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.24/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.24/docs/tasks/observability/gateways/>Remotely Accessing Telemetry Addons</a></li></ul></li><li role=treeitem aria-label=Extensibility><button aria-hidden=true tabindex=-1></button><a title="Demonstrates how to extend mesh behavior." href=/v1.24/docs/tasks/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.24/docs/tasks/extensibility/wasm-module-distribution/>Distributing WebAssembly Modules *</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.24/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.24/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.24/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 tabindex=-1></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.24/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 title href=/v1.24/docs/examples/microservices-istio/prereq/>Prerequisites</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/setup-kubernetes-cluster/>Set up a Kubernetes Cluster</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/setup-local-computer/>Set up a Local Computer</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/single/>Run a Microservice Locally</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/package-service/>Run ratings in Docker</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/bookinfo-kubernetes/>Run Bookinfo with Kubernetes</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/production-testing/>Test in production</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/add-new-microservice-version/>Add a new version of reviews</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/add-istio/>Enable Istio on productpage</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/enable-istio-all-microservices/>Enable Istio on all the microservices</a></li><li role=none><a role=treeitem title href=/v1.24/docs/examples/microservices-istio/istio-ingress-gateway/>Configure Istio Ingress Gateway</a></li><li role=none><a role=treeitem title href=/v1.24/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.24/docs/ops/>Operations</a><ul role=group aria-expanded=true><li role=treeitem aria-label=Deployment><button aria-hidden=true tabindex=-1></button><a title="Requirements, concepts, and considerations for setting up an Istio deployment." href=/v1.24/docs/ops/deployment/>Deployment</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Platform requirements for Istio." href=/v1.24/docs/ops/deployment/platform-requirements/>Platform Requirements</a></li><li role=none><a role=treeitem title="Describes Istio's high-level architecture and design goals." href=/v1.24/docs/ops/deployment/architecture/>Architecture</a></li><li role=none><a role=treeitem title="Describes Istio's security model." href=/v1.24/docs/ops/deployment/security-model/>Security Model</a></li><li role=none><a role=treeitem title="Describes the options and considerations when configuring your Istio deployment." href=/v1.24/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.24/docs/ops/deployment/vm-architecture/>Virtual Machine Architecture</a></li><li role=none><a role=treeitem title="Istio performance and scalability summary." href=/v1.24/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.24/docs/ops/deployment/application-requirements/>Application Requirements</a></li></ul></li><li role=treeitem aria-label=Configuration><button aria-hidden=true tabindex=-1></button><a title="Advanced concepts and features for configuring a running Istio mesh." href=/v1.24/docs/ops/configuration/>Configuration</a><ul role=group aria-expanded=false><li role=treeitem aria-label="Mesh Configuration"><button aria-hidden=true tabindex=-1></button><a title="Helps you manage the global mesh configuration." href=/v1.24/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.24/docs/ops/configuration/mesh/webhook/>Dynamic Admission Webhooks Overview</a></li><li role=none><a role=treeitem title="Shows how to do health checking for Istio services." href=/v1.24/docs/ops/configuration/mesh/app-health-check/>Health Checking of Istio Services</a></li><li role=none><a role=treeitem title="Shows how to scope configuration in Istio, for operational and performance benefits." href=/v1.24/docs/ops/configuration/mesh/configuration-scoping/>Configuration Scoping</a></li></ul></li><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true tabindex=-1></button><a title="Helps you manage the networking aspects of a running mesh." href=/v1.24/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.24/docs/ops/configuration/traffic-management/protocol-selection/>Protocol Selection</a></li><li role=none><a role=treeitem title="How to configure certificates within your mesh." href=/v1.24/docs/ops/configuration/traffic-management/manage-mesh-certificates/>Managing In-Mesh Certificates</a></li><li role=none><a role=treeitem title="How to configure TLS settings to secure network traffic." href=/v1.24/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.24/docs/ops/configuration/traffic-management/traffic-routing/>Traffic Routing</a></li><li role=none><a role=treeitem title="How DNS interacts with Istio." href=/v1.24/docs/ops/configuration/traffic-management/dns/>DNS</a></li><li role=none><a role=treeitem title="How to configure gateway network topology (Alpha)" href=/v1.24/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.24/docs/ops/configuration/traffic-management/dns-proxy/>DNS Proxying</a></li><li role=none><a role=treeitem title="How to configure how traffic is distributed among clusters in the mesh." href=/v1.24/docs/ops/configuration/traffic-management/multicluster/>Multi-cluster Traffic Management</a></li></ul></li><li role=treeitem aria-label=Security><button aria-hidden=true tabindex=-1></button><a title="Helps you manage the security aspects of a running mesh." href=/v1.24/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.24/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.24/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 tabindex=-1></button><a title="Helps you manage telemetry collection and visualization in a running mesh." href=/v1.24/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.24/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.24/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 tabindex=-1></button><a title="Helps you manage extensions to the service mesh." href=/v1.24/docs/ops/configuration/extensibility/>Extensibility</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes how Istio determines whether to pull Wasm modules or use cached versions (Alpha)" href=/v1.24/docs/ops/configuration/extensibility/wasm-pull-policy/>Pull Policy for WebAssembly Modules *</a></li></ul></li></ul></li><li role=treeitem aria-label="Best Practices"><button aria-hidden=true tabindex=-1></button><a title="Best practices for setting up and managing an Istio service mesh." href=/v1.24/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.24/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.24/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.24/docs/ops/best-practices/security/>Security Best Practices</a></li><li role=none><a role=treeitem title="Describes how to use image signatures to verify the provenance of Istio images." href=/v1.24/docs/ops/best-practices/image-signing-validation/>Image Signing and Validation</a></li><li role=none><a role=treeitem title="Best practices for observing applications using Istio." href=/v1.24/docs/ops/best-practices/observability/>Observability Best Practices</a></li></ul></li><li role=treeitem aria-label="Common Problems"><button aria-hidden=true tabindex=-1></button><a title="Describes how to identify and resolve common problems in Istio." href=/v1.24/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.24/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.24/docs/ops/common-problems/security-issues/>Security Problems</a></li><li role=none><a role=treeitem title="Dealing with telemetry collection issues." href=/v1.24/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.24/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.24/docs/ops/common-problems/validation/>Configuration Validation Problems</a></li><li role=none><a role=treeitem title="Resolve common problems with Istio upgrades." href=/v1.24/docs/ops/common-problems/upgrade-issues/>Upgrade Problems</a></li></ul></li><li role=treeitem aria-label="Diagnostic Tools"><button aria-hidden=true tabindex=-1></button><a title="Tools and techniques to help troubleshoot an Istio mesh." href=/v1.24/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.24/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.24/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.24/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.24/docs/ops/diagnostic-tools/istioctl-analyze/>Diagnose your Configuration with Istioctl Analyze</a></li><li role=none><a role=treeitem title="Learn how to use istioctl check-inject to confirm if Istio sidecar injection is properly enabled for your deployments." href=/v1.24/docs/ops/diagnostic-tools/check-inject/>Verifying Istio Sidecar Injection with Istioctl Check-Inject</a></li><li role=none><a role=treeitem title="Describes how to use ControlZ to get insight into a running istiod component." href=/v1.24/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.24/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.24/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.24/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.24/docs/ops/diagnostic-tools/cni/>Troubleshooting the Istio CNI plugin</a></li></ul></li><li role=treeitem aria-label=Integrations><button aria-hidden=true tabindex=-1></button><a title="Other software that Istio can integrate with to provide additional functionality." href=/v1.24/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.24/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.24/docs/ops/integrations/grafana/>Grafana</a></li><li role=none><a role=treeitem title="How to integrate with Jaeger." href=/v1.24/docs/ops/integrations/jaeger/>Jaeger</a></li><li role=none><a role=treeitem title="Information on how to integrate with Kiali." href=/v1.24/docs/ops/integrations/kiali/>Kiali</a></li><li role=none><a role=treeitem title="How to integrate with Prometheus." href=/v1.24/docs/ops/integrations/prometheus/>Prometheus</a></li><li role=none><a role=treeitem title="How to configure Istio to integrate with SPIRE to get cryptographic identities through Envoy's SDS API." href=/v1.24/docs/ops/integrations/spire/>SPIRE</a></li><li role=none><a role=treeitem title="How to integrate with Apache SkyWalking." href=/v1.24/docs/ops/integrations/skywalking/>Apache SkyWalking</a></li><li role=none><a role=treeitem title="How to integrate with Zipkin." href=/v1.24/docs/ops/integrations/zipkin/>Zipkin</a></li><li role=none><a role=treeitem title="How to integrate Istio with third party load balancers." href=/v1.24/docs/ops/integrations/loadbalancers/>Third Party Load Balancers</a></li></ul></li></ul></li><li role=treeitem aria-label=Releases><a class=main title="Information relating to Istio releases." href=/v1.24/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.24/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.24/docs/releases/bugs/>Reporting Bugs</a></li><li role=none><a role=treeitem title="How we handle security vulnerabilities." href=/v1.24/docs/releases/security-vulnerabilities/>Security Vulnerabilities</a></li><li role=none><a role=treeitem title="The currently supported Istio releases." href=/v1.24/docs/releases/supported-releases/>Supported Releases</a></li><li role=treeitem aria-label="Contribute Documentation"><button aria-hidden=true tabindex=-1></button><a title="Details how to create and maintain Istio documentation pages." href=/v1.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/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.24/docs/reference/>Reference</a><ul role=group aria-expanded=true><li role=treeitem aria-label=Configuration><button aria-hidden=true tabindex=-1></button><a title="Detailed information on configuration options." href=/v1.24/docs/reference/config/>Configuration</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Describes the structure of messages generated by Istio analyzers." href=/v1.24/docs/reference/config/istio.analysis.v1alpha1/>Analysis Messages</a></li><li role=none><a role=treeitem title="Configuration affecting the service mesh as a whole." href=/v1.24/docs/reference/config/istio.mesh.v1alpha1/>Global Mesh Options</a></li><li role=none><a role=treeitem title="Configuration affecting Istio control plane installation version and shape." href=/v1.24/docs/reference/config/istio.operator.v1alpha1/>IstioOperator Options</a></li><li role=none><a role=treeitem title="Describes the role of the `status` field in configuration workflow." href=/v1.24/docs/reference/config/config-status/>Configuration Status Field</a></li><li role=treeitem aria-label="Proxy Extensions"><button aria-hidden=true tabindex=-1></button><a title="Describes how to configure Istio proxy extensions." href=/v1.24/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.24/docs/reference/config/proxy_extensions/wasm-plugin/>Wasm Plugin</a></li><li role=none><a role=treeitem title="Configuration for Stats Filter." href=/v1.24/docs/reference/config/proxy_extensions/stats/>Stats Config</a></li></ul></li><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true tabindex=-1></button><a title="Describes how to configure HTTP/TCP routing features." href=/v1.24/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.24/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.24/docs/reference/config/networking/envoy-filter/>Envoy Filter</a></li><li role=none><a role=treeitem title="Configuration affecting edge load balancer." href=/v1.24/docs/reference/config/networking/gateway/>Gateway</a></li><li role=none><a role=treeitem title="Provides configuration for individual workloads." href=/v1.24/docs/reference/config/networking/proxy-config/>ProxyConfig</a></li><li role=none><a role=treeitem title="Configuration affecting service registry." href=/v1.24/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.24/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.24/docs/reference/config/networking/virtual-service/>Virtual Service</a></li><li role=none><a role=treeitem title="Configuration affecting VMs onboarded into the mesh." href=/v1.24/docs/reference/config/networking/workload-entry/>Workload Entry</a></li><li role=none><a role=treeitem title="Describes a collection of workload instances." href=/v1.24/docs/reference/config/networking/workload-group/>Workload Group</a></li></ul></li><li role=treeitem aria-label=Security><button aria-hidden=true tabindex=-1></button><a title="Describes how to configure Istio's security features." href=/v1.24/docs/reference/config/security/>Security</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Peer authentication configuration for workloads." href=/v1.24/docs/reference/config/security/peer_authentication/>PeerAuthentication</a></li><li role=none><a role=treeitem title="Request authentication configuration for workloads." href=/v1.24/docs/reference/config/security/request_authentication/>RequestAuthentication</a></li><li role=none><a role=treeitem title="Configuration for access control on workloads." href=/v1.24/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.24/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.24/docs/reference/config/security/normalization/>Authorization Policy Normalization</a></li></ul></li><li role=none><a role=treeitem title="Telemetry configuration for workloads." href=/v1.24/docs/reference/config/telemetry/>Telemetry</a></li><li role=treeitem aria-label="Common Types"><button aria-hidden=true tabindex=-1></button><a title="Describes common types in Istio API." href=/v1.24/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.24/docs/reference/config/type/workload-selector/>Workload Selector</a></li></ul></li><li role=none><a role=treeitem title="Istio standard metrics exported by Istio telemetry." href=/v1.24/docs/reference/config/metrics/>Istio Standard Metrics</a></li><li role=none><a role=treeitem title="Resource annotations used by Istio." href=/v1.24/docs/reference/config/annotations/>Resource Annotations</a></li><li role=none><a role=treeitem title="Resource labels used by Istio." href=/v1.24/docs/reference/config/labels/>Resource Labels</a></li><li role=treeitem aria-label="Configuration Analysis Messages"><button aria-hidden=true tabindex=-1></button><a title="Documents the individual error and warning messages produced during configuration analysis." href=/v1.24/docs/reference/config/analysis/>Configuration Analysis Messages</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0136/>AlphaAnnotation</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/message-format/>Analyzer Message Format</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0109/>ConflictingMeshGatewayVirtualServiceHosts</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0110/>ConflictingSidecarWorkloadSelectors</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0159/>ConflictingTelemetryWorkloadSelectors</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0116/>DeploymentAssociatedToMultipleServices</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0137/>DeploymentConflictingPorts</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0002/>Deprecated</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0135/>DeprecatedAnnotation</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0153/>EnvoyFilterUsesAddOperationIncorrectly</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0151/>EnvoyFilterUsesRelativeOperation</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0155/>EnvoyFilterUsesRelativeOperationWithProxyVersion</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0154/>EnvoyFilterUsesRemoveOperationIncorrectly</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0152/>EnvoyFilterUsesReplaceOperationIncorrectly</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0164/>ExternalControlPlaneAddressIsNotAHostname</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0150/>ExternalNameServiceTypeInvalidPortName</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0162/>GatewayPortNotDefinedOnService</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0167/>IneffectivePolicy</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0166/>IneffectiveSelector</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0001/>InternalError</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0125/>InvalidAnnotation</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0144/>InvalidApplicationUID</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0163/>InvalidExternalControlPlaneConfig</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0161/>InvalidGatewayCredential</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0157/>InvalidTelemetryProvider</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0143/>LocalhostListener</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0107/>MisplacedAnnotation</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0111/>MultipleSidecarsWithoutWorkloadSelectors</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0160/>MultipleTelemetriesWithoutWorkloadSelectors</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0123/>NamespaceMultipleInjectionLabels</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0102/>NamespaceNotInjected</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0127/>NoMatchingWorkloadsFound</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0128/>NoServerCertificateVerificationDestinationLevel</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0129/>NoServerCertificateVerificationPortLevel</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0103/>PodMissingProxy</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0158/>PodsIstioProxyImageMismatchInNamespace</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0118/>PortNameIsNotUnderNamingConvention</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0101/>ReferencedResourceNotFound</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0106/>SchemaValidationError</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0134/>ServiceEntryAddressesRequired</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0108/>UnknownAnnotation</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0112/>VirtualServiceDestinationPortSelectorRequired</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0132/>VirtualServiceHostNotFoundInGateway</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0131/>VirtualServiceIneffectiveMatch</a></li><li role=none><a role=treeitem title href=/v1.24/docs/reference/config/analysis/ist0130/>VirtualServiceUnreachableRule</a></li></ul></li></ul></li><li role=treeitem aria-label=Commands><button class=show aria-hidden=true tabindex=-1></button><a title="Describes usage and options of the Istio commands and utilities." href=/v1.24/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.24/docs/reference/commands/install-cni/>install-cni</a></li><li role=none><a role=treeitem title="Istio control interface." href=/v1.24/docs/reference/commands/istioctl/>istioctl</a></li><li role=none><a role=treeitem title="Istio Pilot agent." href=/v1.24/docs/reference/commands/pilot-agent/>pilot-agent</a></li><li role=none><a role=treeitem title="Istio Pilot." href=/v1.24/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.24/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.24/img/icons.svg#hamburger-sidebar"/></svg>
|
||
Contents</button><article aria-labelledby=title><nav aria-label=Breadcrumb><ol><li><a href=/v1.24/docs/ title="Learn how to deploy, use, and operate Istio.">Documentation</a><svg class="icon breadcrumb-arrow"><use xlink:href="/v1.24/img/icons.svg#breadcrumb-arrow"/></svg></li><li><a href=/v1.24/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.24/img/icons.svg#breadcrumb-arrow"/></svg></li><li><a href=/v1.24/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.24/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="24472 words"><svg class="icon clock"><use xlink:href="/v1.24/img/icons.svg#clock"/></svg><span> </span>115 minute read</span>
|
||
<span> </span>
|
||
<span></span></p></div></div><nav class=toc-inlined aria-label="Table of Contents"><div><hr><ol><li role=none aria-label=Parameters><a href=#title>Parameters</a><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 create-remote-secret"><a href=#istioctl-create-remote-secret>create-remote-secret</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 istiod-debug"><a href=#istioctl-dashboard-istiod-debug>dashboard istiod-debug</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 proxy"><a href=#istioctl-dashboard-proxy>dashboard proxy</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 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 check-inject"><a href=#istioctl-experimental-check-inject>experimental check-inject</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 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 envoy-stats"><a href=#istioctl-experimental-envoy-stats>experimental envoy-stats</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 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 version"><a href=#istioctl-experimental-version>experimental version</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 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 manifest translate"><a href=#istioctl-manifest-translate>manifest translate</a><li role=none aria-label="istioctl options"><a href=#istioctl-options>options</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 ecds"><a href=#istioctl-proxy-config-ecds>proxy-config ecds</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 remote-clusters"><a href=#istioctl-remote-clusters>remote-clusters</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 uninstall"><a href=#istioctl-uninstall>uninstall</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 version"><a href=#istioctl-version>version</a><li role=none aria-label="istioctl waypoint"><a href=#istioctl-waypoint>waypoint</a><li role=none aria-label="istioctl waypoint apply"><a href=#istioctl-waypoint-apply>waypoint apply</a><li role=none aria-label="istioctl waypoint delete"><a href=#istioctl-waypoint-delete>waypoint delete</a><li role=none aria-label="istioctl waypoint generate"><a href=#istioctl-waypoint-generate>waypoint generate</a><li role=none aria-label="istioctl waypoint list"><a href=#istioctl-waypoint-list>waypoint list</a><li role=none aria-label="istioctl waypoint status"><a href=#istioctl-waypoint-status>waypoint status</a><li role=none aria-label="istioctl ztunnel-config"><a href=#istioctl-ztunnel-config>ztunnel-config</a><li role=none aria-label="istioctl ztunnel-config all"><a href=#istioctl-ztunnel-config-all>ztunnel-config all</a><li role=none aria-label="istioctl ztunnel-config certificate"><a href=#istioctl-ztunnel-config-certificate>ztunnel-config certificate</a><li role=none aria-label="istioctl ztunnel-config log"><a href=#istioctl-ztunnel-config-log>ztunnel-config log</a><li role=none aria-label="istioctl ztunnel-config policy"><a href=#istioctl-ztunnel-config-policy>ztunnel-config policy</a><li role=none aria-label="istioctl ztunnel-config service"><a href=#istioctl-ztunnel-config-service>ztunnel-config service</a><li role=none aria-label="istioctl ztunnel-config workload"><a href=#istioctl-ztunnel-config-workload>ztunnel-config workload</a></ol></li><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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>istioctl admin</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--selector <string></code></td><td><code>-l</code></td><td>label selector (default `app=istiod`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-admin Examples">Examples</h4><pre class=language-bash><code> # Retrieve information about istiod configuration.
|
||
istioctl admin log
|
||
</code></pre><h3 id=istioctl-admin-log>istioctl admin log</h3><p>Retrieve or update logging levels of istiod components.</p><pre class=language-bash><code>istioctl admin log [<pod-name>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|yaml] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl admin l [<pod-name>]|[-r|--revision] [--level <scope>:<level>][--stack-trace-level <scope>:<level>]|[--reset]|[--output|-o short|json|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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--ctrlz_port <int></code></td><td></td><td>ControlZ port (default `9876`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--level <string></code></td><td></td><td>Comma-separated list of output logging level for scopes in the format of <scope>:<level>[,<scope>:<level>,...]. Possible values for <level>: none, error, warn, info, debug (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <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></td><td>Reset levels to default value. (info)</td></tr><tr><td><code>--revision <string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--selector <string></code></td><td><code>-l</code></td><td>label selector (default `app=istiod`)</td></tr><tr><td><code>--stack-trace-level <string></code></td><td></td><td>Comma-separated list of stack trace level for scopes in the format of <scope>:<stack-trace-level>[,<scope>:<stack-trace-level>,...]. Possible values for <stack-trace-level>: none, error, warn, info, debug (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-admin-log Examples">Examples</h4><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
|
||
|
||
# Retrieve information about istiod logging levels for a specified revision.
|
||
istioctl admin log --revision v1
|
||
|
||
# Reset levels of all the loggers to default value (info).
|
||
istioctl admin log --reset
|
||
|
||
</code></pre><h3 id=istioctl-analyze>istioctl analyze</h3><p>Analyze Istio configuration and print validation messages</p><pre class=language-bash><code>istioctl analyze <file>... [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--all-namespaces</code></td><td><code>-A</code></td><td>Analyze all namespaces</td></tr><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--failure-threshold <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>--ignore-unknown</code></td><td></td><td>Don't complain about un-parseable input documents, for cases where analyze should run only on k8s compliant inputs.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--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 <string></code></td><td></td><td>Overrides the mesh config values to use for analysis. (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <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 <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>--remote-contexts <stringArray></code></td><td></td><td>Kubernetes configuration contexts for remote clusters to be used in multi-cluster analysis. Not to be confused with '--context'. If unspecified, contexts are read from the remote secrets in the cluster. (default `[]`)</td></tr><tr><td><code>--revision <string></code></td><td></td><td>analyze a specific revision deployed. (default `default`)</td></tr><tr><td><code>--suppress <stringArray></code></td><td><code>-S</code></td><td>Suppress reporting a message code on a specific resource. Values are supplied in the form <code>=<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 <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 <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-analyze Examples">Examples</h4><pre class=language-bash><code> # Analyze the current live cluster
|
||
istioctl analyze
|
||
|
||
# Analyze the current live cluster for a specific revision
|
||
istioctl analyze --revision 1-16
|
||
|
||
# Analyze the current live cluster, simulating the effect of applying additional yaml files
|
||
istioctl analyze a.yaml b.yaml my-app-config/
|
||
|
||
# Analyze the current live cluster, simulating the effect of applying a directory of config recursively
|
||
istioctl analyze --recursive my-istio-config/
|
||
|
||
# Analyze yaml files without connecting to a live cluster
|
||
istioctl analyze --use-kube=false a.yaml b.yaml my-app-config/
|
||
|
||
# Analyze the current live cluster and suppress PodMissingProxy for pod mypod in namespace 'testing'.
|
||
istioctl analyze -S "IST0103=Pod mypod.testing"
|
||
|
||
# Analyze the current live cluster and suppress PodMissingProxy for all pods in namespace 'testing',
|
||
# and suppress MisplacedAnnotation on deployment foobar in namespace default.
|
||
istioctl analyze -S "IST0103=Pod *.testing" -S "IST0107=Deployment foobar.default"
|
||
|
||
# List available analyzers
|
||
istioctl analyze -L
|
||
</code></pre><h3 id=istioctl-authz>istioctl authz</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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-bug-report>istioctl bug-report</h3><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.../lbl1=val1,lbl2=val2.../ann1=val1,ann2=val2.../cntr1,cntr...
|
||
where ns=namespace, dep=deployment, lbl=label, ann=annotation, cntr=container</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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Name of the kubeconfig Context to use. (default ``)</td></tr><tr><td><code>--critical-errs <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 <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 <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 <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 <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-node-lease,kube-public,kube-system,local-path-storage"]`)</td></tr><tr><td><code>--filename <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 <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 <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 <string></code></td><td></td><td>Namespace where Istio control plane is installed. (default `istio-system`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Path to kube config. (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output-dir <string></code></td><td></td><td>Set a specific directory for output archive file. (default ``)</td></tr><tr><td><code>--rq-concurrency <int></code></td><td></td><td>Set the concurrency limit of requests to the Kubernetes API server, defaults to 32. (default `0`)</td></tr><tr><td><code>--start-time <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 <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 <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-bug-report-version>istioctl bug-report version</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Name of the kubeconfig Context to use. (default ``)</td></tr><tr><td><code>--critical-errs <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 <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 <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 <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 <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-node-lease,kube-public,kube-system,local-path-storage"]`)</td></tr><tr><td><code>--filename <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 <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 <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 <string></code></td><td></td><td>Namespace where Istio control plane is installed. (default `istio-system`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Path to kube config. (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>One of 'yaml' or 'json'. (default ``)</td></tr><tr><td><code>--output-dir <string></code></td><td></td><td>Set a specific directory for output archive file. (default ``)</td></tr><tr><td><code>--rq-concurrency <int></code></td><td></td><td>Set the concurrency limit of requests to the Kubernetes API server, defaults to 32. (default `0`)</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 <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 <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 <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-completion>istioctl completion</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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-completion-bash>istioctl completion bash</h3><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:</p><pre class=language-bash><code>source <(istioctl completion bash)</code></pre><p>To load completions for every new session, execute once:</p><h4>Linux:</h4><pre class=language-bash><code>istioctl completion bash > /etc/bash_completion.d/istioctl</code></pre><h4>macOS:</h4><pre class=language-bash><code>istioctl completion bash > /usr/local/etc/bash_completion.d/istioctl</code></pre><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--no-descriptions</code></td><td></td><td>disable completion descriptions</td></tr><tr><td><code>--vklog <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-completion-fish>istioctl completion fish</h3><p>Generate the autocompletion script for the fish shell.</p><p>To load completions in your current shell session:</p><pre class=language-bash><code>istioctl completion fish | source</code></pre><p>To load completions for every new session, execute once:</p><pre class=language-bash><code>istioctl completion bash > ~/.config/fish/completions/istioctl.fish</code></pre><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--no-descriptions</code></td><td></td><td>disable completion descriptions</td></tr><tr><td><code>--vklog <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-completion-powershell>istioctl completion powershell</h3><p>Generate the autocompletion script for PowerShell.</p><p>To load completions in your current shell session:</p><pre class=language-bash><code>istioctl completion powershell | Out-String | Invoke-Expression</code></pre><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--no-descriptions</code></td><td></td><td>disable completion descriptions</td></tr><tr><td><code>--vklog <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-completion-zsh>istioctl completion zsh</h3><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><pre class=language-bash><code>echo "autoload -U compinit; compinit" >> ~/.zshrc</code></pre><p>To load completions in your current shell session:</p><pre class=language-bash><code>source <(istioctl completion zsh)</code></pre><p>To load completions for every new session, execute once:</p><h4>Linux:</h4><pre class=language-bash><code>istioctl completion zsh > "${fpath[1]}/_istioctl"</code></pre><h4>macOS:</h4><pre class=language-bash><code>istioctl completion zsh > $(brew --prefix)/share/zsh/site-functions/_istioctl</code></pre><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--no-descriptions</code></td><td></td><td>disable completion descriptions</td></tr><tr><td><code>--vklog <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-create-remote-secret>istioctl create-remote-secret</h3><p>Create a secret with credentials to allow Istio to access remote Kubernetes apiservers</p><pre class=language-bash><code>istioctl 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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--auth-plugin-config <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 <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 <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 <string></code></td><td></td><td>Kubernetes configuration context (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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests <string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
|
||
(e.g. ~/Downloads/istio-1.24.0/manifests). (default ``)</td></tr><tr><td><code>--name <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 <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--secret-name <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 <string></code></td><td></td><td>The address and port of the Kubernetes API server. (default ``)</td></tr><tr><td><code>--service-account <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 <SecretType></code></td><td></td><td>Type of the generated secret. supported values = [remote config] (default `remote`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-create-remote-secret Examples">Examples</h4><pre class=language-bash><code> # Create a secret to access cluster c0's apiserver and install it in cluster c1.
|
||
istioctl --kubeconfig=c0.yaml create-remote-secret --name c0 \
|
||
| kubectl --kubeconfig=c1.yaml apply -f -
|
||
|
||
# Delete a secret that was previously installed in c1
|
||
istioctl --kubeconfig=c0.yaml 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 create-remote-secret --name c0 --auth-type=plugin --auth-plugin-name=gcp \
|
||
| kubectl --kubeconfig=c1.yaml apply -f -
|
||
</code></pre><h3 id=istioctl-dashboard>istioctl dashboard</h3><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 <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--vklog <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>istioctl dashboard controlz</h3><p>Open the ControlZ web UI for a pod in the Istio control plane</p><pre class=language-bash><code>istioctl dashboard controlz [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--ctrlz_port <int></code></td><td></td><td>ControlZ port (default `9876`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--selector <string></code></td><td><code>-l</code></td><td>Label selector (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-controlz Examples">Examples</h4><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><h3 id=istioctl-dashboard-envoy>istioctl dashboard envoy</h3><p>Open the Envoy admin dashboard for a sidecar</p><p>Note: envoy command is deprecated and can be replaced with proxy command, e.g. `istioctl dashboard proxy --help`</p><pre class=language-bash><code>istioctl dashboard envoy [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--selector <string></code></td><td><code>-l</code></td><td>Label selector (default ``)</td></tr><tr><td><code>--ui-port <int></code></td><td></td><td>The component dashboard UI port. (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-envoy Examples">Examples</h4><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><h3 id=istioctl-dashboard-grafana>istioctl dashboard grafana</h3><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 <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--ui-port <int></code></td><td></td><td>The component dashboard UI port. (default `3000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-grafana Examples">Examples</h4><pre class=language-bash><code> istioctl dashboard grafana
|
||
|
||
# with short syntax
|
||
istioctl dash grafana
|
||
istioctl d grafana
|
||
</code></pre><h3 id=istioctl-dashboard-istiod-debug>istioctl dashboard istiod-debug</h3><p>Open the debug web UI for a Istio control plane pod</p><pre class=language-bash><code>istioctl dashboard istiod-debug [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--selector <string></code></td><td><code>-l</code></td><td>Label selector (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-istiod-debug Examples">Examples</h4><pre class=language-bash><code> # Open Istio debug web UI for the istiod-123-456.istio-system pod
|
||
istioctl dashboard istiod-debug istiod-123-456.istio-system
|
||
|
||
# Open Istio debug web UI for the istiod-56dd66799-jfdvs pod in a custom namespace
|
||
istioctl dashboard istiod-debug istiod-123-456 -n custom-ns
|
||
|
||
# Open Istio debug web UI for any Istiod pod
|
||
istioctl dashboard istiod-debug deployment/istiod.istio-system
|
||
|
||
# with short syntax
|
||
istioctl dash istiod-debug pilot-123-456.istio-system
|
||
istioctl d istiod-debug pilot-123-456.istio-system
|
||
|
||
</code></pre><h3 id=istioctl-dashboard-jaeger>istioctl dashboard jaeger</h3><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 <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--ui-port <int></code></td><td></td><td>The component dashboard UI port. (default `16686`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-jaeger Examples">Examples</h4><pre class=language-bash><code> istioctl dashboard jaeger
|
||
|
||
# with short syntax
|
||
istioctl dash jaeger
|
||
istioctl d jaeger
|
||
</code></pre><h3 id=istioctl-dashboard-kiali>istioctl dashboard kiali</h3><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 <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--ui-port <int></code></td><td></td><td>The component dashboard UI port. (default `20001`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-kiali Examples">Examples</h4><pre class=language-bash><code> istioctl dashboard kiali
|
||
|
||
# with short syntax
|
||
istioctl dash kiali
|
||
istioctl d kiali
|
||
</code></pre><h3 id=istioctl-dashboard-prometheus>istioctl dashboard prometheus</h3><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 <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--ui-port <int></code></td><td></td><td>The component dashboard UI port. (default `9090`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-prometheus Examples">Examples</h4><pre class=language-bash><code> istioctl dashboard prometheus
|
||
|
||
# with short syntax
|
||
istioctl dash prometheus
|
||
istioctl d prometheus
|
||
</code></pre><h3 id=istioctl-dashboard-proxy>istioctl dashboard proxy</h3><p>Open the admin dashboard for a proxy, like envoy and ztunnel pods</p><pre class=language-bash><code>istioctl dashboard proxy [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--selector <string></code></td><td><code>-l</code></td><td>Label selector (default ``)</td></tr><tr><td><code>--ui-port <int></code></td><td></td><td>The component dashboard UI port. (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-proxy Examples">Examples</h4><pre class=language-bash><code> # Open envoy admin dashboard for the productpage-123-456.default pod
|
||
istioctl dashboard proxy productpage-123-456.default
|
||
|
||
# Open envoy admin dashboard for one pod under a deployment
|
||
istioctl dashboard proxy deployment/productpage-v1
|
||
|
||
# Open dashboard for the ztunnel-bwh89.istio-system pod
|
||
istioctl dashboard proxy ztunnel-bwh89.istio-system
|
||
|
||
# Open dashboard for a waypoint pod
|
||
istioctl dashboard proxy namespace-istio-waypoint-869b56b69c-7khz4
|
||
|
||
# with short syntax
|
||
istioctl dash proxy ztunnel-bwh89.istio-system
|
||
istioctl d proxy ztunnel-bwh89.istio-system
|
||
|
||
</code></pre><h3 id=istioctl-dashboard-skywalking>istioctl dashboard skywalking</h3><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 <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--ui-port <int></code></td><td></td><td>The component dashboard UI port. (default `8080`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-skywalking Examples">Examples</h4><pre class=language-bash><code> istioctl dashboard skywalking
|
||
|
||
# with short syntax
|
||
istioctl dash skywalking
|
||
istioctl d skywalking
|
||
</code></pre><h3 id=istioctl-dashboard-zipkin>istioctl dashboard zipkin</h3><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 <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--port <int></code></td><td><code>-p</code></td><td>Local port to listen to (default `0`)</td></tr><tr><td><code>--ui-port <int></code></td><td></td><td>The component dashboard UI port. (default `9411`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-dashboard-zipkin Examples">Examples</h4><pre class=language-bash><code> istioctl dashboard zipkin
|
||
|
||
# with short syntax
|
||
istioctl dash zipkin
|
||
istioctl d zipkin
|
||
</code></pre><h3 id=istioctl-experimental>istioctl experimental</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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>istioctl experimental authz</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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>istioctl experimental authz check</h3><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 [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-authz-check Examples">Examples</h4><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 x authz check deployment/productpage-v1
|
||
|
||
# Check AuthorizationPolicy from Envoy config dump file:
|
||
istioctl x authz check -f httpbin_config_dump.json
|
||
</code></pre><h3 id=istioctl-experimental-check-inject>istioctl experimental check-inject</h3><p>Checks associated resources of the given resource, and running webhooks to examine whether the pod can be or will be injected or not.</p><pre class=language-bash><code>istioctl experimental check-inject [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--labels <string></code></td><td><code>-l</code></td><td>Check namespace and label pairs injection status, split multiple labels by commas (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-check-inject Examples">Examples</h4><pre class=language-bash><code> # Check the injection status of a pod
|
||
istioctl experimental check-inject details-v1-fcff6c49c-kqnfk.test
|
||
|
||
# Check the injection status of a pod under a deployment
|
||
istioctl x check-inject deployment/details-v1
|
||
|
||
# Check the injection status of a pod under a deployment in namespace test
|
||
istioctl x check-inject deployment/details-v1 -n test
|
||
|
||
# Check the injection status of label pairs in a specific namespace before actual injection
|
||
istioctl x check-inject -n test -l app=helloworld,version=v1
|
||
|
||
</code></pre><h3 id=istioctl-experimental-config>istioctl experimental config</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-config Examples">Examples</h4><pre class=language-bash><code> # list configuration parameters
|
||
istioctl experimental config list
|
||
</code></pre><h3 id=istioctl-experimental-config-list>istioctl experimental config list</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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>istioctl experimental describe</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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>istioctl experimental describe pod</h3><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 <pod> [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental describe po <pod> [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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--ignoreUnmeshed</code></td><td></td><td>Suppress warnings for unmeshed pods</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-describe-pod Examples">Examples</h4><pre class=language-bash><code> istioctl experimental describe pod productpage-v1-c7765c886-7zzd4
|
||
</code></pre><h3 id=istioctl-experimental-describe-service>istioctl experimental describe service</h3><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 <svc> [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental describe svc <svc> [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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--ignoreUnmeshed</code></td><td></td><td>Suppress warnings for unmeshed pods</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-describe-service Examples">Examples</h4><pre class=language-bash><code> istioctl experimental describe service productpage
|
||
</code></pre><h3 id=istioctl-experimental-envoy-stats>istioctl experimental envoy-stats</h3><p>Retrieve Envoy emitted metrics for the specified pod.</p><pre class=language-bash><code>istioctl experimental envoy-stats [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental es [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short|prom|prom-merged (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--selector <string></code></td><td><code>-l</code></td><td>Label selector (default ``)</td></tr><tr><td><code>--type <string></code></td><td><code>-t</code></td><td>Where to grab the stats: one of server|clusters (default `server`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-envoy-stats Examples">Examples</h4><pre class=language-bash><code> # Retrieve Envoy emitted metrics for the specified pod.
|
||
istioctl experimental envoy-stats <pod-name[.namespace]>
|
||
|
||
# Retrieve Envoy server metrics in prometheus format
|
||
istioctl experimental envoy-stats <pod-name[.namespace]> --output prom
|
||
|
||
# Retrieve Envoy server metrics in prometheus format with custom proxy admin port
|
||
istioctl experimental envoy-stats <pod-name[.namespace]> --output prom --proxy-admin-port 15000
|
||
|
||
# Retrieve Envoy server metrics in prometheus format with merged application metrics
|
||
istioctl experimental envoy-stats <pod-name[.namespace]> --output prom-merged
|
||
|
||
# Retrieve Envoy cluster metrics
|
||
istioctl experimental envoy-stats <pod-name[.namespace]> --type clusters
|
||
|
||
</code></pre><h3 id=istioctl-experimental-injector>istioctl experimental injector</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-injector Examples">Examples</h4><pre class=language-bash><code> istioctl experimental injector list
|
||
</code></pre><h3 id=istioctl-experimental-injector-list>istioctl experimental injector list</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-injector-list Examples">Examples</h4><pre class=language-bash><code> istioctl experimental injector list
|
||
</code></pre><h3 id=istioctl-experimental-internal-debug>istioctl experimental internal-debug</h3><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 [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--authority <string></code></td><td></td><td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td></tr><tr><td><code>--cert-dir <string></code></td><td></td><td>XDS Endpoint certificate directory (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes 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 <string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--timeout <duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--vklog <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 <string></code></td><td></td><td>XDS Endpoint (default ``)</td></tr><tr><td><code>--xds-label <string></code></td><td></td><td>Istiod pod label selector (default ``)</td></tr><tr><td><code>--xds-port <int></code></td><td></td><td>Istiod pod port (default `15012`)</td></tr></tbody></table><h4 id="istioctl-experimental-internal-debug Examples">Examples</h4><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><h3 id=istioctl-experimental-metrics>istioctl experimental metrics</h3><p>Prints the metrics for the specified service(s) when running in Kubernetes.</p><p>This command finds a Prometheus pod running in the specified istio system
|
||
namespace. It then executes a series of queries per requested workload to
|
||
find the following top-level workload metrics: total requests per second,
|
||
error rate, and request latency at p50, p90, and p99 percentiles. The
|
||
query results are printed to the console, organized by workload name.</p><p>All metrics returned are from server-side reports. This means that latencies
|
||
and error rates are from the perspective of the service itself and not of an
|
||
individual client (or aggregate set of clients). Rates and latencies are
|
||
calculated over a time interval of 1 minute.</p><pre class=language-bash><code>istioctl experimental metrics <workload name>...
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental m <workload name>...
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--duration <duration></code></td><td><code>-d</code></td><td>Duration of query metrics, default value is 1m. (default `1m0s`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-metrics Examples">Examples</h4><pre class=language-bash><code> # Retrieve workload metrics for productpage-v1 workload
|
||
istioctl experimental metrics productpage-v1
|
||
|
||
# Retrieve workload metrics for various services with custom duration
|
||
istioctl experimental metrics productpage-v1 -d 2m
|
||
|
||
# Retrieve workload metrics for various services in the different namespaces
|
||
istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
||
</code></pre><h3 id=istioctl-experimental-precheck>istioctl experimental precheck</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--from-version <string></code></td><td><code>-f</code></td><td>check changes since the provided version (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <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 <Level></code></td><td></td><td>The severity level of precheck at which to display messages. Valid values: [Info Warning Error] (default `Warning`)</td></tr><tr><td><code>--revision <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 <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-precheck Examples">Examples</h4><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
|
||
|
||
# Check for behavioral changes since a specific version
|
||
istioctl x precheck --from-version 1.10
|
||
</code></pre><h3 id=istioctl-experimental-proxy-status>istioctl experimental proxy-status</h3><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 [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental ps [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--authority <string></code></td><td></td><td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td></tr><tr><td><code>--cert-dir <string></code></td><td></td><td>XDS Endpoint certificate directory (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes 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 <string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--timeout <duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--vklog <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 <string></code></td><td></td><td>XDS Endpoint (default ``)</td></tr><tr><td><code>--xds-label <string></code></td><td></td><td>Istiod pod label selector (default ``)</td></tr><tr><td><code>--xds-port <int></code></td><td></td><td>Istiod pod port (default `15012`)</td></tr><tr><td><code>--xds-via-agents</code></td><td></td><td>Access Istiod via the tap service of each agent</td></tr><tr><td><code>--xds-via-agents-limit <xds-via-agent></code></td><td></td><td>Maximum number of pods being visited by istioctl when xds-via-agent flag is true.To iterate all the agent pods without limit, set to 0 (default `100`)</td></tr></tbody></table><h4 id="istioctl-experimental-proxy-status Examples">Examples</h4><pre class=language-bash><code> # Retrieve sync status for all Envoys in a mesh
|
||
istioctl proxy-status
|
||
|
||
# Retrieve sync status for Envoys in a specific namespace
|
||
istioctl proxy-status --namespace foo
|
||
|
||
# Retrieve sync diff for a single Envoy and Istiod
|
||
istioctl 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 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 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 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 ps --xds-label istio.io/rev=default
|
||
|
||
</code></pre><h3 id=istioctl-experimental-version>istioctl experimental version</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--authority <string></code></td><td></td><td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td></tr><tr><td><code>--cert-dir <string></code></td><td></td><td>XDS Endpoint certificate directory (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>One of 'yaml' or 'json'. (default ``)</td></tr><tr><td><code>--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 <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 <duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--vklog <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 <string></code></td><td></td><td>XDS Endpoint (default ``)</td></tr><tr><td><code>--xds-label <string></code></td><td></td><td>Istiod pod label selector (default ``)</td></tr><tr><td><code>--xds-port <int></code></td><td></td><td>Istiod pod port (default `15012`)</td></tr></tbody></table><h4 id="istioctl-experimental-version Examples">Examples</h4><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><h3 id=istioctl-experimental-workload>istioctl experimental workload</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-workload Examples">Examples</h4><pre class=language-bash><code> # workload group yaml generation
|
||
istioctl x workload group create
|
||
|
||
# workload entry configuration generation
|
||
istioctl x workload entry configure
|
||
</code></pre><h3 id=istioctl-experimental-workload-entry>istioctl experimental workload entry</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-workload-entry Examples">Examples</h4><pre class=language-bash><code> istioctl x workload entry configure -f workloadgroup.yaml -o outputDir
|
||
</code></pre><h3 id=istioctl-experimental-workload-entry-configure>istioctl experimental workload entry configure</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><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 <string></code></td><td></td><td>The ID used to identify the cluster (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--externalIP <string></code></td><td></td><td>External IP address of the workload (default ``)</td></tr><tr><td><code>--file <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 <string></code></td><td></td><td>IP address of the ingress gateway (default ``)</td></tr><tr><td><code>--ingressService <string></code></td><td></td><td>Name of the Service to be used as the ingress gateway, in the format <service>.<namespace>. If no namespace is provided, the default istio-system namespace will be used. (default `istio-eastwestgateway`)</td></tr><tr><td><code>--internalIP <string></code></td><td></td><td>Internal IP address of the workload (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name <string></code></td><td></td><td>The name of the workload group (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>The namespace that the workload instances belong to (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output directory for generated files (default ``)</td></tr><tr><td><code>--revision <string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--tokenDuration <int></code></td><td></td><td>The token duration in seconds (default: 1 hour) (default `3600`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-workload-entry-configure Examples">Examples</h4><pre class=language-bash><code> # configure example using a local WorkloadGroup artifact
|
||
istioctl x workload entry configure -f workloadgroup.yaml -o config
|
||
|
||
# configure example using the API server
|
||
istioctl x workload entry configure --name foo --namespace bar -o config
|
||
</code></pre><h3 id=istioctl-experimental-workload-group>istioctl experimental workload group</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-workload-group Examples">Examples</h4><pre class=language-bash><code> istioctl x workload group create --name foo --namespace bar --labels app=foobar
|
||
</code></pre><h3 id=istioctl-experimental-workload-group-create>istioctl experimental workload group create</h3><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 <stringSlice></code></td><td><code>-a</code></td><td>The annotations to apply to the workload instances (default `[]`)</td></tr><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--labels <stringSlice></code></td><td><code>-l</code></td><td>The labels to apply to the workload instances; e.g. -l env=prod,vers=2 (default `[]`)</td></tr><tr><td><code>--name <string></code></td><td></td><td>The name of the workload group (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>The namespace that the workload instances will belong to (default ``)</td></tr><tr><td><code>--ports <stringSlice></code></td><td><code>-p</code></td><td>The incoming ports exposed by the workload instance (default `[]`)</td></tr><tr><td><code>--serviceAccount <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 <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-experimental-workload-group-create Examples">Examples</h4><pre class=language-bash><code> istioctl x workload group create --name foo --namespace bar --labels app=foo,bar=baz --ports grpc=3550,http=8080 --annotations annotation=foobar --serviceAccount sa
|
||
</code></pre><h3 id=istioctl-install>istioctl install</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--charts <string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (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 <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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests <string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
|
||
(e.g. ~/Downloads/istio-1.24.0/manifests).
|
||
(default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--readiness-timeout <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 <string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set <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.24/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 <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-install Examples">Examples</h4><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't wait for confirmation
|
||
istioctl install --set profile=demo --skip-confirmation
|
||
|
||
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
|
||
istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
|
||
|
||
</code></pre><h3 id=istioctl-kube-inject>istioctl kube-inject</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--authority <string></code></td><td></td><td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td></tr><tr><td><code>--cert-dir <string></code></td><td></td><td>XDS Endpoint certificate directory (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Input Kubernetes resource filename (default ``)</td></tr><tr><td><code>--injectConfigFile <string></code></td><td></td><td>Injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--insecure</code></td><td></td><td>Skip server certificate and domain verification. (NOT SECURE!)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--meshConfigFile <string></code></td><td></td><td>Mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--operatorFileName <string></code></td><td></td><td>Path to file containing IstioOperator custom resources. If configs from files like meshConfigFile, valuesFile are provided, they will be overridden by iop config values. (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Modified output Kubernetes resource filename (default ``)</td></tr><tr><td><code>--plaintext</code></td><td></td><td>Use plain-text HTTP/2 when connecting to server (no TLS).</td></tr><tr><td><code>--revision <string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--timeout <duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--valuesFile <string></code></td><td></td><td>Injection values configuration filename. (default ``)</td></tr><tr><td><code>--vklog <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 <string></code></td><td></td><td>MutatingWebhookConfiguration name for Istio (default `istio-sidecar-injector`)</td></tr><tr><td><code>--xds-address <string></code></td><td></td><td>XDS Endpoint (default ``)</td></tr><tr><td><code>--xds-label <string></code></td><td></td><td>Istiod pod label selector (default ``)</td></tr><tr><td><code>--xds-port <int></code></td><td></td><td>Istiod pod port (default `15012`)</td></tr></tbody></table><h4 id="istioctl-kube-inject Examples">Examples</h4><pre class=language-bash><code> # Update resources on the fly before applying.
|
||
kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)
|
||
|
||
# Create a persistent version of the deployment with 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="{.data.config}" > /tmp/inj-template.tmpl
|
||
kubectl -n istio-system get cm istio -o jsonpath="{.data.mesh}" > /tmp/mesh.yaml
|
||
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.values}" > /tmp/values.json
|
||
|
||
# Use kube-inject based on captured configuration
|
||
istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \
|
||
--injectConfigFile /tmp/inj-template.tmpl \
|
||
--meshConfigFile /tmp/mesh.yaml \
|
||
--valuesFile /tmp/values.json
|
||
|
||
</code></pre><h3 id=istioctl-manifest>istioctl manifest</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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>istioctl manifest generate</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--charts <string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--cluster-specific</code></td><td></td><td>If enabled, the current cluster will be checked for cluster-specific setting detection.</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (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 <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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests <string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
|
||
(e.g. ~/Downloads/istio-1.24.0/manifests).
|
||
(default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--revision <string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set <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.24/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-manifest-generate Examples">Examples</h4><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 "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
|
||
|
||
</code></pre><h3 id=istioctl-manifest-install>istioctl manifest install</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--charts <string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (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 <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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests <string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
|
||
(e.g. ~/Downloads/istio-1.24.0/manifests).
|
||
(default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--readiness-timeout <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 <string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set <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.24/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 <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-manifest-install Examples">Examples</h4><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't wait for confirmation
|
||
istioctl install --set profile=demo --skip-confirmation
|
||
|
||
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
|
||
istioctl install --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
|
||
|
||
</code></pre><h3 id=istioctl-manifest-translate>istioctl manifest translate</h3><p>The translate subcommand translates an Istio install manifest and outputs to the console by default.</p><pre class=language-bash><code>istioctl manifest translate [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (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 <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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests <string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
|
||
(e.g. ~/Downloads/istio-1.24.0/manifests).
|
||
(default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>where to put translated outputs (default ``)</td></tr><tr><td><code>--revision <string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set <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.24/docs/reference/config/istio.operator.v1alpha1/#IstioOperatorSpec (default `[]`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-manifest-translate Examples">Examples</h4><pre class=language-bash><code> # Translate an IstioOperator yaml file into helm values
|
||
istioctl manifest translate -f istio.yaml
|
||
|
||
# Translate a default Istio installation
|
||
istioctl manifest translate
|
||
|
||
# Enable Tracing
|
||
istioctl manifest translate --set meshConfig.enableTracing=true
|
||
|
||
# Translate the demo profile
|
||
istioctl manifest translate --set profile=demo
|
||
|
||
# To override a setting that includes dots, escape them with a backslash (\). Your shell may require enclosing quotes.
|
||
istioctl manifest translate --set "values.sidecarInjectorWebhook.injectedAnnotations.container\.apparmor\.security\.beta\.kubernetes\.io/istio-proxy=runtime/default"
|
||
|
||
</code></pre><h3 id=istioctl-options>istioctl options</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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>istioctl proxy-config</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config Examples">Examples</h4><pre class=language-bash><code> # Retrieve information about proxy configuration from an Envoy instance.
|
||
istioctl proxy-config <clusters|listeners|routes|endpoints|ecds|bootstrap|log|secret> <pod-name[.namespace]>
|
||
</code></pre><h3 id=istioctl-proxy-config-all>istioctl proxy-config all</h3><p>Retrieve information about all configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config all [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config a [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <string></code></td><td></td><td>Filter listeners by address field (default ``)</td></tr><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--direction <string></code></td><td></td><td>Filter clusters by Direction field (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Envoy config dump file (default ``)</td></tr><tr><td><code>--fqdn <string></code></td><td></td><td>Filter clusters by substring of Service FQDN field (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name <string></code></td><td></td><td>Filter routes by route name field (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter clusters and listeners by Port field (default `0`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--subset <string></code></td><td></td><td>Filter clusters by substring of Subset field (default ``)</td></tr><tr><td><code>--type <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 <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-all Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about all configuration for a given pod from Envoy.
|
||
istioctl proxy-config all <pod-name[.namespace]>
|
||
|
||
# Retrieve summary about all configuration for a pod under a deployment from Envoy.
|
||
istioctl proxy-config all deployment/<deployment-name[.namespace]>
|
||
|
||
# Retrieve full cluster dump as JSON
|
||
istioctl proxy-config all <pod-name[.namespace]> -o json
|
||
|
||
# Retrieve full cluster dump with short syntax
|
||
istioctl pc a <pod-name[.namespace]>
|
||
|
||
# Retrieve cluster summary without using Kubernetes API
|
||
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
||
istioctl proxy-config all --file envoy-config.json
|
||
|
||
</code></pre><h3 id=istioctl-proxy-config-bootstrap>istioctl proxy-config bootstrap</h3><p>Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config bootstrap [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config b [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `json`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-bootstrap Examples">Examples</h4><pre class=language-bash><code> # Retrieve full bootstrap configuration for a given pod from Envoy.
|
||
istioctl proxy-config bootstrap <pod-name[.namespace]>
|
||
|
||
# Retrieve full bootstrap configuration for a pod under a deployment from Envoy.
|
||
istioctl proxy-config bootstrap deployment/<deployment-name[.namespace]>
|
||
|
||
# Retrieve full bootstrap without using Kubernetes API
|
||
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
||
istioctl proxy-config bootstrap --file envoy-config.json
|
||
|
||
# Show a human-readable Istio and Envoy version summary
|
||
istioctl proxy-config bootstrap <pod-name[.namespace]> -o short
|
||
|
||
</code></pre><h3 id=istioctl-proxy-config-cluster>istioctl proxy-config cluster</h3><p>Retrieve information about cluster configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config cluster [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config clusters [<type>/]<name>[.<namespace>] [flags]
|
||
istioctl proxy-config c [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--direction <string></code></td><td></td><td>Filter clusters by Direction field (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--fqdn <string></code></td><td></td><td>Filter clusters by substring of Service FQDN field (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter clusters by Port field (default `0`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--subset <string></code></td><td></td><td>Filter clusters by substring of Subset field (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-cluster Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about cluster configuration for a given pod from Envoy.
|
||
istioctl proxy-config clusters <pod-name[.namespace]>
|
||
|
||
# Retrieve summary about cluster configuration for a pod under a deployment from Envoy.
|
||
istioctl proxy-config clusters deployment/<deployment-name[.namespace]>
|
||
|
||
# Retrieve cluster summary for clusters with port 9080.
|
||
istioctl proxy-config clusters <pod-name[.namespace]> --port 9080
|
||
|
||
# Retrieve full cluster dump for clusters that are inbound with a FQDN of details.default.svc.cluster.local.
|
||
istioctl proxy-config clusters <pod-name[.namespace]> --fqdn details.default.svc.cluster.local --direction inbound -o json
|
||
|
||
# Retrieve cluster summary without using Kubernetes API
|
||
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
||
istioctl proxy-config clusters --file envoy-config.json
|
||
|
||
</code></pre><h3 id=istioctl-proxy-config-ecds>istioctl proxy-config ecds</h3><p>Retrieve information about typed extension configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config ecds [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config ec [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-ecds Examples">Examples</h4><pre class=language-bash><code> # Retrieve full typed extension configuration for a given pod from Envoy.
|
||
istioctl proxy-config ecds <pod-name[.namespace]>
|
||
|
||
# Retrieve full typed extension configuration for a pod under a deployment from Envoy.
|
||
istioctl proxy-config ecds deployment/<deployment-name[.namespace]>
|
||
|
||
# Retrieve endpoint summary without using Kubernetes API
|
||
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
||
istioctl proxy-config ecds --file envoy-config.json
|
||
|
||
</code></pre><h3 id=istioctl-proxy-config-endpoint>istioctl proxy-config endpoint</h3><p>Retrieve information about endpoint configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config endpoint [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config endpoints [<type>/]<name>[.<namespace>] [flags]
|
||
istioctl proxy-config ep [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <string></code></td><td></td><td>Filter endpoints by address field (default ``)</td></tr><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--cluster <string></code></td><td></td><td>Filter endpoints by cluster name field (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter endpoints by Port field (default `0`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--status <string></code></td><td></td><td>Filter endpoints by status field (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-endpoint Examples">Examples</h4><pre class=language-bash><code> # Retrieve full endpoint configuration for a given pod from Envoy.
|
||
istioctl proxy-config endpoint <pod-name[.namespace]>
|
||
|
||
# Retrieve full endpoint configuration for a pod under a deployment from Envoy.
|
||
istioctl proxy-config endpoint deployment/<deployment-name[.namespace]>
|
||
|
||
# Retrieve endpoint summary for endpoint with port 9080.
|
||
istioctl proxy-config endpoint <pod-name[.namespace]> --port 9080
|
||
|
||
# Retrieve full endpoint with a address (172.17.0.2).
|
||
istioctl proxy-config endpoint <pod-name[.namespace]> --address 172.17.0.2 -o json
|
||
|
||
# Retrieve full endpoint with a cluster name (outbound|9411||zipkin.istio-system.svc.cluster.local).
|
||
istioctl proxy-config endpoint <pod-name[.namespace]> --cluster "outbound|9411||zipkin.istio-system.svc.cluster.local" -o json
|
||
# Retrieve full endpoint with the status (healthy).
|
||
istioctl proxy-config endpoint <pod-name[.namespace]> --status healthy -ojson
|
||
|
||
# Retrieve endpoint summary without using Kubernetes API
|
||
ssh <user@hostname> 'curl localhost:15000/clusters?format=json' > envoy-clusters.json
|
||
istioctl proxy-config endpoints --file envoy-clusters.json
|
||
|
||
</code></pre><h3 id=istioctl-proxy-config-listener>istioctl proxy-config listener</h3><p>Retrieve information about listener configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config listener [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config listeners [<type>/]<name>[.<namespace>] [flags]
|
||
istioctl proxy-config l [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <string></code></td><td></td><td>Filter listeners by address field (default ``)</td></tr><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter listeners by Port field (default `0`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--type <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 <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-listener Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about listener configuration for a given pod from Envoy.
|
||
istioctl proxy-config listeners <pod-name[.namespace]>
|
||
|
||
# Retrieve summary about listener configuration a pod under a deployment from Envoy.
|
||
istioctl proxy-config deployment/<deployment-name[.namespace]>
|
||
|
||
# Retrieve listener summary for listeners with port 9080.
|
||
istioctl proxy-config listeners <pod-name[.namespace]> --port 9080
|
||
|
||
# Retrieve full listener dump for HTTP listeners with a wildcard address (0.0.0.0).
|
||
istioctl proxy-config listeners <pod-name[.namespace]> --type HTTP --address 0.0.0.0 -o json
|
||
|
||
# Retrieve listener summary without using Kubernetes API
|
||
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
||
istioctl proxy-config listeners --file envoy-config.json
|
||
|
||
</code></pre><h3 id=istioctl-proxy-config-log>istioctl proxy-config log</h3><p>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 [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config o [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--level <string></code></td><td></td><td>Comma-separated minimum per-logger level of messages to output, in the form of [<logger>:]<level>,[<logger>:]<level>,... or <level> to change all active loggers, where logger components can be listed by running "istioctl proxy-config log <pod-name[.namespace]>"or referred from https://github.com/envoyproxy/envoy/blob/main/source/common/common/logger.h, and level can be one of [trace, debug, info, warning, error, critical, off] (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</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 <string></code></td><td><code>-l</code></td><td>Label selector (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-log Examples">Examples</h4><pre class=language-bash><code> # Retrieve information about logging levels for a given pod from Envoy.
|
||
istioctl proxy-config log <pod-name[.namespace]>
|
||
|
||
# Update levels of the all loggers
|
||
istioctl proxy-config log <pod-name[.namespace]> --level none
|
||
|
||
# Update levels of the specified loggers.
|
||
istioctl proxy-config log <pod-name[.namespace]> --level http:debug,redis:debug
|
||
|
||
# Reset levels of all the loggers to default value (warning).
|
||
istioctl proxy-config log <pod-name[.namespace]> -r
|
||
|
||
</code></pre><h3 id=istioctl-proxy-config-rootca-compare>istioctl proxy-config rootca-compare</h3><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/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config rc [pod/]<name-1>[.<namespace-1>] [pod/]<name-2>[.<namespace-2>] [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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-rootca-compare Examples">Examples</h4><pre class=language-bash><code> # Compare ROOTCA values for given 2 pods to check the connectivity between them.
|
||
istioctl proxy-config rootca-compare <pod-name-1[.namespace]> <pod-name-2[.namespace]>
|
||
</code></pre><h3 id=istioctl-proxy-config-route>istioctl proxy-config route</h3><p>Retrieve information about route configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config route [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config routes [<type>/]<name>[.<namespace>] [flags]
|
||
istioctl proxy-config r [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name <string></code></td><td></td><td>Filter listeners by route name field (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Output more information</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-route Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about route configuration for a given pod from Envoy.
|
||
istioctl proxy-config routes <pod-name[.namespace]>
|
||
|
||
# Retrieve summary about route configuration for a pod under a deployment from Envoy.
|
||
istioctl proxy-config routes deployment/<deployment-name[.namespace]>
|
||
|
||
# Retrieve route summary for route 9080.
|
||
istioctl proxy-config route <pod-name[.namespace]> --name 9080
|
||
|
||
# Retrieve full route dump for route 9080
|
||
istioctl proxy-config route <pod-name[.namespace]> --name 9080 -o json
|
||
|
||
# Retrieve route summary without using Kubernetes API
|
||
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
||
istioctl proxy-config routes --file envoy-config.json
|
||
|
||
</code></pre><h3 id=istioctl-proxy-config-secret>istioctl proxy-config secret</h3><p>Retrieve information about secret configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config secret [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config secrets [<type>/]<name>[.<namespace>] [flags]
|
||
istioctl proxy-config s [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Envoy config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Envoy proxy admin port (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-proxy-config-secret Examples">Examples</h4><pre class=language-bash><code> # Retrieve full secret configuration for a given pod from Envoy.
|
||
istioctl proxy-config secret <pod-name[.namespace]>
|
||
|
||
# Retrieve full secret configuration for a pod under a deployment from Envoy.
|
||
istioctl proxy-config secret deployment/<deployment-name[.namespace]>
|
||
|
||
# Retrieve full bootstrap without using Kubernetes API
|
||
ssh <user@hostname> 'curl localhost:15000/config_dump' > envoy-config.json
|
||
istioctl proxy-config secret --file envoy-config.json
|
||
</code></pre><h3 id=istioctl-proxy-status>istioctl proxy-status</h3><p>Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in the mesh</p><pre class=language-bash><code>istioctl proxy-status [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl ps [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--authority <string></code></td><td></td><td>XDS Subject Alternative Name (for example istiod.istio-system.svc) (default ``)</td></tr><tr><td><code>--cert-dir <string></code></td><td></td><td>XDS Endpoint certificate directory (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes 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 <string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--timeout <duration></code></td><td></td><td>The duration to wait before failing (default `30s`)</td></tr><tr><td><code>--vklog <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 <string></code></td><td></td><td>XDS Endpoint (default ``)</td></tr><tr><td><code>--xds-label <string></code></td><td></td><td>Istiod pod label selector (default ``)</td></tr><tr><td><code>--xds-port <int></code></td><td></td><td>Istiod pod port (default `15012`)</td></tr></tbody></table><h4 id="istioctl-proxy-status Examples">Examples</h4><pre class=language-bash><code> # Retrieve sync status for all Envoys in a mesh
|
||
istioctl proxy-status
|
||
|
||
# Retrieve sync status for Envoys in a specific namespace
|
||
istioctl proxy-status --namespace foo
|
||
|
||
# Retrieve sync diff for a single Envoy and Istiod
|
||
istioctl 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 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 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 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 ps --xds-label istio.io/rev=default
|
||
|
||
</code></pre><h3 id=istioctl-remote-clusters>istioctl remote-clusters</h3><p>Lists the remote clusters each istiod instance is connected to.</p><pre class=language-bash><code>istioctl 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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--revision <string></code></td><td><code>-r</code></td><td>Control plane revision (default ``)</td></tr><tr><td><code>--vklog <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>istioctl tag</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <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-generate>istioctl tag generate</h3><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 <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests <string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
|
||
(e.g. ~/Downloads/istio-1.24.0/manifests). (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes 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 <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 <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 <string></code></td><td></td><td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td></tr></tbody></table><h4 id="istioctl-tag-generate Examples">Examples</h4><pre class=language-bash><code> # Create a revision tag from the "1-8-0" revision
|
||
istioctl tag generate prod --revision 1-8-0 > tag.yaml
|
||
|
||
# Apply the tag to cluster
|
||
kubectl apply -f tag.yaml
|
||
|
||
# Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
|
||
kubectl label ns test-ns istio.io/rev=prod
|
||
|
||
# Rollout namespace "test-ns" to update workloads to the "1-8-0" revision
|
||
kubectl rollout restart deployments -n test-ns
|
||
|
||
</code></pre><h3 id=istioctl-tag-list>istioctl tag list</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format for tag description (available formats: table,json,yaml) (default `table`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-tag-list Examples">Examples</h4><pre class=language-bash><code> istioctl tag list
|
||
</code></pre><h3 id=istioctl-tag-remove>istioctl tag remove</h3><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 <revision-tag> [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl tag delete <revision-tag> [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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes 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 <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-tag-remove Examples">Examples</h4><pre class=language-bash><code> # Remove the revision tag "prod"
|
||
istioctl tag remove prod
|
||
|
||
</code></pre><h3 id=istioctl-tag-set>istioctl tag set</h3><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 <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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><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 <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests <string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
|
||
(e.g. ~/Downloads/istio-1.24.0/manifests). (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes 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 <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 <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 <string></code></td><td></td><td>Name to use for a revision tag's mutating webhook configuration. (default ``)</td></tr></tbody></table><h4 id="istioctl-tag-set Examples">Examples</h4><pre class=language-bash><code> # Create a revision tag from the "1-8-0" revision
|
||
istioctl tag set prod --revision 1-8-0
|
||
|
||
# Point namespace "test-ns" at the revision pointed to by the "prod" revision tag
|
||
kubectl label ns test-ns istio.io/rev=prod
|
||
|
||
# Change the revision tag to reference the "1-8-1" revision
|
||
istioctl tag set prod --revision 1-8-1 --overwrite
|
||
|
||
# Make revision "1-8-1" the default revision, both resulting in that revision handling injection for "istio-injection=enabled"
|
||
# and validating resources cluster-wide
|
||
istioctl tag set default --revision 1-8-1
|
||
|
||
# Rollout namespace "test-ns" to update workloads to the "1-8-1" revision
|
||
kubectl rollout restart deployments -n test-ns
|
||
|
||
</code></pre><h3 id=istioctl-uninstall>istioctl uninstall</h3><p>The uninstall command uninstalls Istio from a cluster</p><pre class=language-bash><code>istioctl 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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests <string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
|
||
(e.g. ~/Downloads/istio-1.24.0/manifests).
|
||
(default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes 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 <string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set <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.24/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 <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-uninstall Examples">Examples</h4><pre class=language-bash><code> # Uninstall a single control plane by revision
|
||
istioctl uninstall --revision foo
|
||
|
||
# Uninstall a single control plane by iop file
|
||
istioctl uninstall -f iop.yaml
|
||
|
||
# Uninstall all control planes and shared resources
|
||
istioctl uninstall --purge
|
||
</code></pre><h3 id=istioctl-upgrade>istioctl upgrade</h3><p>The upgrade command is an alias for the install command</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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--charts <string></code></td><td></td><td>Deprecated, use --manifests instead. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (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 <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 <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--manifests <string></code></td><td><code>-d</code></td><td>Specify a path to a directory of charts and profiles
|
||
(e.g. ~/Downloads/istio-1.24.0/manifests).
|
||
(default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--readiness-timeout <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 <string></code></td><td><code>-r</code></td><td>Target control plane revision for the command. (default ``)</td></tr><tr><td><code>--set <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.24/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 <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>istioctl validate</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--filename <stringSlice></code></td><td><code>-f</code></td><td>Inputs of files to validate (default `[]`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-validate Examples">Examples</h4><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 all yaml files under samples/bookinfo/networking directory
|
||
istioctl validate -f samples/bookinfo/networking
|
||
|
||
# Validate current deployments under 'default' namespace within the cluster
|
||
kubectl get deployments -o yaml | istioctl validate -f -
|
||
|
||
# Validate current services under 'default' namespace within the cluster
|
||
kubectl get services -o yaml | istioctl validate -f -
|
||
|
||
# Also see the related command 'istioctl analyze'
|
||
istioctl analyze samples/bookinfo/networking/bookinfo-gateway.yaml
|
||
|
||
</code></pre><h3 id=istioctl-version>istioctl version</h3><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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>One of 'yaml' or 'json'. (default ``)</td></tr><tr><td><code>--remote</code></td><td></td><td>Use --remote=false to suppress control plane check</td></tr><tr><td><code>--revision <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 <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-waypoint>istioctl waypoint</h3><p>A group of commands used to manage waypoint configuration</p><pre class=language-bash><code>istioctl waypoint [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name <string></code></td><td></td><td>name of the waypoint (default `waypoint`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-waypoint Examples">Examples</h4><pre class=language-bash><code> # Apply a waypoint to the current namespace
|
||
istioctl waypoint apply
|
||
|
||
# Generate a waypoint as yaml
|
||
istioctl waypoint generate --namespace default
|
||
|
||
# List all waypoints in a specific namespace
|
||
istioctl waypoint list --namespace default
|
||
</code></pre><h3 id=istioctl-waypoint-apply>istioctl waypoint apply</h3><p>Apply a waypoint configuration to the cluster</p><pre class=language-bash><code>istioctl waypoint apply [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--enroll-namespace</code></td><td></td><td>If set, the namespace will be labeled with the waypoint name</td></tr><tr><td><code>--for <string></code></td><td></td><td>Specify the traffic type [all none service workload] for the waypoint (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name <string></code></td><td></td><td>name of the waypoint (default `waypoint`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--overwrite</code></td><td></td><td>Overwrite the existing Waypoint used by the namespace</td></tr><tr><td><code>--revision <string></code></td><td><code>-r</code></td><td>The revision to label the waypoint with (default ``)</td></tr><tr><td><code>--vklog <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>--wait</code></td><td><code>-w</code></td><td>Wait for the waypoint to be ready</td></tr></tbody></table><h4 id="istioctl-waypoint-apply Examples">Examples</h4><pre class=language-bash><code> # Apply a waypoint to the current namespace
|
||
istioctl waypoint apply
|
||
|
||
# Apply a waypoint to a specific namespace and wait for it to be ready
|
||
istioctl waypoint apply --namespace default --wait
|
||
</code></pre><h3 id=istioctl-waypoint-delete>istioctl waypoint delete</h3><p>Delete a waypoint configuration from the cluster</p><pre class=language-bash><code>istioctl waypoint delete [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>Delete all waypoints in the namespace</td></tr><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name <string></code></td><td></td><td>name of the waypoint (default `waypoint`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-waypoint-delete Examples">Examples</h4><pre class=language-bash><code> # Delete a waypoint from the default namespace
|
||
istioctl waypoint delete
|
||
|
||
# Delete a waypoint by name, which can obtain from istioctl waypoint list
|
||
istioctl waypoint delete waypoint-name --namespace default
|
||
|
||
# Delete several waypoints by name
|
||
istioctl waypoint delete waypoint-name1 waypoint-name2 --namespace default
|
||
|
||
# Delete all waypoints in a specific namespace
|
||
istioctl waypoint delete --all --namespace default
|
||
</code></pre><h3 id=istioctl-waypoint-generate>istioctl waypoint generate</h3><p>Generate a waypoint configuration as YAML</p><pre class=language-bash><code>istioctl waypoint 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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--for <string></code></td><td></td><td>Specify the traffic type [all none service workload] for the waypoint (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name <string></code></td><td></td><td>name of the waypoint (default `waypoint`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--revision <string></code></td><td><code>-r</code></td><td>The revision to label the waypoint with (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-waypoint-generate Examples">Examples</h4><pre class=language-bash><code> # Generate a waypoint as yaml
|
||
istioctl waypoint generate --namespace default
|
||
</code></pre><h3 id=istioctl-waypoint-list>istioctl waypoint list</h3><p>List managed waypoint configurations in the cluster</p><pre class=language-bash><code>istioctl waypoint 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>--all-namespaces</code></td><td><code>-A</code></td><td>List all waypoints in all namespaces</td></tr><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name <string></code></td><td></td><td>name of the waypoint (default `waypoint`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-waypoint-list Examples">Examples</h4><pre class=language-bash><code> # List all waypoints in a specific namespace
|
||
istioctl waypoint list --namespace default
|
||
|
||
# List all waypoints in the cluster
|
||
istioctl waypoint list -A
|
||
</code></pre><h3 id=istioctl-waypoint-status>istioctl waypoint status</h3><p>Show the status of waypoints for the namespace provided or default namespace if none is provided</p><pre class=language-bash><code>istioctl waypoint status [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--name <string></code></td><td></td><td>name of the waypoint (default `waypoint`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-waypoint-status Examples">Examples</h4><pre class=language-bash><code> # Show the status of the waypoint in the default namespace
|
||
istioctl waypoint status
|
||
|
||
# Show the status of the waypoint in a specific namespace
|
||
istioctl waypoint status --namespace default
|
||
</code></pre><h3 id=istioctl-ztunnel-config>istioctl ztunnel-config</h3><p>A group of commands used to update or retrieve Ztunnel configuration from a Ztunnel instance.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-ztunnel-config Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about workload configuration
|
||
istioctl ztunnel-config workload
|
||
|
||
# Retrieve summary about certificates
|
||
istioctl ztunnel-config certificates
|
||
</code></pre><h3 id=istioctl-ztunnel-config-all>istioctl ztunnel-config all</h3><p>Retrieve information about all configuration for the Ztunnel instance.</p><pre class=language-bash><code>istioctl ztunnel-config all [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Ztunnel config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--node <string></code></td><td></td><td>Filter workloads by node field (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Ztunnel proxy admin port (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-ztunnel-config-all Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about all configuration for a randomly chosen ztunnel.
|
||
istioctl ztunnel-config all
|
||
|
||
# Retrieve full configuration dump of workloads for a given Ztunnel instance.
|
||
istioctl ztunnel-config all <ztunnel-name[.namespace]> -o json
|
||
|
||
</code></pre><h3 id=istioctl-ztunnel-config-certificate>istioctl ztunnel-config certificate</h3><p>Retrieve information about certificates for the Ztunnel instance.</p><pre class=language-bash><code>istioctl ztunnel-config certificate [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl ztunnel-config certificates [flags]
|
||
istioctl ztunnel-config certs [flags]
|
||
istioctl ztunnel-config cert [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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Ztunnel config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--node <string></code></td><td></td><td>Filter workloads by node field (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Ztunnel proxy admin port (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-ztunnel-config-certificate Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about workload configuration for a randomly chosen ztunnel.
|
||
istioctl ztunnel-config certificates
|
||
|
||
# Retrieve full certificate dump of workloads for a given Ztunnel instance.
|
||
istioctl ztunnel-config certificates <ztunnel-name[.namespace]> -o json
|
||
|
||
</code></pre><h3 id=istioctl-ztunnel-config-log>istioctl ztunnel-config log</h3><p>Retrieve information about logging levels of the Ztunnel instance in the specified pod, and update optionally.</p><pre class=language-bash><code>istioctl ztunnel-config log [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl ztunnel-config o [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Ztunnel config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--level <string></code></td><td></td><td>Comma-separated minimum per-logger level of messages to output, in the form of [<logger>:]<level>,[<logger>:]<level>,... or <level> to change all active loggers, where logger components can be listed by running "istioctl ztunnel-config log <pod-name[.namespace]>", and level can be one of [trace, debug, info, warning, error, critical, off] (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--node <string></code></td><td></td><td>Filter workloads by node field (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Ztunnel proxy admin port (default `15000`)</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>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-ztunnel-config-log Examples">Examples</h4><pre class=language-bash><code> # Retrieve information about logging levels from all Ztunnel pods
|
||
istioctl ztunnel-config log
|
||
|
||
# Update levels of the all loggers for a specific Ztunnel pod
|
||
istioctl ztunnel-config log <pod-name[.namespace]> --level off
|
||
|
||
# Update levels of the specified loggers for all Ztunnl pods
|
||
istioctl ztunnel-config log --level access:debug,info
|
||
|
||
# Reset levels of all the loggers to default value (warning) for a specific Ztunnel pod.
|
||
istioctl ztunnel-config log <pod-name[.namespace]> -r
|
||
|
||
</code></pre><h3 id=istioctl-ztunnel-config-policy>istioctl ztunnel-config policy</h3><p>Retrieve information about policies for the Ztunnel instance.</p><pre class=language-bash><code>istioctl ztunnel-config policy [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl ztunnel-config policies [flags]
|
||
istioctl ztunnel-config p [flags]
|
||
istioctl ztunnel-config pol [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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Ztunnel config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--node <string></code></td><td></td><td>Filter workloads by node field (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--policy-namespace <string></code></td><td></td><td>Filter policies by namespace field (default ``)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Ztunnel proxy admin port (default `15000`)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-ztunnel-config-policy Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about policy configuration for a randomly chosen ztunnel.
|
||
istioctl ztunnel-config policies
|
||
|
||
# Retrieve full policy dump of workloads for a given Ztunnel instance.
|
||
istioctl ztunnel-config policies <ztunnel-name[.namespace]> -o json
|
||
|
||
</code></pre><h3 id=istioctl-ztunnel-config-service>istioctl ztunnel-config service</h3><p>Retrieve information about services for the Ztunnel instance.</p><pre class=language-bash><code>istioctl ztunnel-config service [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl ztunnel-config services [flags]
|
||
istioctl ztunnel-config s [flags]
|
||
istioctl ztunnel-config svc [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>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Ztunnel config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--node <string></code></td><td></td><td>Filter workloads by node field (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Ztunnel proxy admin port (default `15000`)</td></tr><tr><td><code>--service-namespace <string></code></td><td></td><td>Filter services by namespace field (default ``)</td></tr><tr><td><code>--vklog <Level></code></td><td></td><td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td></tr></tbody></table><h4 id="istioctl-ztunnel-config-service Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about services configuration for a randomly chosen ztunnel.
|
||
istioctl ztunnel-config services
|
||
|
||
# Retrieve full services dump of workloads for a given Ztunnel instance.
|
||
istioctl ztunnel-config services <ztunnel-name[.namespace]> -o json
|
||
|
||
</code></pre><h3 id=istioctl-ztunnel-config-workload>istioctl ztunnel-config workload</h3><p>Retrieve information about workload configuration for the Ztunnel instance.</p><pre class=language-bash><code>istioctl ztunnel-config workload [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl ztunnel-config w [<type>/]<name>[.<namespace>] [flags]
|
||
istioctl ztunnel-config workloads [<type>/]<name>[.<namespace>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <string></code></td><td></td><td>Filter workloads by address field (default ``)</td></tr><tr><td><code>--as <string></code></td><td></td><td>Username to impersonate for the operation. User could be a regular user or a service account in a namespace (default ``)</td></tr><tr><td><code>--as-group <stringArray></code></td><td></td><td>Group to impersonate for the operation, this flag can be repeated to specify multiple groups. (default `[]`)</td></tr><tr><td><code>--as-uid <string></code></td><td></td><td>UID to impersonate for the operation. (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>Kubernetes configuration context (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Ztunnel config dump JSON file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Kubernetes namespace (default ``)</td></tr><tr><td><code>--node <string></code></td><td></td><td>Filter workloads by node field (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|yaml|short (default `short`)</td></tr><tr><td><code>--proxy-admin-port <int></code></td><td></td><td>Ztunnel proxy admin port (default `15000`)</td></tr><tr><td><code>--vklog <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>--workload-namespace <string></code></td><td></td><td>Filter workloads by namespace field (default ``)</td></tr><tr><td><code>--workload-node <string></code></td><td></td><td>Filter workloads by node (default ``)</td></tr></tbody></table><h4 id="istioctl-ztunnel-config-workload Examples">Examples</h4><pre class=language-bash><code> # Retrieve summary about workload configuration for a randomly chosen ztunnel.
|
||
istioctl ztunnel-config workload
|
||
|
||
# Retrieve summary of workloads on node XXXX for a given Ztunnel instance.
|
||
istioctl ztunnel-config workload <ztunnel-name[.namespace]> --node ambient-worker
|
||
|
||
# Retrieve full workload dump of workloads with address XXXX for a given Ztunnel instance.
|
||
istioctl ztunnel-config workload <ztunnel-name[.namespace]> --address 0.0.0.0 -o json
|
||
|
||
# Retrieve Ztunnel config dump separately and inspect from file.
|
||
kubectl exec -it $ZTUNNEL -n istio-system -- curl localhost:15000/config_dump > ztunnel-config.json
|
||
istioctl ztunnel-config workloads --file ztunnel-config.json
|
||
|
||
# Retrieve workload summary for a specific namespace
|
||
istioctl ztunnel-config workloads <ztunnel-name[.namespace]> --workloads-namespace foo
|
||
|
||
</code></pre><h2 id=envvars>Environment variables</h2>These environment variables affect the behavior of the <code>istioctl</code> command.<table class=envvars><thead><tr><th>Variable Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td><code>AMBIENT_ENABLE_STATUS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, status messages for ambient mode will be written to resources. Currently, this does not do leader election, so may be unsafe to enable with multiple replicas.</td></tr><tr><td><code>BYPASS_OVERLOAD_MANAGER_FOR_STATIC_LISTENERS</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, overload manager will not be applied to static listeners</td></tr><tr><td><code>CA_TRUSTED_NODE_ACCOUNTS</code></td><td>String</td><td><code></code></td><td>If set, the list of service accounts that are allowed to use node authentication for CSRs. Node authentication allows an identity to create CSRs on behalf of other identities, but only if there is a pod running on the same node with that identity. This is intended for use with node proxies.</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>CLOUD_PLATFORM</code></td><td>String</td><td><code></code></td><td>Cloud Platform on which proxy is running, if not specified, Istio will try to discover the platform. Valid platform values are aws, azure, gcp, none</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 belongs to</td></tr><tr><td><code>COMPLIANCE_POLICY</code></td><td>String</td><td><code></code></td><td>If set, applies policy-specific restrictions over all existing TLS
|
||
settings, including in-mesh mTLS and external TLS. Valid values are:
|
||
* '' or unset places no additional restrictions.
|
||
* 'fips-140-2' which enforces a version of the TLS protocol and a subset
|
||
of cipher suites overriding any user preferences or defaults for all runtime
|
||
components, including Envoy, gRPC Go SDK, and gRPC C++ SDK.
|
||
WARNING: Setting compliance policy in the control plane is a necessary but
|
||
not a sufficient requirement to achieve compliance. There are additional
|
||
steps necessary to claim compliance, including using the validated
|
||
cryptograhic modules (please consult
|
||
https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/ssl#fips-140-2).</td></tr><tr><td><code>ENABLE_100_CONTINUE_HEADERS</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, istiod will proxy 100-continue headers as is</td></tr><tr><td><code>ENABLE_AUTO_SNI</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, automatically set SNI when `DestinationRules` do not specify the same</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 enabled, recommended for production</td></tr><tr><td><code>ENABLE_DEFERRED_CLUSTER_CREATION</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, Istio will create clusters only when there are requests. This will save memory and CPU cycles in cases where there are lots of inactive clusters and > 1 worker thread</td></tr><tr><td><code>ENABLE_DEFERRED_STATS_CREATION</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, Istio will lazily initialize a subset of the stats</td></tr><tr><td><code>ENABLE_DELIMITED_STATS_TAG_REGEX</code></td><td>Boolean</td><td><code>true</code></td><td>If true, pilot will use the new delimited stat tag regex to generate Envoy stats tags.</td></tr><tr><td><code>ENABLE_ENHANCED_DESTINATIONRULE_MERGE</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, Istio merge destinationrules considering their exportTo fields, they will be kept as independent rules if the exportTos are not equal.</td></tr><tr><td><code>ENABLE_ENHANCED_RESOURCE_SCOPING</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, meshConfig.discoverySelectors will limit the CustomResource configurations(like Gateway,VirtualService,DestinationRule,Ingress, etc)that can be processed by pilot. This will also restrict the root-ca certificate distribution.</td></tr><tr><td><code>ENABLE_HCM_INTERNAL_NETWORKS</code></td><td>Boolean</td><td><code>false</code></td><td>If enable, endpoints defined in mesh networks will be configured as internal addresses in Http Connection Manager</td></tr><tr><td><code>ENABLE_INBOUND_RETRY_POLICY</code></td><td>Boolean</td><td><code>true</code></td><td>If true, enables retry policy for inbound routes which automatically retries requests that were reset before it reaches the service.</td></tr><tr><td><code>ENABLE_INGRESS_WAYPOINT_ROUTING</code></td><td>Boolean</td><td><code>false</code></td><td>If true, Gateways will call service waypoints if the 'istio.io/ingress-use-waypoint' label set on the Service.</td></tr><tr><td><code>ENABLE_LEADER_ELECTION</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled (default), starts a leader election client and gains leadership before executing controllers. If false, it assumes that only one instance of istiod is running and skips leader election.</td></tr><tr><td><code>ENABLE_LOCALITY_WEIGHTED_LB_CONFIG</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, always set LocalityWeightedLbConfig for a cluster, otherwise only apply it when locality lb is specified by DestinationRule for a service</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 `<svc>.<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 (<svc>.<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_NATIVE_SIDECARS</code></td><td>Boolean</td><td><code>false</code></td><td>If set, used Kubernetes native Sidecar container support. Requires SidecarContainer feature flag.</td></tr><tr><td><code>ENABLE_PROBE_KEEPALIVE_CONNECTIONS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, readiness probes will keep the connection from pilot-agent to the application alive. This mirrors older Istio versions' behaviors, but not kubelet's.</td></tr><tr><td><code>ENABLE_RESOLUTION_NONE_TARGET_PORT</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, targetPort will be supported for resolution=NONE ServiceEntry</td></tr><tr><td><code>ENABLE_SELECTOR_BASED_K8S_GATEWAY_POLICY</code></td><td>Boolean</td><td><code>true</code></td><td>If disabled, Gateway API gateways will ignore workloadSelector policies, onlyapplying policies that select the gateway with a targetRef.</td></tr><tr><td><code>ENABLE_TLS_ON_SIDECAR_INGRESS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, the TLS configuration on Sidecar.ingress will take effect</td></tr><tr><td><code>ENABLE_VTPROTOBUF</code></td><td>Boolean</td><td><code>true</code></td><td>If true, will use optimized vtprotobuf based marshaling. Requires a build with -tags=vtprotobuf.</td></tr><tr><td><code>EXCLUDE_UNSAFE_503_FROM_DEFAULT_RETRY</code></td><td>Boolean</td><td><code>true</code></td><td>If true, excludes unsafe retry on 503 from default retry policy.</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>GRPC_KEEPALIVE_INTERVAL</code></td><td>Time Duration</td><td><code>30s</code></td><td>gRPC Keepalive Interval</td></tr><tr><td><code>GRPC_KEEPALIVE_TIMEOUT</code></td><td>Time Duration</td><td><code>10s</code></td><td>gRPC Keepalive Timeout</td></tr><tr><td><code>HTTP_STRIP_FRAGMENT_FROM_PATH_UNSAFE_IF_DISABLED</code></td><td>Boolean</td><td><code>true</code></td><td></td></tr><tr><td><code>INBOUND_INTERCEPTION_MODE</code></td><td>String</td><td><code></code></td><td>The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY"</td></tr><tr><td><code>INBOUND_TPROXY_MARK</code></td><td>String</td><td><code></code></td><td></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. Multiple custom host names are supported, and multiple values are separated by commas.</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_DELTA_XDS</code></td><td>Boolean</td><td><code>true</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_DUAL_STACK</code></td><td>Boolean</td><td><code>false</code></td><td>If true, Istio will enable the Dual Stack feature.</td></tr><tr><td><code>ISTIO_ENABLE_CONTROLLER_QUEUE_METRICS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, publishes metrics for queue depth, latency and processing times.</td></tr><tr><td><code>ISTIO_ENABLE_HTTP2_PROBING</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, HTTP2 probes will be enabled for HTTPS probes, following Kubernetes</td></tr><tr><td><code>ISTIO_ENABLE_IPV4_OUTBOUND_LISTENER_FOR_IPV6_CLUSTERS</code></td><td>Boolean</td><td><code>false</code></td><td>If true, pilot will configure an additional IPv4 listener for outbound traffic in IPv6 only clusters, e.g. AWS EKS IPv6 only clusters.</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_KUBE_CLIENT_CONTENT_TYPE</code></td><td>String</td><td><code>protobuf</code></td><td>The content type to use for Kubernetes clients. Defaults to protobuf. Valid options: [protobuf, json]</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_OUTBOUND_IPV4_LOOPBACK_CIDR</code></td><td>String</td><td><code>127.0.0.1/32</code></td><td>IPv4 CIDR range used to identify outbound traffic on loopback interface intended for application container</td></tr><tr><td><code>ISTIO_OUTBOUND_OWNER_GROUPS</code></td><td>String</td><td><code>*</code></td><td>Comma separated list of groups whose outgoing traffic is to be redirected to Envoy.
|
||
A group can be specified either by name or by a numeric GID.
|
||
The wildcard character "*" can be used to configure redirection of traffic from all groups.</td></tr><tr><td><code>ISTIO_OUTBOUND_OWNER_GROUPS_EXCLUDE</code></td><td>String</td><td><code></code></td><td>Comma separated list of groups whose outgoing traffic is to be excluded from redirection to Envoy.
|
||
A group can be specified either by name or by a numeric GID.
|
||
Only applies when traffic from all groups (i.e. "*") is being redirected to Envoy.</td></tr><tr><td><code>ISTIO_PROMETHEUS_ANNOTATIONS</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>ISTIO_WATCH_NAMESPACE</code></td><td>String</td><td><code></code></td><td>If set, limit Kubernetes watches to a single namespace. Warning: only a single namespace can be set.</td></tr><tr><td><code>ISTIO_WORKLOAD_ENTRY_VALIDATE_IDENTITY</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, will validate the identity of a workload matches the identity of the WorkloadEntry it is associating with for health checks and auto registration. This flag is added for backwards compatibility only and will be removed in future releases</td></tr><tr><td><code>JWKS_RESOLVER_INSECURE_SKIP_VERIFY</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, istiod will skip verifying the certificate of the JWKS server.</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>LABEL_CANONICAL_SERVICES_FOR_MESH_EXTERNAL_SERVICE_ENTRIES</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, metadata representing canonical services for ServiceEntry resources with a location of mesh_external will be populatedin the cluster metadata for those endpoints.</td></tr><tr><td><code>LOCAL_CLUSTER_SECRET_WATCHER</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, the cluster secret watcher will watch the namespace of the external cluster instead of config cluster</td></tr><tr><td><code>MCS_API_GROUP</code></td><td>String</td><td><code>multicluster.x-k8s.io</code></td><td>The group to be used for the Kubernetes Multi-Cluster Services (MCS) API.</td></tr><tr><td><code>MCS_API_VERSION</code></td><td>String</td><td><code>v1alpha1</code></td><td>The version to be used for the Kubernetes Multi-Cluster Services (MCS) API.</td></tr><tr><td><code>METRICS_LOCALHOST_ACCESS_ONLY</code></td><td>Boolean</td><td><code>false</code></td><td>This will disable metrics endpoint from outside of the pod, allowing only localhost access.</td></tr><tr><td><code>METRIC_GRACEFUL_DELETION_INTERVAL</code></td><td>Time Duration</td><td><code>5m0s</code></td><td>Metric expiry graceful deletion interval. No-op if METRIC_ROTATION_INTERVAL is disabled.</td></tr><tr><td><code>METRIC_ROTATION_INTERVAL</code></td><td>Time Duration</td><td><code>0s</code></td><td>Metric scope rotation interval, set to 0 to disable the metric scope rotation</td></tr><tr><td><code>MUTEX_PROFILE_FRACTION</code></td><td>Integer</td><td><code>1000</code></td><td>If set to a non-zero value, enables mutex profiling a rate of 1/MUTEX_PROFILE_FRACTION events. For example, '1000' will record 0.1% of events. Set to 0 to disable entirely.</td></tr><tr><td><code>PILOT_ALLOW_SIDECAR_SERVICE_INBOUND_LISTENER_MERGE</code></td><td>Boolean</td><td><code>false</code></td><td>If set, it allows creating inbound listeners for service ports and sidecar ingress listeners</td></tr><tr><td><code>PILOT_ANALYSIS_INTERVAL</code></td><td>Time Duration</td><td><code>10s</code></td><td>If analysis is enabled, pilot will run istio analyzers using this value as interval in seconds Istio Resources</td></tr><tr><td><code>PILOT_AUTO_ALLOW_WAYPOINT_POLICY</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, zTunnel will receive synthetic authorization policies for each workload ALLOW the Waypoint's identity. Unless other ALLOW policies are created, this effectively denies traffic that doesn't go through the waypoint.</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. K8S RA will be used for k8s.io/NAME. 'istiod' value will sign using Istio build in CA. Other values will not not generate TLS certs, but still distribute ./etc/certs/root-cert.pem. Only used if custom certificates are not mounted.</td></tr><tr><td><code>PILOT_CONVERT_SIDECAR_SCOPE_CONCURRENCY</code></td><td>Integer</td><td><code>1</code></td><td>Used to adjust the concurrency of SidecarScope conversions. When istiod is deployed on a multi-core CPU server, increasing this value will help to use the CPU to accelerate configuration push, but it also means that istiod will consume more CPU resources.</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_DISABLE_MX_ALPN</code></td><td>Boolean</td><td><code>false</code></td><td>If true, pilot will not put istio-peer-exchange ALPN into TLS handshake configuration.</td></tr><tr><td><code>PILOT_DRAINING_LABEL</code></td><td>String</td><td><code>istio.io/draining</code></td><td>If not empty, endpoints with the label value present will be sent with status DRAINING.</td></tr><tr><td><code>PILOT_ENABLE_ALPHA_GATEWAY_API</code></td><td>Boolean</td><td><code>false</code></td><td>If this is set to true, support for alpha APIs in the 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_ALPN_FILTER</code></td><td>Boolean</td><td><code>true</code></td><td>If true, pilot will add Istio ALPN filters, required for proper protocol sniffing.</td></tr><tr><td><code>PILOT_ENABLE_AMBIENT</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, ambient mode can be used. Individual flags configure fine grained enablement; this must be enabled for any ambient functionality.</td></tr><tr><td><code>PILOT_ENABLE_AMBIENT_WAYPOINTS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, controllers required for ambient will run. This is required to run ambient mesh.</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_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_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_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_GATEWAYCLASS_CONTROLLER</code></td><td>Boolean</td><td><code>true</code></td><td>If this is set to true, istiod will create and manage its default GatewayClasses</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_IP_AUTOALLOCATE</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, pilot will start a controller that assigns IP addresses to ServiceEntry which do not have a user-supplied IP. This, when combined with DNS capture allows for tcp routing of traffic sent to the ServiceEntry.</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_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_NODE_UNTAINT_CONTROLLERS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, controller that untaints nodes with cni pods ready will run. This should be enabled if you disabled ambient init containers.</td></tr><tr><td><code>PILOT_ENABLE_PERSISTENT_SESSION_FILTER</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, Istiod sets up persistent session filter for listeners, if services have 'PILOT_PERSISTENT_SESSION_LABEL' set.</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_SENDING_HBONE</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, HBONE will be allowed when sending to destinations.</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_SIDECAR_LISTENING_HBONE</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, HBONE support can be configured for proxies.</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_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>If enabled, Pilot will send only clusters that referenced in gateway virtual services attached to gateway</td></tr><tr><td><code>PILOT_GATEWAY_API_CONTROLLER_NAME</code></td><td>String</td><td><code>istio.io/gateway-controller</code></td><td>Gateway API controller name. istiod will only reconcile Gateway API resources referencing a GatewayClass with this controller name</td></tr><tr><td><code>PILOT_GATEWAY_API_DEFAULT_GATEWAYCLASS_NAME</code></td><td>String</td><td><code>istio</code></td><td>Name of the default GatewayClass</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_INSECURE_MULTICLUSTER_KUBECONFIG_OPTIONS</code></td><td>String</td><td><code></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>String</td><td><code>false</code></td><td>Mode of fetching JWKs from JwksUri in RequestAuthentication. Supported value: istiod, false, hybrid, true, envoy. The client fetching JWKs is as following: istiod/false - Istiod; hybrid/true - Envoy and fallback to Istiod if JWKs server is external; envoy - Envoy.</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>0</code></td><td>Limits the number of incoming XDS requests per second. On larger machines this can be increased to handle more proxies concurrently. If set to 0 or unset, the max will be automatically determined based on the machine size</td></tr><tr><td><code>PILOT_MULTI_NETWORK_DISCOVER_GATEWAY_API</code></td><td>Boolean</td><td><code>true</code></td><td>If true, Pilot will discover labeled Kubernetes gateway objects as multi-network gateways.</td></tr><tr><td><code>PILOT_PERSISTENT_SESSION_HEADER_LABEL</code></td><td>String</td><td><code>istio.io/persistent-session-header</code></td><td>If not empty, services with this label will use header based persistent sessions</td></tr><tr><td><code>PILOT_PERSISTENT_SESSION_LABEL</code></td><td>String</td><td><code>istio.io/persistent-session</code></td><td>If not empty, services with this label will use cookie based persistent sessions</td></tr><tr><td><code>PILOT_PREFER_SENDING_HBONE</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, HBONE will be preferred when sending to destinations.</td></tr><tr><td><code>PILOT_PUSH_THROTTLE</code></td><td>Integer</td><td><code>0</code></td><td>Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes. If set to 0 or unset, the max will be automatically determined based on the machine size</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_SEND_UNHEALTHY_ENDPOINTS</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, Pilot will include unhealthy endpoints in EDS pushes and even if they are sent Envoy does not use them for load balancing. To avoid, sending traffic to non ready endpoints, enabling this flag, disables panic threshold in Envoy i.e. Envoy does not load balance requests to unhealthy/non-ready hosts even if the percentage of healthy hosts fall below minimum health percentage(panic threshold).</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 sidecar 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>Integer</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_UNIFIED_SIDECAR_SCOPE</code></td><td>Boolean</td><td><code>true</code></td><td>If true, unified SidecarScope creation will be used. This is only intended as a temporary feature flag for backwards compatibility.</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_INDEX_CLEAR_INTERVAL</code></td><td>Time Duration</td><td><code>5s</code></td><td>The interval for xds cache index clearing.</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>PLATFORM</code></td><td>String</td><td><code></code></td><td>Platform where Istio is deployed. Possible values are "openshift" and "gcp"</td></tr><tr><td><code>PREFER_DESTINATIONRULE_TLS_FOR_EXTERNAL_SERVICES</code></td><td>Boolean</td><td><code>true</code></td><td>If true, external services will prefer the TLS settings from DestinationRules over the metadata TLS settings.</td></tr><tr><td><code>RESOLVE_HOSTNAME_GATEWAYS</code></td><td>Boolean</td><td><code>true</code></td><td>If true, hostnames in the LoadBalancer addresses of a Service will be resolved at the control plane for use in cross-network gateways.</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>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>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>TRUSTED_GATEWAY_CIDR</code></td><td>String</td><td><code></code></td><td>If set, any connections from gateway to Istiod with this CIDR range are treated as trusted for using authentication mechanisms like XFCC. This can only be used when the network where Istiod and the authenticating gateways are running in a trusted/secure network</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_DELTA_TEST</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, addition runtime tests for Delta XDS efficiency are added. These checks are extremely expensive, so this should be used only for testing, not 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>USE_CACERTS_FOR_SELF_SIGNED_CA</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, istiod will use a secret named cacerts to store its self-signed istio-generated root certificate.</td></tr><tr><td><code>VALIDATION_WEBHOOK_CONFIG_NAME</code></td><td>String</td><td><code>istio-istio-system</code></td><td>If not empty, the controller will automatically patch validatingwebhookconfiguration when the CA certificate changes. Only works in kubernetes environment.</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 running on a secure/trusted network</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>controller_sync_errors_total</code></td><td><code>Sum</code></td><td>Total number of errorMetric syncing controllers.</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>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>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>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_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_debounce_time</code></td><td><code>Distribution</code></td><td>Delay in seconds between the first config enters debouncing and the merged push request is pushed into the push queue.</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_dns_cluster_without_endpoints</code></td><td><code>LastValue</code></td><td>DNS clusters without endpoints caused by the endpoint field in STRICT_DNS type cluster is not set or the corresponding subset cannot select any endpoint</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_envoy_filter_status</code></td><td><code>LastValue</code></td><td>Status of Envoy filters whether it was applied or errored.</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_pushcontext_init_seconds</code></td><td><code>Distribution</code></td><td>Total time in seconds Pilot takes to init pushContext.</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_worker_queue_depth</code></td><td><code>LastValue</code></td><td>Depth of the controller queues</td></tr><tr><td><code>pilot_worker_queue_duration</code></td><td><code>Distribution</code></td><td>Time taken to process an item</td></tr><tr><td><code>pilot_worker_queue_latency</code></td><td><code>Distribution</code></td><td>Latency before the item is processed</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_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>provider_lookup_cluster_failures</code></td><td><code>Sum</code></td><td>Number of times a cluster lookup failed</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>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>sidecar_injection_time_seconds</code></td><td><code>Distribution</code></td><td>Total time taken for injection in seconds.</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>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_dependent_config_size</code></td><td><code>LastValue</code></td><td>Current size of dependent configs</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.24/docs/reference/commands/install-cni/ class=next-link><svg class="icon left-arrow"><use xlink:href="/v1.24/img/icons.svg#left-arrow"/></svg>install-cni</a></div><div class=right><a title="Istio Pilot agent." href=/v1.24/docs/reference/commands/pilot-agent/ class=next-link>pilot-agent<svg class="icon right-arrow"><use xlink:href="/v1.24/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=Parameters><a href=#title>Parameters</a><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 create-remote-secret"><a href=#istioctl-create-remote-secret>create-remote-secret</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 istiod-debug"><a href=#istioctl-dashboard-istiod-debug>dashboard istiod-debug</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 proxy"><a href=#istioctl-dashboard-proxy>dashboard proxy</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 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 check-inject"><a href=#istioctl-experimental-check-inject>experimental check-inject</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 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 envoy-stats"><a href=#istioctl-experimental-envoy-stats>experimental envoy-stats</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 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 version"><a href=#istioctl-experimental-version>experimental version</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 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 manifest translate"><a href=#istioctl-manifest-translate>manifest translate</a><li role=none aria-label="istioctl options"><a href=#istioctl-options>options</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 ecds"><a href=#istioctl-proxy-config-ecds>proxy-config ecds</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 remote-clusters"><a href=#istioctl-remote-clusters>remote-clusters</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 uninstall"><a href=#istioctl-uninstall>uninstall</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 version"><a href=#istioctl-version>version</a><li role=none aria-label="istioctl waypoint"><a href=#istioctl-waypoint>waypoint</a><li role=none aria-label="istioctl waypoint apply"><a href=#istioctl-waypoint-apply>waypoint apply</a><li role=none aria-label="istioctl waypoint delete"><a href=#istioctl-waypoint-delete>waypoint delete</a><li role=none aria-label="istioctl waypoint generate"><a href=#istioctl-waypoint-generate>waypoint generate</a><li role=none aria-label="istioctl waypoint list"><a href=#istioctl-waypoint-list>waypoint list</a><li role=none aria-label="istioctl waypoint status"><a href=#istioctl-waypoint-status>waypoint status</a><li role=none aria-label="istioctl ztunnel-config"><a href=#istioctl-ztunnel-config>ztunnel-config</a><li role=none aria-label="istioctl ztunnel-config all"><a href=#istioctl-ztunnel-config-all>ztunnel-config all</a><li role=none aria-label="istioctl ztunnel-config certificate"><a href=#istioctl-ztunnel-config-certificate>ztunnel-config certificate</a><li role=none aria-label="istioctl ztunnel-config log"><a href=#istioctl-ztunnel-config-log>ztunnel-config log</a><li role=none aria-label="istioctl ztunnel-config policy"><a href=#istioctl-ztunnel-config-policy>ztunnel-config policy</a><li role=none aria-label="istioctl ztunnel-config service"><a href=#istioctl-ztunnel-config-service>ztunnel-config service</a><li role=none aria-label="istioctl ztunnel-config workload"><a href=#istioctl-ztunnel-config-workload>ztunnel-config workload</a></ol></li><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.24/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.24/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.24/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.24/img/icons.svg#stackoverflow"/></svg>
|
||
</a><a class=channel title='Follow us on LinkedIn to get the latest news' href=https://www.linkedin.com/company/istio/ aria-label=LinkedIn><svg class="icon linkedin"><use xlink:href="/v1.24/img/icons.svg#linkedin"/></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.24/img/icons.svg#twitter"/></svg>
|
||
</a><a class=channel title='Follow us on Bluesky to get the latest news' href=https://bsky.app/profile/istio.io aria-label=Bluesky><svg class="icon bluesky"><use xlink:href="/v1.24/img/icons.svg#bluesky"/></svg>
|
||
</a><a class=channel title='Follow us on Mastodon to get the latest news' href=https://mastodon.social/@istio aria-label=Mastodon rel=me><svg class="icon mastodon"><use xlink:href="/v1.24/img/icons.svg#mastodon"/></svg></a></div><hr class=footer-separator role=separator><div class="info footer-info"><a class=logo href=/v1.24/ aria-label=logotype><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.371A7.869 7.869.0 01114 30.56a9.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 lang=en id=switch-lang-en class="footer-languages-item active"><svg class="icon tick"><use xlink:href="/v1.24/img/icons.svg#tick"/></svg>
|
||
English
|
||
</a><a tabindex=-1 lang=zh id=switch-lang-zh class=footer-languages-item>中文
|
||
</a><a tabindex=-1 lang=uk id=switch-lang-uk class=footer-languages-item>Українська</a></div></div><ul class=footer-policies><li class=footer-policies-item><a class=footer-policies-link href=https://www.linuxfoundation.org/legal/terms>Terms and Conditions
|
||
</a>|
|
||
<a class=footer-policies-link href=https://www.linuxfoundation.org/legal/privacy-policy>Privacy policy
|
||
</a>|
|
||
<a class=footer-policies-link href=https://www.linuxfoundation.org/legal/trademark-usage>Trademarks
|
||
</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>© 2024 the Istio Authors.</span>
|
||
<span class=footer-base-version>Version
|
||
Archive
|
||
1.24.3</span><ul class=footer-base-releases><li class=footer-base-releases-item><a tabindex=-1 class=footer-base-releases-link onclick='return navigateToUrlOrRoot("https://istio.io/docs/reference/commands/istioctl/"),!1'>current release</a></li><li class=footer-base-releases-item><a tabindex=-1 class=footer-base-releases-link onclick='return navigateToUrlOrRoot("https://preliminary.istio.io/docs/reference/commands/istioctl/"),!1'>next release</a></li><li class=footer-base-releases-item><a tabindex=-1 class=footer-base-releases-link 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' tabindex=-1><svg class="icon top"><use xlink:href="/v1.24/img/icons.svg#top"/></svg></button></div></body></html> |