mirror of https://github.com/istio/istio.io.git
444 lines
257 KiB
HTML
444 lines
257 KiB
HTML
<!doctype html><html lang=zh 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.9/zh/docs/reference/commands/istioctl/"><meta property="og:image" content="/v1.9/img/istio-whitelogo-bluebackground-framed.svg"><meta property="og:image:alt" content="Istio Logo"><meta property="og:image:width" content="112"><meta property="og:image:height" content="150"><meta property="og:site_name" content="Istio"><meta name=twitter:card content="summary"><meta name=twitter:site content="@IstioMesh"><title>Istioldie 1.9 / istioctl</title><script async src="https://www.googletagmanager.com/gtag/js?id=UA-98480406-2"></script><script>window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments);}
|
||
gtag('js',new Date());gtag('config','UA-98480406-2');</script><link rel=alternate type=application/rss+xml title="Istio Blog" href=/v1.9/blog/feed.xml><link rel=alternate type=application/rss+xml title="Istio News" href=/v1.9/news/feed.xml><link rel=alternate type=application/rss+xml title="Istio Blog and News" href=/v1.9/feed.xml><link rel="shortcut icon" href=/v1.9/favicons/favicon.ico><link rel=apple-touch-icon href=/v1.9/favicons/apple-touch-icon-180x180.png sizes=180x180><link rel=icon type=image/png href=/v1.9/favicons/favicon-16x16.png sizes=16x16><link rel=icon type=image/png href=/v1.9/favicons/favicon-32x32.png sizes=32x32><link rel=icon type=image/png href=/v1.9/favicons/android-36x36.png sizes=36x36><link rel=icon type=image/png href=/v1.9/favicons/android-48x48.png sizes=48x48><link rel=icon type=image/png href=/v1.9/favicons/android-72x72.png sizes=72x72><link rel=icon type=image/png href=/v1.9/favicons/android-96x96.png sizes=96xW96><link rel=icon type=image/png href=/v1.9/favicons/android-144x144.png sizes=144x144><link rel=icon type=image/png href=/v1.9/favicons/android-192x192.png sizes=192x192><link rel=manifest href=/v1.9/manifest.json><meta name=apple-mobile-web-app-title content="Istio"><meta name=application-name content="Istio"><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Work+Sans:400|Chivo:400|Work+Sans:500,300,600,300italic,400italic,500italic,600italic|Chivo:500,300,600,300italic,400italic,500italic,600italic"><link rel=stylesheet href=/v1.9/css/all.css><script src=/v1.9/js/themes_init.min.js></script></head><body class="language-unknown archive-site"><script>const branchName="release-1.9";const docTitle="istioctl";const iconFile="\/v1.9/img/icons.svg";const buttonCopy='复制到剪切板';const buttonPrint='打印';const buttonDownload='下载';</script><script src="https://www.google.com/cse/brand?form=search-form" defer></script><script src=/v1.9/js/all.min.js data-manual defer></script><header><nav><a id=brand href=/v1.9/zh/><span class=logo><svg viewBox="0 0 300 300"><circle cx="150" cy="150" r="146" stroke-width="2"/><polygon points="65 240 225 240 125 270"/><polygon points="65 230 125 220 125 110"/><polygon points="135 220 225 230 135 30"/></svg></span><span class=name>Istioldie 1.9</span></a><div id=hamburger><svg class="icon hamburger"><use xlink:href="/v1.9/img/icons.svg#hamburger"/></svg></div><div id=header-links><a class=current title="了解如何部署、使用和运维 Istio。" href=/v1.9/zh/docs/>文档</a>
|
||
<a title="关于使用 Istio 的博客文章。" href=/v1.9/zh/blog/2020/>博客<i class=dot data-prefix=/blog></i></a>
|
||
<a title="关于 Istio 项目的最新报道。" href=/v1.9/zh/news/>新闻<i class=dot data-prefix=/news></i></a>
|
||
<a title="关于 Istio 的常见问题。" href=/v1.9/zh/faq/>FAQ</a>
|
||
<a title="关于 Istio 项目的说明。" href=/v1.9/zh/about/>关于</a><div class=menu><button id=gearDropdownButton class=menu-trigger title=选项和设置 aria-label="Options and Settings" aria-controls=gearDropdownContent><svg class="icon gear"><use xlink:href="/v1.9/img/icons.svg#gear"/></svg></button><div id=gearDropdownContent class=menu-content aria-labelledby=gearDropdownButton role=menu><a tabindex=-1 role=menuitem lang=en id=switch-lang-en>English</a>
|
||
<a tabindex=-1 role=menuitem lang=zh id=switch-lang-zh class=active>中文</a><div role=separator></div><a tabindex=-1 role=menuitem class=active id=light-theme-item>亮主题</a>
|
||
<a tabindex=-1 role=menuitem id=dark-theme-item>暗主题</a><div role=separator></div><a tabindex=-1 role=menuitem id=syntax-coloring-item>代码高亮</a><div role=separator></div><h6>本站的其它版本</h6><a tabindex=-1 role=menuitem onclick="navigateToUrlOrRoot('https://istio.io/docs\/reference\/commands\/istioctl\/');return false;">当前版本</a>
|
||
<a tabindex=-1 role=menuitem onclick="navigateToUrlOrRoot('https://preliminary.istio.io/docs\/reference\/commands\/istioctl\/');return false;">下个版本</a>
|
||
<a tabindex=-1 role=menuitem href=https://istio.io/archive>旧版本</a></div></div><button id=search-show title="搜索 istio.io" aria-label=搜索><svg class="icon magnifier"><use xlink:href="/v1.9/img/icons.svg#magnifier"/></svg></button></div><form id=search-form 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=/v1.9/search>
|
||
<input id=search-textbox class=form-control name=q type=search aria-label="搜索 istio.io">
|
||
<button id=search-close title=取消搜索 type=reset aria-label=取消搜索><svg class="icon cancel-x"><use xlink:href="/v1.9/img/icons.svg#cancel-x"/></svg></button></form></nav></header><div class=banner-container></div><main class=primary><div id=sidebar-container class="sidebar-container sidebar-offcanvas"><nav id=sidebar aria-label="Section Navigation"><div class=directory><div class=card><button class="header dynamic" id=card31 title="一些概念,理解它们有助于您更好地了解 Istio 系统的不同部分及其使用的抽象。" aria-controls=card31-body><svg class="icon concepts"><use xlink:href="/v1.9/img/icons.svg#concepts"/></svg>概念</button><div class=body aria-labelledby=card31 role=region id=card31-body><ul role=tree aria-expanded=true class=leaf-section aria-labelledby=card31><li role=none><a role=treeitem title="介绍 Istio,它要解决的问题,高层面的架构和设计目标。" href=/v1.9/zh/docs/concepts/what-is-istio/>Istio 是什么?</a></li><li role=none><a role=treeitem title="描述 Istio 多样的流量路由和控制特性。" href=/v1.9/zh/docs/concepts/traffic-management/>流量管理</a></li><li role=none><a role=treeitem title="讲述 Istio 的 WebAssembly 插件系统。" href=/v1.9/zh/docs/concepts/wasm/>扩展性</a></li><li role=none><a role=treeitem title="描述 Istio 的授权与认证功能。" href=/v1.9/zh/docs/concepts/security/>安全</a></li><li role=none><a role=treeitem title="描述 Istio 提供的遥测和监控特性。" href=/v1.9/zh/docs/concepts/observability/>可观察性</a></li></ul></div></div><div class=card><button class="header dynamic" id=card47 title="关于如何在 Kubernetes 集群中安装 Istio 控制平面和添加虚拟机到 mesh 中的说明。" aria-controls=card47-body><svg class="icon setup"><use xlink:href="/v1.9/img/icons.svg#setup"/></svg>安装</button><div class=body aria-labelledby=card47 role=region id=card47-body><ul role=tree aria-expanded=true aria-labelledby=card47><li role=none><a role=treeitem title="快速、轻松地尝试 Istio 特性。" href=/v1.9/zh/docs/setup/getting-started/>入门</a></li><li role=treeitem aria-label=平台安装><button aria-hidden=true></button><a title="在安装 Istio 之前如何准备各种 Kubernetes 平台。" href=/v1.9/zh/docs/setup/platform-setup/>平台安装</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="对阿里云 Kubernetes 集群进行配置以便安装运行 Istio。" href=/v1.9/zh/docs/setup/platform-setup/alicloud/>阿里云</a></li><li role=none><a role=treeitem title="为 Istio 设置一个 Azure 集群的指令。" href=/v1.9/zh/docs/setup/platform-setup/azure/>Azure</a></li><li role=none><a role=treeitem title="在 Docker Desktop 中运行 Istio 的设置说明。" href=/v1.9/zh/docs/setup/platform-setup/docker/>Docker Desktop</a></li><li role=none><a role=treeitem title="在 Google Kubernetes Engine (GKE) 上快速搭建 Istio 服务。" href=/v1.9/zh/docs/setup/platform-setup/gke/>使用 Google Kubernetes Engine 快速开始</a></li><li role=none><a role=treeitem title="在 IBM 公有云或私有云上快速搭建 Istio 服务。" href=/v1.9/zh/docs/setup/platform-setup/ibm/>IBM Cloud 快速开始</a></li><li role=none><a role=treeitem title="为 Istio 设置 kind 的说明。" href=/v1.9/zh/docs/setup/platform-setup/kind/>kind</a></li><li role=none><a role=treeitem title="使用 Gardener 快速搭建 Istio 服务。" href=/v1.9/zh/docs/setup/platform-setup/gardener/>Kubernetes Gardener 快速开始</a></li><li role=none><a role=treeitem title="配置 MicroK8s 以便使用 Istio。" href=/v1.9/zh/docs/setup/platform-setup/microk8s/>MicroK8s</a></li><li role=none><a role=treeitem title="在 Minikube 上配置 Istio。" href=/v1.9/zh/docs/setup/platform-setup/minikube/>Minikube</a></li><li role=none><a role=treeitem title="对 OpenShift 集群进行配置以便安装运行 Istio。" href=/v1.9/zh/docs/setup/platform-setup/openshift/>OpenShift</a></li><li role=none><a role=treeitem title="为 Istio 配置 OKE 集群环境的说明。" href=/v1.9/zh/docs/setup/platform-setup/oci/>Oracle Cloud Infrastructure</a></li></ul></li><li role=treeitem aria-label=安装><button aria-hidden=true></button><a title=选择最适合你需求和平台的安装指南。 href=/v1.9/zh/docs/setup/install/>安装</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="安装、定制 Istio 配置文件,用于深入评估、及生产发布。" href=/v1.9/zh/docs/setup/install/istioctl/>使用 Istioctl 安装</a></li><li role=none><a role=treeitem title="使用 Istio operator 在 Kubernetes 集群中安装 Istio 的说明。" href=/v1.9/zh/docs/setup/install/operator/>使用 Istio Operator 安装</a></li><li role=none><a role=treeitem title="安装、配置、并深入评估 Istio。" href=/v1.9/zh/docs/setup/install/helm/>使用 Helm 安装</a></li><li role=treeitem aria-label=多集群安装><button aria-hidden=true></button><a title="跨多 Kubernetes 集群,安装 Istio 服务网格。" href=/v1.9/zh/docs/setup/install/multicluster/>多集群安装</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="在多个集群上安装 Istio 之前的初始步骤。" href=/v1.9/zh/docs/setup/install/multicluster/before-you-begin/>准备工作</a></li><li role=none><a role=treeitem title="跨多个主集群,安装 Istio 网格。" href=/v1.9/zh/docs/setup/install/multicluster/multi-primary/>多主架构的安装</a></li><li role=none><a role=treeitem title="跨主-从集群,安装 Istio 网格。" href=/v1.9/zh/docs/setup/install/multicluster/primary-remote/>主-从架构的安装</a></li><li role=none><a role=treeitem title="跨网络、多主架构的 Istio 网格安装。" href=/v1.9/zh/docs/setup/install/multicluster/multi-primary_multi-network/>跨网络多主架构的安装</a></li><li role=none><a role=treeitem title="跨网络、主-从架构的 Istio 网格安装。" href=/v1.9/zh/docs/setup/install/multicluster/primary-remote_multi-network/>跨网络主-从架构的安装</a></li><li role=none><a role=treeitem title="验证 Istio 已成功安装到多集群环境中。" href=/v1.9/zh/docs/setup/install/multicluster/verify/>验证安装结果</a></li></ul></li><li role=none><a role=treeitem title="部署 Istio,接入虚拟机中运行的工作负载。" href=/v1.9/zh/docs/setup/install/virtual-machine/>虚拟机安装</a></li></ul></li><li role=treeitem aria-label=升级><button aria-hidden=true></button><a title="选择与您先前用于安装 Istio 的方法相对应的升级指南。" href=/v1.9/zh/docs/setup/upgrade/>升级</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="使用 istioctl 命令来升级或降级 Istio。" href=/v1.9/zh/docs/setup/upgrade/istioctl-upgrade/>使用 istioctl 命令升级 Istio [实验中]</a></li><li role=none><a role=treeitem title="升级 Istio 控制平面,可以选择使用 Helm 升级 CNI 插件。" href=/v1.9/zh/docs/setup/upgrade/cni-helm-upgrade/>使用 Helm 升级</a></li></ul></li><li role=treeitem aria-label=更多指南><button aria-hidden=true></button><a title=有关其他设置任务的更多信息。 href=/v1.9/zh/docs/setup/additional-setup/>更多指南</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="描述 Istio 内置的安装配置文件。" href=/v1.9/zh/docs/setup/additional-setup/config-profiles/>安装配置</a></li><li role=none><a role=treeitem title="在应用程序 Pod 中使用 sidecar injector webhook 自动安装或使用 istioctl CLI 手动安装 Istio sidecar。" href=/v1.9/zh/docs/setup/additional-setup/sidecar-injection/>设置 Sidecar</a></li><li role=none><a role=treeitem title="安装并使用 Istio CNI 插件,可以让运维人员用更低的权限来部署服务。" href=/v1.9/zh/docs/setup/additional-setup/cni/>安装 Istio CNI 插件</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card64 title="如何用 Istio 系统实现特定目标的行为。" aria-controls=card64-body><svg class="icon tasks"><use xlink:href="/v1.9/img/icons.svg#tasks"/></svg>任务</button><div class=body aria-labelledby=card64 role=region id=card64-body><ul role=tree aria-expanded=true aria-labelledby=card64><li role=treeitem aria-label=流量管理><button aria-hidden=true></button><a title="演示 Istio 的流量路由功能的任务。" href=/v1.9/zh/docs/tasks/traffic-management/>流量管理</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title=此任务将展示如何将请求动态路由到微服务的多个版本。 href=/v1.9/zh/docs/tasks/traffic-management/request-routing/>配置请求路由</a></li><li role=none><a role=treeitem title=此任务说明如何注入故障并测试应用程序的弹性。 href=/v1.9/zh/docs/tasks/traffic-management/fault-injection/>故障注入</a></li><li role=none><a role=treeitem title=展示如何将流量从旧版本迁移到新版本的服务。 href=/v1.9/zh/docs/tasks/traffic-management/traffic-shifting/>流量转移</a></li><li role=none><a role=treeitem title="展示如何将一个服务的 TCP 流量从旧版本迁移到新版本。" href=/v1.9/zh/docs/tasks/traffic-management/tcp-traffic-shifting/>TCP 流量转移</a></li><li role=none><a role=treeitem title="本任务用于示范如何使用 Istio 在 Envoy 中设置请求超时。" href=/v1.9/zh/docs/tasks/traffic-management/request-timeouts/>设置请求超时</a></li><li role=none><a role=treeitem title=本任务展示如何为连接、请求以及异常检测配置熔断。 href=/v1.9/zh/docs/tasks/traffic-management/circuit-breaking/>熔断</a></li><li role=none><a role=treeitem title="此任务演示了 Istio 的流量镜像/影子功能。" href=/v1.9/zh/docs/tasks/traffic-management/mirroring/>镜像</a></li><li role=treeitem aria-label=Ingress><button aria-hidden=true></button><a title="控制 Istio 服务网格的入口流量。" href=/v1.9/zh/docs/tasks/traffic-management/ingress/>Ingress</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="描述如何配置 Istio gateway,以将服务暴露至服务网格之外。" href=/v1.9/zh/docs/tasks/traffic-management/ingress/ingress-control/>Ingress Gateway</a></li><li role=none><a role=treeitem title="使用文件挂载的证书并通过 TLS 或 mTLS 将服务暴露至服务网格之外。" href=/v1.9/zh/docs/tasks/traffic-management/ingress/secure-ingress-mount/>安全网关(文件挂载)</a></li><li role=none><a role=treeitem title="使用 Secret 发现服务(SDS) 通过 TLS 或者 mTLS 把服务暴露给服务网格外部。" href=/v1.9/zh/docs/tasks/traffic-management/ingress/secure-ingress-sds/>使用 SDS 为 Gateway 提供 HTTPS 加密支持</a></li><li role=none><a role=treeitem title="说明了如何为一个 ingress gateway 配置 SNI 透传。" href=/v1.9/zh/docs/tasks/traffic-management/ingress/ingress-sni-passthrough/>无 TLS 终止的 Ingress Gateway</a></li></ul></li><li role=treeitem aria-label=Egress><button aria-hidden=true></button><a title="控制 Istio 服务网格的出口流量。" href=/v1.9/zh/docs/tasks/traffic-management/egress/>Egress</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="描述如何配置 Istio 以将流量从网格中的服务路由到外部服务。" href=/v1.9/zh/docs/tasks/traffic-management/egress/egress-control/>访问外部服务</a></li><li role=none><a role=treeitem title="描述如何配置 Istio 对来自外部服务的流量执行 TLS 发起。" href=/v1.9/zh/docs/tasks/traffic-management/egress/egress-tls-origination/>Egress TLS Origination</a></li><li role=none><a role=treeitem title="描述如何配置 Istio 通过专用网关服务将流量定向到外部服务。" href=/v1.9/zh/docs/tasks/traffic-management/egress/egress-gateway/>Egress Gateway</a></li><li role=none><a role=treeitem title="描述如何配置一个 Egress 网关,来向外部服务发起 TLS 连接。" href=/v1.9/zh/docs/tasks/traffic-management/egress/egress-gateway-tls-origination/>Egress 网关的 TLS 发起过程</a></li><li role=none><a role=treeitem title="描述如何开启通用域中一组主机的 egress,无需单独配置每一台主机。" href=/v1.9/zh/docs/tasks/traffic-management/egress/wildcard-egress-hosts/>Wildcard 主机的 egress</a></li><li role=none><a role=treeitem title="描述如何在 TLS Egress 上配置 SNI 监控和策略。" href=/v1.9/zh/docs/tasks/traffic-management/egress/egress_sni_monitoring_and_policies/>TLS Egress 监控和策略配置</a></li><li role=none><a role=treeitem title="展示如何配置 Istio Kubernetes 外部服务。" href=/v1.9/zh/docs/tasks/traffic-management/egress/egress-kubernetes-services/>Kubernetes Egress 流量服务</a></li><li role=none><a role=treeitem title="描述如何配置 Istio 以允许应用程序使用外部 HTTPS 代理。" href=/v1.9/zh/docs/tasks/traffic-management/egress/http-proxy/>使用外部 HTTPS 代理</a></li></ul></li></ul></li><li role=treeitem aria-label=安全><button aria-hidden=true></button><a title=演示如何保护网格。 href=/v1.9/zh/docs/tasks/security/>安全</a><ul role=group aria-expanded=false><li role=treeitem aria-label=认证><button aria-hidden=true></button><a title="管控网格服务间的双向 TLS 和终端用户的身份认证。" href=/v1.9/zh/docs/tasks/security/authentication/>认证</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="通过一个简化的工作流和最小化配置实现双向 TLS。" href=/v1.9/zh/docs/tasks/security/authentication/auto-mtls/>自动双向 TLS</a></li><li role=none><a role=treeitem title="为您展示如何使用 Istio 认证策略设置双向 TLS 和基础终端用户认证。" href=/v1.9/zh/docs/tasks/security/authentication/authn-policy/>认证策略</a></li><li role=none><a role=treeitem title="展示如何在 HTTPS 服务上启用双向 TLS。" href=/v1.9/zh/docs/tasks/security/authentication/https-overlay/>通过 HTTPS 进行 TLS</a></li><li role=none><a role=treeitem title="阐述如何将 Istio 服务逐步迁移至双向 TLS 通信模式。" href=/v1.9/zh/docs/tasks/security/authentication/mtls-migration/>双向 TLS 迁移</a></li></ul></li><li role=treeitem aria-label="Citadel 配置"><button aria-hidden=true></button><a title="定制 Citadel 证书颁发机构。" href=/v1.9/zh/docs/tasks/security/citadel-config/>Citadel 配置</a><ul role=group aria-expanded=false class=leaf-section></ul></li><li role=treeitem aria-label=授权><button aria-hidden=true></button><a title="展示如何控制到 Istio 服务的访问。" href=/v1.9/zh/docs/tasks/security/authorization/>授权</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="展示如何设置基于角色的 HTTP 流量访问控制。" href=/v1.9/zh/docs/tasks/security/authorization/authz-http/>HTTP 流量授权</a></li><li role=none><a role=treeitem title="展示如何设置 TCP 流量的访问控制。" href=/v1.9/zh/docs/tasks/security/authorization/authz-tcp/>TCP 流量的授权</a></li><li role=none><a role=treeitem title="有关如何在 Istio 中通过 JWT 实现访问控制的教程。" href=/v1.9/zh/docs/tasks/security/authorization/authz-jwt/>基于 JWT 授权</a></li><li role=none><a role=treeitem title=阐述如何在不更改授权策略的前提下从一个信任域迁移到另一个。 href=/v1.9/zh/docs/tasks/security/authorization/authz-td-migration/>授权策略信任域迁移</a></li></ul></li><li role=none><a role=treeitem title="演示系统管理员如何使用现有的根证书、签名证书和密钥配置 Istio 的 CA。" href=/v1.9/zh/docs/tasks/security/plugin-ca-cert/>插入外部 CA 证书</a></li><li role=none><a role=treeitem title="展示如何准备和管理 Istio DNS 证书。" href=/v1.9/zh/docs/tasks/security/dns-cert/>Istio DNS 证书管理</a></li></ul></li><li role=treeitem aria-label=策略><button aria-hidden=true></button><a title=演示策略执行功能。 href=/v1.9/zh/docs/tasks/policy-enforcement/>策略</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="这个任务将告诉你如何开启 Istio 的策略检查功能。" href=/v1.9/zh/docs/tasks/policy-enforcement/enabling-policy/>启用策略检查功能</a></li><li role=none><a role=treeitem title="这部分内容将向您展示如何使用 Istio 去动态限制服务间的流量。" href=/v1.9/zh/docs/tasks/policy-enforcement/rate-limiting/>启用速率限制</a></li><li role=none><a role=treeitem title="描述如何使用简单的 denials 或黑白名单来控制对服务的访问。" href=/v1.9/zh/docs/tasks/policy-enforcement/denial-and-list/>Denials 和黑白名单</a></li><li role=none><a role=treeitem title=演示如何使用策略适配器修改请求头和路由。 href=/v1.9/zh/docs/tasks/policy-enforcement/control-headers/>请求头和路由控制</a></li></ul></li><li role=treeitem aria-label=可观察性><button aria-hidden=true></button><a title=演示如何从网格收集遥测信息。 href=/v1.9/zh/docs/tasks/observability/>可观察性</a><ul role=group aria-expanded=false><li role=treeitem aria-label=指标度量><button aria-hidden=true></button><a title="演示 Istio 网格指标度量的配置、收集和处理。" href=/v1.9/zh/docs/tasks/observability/metrics/>指标度量</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="此任务向您展示如何配置 Istio 以采集和自定义指标。" href=/v1.9/zh/docs/tasks/observability/metrics/collecting-metrics/>采集指标</a></li><li role=none><a role=treeitem title="本任务展示了如何配置 Istio 进行 TCP 服务的指标收集。" href=/v1.9/zh/docs/tasks/observability/metrics/tcp-metrics/>收集 TCP 服务指标</a></li><li role=none><a role=treeitem title="本任务介绍如何通过 Prometheus 查询 Istio 度量指标。" href=/v1.9/zh/docs/tasks/observability/metrics/querying-metrics/>通过 Prometheus 查询度量指标</a></li><li role=none><a role=treeitem title="此任务展示了如何设置和使用 Istio Dashboard 监控网格流量。" href=/v1.9/zh/docs/tasks/observability/metrics/using-istio-dashboard/>使用 Grafana 可视化指标</a></li></ul></li><li role=treeitem aria-label=日志><button aria-hidden=true></button><a title="演示 Istio 网格日志的配置、收集和处理。" href=/v1.9/zh/docs/tasks/observability/logs/>日志</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="本任务向您展示如何配置 Istio 来收集和定制日志。" href=/v1.9/zh/docs/tasks/observability/logs/collecting-logs/>收集日志</a></li><li role=none><a role=treeitem title="此任务向您展示如何配置 Envoy 代理将访问日志打印到其标准输出。" href=/v1.9/zh/docs/tasks/observability/logs/access-log/>获取 Envoy 访问日志</a></li><li role=none><a role=treeitem title="此任务向您展示如何配置 Istio 以连接到 Fluentd 守护程序进行日志收集。" href=/v1.9/zh/docs/tasks/observability/logs/fluentd/>使用 Fluentd 进行日志收集</a></li></ul></li><li role=treeitem aria-label=分布式追踪><button aria-hidden=true></button><a title="该任务展示了如何为启用了 Istio 支持的应用进行追踪。" href=/v1.9/zh/docs/tasks/observability/distributed-tracing/>分布式追踪</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Istio 分布式追踪的概述。" href=/v1.9/zh/docs/tasks/observability/distributed-tracing/overview/>概述</a></li><li role=none><a role=treeitem title="了解如何通过配置代理以将追踪请求发送到 Zipkin。" href=/v1.9/zh/docs/tasks/observability/distributed-tracing/zipkin/>Zipkin</a></li><li role=none><a role=treeitem title="了解如何配置代理以向 Jaeger 发送追踪请求。" href=/v1.9/zh/docs/tasks/observability/distributed-tracing/jaeger/>Jaeger</a></li><li role=none><a role=treeitem title="怎样配置代理才能把追踪请求发送到 LightStep。" href=/v1.9/zh/docs/tasks/observability/distributed-tracing/lightstep/>LightStep</a></li></ul></li><li role=none><a role=treeitem title="此任务向您展示如何在 Istio 网格中可视化服务。" href=/v1.9/zh/docs/tasks/observability/kiali/>网络可视化</a></li><li role=none><a role=treeitem title="此任务向您展示如何配置从外部访问 Istio 遥测插件。" href=/v1.9/zh/docs/tasks/observability/gateways/>远程访问遥测插件</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card115 title="这里包括多个可供 Istio 使用的可完整工作的示例,你可以用来亲自部署和体验这些示例。" aria-controls=card115-body><svg class="icon examples"><use xlink:href="/v1.9/img/icons.svg#examples"/></svg>示例</button><div class=body aria-labelledby=card115 role=region id=card115-body><ul role=tree aria-expanded=true aria-labelledby=card115><li role=none><a role=treeitem title="部署一个用于演示多种 Istio 特性的应用,由四个单独的微服务构成。" href=/v1.9/zh/docs/examples/bookinfo/>Bookinfo 应用</a></li><li role=treeitem aria-label=虚拟机><button aria-hidden=true></button><a title="将虚拟机中运行的工作负载添加到 Istio 网格的示例。" href=/v1.9/zh/docs/examples/virtual-machines/>虚拟机</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="学习如何新增一个服务,使其运行在单网络 Istio 网格的虚拟机上。" href=/v1.9/zh/docs/examples/virtual-machines/single-network/>单个网络网格中的虚拟机</a></li><li role=none><a role=treeitem title="学习怎样添加运行在虚拟机上的服务到您的多网络 Istio 网格中。" href=/v1.9/zh/docs/examples/virtual-machines/multi-network/>多网络网格中的虚拟机</a></li><li role=none><a role=treeitem title="使用在网格内的虚拟机上运行的 MySQL 服务运行 Bookinfo 应用程序。" href=/v1.9/zh/docs/examples/virtual-machines/bookinfo/>在虚拟机上部署 Bookinfo 应用程序</a></li></ul></li><li role=treeitem aria-label="使用 Kubernetes 和 Istio 学习微服务"><button aria-hidden=true></button><a title="该模块化教程为新用户提供了一步步将 Istio 应用于常见微服务场景的动手经验。" href=/v1.9/zh/docs/examples/microservices-istio/>使用 Kubernetes 和 Istio 学习微服务</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem href=/v1.9/zh/docs/examples/microservices-istio/prereq/>前提条件</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/examples/microservices-istio/setup-kubernetes-cluster/>设置 Kubernetes 集群</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/examples/microservices-istio/setup-local-computer/>设置本地计算机</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/examples/microservices-istio/single/>本地运行微服务</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/examples/microservices-istio/package-service/>在 Docker 中运行 ratings 服务</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/examples/microservices-istio/bookinfo-kubernetes/>使用 Kubernetes 运行 Bookinfo</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/examples/microservices-istio/production-testing/>生产测试</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card122 title="关于部署和管理 Istio 网格的概念、工具和技术。" aria-controls=card122-body><svg class="icon guide"><use xlink:href="/v1.9/img/icons.svg#guide"/></svg>运维</button><div class=body aria-labelledby=card122 role=region id=card122-body><ul role=tree aria-expanded=true aria-labelledby=card122><li role=treeitem aria-label=部署><button aria-hidden=true></button><a title="设置 Istio 部署的要求、概念和注意事项。" href=/v1.9/zh/docs/ops/deployment/>部署</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="描述 Istio 的整体架构与设计目标。" href=/v1.9/zh/docs/ops/deployment/architecture/>架构</a></li><li role=none><a role=treeitem title="描述 Istio 部署中的选择和建议。" href=/v1.9/zh/docs/ops/deployment/deployment-models/>部署模型</a></li><li role=none><a role=treeitem title="介绍 Istio 的性能和可扩展性。" href=/v1.9/zh/docs/ops/deployment/performance-and-scalability/>性能和可扩展性</a></li><li role=none><a role=treeitem title="在启用了 Istio 的集群中运行 Kubernetes 的 Pod 和 Service,您需要做些准备。" href=/v1.9/zh/docs/ops/deployment/requirements/>Pod 和 Service</a></li></ul></li><li role=treeitem aria-label=配置><button aria-hidden=true></button><a title="配置运行中的 Istio 网格的高级概念和功能。" href=/v1.9/zh/docs/ops/configuration/>配置</a><ul role=group aria-expanded=false><li role=treeitem aria-label=网格配置><button aria-hidden=true></button><a title=帮助您管理全局网格配置。 href=/v1.9/zh/docs/ops/configuration/mesh/>网格配置</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="简要描述 Istio 对 Kubernetes webhook 的使用以及可能出现的相关问题。" href=/v1.9/zh/docs/ops/configuration/mesh/webhook/>动态准入 Webhook 概述</a></li><li role=none><a role=treeitem title="介绍 Istio 是如何通过 Kubernetes 的 webhooks 机制来实现 Sidecar 自动注入。" href=/v1.9/zh/docs/ops/configuration/mesh/injection-concepts/>Sidecar 自动注入</a></li><li role=none><a role=treeitem title="描述 Citadel 如何确定是否创建服务账号 secret。" href=/v1.9/zh/docs/ops/configuration/mesh/secret-creation/>创建服务账号 Secret</a></li><li role=none><a role=treeitem title="为您展示如何对 Istio 服务做健康检查。" href=/v1.9/zh/docs/ops/configuration/mesh/app-health-check/>Istio 服务的健康检查</a></li></ul></li><li role=treeitem aria-label=流量管理><button aria-hidden=true></button><a title=帮助您管理正在运行的网格的网络方面。 href=/v1.9/zh/docs/ops/configuration/traffic-management/>流量管理</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title=关于怎么声明协议的信息。 href=/v1.9/zh/docs/ops/configuration/traffic-management/protocol-selection/>协议选择</a></li><li role=none><a role=treeitem title=有关如何启用和理解地域负载平衡。 href=/v1.9/zh/docs/ops/configuration/traffic-management/locality-load-balancing/>地域负载均衡</a></li></ul></li><li role=treeitem aria-label=安全><button aria-hidden=true></button><a title=帮助您管理正在运行的网格的安全性方面。 href=/v1.9/zh/docs/ops/configuration/security/>安全</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="使用加固的容器镜像来减小 Istio 的攻击面。" href=/v1.9/zh/docs/ops/configuration/security/harden-docker-images/>加固 Docker 容器镜像</a></li><li role=none><a role=treeitem title="学习如何延长 Istio 自签名根证书的寿命。" href=/v1.9/zh/docs/ops/configuration/security/root-transition/>延长自签名证书的寿命</a></li></ul></li><li role=treeitem aria-label=可观测性><button aria-hidden=true></button><a title=帮助您管理正在运行的网格中的遥测收集和可视化。 href=/v1.9/zh/docs/ops/configuration/telemetry/>可观测性</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="精细化控制 Envoy 的统计信息。" href=/v1.9/zh/docs/ops/configuration/telemetry/envoy-stats/>Envoy 的统计信息</a></li><li role=none><a role=treeitem title=怎样使用代理生成服务级别的指标。 href=/v1.9/zh/docs/ops/configuration/telemetry/in-proxy-service-telemetry/>不使用 Mixer 生成 Istio 指标 [Alpha]</a></li></ul></li></ul></li><li role=treeitem aria-label=最佳实践><button aria-hidden=true></button><a title="设置和管理 Istio 服务网格的最佳实践。" href=/v1.9/zh/docs/ops/best-practices/>最佳实践</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="设置 Istio 服务网格时的最佳实践。" href=/v1.9/zh/docs/ops/best-practices/deployment/>Deployment 最佳实践</a></li><li role=none><a role=treeitem title=避免网络或流量管理问题的配置最佳实践。 href=/v1.9/zh/docs/ops/best-practices/traffic-management/>流量管理最佳实践</a></li><li role=none><a role=treeitem title="使用 Istio 保护应用的最佳实践。" href=/v1.9/zh/docs/ops/best-practices/security/>安全最佳实践</a></li></ul></li><li role=treeitem aria-label=常见问题><button aria-hidden=true></button><a title="描述如何辨认和解决 Istio 中的常见问题。" href=/v1.9/zh/docs/ops/common-problems/>常见问题</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="定位常见的 Istio 流量管理和网络问题的技术。" href=/v1.9/zh/docs/ops/common-problems/network-issues/>流量管理问题</a></li><li role=none><a role=treeitem title="定位常见 Istio 认证、授权、安全相关问题的技巧。" href=/v1.9/zh/docs/ops/common-problems/security-issues/>安全问题</a></li><li role=none><a role=treeitem title="处理 Telemetry 收集问题。" href=/v1.9/zh/docs/ops/common-problems/observability-issues/>可观测性问题</a></li><li role=none><a role=treeitem title="解决 Istio 使用 Kubernetes Webhooks 进行 sidecar 自动注入的常见问题。" href=/v1.9/zh/docs/ops/common-problems/injection/>Sidecar 自动注入问题</a></li><li role=none><a role=treeitem title=如何解决配置验证的问题。 href=/v1.9/zh/docs/ops/common-problems/validation/>配置验证的问题</a></li></ul></li><li role=treeitem aria-label=诊断工具><button aria-hidden=true></button><a title="帮助解决 Istio 网格问题的工具和技术。" href=/v1.9/zh/docs/ops/diagnostic-tools/>诊断工具</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Istio 自带的一个可以为服务网格部署提供调试和诊断的补充工具。" href=/v1.9/zh/docs/ops/diagnostic-tools/istioctl/>使用 Istioctl 命令行工具</a></li><li role=none><a role=treeitem title="描述诊断与流量管理相关的 Envoy 配置问题的工具和技术。" href=/v1.9/zh/docs/ops/diagnostic-tools/proxy-cmd/>调试 Envoy 和 Pilot</a></li><li role=none><a role=treeitem title="向您展示如何使用 istioctl describe 来验证您的网格中的 pod 的配置。" href=/v1.9/zh/docs/ops/diagnostic-tools/istioctl-describe/>通过 Istioctl Describe 理解您的网格</a></li><li role=none><a role=treeitem title="演示如何使用 istioctl analyze 来识别配置中的潜在问题。" href=/v1.9/zh/docs/ops/diagnostic-tools/istioctl-analyze/>使用 Istioctl Analyze 诊断配置</a></li><li role=none><a role=treeitem title="介绍如何使用 ControlZ 深入了解各个运行组件。" href=/v1.9/zh/docs/ops/diagnostic-tools/controlz/>组件自检</a></li><li role=none><a role=treeitem title=如何使用组件的级别日志来记录正在运行中的组件的行为。 href=/v1.9/zh/docs/ops/diagnostic-tools/component-logging/>组件日志记录</a></li></ul></li><li role=treeitem aria-label=集成><button aria-hidden=true></button><a title="能够与 Istio 集成以提供额外功能的其他软件。" href=/v1.9/zh/docs/ops/integrations/>集成</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="关于如何与 cert-manager 集成的相关说明。" href=/v1.9/zh/docs/ops/integrations/certmanager/>cert-manager</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card159 title="参考部分包含详细的权威参考资料,如命令行选项、配置选项和 API 调用参数。" aria-controls=card159-body><svg class="icon reference"><use xlink:href="/v1.9/img/icons.svg#reference"/></svg>参考</button><div class="body default" aria-labelledby=card159 role=region id=card159-body><ul role=tree aria-expanded=true aria-labelledby=card159><li role=treeitem aria-label=配置><button aria-hidden=true></button><a title=关于配置选项的详细信息。 href=/v1.9/zh/docs/reference/config/>配置</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Configuration affecting the service mesh as a whole." href=/v1.9/zh/docs/reference/config/istio.mesh.v1alpha1/>Service Mesh</a></li><li role=none><a role=treeitem title="Configuration for Istio control plane installation through the Operator." href=/v1.9/zh/docs/reference/config/istio.operator.v1alpha12.pb/>Operator Installation</a></li><li role=none><a role=treeitem title="描述使用 Helm chart 安装 Istio 时的可选项。" href=/v1.9/zh/docs/reference/config/installation-options/>安装选项(Helm)</a></li><li role=none><a role=treeitem title="Configuration affecting Istio control plane installation version and shape." href=/v1.9/zh/docs/reference/config/istio.operator.v1alpha1/>IstioOperator Options</a></li><li role=none><a role=treeitem title="Resource annotations used by Istio." href=/v1.9/zh/docs/reference/config/annotations/>Resource Annotations</a></li><li role=treeitem aria-label=流量管理><button aria-hidden=true></button><a title="描述如何配置 HTTP/TCP 路由功能。" href=/v1.9/zh/docs/reference/config/networking/>流量管理</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.9/zh/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.9/zh/docs/reference/config/networking/envoy-filter/>Envoy Filter</a></li><li role=none><a role=treeitem title="Configuration affecting edge load balancer." href=/v1.9/zh/docs/reference/config/networking/gateway/>Gateway</a></li><li role=none><a role=treeitem title="Configuration affecting label/content routing, sni routing, etc." href=/v1.9/zh/docs/reference/config/networking/virtual-service/>Virtual Service</a></li><li role=none><a role=treeitem title="Configuration affecting network reachability of a sidecar." href=/v1.9/zh/docs/reference/config/networking/sidecar/>Sidecar</a></li><li role=none><a role=treeitem title="Configuration affecting service registry." href=/v1.9/zh/docs/reference/config/networking/service-entry/>Service Entry</a></li></ul></li><li role=treeitem aria-label=Security><button aria-hidden=true></button><a title="如何配置 Istio 的安全功能。" href=/v1.9/zh/docs/reference/config/security/>Security</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Configuration to validate JWT." href=/v1.9/zh/docs/reference/config/security/jwt/>JWTRule</a></li><li role=none><a role=treeitem title="Request authentication configuration for workloads." href=/v1.9/zh/docs/reference/config/security/request_authentication/>RequestAuthentication</a></li><li role=none><a role=treeitem title="Peer authentication configuration for workloads." href=/v1.9/zh/docs/reference/config/security/peer_authentication/>PeerAuthentication</a></li><li role=none><a role=treeitem title="Authentication policy for Istio services." href=/v1.9/zh/docs/reference/config/security/istio.authentication.v1alpha1/>Authentication Policy</a></li><li role=none><a role=treeitem title="Configuration for access control on workloads." href=/v1.9/zh/docs/reference/config/security/authorization-policy/>Authorization Policy</a></li><li role=none><a role=treeitem title=授权策略中支持的条件。 href=/v1.9/zh/docs/reference/config/security/conditions/>授权策略</a></li><li role=none><a role=treeitem title="Configuration for Role Based Access Control." href=/v1.9/zh/docs/reference/config/security/istio.rbac.v1alpha1/>RBAC (deprecated)</a></li><li role=none><a role=treeitem title=受支持的约束条件和属性。 href=/v1.9/zh/docs/reference/config/security/constraints-and-properties/>RBAC 约束和属性(不建议使用)</a></li></ul></li><li role=treeitem aria-label="Telemetry V2"><button aria-hidden=true></button><a title="介绍如何配置 Istio telemetry V2。" href=/v1.9/zh/docs/reference/config/telemetry/>Telemetry V2</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="通过 Istio 遥测导出的 Istio 标准指标。" href=/v1.9/zh/docs/reference/config/telemetry/metrics/>Istio 标准度量指标</a></li><li role=none><a role=treeitem title="如何配置 v2 指标(实验性)。" href=/v1.9/zh/docs/reference/config/telemetry/configurable_metrics/>可配置指标(实验性)</a></li><li role=none><a role=treeitem title="如何通过 Wasm 运行时启用 Telemetry V2(实验性)。" href=/v1.9/zh/docs/reference/config/telemetry/telemetry_v2_with_wasm/>使用 Wasm 运行时的 Telemetry V2(实验性)</a></li></ul></li><li role=treeitem aria-label=配置分析消息><button aria-hidden=true></button><a title=记录配置分析期间产生的各个错误和警告消息。 href=/v1.9/zh/docs/reference/config/analysis/>配置分析消息</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0123/>NamespaceMultipleInjectionLabels</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/message-format/>Analyzer Message Format</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0109/>ConflictingMeshGatewayVirtualServiceHosts</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0110/>ConflictingSidecarWorkloadSelectors</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0002/>Deprecated</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0104/>GatewayPortNotOnWorkload</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0001/>InternalError</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0122/>InvalidRegexp</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0105/>IstioProxyImageMismatch</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0119/>JwtFailureDueToInvalidServicePortPrefix</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0107/>MisplacedAnnotation</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0113/>MTLSPolicyConflict</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0111/>MultipleSidecarsWithoutWorkloadSelectors</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0112/>VirtualServiceDestinationPortSelectorRequired</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0108/>UnknownAnnotation</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0106/>SchemaValidationError</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0101/>ReferencedResourceNotFound</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0118/>PortNameIsNotUnderNamingConvention</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0103/>PodMissingProxy</a></li><li role=none><a role=treeitem href=/v1.9/zh/docs/reference/config/analysis/ist0102/>NamespaceNotInjected</a></li></ul></li><li role=treeitem aria-label="Mixer 策略和遥测"><button aria-hidden=true></button><a title="描述如何配置 Mixer 的策略和遥测功能。" href=/v1.9/zh/docs/reference/config/policy-and-telemetry/>Mixer 策略和遥测</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Configuration state for the Mixer client library." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/istio.mixer.v1.config.client/>Mixer Client</a></li><li role=none><a role=treeitem title="Describes the rules used to configure Mixer's policy and telemetry features." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/>Rules</a></li><li role=none><a role=treeitem title="描述 Istio 策略执行和遥测机制的配置模型。" href=/v1.9/zh/docs/reference/config/policy-and-telemetry/mixer-overview/>Mixer 配置模型</a></li><li role=none><a role=treeitem title=描述用于策略和控制的基本属性词汇表。 href=/v1.9/zh/docs/reference/config/policy-and-telemetry/attribute-vocabulary/>属性词汇</a></li><li role=none><a role=treeitem title="Mixer 配置表达式语言手册。" href=/v1.9/zh/docs/reference/config/policy-and-telemetry/expression-language/>表达式语言</a></li><li role=treeitem aria-label=适配器><button aria-hidden=true></button><a title="Mixer 适配器能够让 Istio 连接各种基础设施后端以完成类似指标和日志这样的功能。" href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/>适配器</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Adapter to deliver metrics to Apache SkyWalking." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/apache-skywalking/>Apache SkyWalking</a></li><li role=none><a role=treeitem title="Adapter for Apigee's distributed policy checks and analytics." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/apigee/>Apigee</a></li><li role=none><a role=treeitem title="Adapter to enforce authentication and authorization policies for web apps and APIs." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/app-identity-access-adapter/>App Identity and Access</a></li><li role=none><a role=treeitem title="Adapter for circonus.com's monitoring solution." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/circonus/>Circonus</a></li><li role=none><a role=treeitem title="Adapter for cloudmonitor metrics." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/cloudmonitor/>CloudMonitor</a></li><li role=none><a role=treeitem title="Adapter for cloudwatch metrics." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/cloudwatch/>CloudWatch</a></li><li role=none><a role=treeitem title="Adapter to deliver metrics to a dogstatsd agent for delivery to DataDog." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/datadog/>Datadog</a></li><li role=none><a role=treeitem title="Adapter to deliver tracing data to Zipkin." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/zipkin/>Zipkin</a></li><li role=none><a role=treeitem title="Adapter that always returns a precondition denial." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/denier/>Denier</a></li><li role=none><a role=treeitem title="Adapter that delivers logs to a Fluentd daemon." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/fluentd/>Fluentd</a></li><li role=none><a role=treeitem title="Adapter that extracts information from a Kubernetes environment." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv/>Kubernetes Env</a></li><li role=none><a role=treeitem title="Adapter that performs whitelist or blacklist checks." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/list/>List</a></li><li role=none><a role=treeitem title="Adapter for a simple in-memory quota management system." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/memquota/>Memory quota</a></li><li role=none><a role=treeitem title="Adapter to deliver metrics to Wavefront by VMware." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/wavefront/>Wavefront by VMware</a></li><li role=none><a role=treeitem title="Adapter to locally output logs and metrics." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/stdio/>Stdio</a></li><li role=none><a role=treeitem title="Adapter to deliver metrics to a StatsD backend." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/statsd/>StatsD</a></li><li role=none><a role=treeitem title="Adapter to deliver logs, metrics, and traces to Stackdriver." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/stackdriver/>Stackdriver</a></li><li role=none><a role=treeitem title="Adapter to deliver logs and metrics to Papertrail and AppOptics backends." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/solarwinds/>SolarWinds</a></li><li role=none><a role=treeitem title="Adapter for a Redis-based quota management system." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/redisquota/>Redis Quota</a></li><li role=none><a role=treeitem title="Adapter that exposes Istio metrics for ingestion by a Prometheus harvester." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/prometheus/>Prometheus</a></li><li role=none><a role=treeitem title="Adapter that implements an Open Policy Agent engine." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/opa/>OPA</a></li><li role=none><a role=treeitem title="An Istio Mixer adapter to send telemetry data to New Relic." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/adapters/newrelic/>New Relic</a></li></ul></li><li role=none><a role=treeitem title="通过 Mixer 从 Istio 导出的默认监控指标。" href=/v1.9/zh/docs/reference/config/policy-and-telemetry/metrics/>默认监控指标</a></li><li role=treeitem aria-label=模板><button aria-hidden=true></button><a title="Mixer 模板用于将数据发送到各个适配器。" href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/>模板</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="The Analytics template is used to dispatch runtime telemetry to Apigee." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/analytics/>Analytics</a></li><li role=none><a role=treeitem title="A template that represents a single API key." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/apikey/>API Key</a></li><li role=none><a role=treeitem title="A template used to represent an access control query." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/authorization/>Authorization</a></li><li role=none><a role=treeitem title="A template that carries no data, useful for testing." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/checknothing/>Check Nothing</a></li><li role=none><a role=treeitem title="A template designed to report observed communication edges between workloads." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/edge/>Edge</a></li><li role=none><a role=treeitem title="A template that is used to control the production of Kubernetes-specific attributes." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/kubernetes/>Kubernetes</a></li><li role=none><a role=treeitem title="A template designed to let you perform list checking operations." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/listentry/>List Entry</a></li><li role=none><a role=treeitem title="A template that represents a single runtime log entry." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/logentry/>Log Entry</a></li><li role=none><a role=treeitem title="A template that represents a single runtime metric." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/metric/>Metric</a></li><li role=none><a role=treeitem title="A template that represents an individual span within a distributed trace." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/tracespan/>Trace Span</a></li><li role=none><a role=treeitem title="A template that carries no data, useful for testing." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/reportnothing/>Report Nothing</a></li><li role=none><a role=treeitem title="A template that represents a quota allocation request." href=/v1.9/zh/docs/reference/config/policy-and-telemetry/templates/quota/>Quota</a></li></ul></li></ul></li></ul></li><li role=treeitem aria-label=命令><button class=show aria-hidden=true></button><a title="描述 Istio 命令和工具的用法及选项。" href=/v1.9/zh/docs/reference/commands/>命令</a><ul role=group aria-expanded=true class=leaf-section><li role=none><a role=treeitem title="Galley provides configuration management services for Istio." href=/v1.9/zh/docs/reference/commands/galley/>galley</a></li><li role=none><a role=treeitem title="Istio Certificate Authority (CA)." href=/v1.9/zh/docs/reference/commands/istio_ca/>istio_ca</a></li><li role=none><span role=treeitem class=current title="Istio control interface.">istioctl</span></li><li role=none><a role=treeitem title="Mixer is Istio's abstraction on top of infrastructure backends." href=/v1.9/zh/docs/reference/commands/mixs/>mixs</a></li><li role=none><a role=treeitem title="Kubernetes webhook for automatic Istio sidecar injection." href=/v1.9/zh/docs/reference/commands/sidecar-injector/>sidecar-injector</a></li><li role=none><a role=treeitem title="Istio Pilot." href=/v1.9/zh/docs/reference/commands/pilot-discovery/>pilot-discovery</a></li><li role=none><a role=treeitem title="Istio Pilot agent." href=/v1.9/zh/docs/reference/commands/pilot-agent/>pilot-agent</a></li><li role=none><a role=treeitem title="The Istio operator." href=/v1.9/zh/docs/reference/commands/operator/>operator</a></li><li role=none><a role=treeitem title="Istio security per-node agent." href=/v1.9/zh/docs/reference/commands/node_agent/>node_agent</a></li></ul></li><li role=none><a role=treeitem title="Istio 常用术语的词汇表。" href=/v1.9/zh/docs/reference/glossary/>术语表</a></li></ul></div></div></div></nav></div><div class=article-container><button tabindex=-1 id=sidebar-toggler title=折叠导航栏><svg class="icon pull"><use xlink:href="/v1.9/img/icons.svg#pull"/></svg></button><nav aria-label=Breadcrumb><ol><li><a href=/v1.9/zh/ title=用于连接、保护、控制和观测服务。>Istio</a></li><li><a href=/v1.9/zh/docs/ title="了解如何部署、使用和运维 Istio。">文档</a></li><li><a href=/v1.9/zh/docs/reference/ title="参考部分包含详细的权威参考资料,如命令行选项、配置选项和 API 调用参数。">参考</a></li><li><a href=/v1.9/zh/docs/reference/commands/ title="描述 Istio 命令和工具的用法及选项。">命令</a></li><li>istioctl</li></ol></nav><article aria-labelledby=title><div class=title-area><div style=width:100%><h1 id=title>istioctl</h1><p class=byline><span title="14584 字"><svg class="icon clock"><use xlink:href="/v1.9/img/icons.svg#clock"/></svg><span> </span>阅读大约需要 69 分钟</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="istioctl analyze"><a href=#istioctl-analyze>analyze</a><li role=none aria-label="istioctl authn"><a href=#istioctl-authn>authn</a><li role=none aria-label="istioctl authn tls-check"><a href=#istioctl-authn-tls-check>authn tls-check</a><li role=none aria-label="istioctl authz"><a href=#istioctl-authz>authz</a><li role=none aria-label="istioctl convert-ingress"><a href=#istioctl-convert-ingress>convert-ingress</a><li role=none aria-label="istioctl dashboard"><a href=#istioctl-dashboard>dashboard</a><li role=none aria-label="istioctl dashboard controlz"><a href=#istioctl-dashboard-controlz>dashboard controlz</a><li role=none aria-label="istioctl dashboard envoy"><a href=#istioctl-dashboard-envoy>dashboard envoy</a><li role=none aria-label="istioctl dashboard grafana"><a href=#istioctl-dashboard-grafana>dashboard grafana</a><li role=none aria-label="istioctl dashboard jaeger"><a href=#istioctl-dashboard-jaeger>dashboard jaeger</a><li role=none aria-label="istioctl dashboard kiali"><a href=#istioctl-dashboard-kiali>dashboard kiali</a><li role=none aria-label="istioctl dashboard prometheus"><a href=#istioctl-dashboard-prometheus>dashboard prometheus</a><li role=none aria-label="istioctl dashboard zipkin"><a href=#istioctl-dashboard-zipkin>dashboard zipkin</a><li role=none aria-label="istioctl deregister"><a href=#istioctl-deregister>deregister</a><li role=none aria-label="istioctl experimental"><a href=#istioctl-experimental>experimental</a><li role=none aria-label="istioctl experimental add-to-mesh"><a href=#istioctl-experimental-add-to-mesh>experimental add-to-mesh</a><li role=none aria-label="istioctl experimental add-to-mesh external-service"><a href=#istioctl-experimental-add-to-mesh-external-service>experimental add-to-mesh external-service</a><li role=none aria-label="istioctl experimental add-to-mesh service"><a href=#istioctl-experimental-add-to-mesh-service>experimental add-to-mesh service</a><li role=none aria-label="istioctl experimental analyze"><a href=#istioctl-experimental-analyze>experimental analyze</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 authz convert"><a href=#istioctl-experimental-authz-convert>experimental authz convert</a><li role=none aria-label="istioctl experimental convert-ingress"><a href=#istioctl-experimental-convert-ingress>experimental convert-ingress</a><li role=none aria-label="istioctl experimental create-remote-secret"><a href=#istioctl-experimental-create-remote-secret>experimental create-remote-secret</a><li role=none aria-label="istioctl experimental dashboard"><a href=#istioctl-experimental-dashboard>experimental dashboard</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 kube-uninject"><a href=#istioctl-experimental-kube-uninject>experimental kube-uninject</a><li role=none aria-label="istioctl experimental metrics"><a href=#istioctl-experimental-metrics>experimental metrics</a><li role=none aria-label="istioctl experimental multicluster"><a href=#istioctl-experimental-multicluster>experimental multicluster</a><li role=none aria-label="istioctl experimental multicluster apply"><a href=#istioctl-experimental-multicluster-apply>experimental multicluster apply</a><li role=none aria-label="istioctl experimental multicluster describe"><a href=#istioctl-experimental-multicluster-describe>experimental multicluster describe</a><li role=none aria-label="istioctl experimental multicluster generate"><a href=#istioctl-experimental-multicluster-generate>experimental multicluster generate</a><li role=none aria-label="istioctl experimental post-install"><a href=#istioctl-experimental-post-install>experimental post-install</a><li role=none aria-label="istioctl experimental post-install webhook"><a href=#istioctl-experimental-post-install-webhook>experimental post-install webhook</a><li role=none aria-label="istioctl experimental post-install webhook disable"><a href=#istioctl-experimental-post-install-webhook-disable>experimental post-install webhook disable</a><li role=none aria-label="istioctl experimental post-install webhook enable"><a href=#istioctl-experimental-post-install-webhook-enable>experimental post-install webhook enable</a><li role=none aria-label="istioctl experimental post-install webhook status"><a href=#istioctl-experimental-post-install-webhook-status>experimental post-install webhook status</a><li role=none aria-label="istioctl experimental remove-from-mesh"><a href=#istioctl-experimental-remove-from-mesh>experimental remove-from-mesh</a><li role=none aria-label="istioctl experimental remove-from-mesh external-service"><a href=#istioctl-experimental-remove-from-mesh-external-service>experimental remove-from-mesh external-service</a><li role=none aria-label="istioctl experimental remove-from-mesh service"><a href=#istioctl-experimental-remove-from-mesh-service>experimental remove-from-mesh service</a><li role=none aria-label="istioctl experimental upgrade"><a href=#istioctl-experimental-upgrade>experimental upgrade</a><li role=none aria-label="istioctl experimental wait"><a href=#istioctl-experimental-wait>experimental wait</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 apply"><a href=#istioctl-manifest-apply>manifest apply</a><li role=none aria-label="istioctl manifest diff"><a href=#istioctl-manifest-diff>manifest diff</a><li role=none aria-label="istioctl manifest generate"><a href=#istioctl-manifest-generate>manifest generate</a><li role=none aria-label="istioctl manifest migrate"><a href=#istioctl-manifest-migrate>manifest migrate</a><li role=none aria-label="istioctl manifest versions"><a href=#istioctl-manifest-versions>manifest versions</a><li role=none aria-label="istioctl profile"><a href=#istioctl-profile>profile</a><li role=none aria-label="istioctl profile diff"><a href=#istioctl-profile-diff>profile diff</a><li role=none aria-label="istioctl profile dump"><a href=#istioctl-profile-dump>profile dump</a><li role=none aria-label="istioctl profile list"><a href=#istioctl-profile-list>profile list</a><li role=none aria-label="istioctl proxy-config"><a href=#istioctl-proxy-config>proxy-config</a><li role=none aria-label="istioctl proxy-config bootstrap"><a href=#istioctl-proxy-config-bootstrap>proxy-config bootstrap</a><li role=none aria-label="istioctl proxy-config cluster"><a href=#istioctl-proxy-config-cluster>proxy-config cluster</a><li role=none aria-label="istioctl proxy-config endpoint"><a href=#istioctl-proxy-config-endpoint>proxy-config endpoint</a><li role=none aria-label="istioctl proxy-config listener"><a href=#istioctl-proxy-config-listener>proxy-config listener</a><li role=none aria-label="istioctl proxy-config log"><a href=#istioctl-proxy-config-log>proxy-config log</a><li role=none aria-label="istioctl proxy-config 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 register"><a href=#istioctl-register>register</a><li role=none aria-label="istioctl validate"><a href=#istioctl-validate>validate</a><li role=none aria-label="istioctl verify-install"><a href=#istioctl-verify-install>verify-install</a><li role=none aria-label="istioctl version"><a href=#istioctl-version>version</a><li role=none aria-label="Environment variables"><a href=#envvars>Environment variables</a><li role=none aria-label="Exported metrics"><a href=#metrics>Exported metrics</a></ol><hr></div></nav><p>Istio configuration command line utility for service operators to
|
||
debug and diagnose their Istio mesh.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-analyze>istioctl analyze</h2><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></td><td>Analyze all namespaces</td></tr><tr><td><code>--color</code></td><td></td><td>Default true. Disable with '=false' or set $TERM to dumb</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--discovery</code></td><td><code>-d</code></td><td>'true' to enable service discovery, 'false' to disable it. Defaults to true if --use-kube is set, false otherwise. Analyzers requiring resources made available by enabling service discovery will be skipped.</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 Warn Error] (default `Warn`)</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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</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>Config 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 Warn Error] (default `Info`)</td></tr><tr><td><code>--use-kube</code></td><td><code>-k</code></td><td>Use live Kubernetes cluster for analysis</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr></tbody></table><h3 id="istioctl-analyze Examples">Examples</h3><pre class=language-bash><code>
|
||
# Analyze yaml files
|
||
istioctl analyze a.yaml b.yaml
|
||
|
||
# Analyze the current live cluster
|
||
istioctl analyze -k
|
||
|
||
# Analyze the current live cluster, simulating the effect of applying additional yaml files
|
||
istioctl analyze -k a.yaml b.yaml
|
||
|
||
# Analyze yaml files, overriding service discovery to enabled
|
||
istioctl analyze -d true a.yaml b.yaml services.yaml
|
||
|
||
# Analyze the current live cluster, overriding service discovery to disabled
|
||
istioctl analyze -k -d false
|
||
|
||
# List available analyzers
|
||
istioctl analyze -L
|
||
|
||
</code></pre><h2 id=istioctl-authn>istioctl authn</h2><p>A group of commands used to interact with Istio authentication policies.
|
||
tls-check</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-authn Examples">Examples</h3><pre class=language-bash><code># Check whether TLS setting are matching between authentication policy and destination rules:
|
||
istioctl authn tls-check
|
||
</code></pre><h2 id=istioctl-authn-tls-check>istioctl authn tls-check</h2><p>Check what authentication policies and destination rules pilot uses to config a proxy instance,
|
||
and check if TLS settings are compatible between them.</p><pre class=language-bash><code>istioctl authn tls-check <pod-name[.namespace]> [<service>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-authn-tls-check Examples">Examples</h3><pre class=language-bash><code>
|
||
# Check settings for pod "foo-656bd7df7c-5zp4s" in namespace default:
|
||
istioctl authn tls-check foo-656bd7df7c-5zp4s.default
|
||
|
||
# Check settings for pod "foo-656bd7df7c-5zp4s" in namespace default, filtered on destination
|
||
service "bar" :
|
||
istioctl authn tls-check foo-656bd7df7c-5zp4s.default bar
|
||
|
||
</code></pre><h2 id=istioctl-authz>istioctl authz</h2><p>(authz is experimental. Use `istioctl experimental authz`)</p><pre class=language-bash><code>istioctl authz [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-convert-ingress>istioctl convert-ingress</h2><p>Converts Ingresses into VirtualService configuration on a best effort basis. The output should be considered a starting point for your Istio configuration and probably require some minor modification. Warnings will be generated where configs cannot be converted perfectly. The input must be a Kubernetes Ingress. The conversion of v1alpha1 Istio rules has been removed from istioctl.</p><pre class=language-bash><code>istioctl convert-ingress [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filenames <stringSlice></code></td><td><code>-f</code></td><td>Input filenames (default `[]`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output filename (default `-`)</td></tr></tbody></table><h3 id="istioctl-convert-ingress Examples">Examples</h3><pre class=language-bash><code>istioctl convert-ingress -f samples/bookinfo/platform/kube/bookinfo-ingress.yaml
|
||
</code></pre><h2 id=istioctl-dashboard>istioctl dashboard</h2><p>Access to Istio web UIs</p><pre class=language-bash><code>istioctl dashboard [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl dash [flags]
|
||
istioctl d [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-dashboard-controlz>istioctl dashboard controlz</h2><p>Open the ControlZ web UI for a pod in the Istio control plane</p><pre class=language-bash><code>istioctl dashboard controlz <pod-name[.namespace]> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--ctrlz_port <int></code></td><td></td><td>ControlZ port (default `9876`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--selector <string></code></td><td><code>-l</code></td><td>label selector (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-controlz Examples">Examples</h3><pre class=language-bash><code>istioctl dashboard controlz pilot-123-456.istio-system
|
||
</code></pre><h2 id=istioctl-dashboard-envoy>istioctl dashboard envoy</h2><p>Open the Envoy admin dashboard for a sidecar</p><pre class=language-bash><code>istioctl dashboard envoy <pod-name[.namespace]> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--selector <string></code></td><td><code>-l</code></td><td>label selector (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-envoy Examples">Examples</h3><pre class=language-bash><code>istioctl dashboard envoy productpage-123-456.default
|
||
</code></pre><h2 id=istioctl-dashboard-grafana>istioctl dashboard grafana</h2><p>Open Istio's Grafana dashboard</p><pre class=language-bash><code>istioctl dashboard grafana [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-grafana Examples">Examples</h3><pre class=language-bash><code>istioctl dashboard grafana
|
||
</code></pre><h2 id=istioctl-dashboard-jaeger>istioctl dashboard jaeger</h2><p>Open Istio's Jaeger dashboard</p><pre class=language-bash><code>istioctl dashboard jaeger [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-jaeger Examples">Examples</h3><pre class=language-bash><code>istioctl dashboard jaeger
|
||
</code></pre><h2 id=istioctl-dashboard-kiali>istioctl dashboard kiali</h2><p>Open Istio's Kiali dashboard</p><pre class=language-bash><code>istioctl dashboard kiali [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-kiali Examples">Examples</h3><pre class=language-bash><code>istioctl dashboard kiali
|
||
</code></pre><h2 id=istioctl-dashboard-prometheus>istioctl dashboard prometheus</h2><p>Open Istio's Prometheus dashboard</p><pre class=language-bash><code>istioctl dashboard prometheus [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-prometheus Examples">Examples</h3><pre class=language-bash><code>istioctl dashboard prometheus
|
||
</code></pre><h2 id=istioctl-dashboard-zipkin>istioctl dashboard zipkin</h2><p>Open Istio's Zipkin dashboard</p><pre class=language-bash><code>istioctl dashboard zipkin [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-dashboard-zipkin Examples">Examples</h3><pre class=language-bash><code>istioctl dashboard zipkin
|
||
</code></pre><h2 id=istioctl-deregister>istioctl deregister</h2><p>De-registers a service instance</p><pre class=language-bash><code>istioctl deregister <svcname> <ip> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-deregister Examples">Examples</h3><pre class=language-bash><code># de-register an endpoint 172.17.0.2 from service my-svc:
|
||
istioctl deregister my-svc 172.17.0.2
|
||
</code></pre><h2 id=istioctl-experimental>istioctl experimental</h2><p>Experimental commands that may be modified or deprecated</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-add-to-mesh>istioctl experimental add-to-mesh</h2><p>Add workloads into Istio service mesh</p><pre class=language-bash><code>istioctl experimental add-to-mesh [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental add [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-add-to-mesh-external-service>istioctl experimental add-to-mesh external-service</h2><p>istioctl experimental add-to-mesh external-service create a ServiceEntry and\
|
||
a Service without selector for the specified external service in Istio service mesh.
|
||
The typical usage scenario is Mesh Expansion on VMs.
|
||
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental add-to-mesh external-service <svcname> <ip>... [name1:]port1 [name2:]port2 ... [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--annotations <stringSlice></code></td><td><code>-a</code></td><td>List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,x=y (default `[]`)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--labels <stringSlice></code></td><td><code>-l</code></td><td>List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--serviceaccount <string></code></td><td><code>-s</code></td><td>Service account to link to the service (default `default`)</td></tr></tbody></table><h3 id="istioctl-experimental-add-to-mesh-external-service Examples">Examples</h3><pre class=language-bash><code>istioctl experimental add-to-mesh external-service vmhttp 172.12.23.125,172.12.23.126\
|
||
http:9080 tcp:8888 -l app=test,version=v1 -a env=stage -s stageAdmin
|
||
</code></pre><h2 id=istioctl-experimental-add-to-mesh-service>istioctl experimental add-to-mesh service</h2><p>istioctl experimental add-to-mesh service restarts pods with the Istio sidecar. Use 'add-to-mesh'
|
||
to test deployments for compatibility with Istio. If your service does not function after
|
||
using 'add-to-mesh' you must re-deploy it and troubleshoot it for Istio compatibility.
|
||
See https://istio.io/docs/setup/kubernetes/additional-setup/requirements/
|
||
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental add-to-mesh service [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--injectConfigFile <string></code></td><td></td><td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--injectConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--meshConfigFile <string></code></td><td></td><td>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--valuesFile <string></code></td><td></td><td>injection values configuration filename. (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-add-to-mesh-service Examples">Examples</h3><pre class=language-bash><code>istioctl experimental add-to-mesh service productpage
|
||
</code></pre><h2 id=istioctl-experimental-analyze>istioctl experimental analyze</h2><p>Analyze Istio configuration and print validation messages (analyze has graduated. Use `istioctl analyze`)</p><pre class=language-bash><code>istioctl experimental analyze <file>... [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--all-namespaces</code></td><td></td><td>Analyze all namespaces</td></tr><tr><td><code>--color</code></td><td></td><td>Default true. Disable with '=false' or set $TERM to dumb</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--discovery</code></td><td><code>-d</code></td><td>'true' to enable service discovery, 'false' to disable it. Defaults to true if --use-kube is set, false otherwise. Analyzers requiring resources made available by enabling service discovery will be skipped.</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 Warn Error] (default `Warn`)</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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</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>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of [yaml log json] (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 Warn Error] (default `Info`)</td></tr><tr><td><code>--use-kube</code></td><td><code>-k</code></td><td>Use live Kubernetes cluster for analysis</td></tr><tr><td><code>--verbose</code></td><td><code>-v</code></td><td>Enable verbose output</td></tr></tbody></table><h3 id="istioctl-experimental-analyze Examples">Examples</h3><pre class=language-bash><code>
|
||
# Analyze yaml files
|
||
istioctl analyze a.yaml b.yaml
|
||
|
||
# Analyze the current live cluster
|
||
istioctl analyze -k
|
||
|
||
# Analyze the current live cluster, simulating the effect of applying additional yaml files
|
||
istioctl analyze -k a.yaml b.yaml
|
||
|
||
# Analyze yaml files, overriding service discovery to enabled
|
||
istioctl analyze -d true a.yaml b.yaml services.yaml
|
||
|
||
# Analyze the current live cluster, overriding service discovery to disabled
|
||
istioctl analyze -k -d false
|
||
|
||
# List available analyzers
|
||
istioctl analyze -L
|
||
|
||
</code></pre><h2 id=istioctl-experimental-authz>istioctl experimental authz</h2><p>Commands to inspect and interact with the authorization policies
|
||
check - check Envoy config dump for authorization configuration
|
||
convert - convert v1alpha1 RBAC policies to v1beta1 authorization policies</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-authz Examples">Examples</h3><pre class=language-bash><code> # Check Envoy authorization configuration for pod httpbin-88ddbcfdd-nt5jb:
|
||
istioctl x authz check httpbin-88ddbcfdd-nt5jb
|
||
|
||
# Convert the v1alpha1 RBAC policies in the current cluster to v1beta1 authorization policies:
|
||
istioctl x authz convert > v1beta1-authz.yaml
|
||
|
||
</code></pre><h2 id=istioctl-experimental-authz-check>istioctl experimental authz check</h2><p>Check reads the Envoy config dump and checks the filter configuration
|
||
related to authorization. For example, it shows whether or not the Envoy is configured
|
||
with authorization and the rules used in the authorization.</p><p>The Envoy config dump could be provided either by pod name or from a config dump file
|
||
(the whole output of http://localhost:15000/config_dump of an Envoy instance).</p><p>THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental authz check <pod-name>[.<pod-namespace>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--all</code></td><td><code>-a</code></td><td>Show additional information (e.g. SNI and ALPN)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file <string></code></td><td><code>-f</code></td><td>Check the Envoy config dump from a file (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-authz-check Examples">Examples</h3><pre class=language-bash><code> # Check Envoy authorization configuration for pod httpbin-88ddbcfdd-nt5jb:
|
||
istioctl x authz check httpbin-88ddbcfdd-nt5jb
|
||
|
||
# Check Envoy authorization configuration from a config dump file:
|
||
istioctl x authz check -f httpbin_config_dump.json
|
||
</code></pre><h2 id=istioctl-experimental-authz-convert>istioctl experimental authz convert</h2><p>Convert Istio v1alpha1 RBAC policy to v1beta1 authorization policy. The command talks to Kubernetes
|
||
API server to get all the information needed to complete the conversion, including the v1alpha1 RBAC policies in the current
|
||
cluster, the Istio config-map for root namespace configuration and the k8s Service translating the
|
||
service name to workload selector.</p><p>The tool can also be used in offline mode without talking to the Kubernetes API server. In this mode,
|
||
all needed information is provided through the command line.</p><p>Note: The converter tool makes a best effort attempt to keep the syntax unchanged when
|
||
converting v1alph1 RBAC policy to v1beta1 policy. However, in some cases, strict
|
||
mapping with equivalent syntax is not possible (e.g., constraints no longer valid
|
||
in the new workload oriented model, converting a service name containing a wildcard
|
||
to workload selector).</p><p>Please always review the converted policies, and remove the "===PLEASE REVIEW THE GENERATED POLICY AND REMOVE THIS LINE BEFORE APPLYING IT==="
|
||
string on top of the converted policies before apply them.</p><p>THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental authz convert [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--file <stringSlice></code></td><td><code>-f</code></td><td>v1alpha1 RBAC policy that needs to be converted to v1beta1 authorization policy (default `[]`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--meshConfigFile <string></code></td><td><code>-m</code></td><td>Istio MeshConfig file that provides the root namespace value (default ``)</td></tr><tr><td><code>--meshConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio mesh configuration (default `istio`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--service <stringSlice></code></td><td><code>-s</code></td><td>Kubernetes Service resource that provides the mapping between service and workload (default `[]`)</td></tr></tbody></table><h3 id="istioctl-experimental-authz-convert Examples">Examples</h3><pre class=language-bash><code> # Convert the v1alpha1 RBAC policy in the current cluster:
|
||
istioctl x authz convert > v1beta1-authz.yaml
|
||
|
||
# Convert the v1alpha1 RBAC policy provided through command line:
|
||
istioctl x authz convert -f v1alpha1-policy-1.yaml,v1alpha1-policy-2.yaml
|
||
--service services.yaml --meshConfigFile meshConfig.yaml > v1beta1-authz.yaml
|
||
|
||
</code></pre><h2 id=istioctl-experimental-convert-ingress>istioctl experimental convert-ingress</h2><p>(convert-ingress has graduated. Use `istioctl convert-ingress`)</p><pre class=language-bash><code>istioctl experimental convert-ingress [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-create-remote-secret>istioctl experimental create-remote-secret</h2><p>Create a secret with credentials to allow Istio to access remote Kubernetes apiservers</p><pre class=language-bash><code>istioctl experimental create-remote-secret <cluster-name> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--auth-plugin-config <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>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--service-account <string></code></td><td></td><td>create a secret with this service account's credentials. (default `istio-reader-service-account`)</td></tr></tbody></table><h3 id="istioctl-experimental-create-remote-secret Examples">Examples</h3><pre class=language-bash><code>
|
||
# Create a secret to access cluster c0's apiserver and install it in cluster c1.
|
||
istioctl --Kubeconfig=c0.yaml x create-remote-secret \
|
||
| kubectl -n istio-system --Kubeconfig=c1.yaml apply -f -
|
||
|
||
# Delete a secret that was previously installed in c1
|
||
istioctl --Kubeconfig=c0.yaml x create-remote-secret \
|
||
| kubectl -n istio-system --Kubeconfig=c1.yaml delete -f -
|
||
|
||
# Create a secret access a remote cluster with an auth plugin
|
||
istioctl --Kubeconfig=c0.yaml x create-remote-secret --auth-type=plugin --auth-plugin-name=gcp \
|
||
| kubectl -n istio-system --Kubeconfig=c1.yaml apply -f -
|
||
|
||
</code></pre><h2 id=istioctl-experimental-dashboard>istioctl experimental dashboard</h2><p>(dashboard has graduated. Use `istioctl dashboard`)</p><pre class=language-bash><code>istioctl experimental dashboard [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-describe>istioctl experimental describe</h2><p>Describe resource and related Istio configuration</p><pre class=language-bash><code>istioctl experimental describe [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental des [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-describe-pod>istioctl experimental describe pod</h2><p>Analyzes pod, its Services, DestinationRules, and VirtualServices and reports
|
||
the configuration objects that affect that pod.</p><p>THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental describe pod <pod> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--ignoreUnmeshed</code></td><td></td><td>Suppress warnings for unmeshed pods</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-describe-pod Examples">Examples</h3><pre class=language-bash><code>istioctl experimental describe pod productpage-v1-c7765c886-7zzd4
|
||
</code></pre><h2 id=istioctl-experimental-describe-service>istioctl experimental describe service</h2><p>Analyzes service, pods, DestinationRules, and VirtualServices and reports
|
||
the configuration objects that affect that service.</p><p>THIS COMMAND IS STILL 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>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--ignoreUnmeshed</code></td><td></td><td>Suppress warnings for unmeshed pods</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-describe-service Examples">Examples</h3><pre class=language-bash><code>istioctl experimental describe service productpage
|
||
</code></pre><h2 id=istioctl-experimental-kube-uninject>istioctl experimental kube-uninject</h2><p></p><p>kube-uninject is used to prevent Istio from adding a sidecar and
|
||
also provides the inverse of "istioctl kube-inject -f".</p><p></p><pre class=language-bash><code>istioctl experimental kube-uninject [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Input Kubernetes resource filename (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Modified output Kubernetes resource filename (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-kube-uninject Examples">Examples</h3><pre class=language-bash><code>
|
||
# Update resources before applying.
|
||
kubectl apply -f <(istioctl experimental kube-uninject -f <resource.yaml>)
|
||
|
||
# Create a persistent version of the deployment by removing Envoy sidecar.
|
||
istioctl experimental kube-uninject -f deployment.yaml -o deployment-uninjected.yaml
|
||
|
||
# Update an existing deployment.
|
||
kubectl get deployment -o yaml | istioctl experimental kube-uninject -f - | kubectl apply -f -
|
||
|
||
</code></pre><h2 id=istioctl-experimental-metrics>istioctl experimental metrics</h2><p>Prints the metrics for the specified service(s) when running in Kubernetes.</p><p>This command finds a Prometheus pod running in the specified istio system
|
||
namespace. It then executes a series of queries per requested workload to
|
||
find the following top-level workload metrics: total requests per second,
|
||
error rate, and request latency at p50, p90, and p99 percentiles. The
|
||
query results are printed to the console, organized by workload name.</p><p>All metrics returned are from server-side reports. This means that latencies
|
||
and error rates are from the perspective of the service itself and not of an
|
||
individual client (or aggregate set of clients). Rates and latencies are
|
||
calculated over a time interval of 1 minute.</p><pre class=language-bash><code>istioctl experimental metrics <workload name>...
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental m <workload name>...
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-metrics Examples">Examples</h3><pre class=language-bash><code>
|
||
# Retrieve workload metrics for productpage-v1 workload
|
||
istioctl experimental metrics productpage-v1
|
||
|
||
# Retrieve workload metrics for various services in the different namespaces
|
||
istioctl experimental metrics productpage-v1.foo reviews-v1.bar ratings-v1.baz
|
||
|
||
</code></pre><h2 id=istioctl-experimental-multicluster>istioctl experimental multicluster</h2><p>Commands to assist in managing a multi-cluster mesh</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-multicluster-apply>istioctl experimental multicluster apply</h2><p>Update clusters in a multi-cluster mesh based on mesh topology</p><pre class=language-bash><code>istioctl experimental multicluster apply -f <mesh.yaml> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>filename of the multicluster mesh description (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-multicluster-describe>istioctl experimental multicluster describe</h2><p>Describe status of the multi-cluster mesh's control plane'</p><pre class=language-bash><code>istioctl experimental multicluster describe -f <mesh.yaml> [--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>--all</code></td><td></td><td>describe the status of all clustersByContext in the mesh</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>filename of the multicluster mesh description (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-multicluster-generate>istioctl experimental multicluster generate</h2><p>generate a cluster-specific control plane configuration based on the mesh description and runtime state</p><pre class=language-bash><code>istioctl experimental multicluster generate -f <mesh.yaml> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>filename of the multicluster mesh description (default ``)</td></tr><tr><td><code>--from <string></code></td><td></td><td>optional source configuration to generate multicluster aware configuration from (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--wait-for-gateways</code></td><td></td><td>wait for all cluster's istio-ingressgateway IPs to be ready before generating configuration.</td></tr></tbody></table><h2 id=istioctl-experimental-post-install>istioctl experimental post-install</h2><p>Commands related to post-install</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-post-install-webhook>istioctl experimental post-install webhook</h2><p>webhook command to manage webhook configurations</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-post-install-webhook-disable>istioctl experimental post-install webhook disable</h2><p>Disable webhook configurations</p><pre class=language-bash><code>istioctl experimental post-install webhook disable [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--injection</code></td><td></td><td>Disable mutating webhook (default true).</td></tr><tr><td><code>--injection-config <string></code></td><td></td><td>The mutating webhook configuration to disable. (default `istio-sidecar-injector`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--validation</code></td><td></td><td>Disable validating webhook (default true).</td></tr><tr><td><code>--validation-config <string></code></td><td></td><td>The validating webhook configuration to disable. (default `istio-galley`)</td></tr></tbody></table><h3 id="istioctl-experimental-post-install-webhook-disable Examples">Examples</h3><pre class=language-bash><code>
|
||
# Disable all webhooks
|
||
istioctl experimental post-install webhook disable
|
||
|
||
# Disable all webhooks except injection
|
||
istioctl experimental post-install webhook disable --injection=false
|
||
|
||
</code></pre><h2 id=istioctl-experimental-post-install-webhook-enable>istioctl experimental post-install webhook enable</h2><p>This command is used to enable webhook configurations after installing Istio.
|
||
For previous Istio versions (e.g., 1.2, 1.3, etc), this command is not needed
|
||
because in previous versions webhooks manage their own configurations.</p><pre class=language-bash><code>istioctl experimental post-install webhook enable [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--ca-bundle-file <string></code></td><td></td><td>PEM encoded CA bundle which will be used to validate the webhook's server certificates. If this is empty, the kube-apisever's root CA is used if it can be confirmed to have signed the webhook's certificates. This condition is sometimes true but is not guaranteed (see https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet-tls-bootstrapping) (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--injection</code></td><td></td><td>Enable injection webhook (default true).</td></tr><tr><td><code>--injection-path <string></code></td><td></td><td>The file path of the injection webhook configuration. (default ``)</td></tr><tr><td><code>--injection-service <string></code></td><td></td><td>The service name of the injection webhook to manage. (default `istio-sidecar-injector`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--read-cert-timeout <duration></code></td><td></td><td>Max time for waiting the webhook certificate to be readable. (default `1m0s`)</td></tr><tr><td><code>--timeout <duration></code></td><td></td><td>Max time for checking the validating webhook server. If the validating webhook server is not readyin the given time, exit. Otherwise, apply the webhook configuration. (default `1m0s`)</td></tr><tr><td><code>--validation</code></td><td></td><td>Enable validatation webhook (default true).</td></tr><tr><td><code>--validation-path <string></code></td><td></td><td>The file path of the validation webhook configuration. (default ``)</td></tr><tr><td><code>--validation-service <string></code></td><td></td><td>The service name of the validation webhook to manage. (default `istio-galley`)</td></tr><tr><td><code>--webhook-secret <string></code></td><td></td><td>The name of an existing Kubernetes secret of a webhook. istioctl will verify that the webhook certificate is issued by the CA certificate. (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-post-install-webhook-enable Examples">Examples</h3><pre class=language-bash><code>
|
||
# Enable the webhook configuration of Galley with the given webhook configuration
|
||
istioctl experimental post-install webhook enable --validation --webhook-secret istio.webhook.galley
|
||
--namespace istio-system --validation-path validatingwebhookconfiguration.yaml
|
||
|
||
# Enable the webhook configuration of Galley with the given webhook configuration and CA certificate
|
||
istioctl experimental post-install webhook enable --validation --webhook-secret istio.webhook.galley
|
||
--namespace istio-system --validation-path validatingwebhookconfiguration.yaml --ca-bundle-file ./k8s-ca-cert.pem
|
||
|
||
</code></pre><h2 id=istioctl-experimental-post-install-webhook-status>istioctl experimental post-install webhook status</h2><p>Get webhook configurations</p><pre class=language-bash><code>istioctl experimental post-install webhook 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>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--injection</code></td><td></td><td>Display the injection webhook configuration.</td></tr><tr><td><code>--injection-config <string></code></td><td></td><td>The name of the MutatingWebhookConfiguration to display. (default `istio-sidecar-injector`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--validation</code></td><td></td><td>Display the validating webhook configuration.</td></tr><tr><td><code>--validation-config <string></code></td><td></td><td>The name of the ValidatingWebhookConfiguration to display. (default `istio-galley`)</td></tr></tbody></table><h3 id="istioctl-experimental-post-install-webhook-status Examples">Examples</h3><pre class=language-bash><code>
|
||
# Display the webhook configuration of Galley
|
||
istioctl experimental post-install webhook status --validation --validation-config istio-galley
|
||
# Display the webhook configuration of Galley and Sidecar Injector
|
||
istioctl experimental post-install webhook status --validation --validation-config istio-galley
|
||
--injection --injection-config istio-sidecar-injector
|
||
|
||
</code></pre><h2 id=istioctl-experimental-remove-from-mesh>istioctl experimental remove-from-mesh</h2><p>Remove workloads from Istio service mesh</p><pre class=language-bash><code>istioctl experimental remove-from-mesh [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl experimental rm [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h2 id=istioctl-experimental-remove-from-mesh-external-service>istioctl experimental remove-from-mesh external-service</h2><p>istioctl experimental remove-from-mesh external-service remove the ServiceEntry and\
|
||
the kubernetes Service for the specified external service(eg:services running on VM) from Istio service mesh.
|
||
The typical usage scenario is Mesh Expansion on VMs.
|
||
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental remove-from-mesh external-service <svcname> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-remove-from-mesh-external-service Examples">Examples</h3><pre class=language-bash><code>istioctl experimental remove-from-mesh external-service vmhttp
|
||
</code></pre><h2 id=istioctl-experimental-remove-from-mesh-service>istioctl experimental remove-from-mesh service</h2><p>istioctl experimental remove-from-mesh service restarts pods with the Istio sidecar un-injected.
|
||
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.</p><pre class=language-bash><code>istioctl experimental remove-from-mesh service [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr></tbody></table><h3 id="istioctl-experimental-remove-from-mesh-service Examples">Examples</h3><pre class=language-bash><code>istioctl experimental remove-from-mesh service productpage
|
||
</code></pre><h2 id=istioctl-experimental-upgrade>istioctl experimental upgrade</h2><p>The upgrade command checks for upgrade version eligibility and, if eligible, upgrades the Istio control plane components in-place. Warning: traffic may be disrupted during upgrade. Please ensure PodDisruptionBudgets are defined to maintain service continuity.</p><pre class=language-bash><code>istioctl experimental 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>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Path to file containing IstioControlPlane CustomResource (default ``)</td></tr><tr><td><code>--force</code></td><td></td><td>Apply the upgrade without eligibility checks and testing for changes in profile default values</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--skip-confirmation</code></td><td></td><td>If skip-confirmation is set, skips the prompting confirmation for value changes in this upgrade</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr><tr><td><code>--versionsURI <string></code></td><td><code>-u</code></td><td>URI for operator versions to Istio versions map (default `https://raw.githubusercontent.com/istio/operator/master/data/versions.yaml`)</td></tr><tr><td><code>--wait</code></td><td><code>-w</code></td><td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of 10m0s</td></tr></tbody></table><h2 id=istioctl-experimental-wait>istioctl experimental wait</h2><p>Waits for the specified condition to be true of an Istio resource.</p><pre class=language-bash><code>istioctl experimental wait [flags] <type> <name>[.<namespace>]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--for <string></code></td><td></td><td>wait condition, must be 'distribution' or 'delete' (default `distribution`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--resource-version <string></code></td><td></td><td>wait for a specific version of config to become current, rather than using whatever is latest in kubernetes (default ``)</td></tr><tr><td><code>--threshold <float32></code></td><td></td><td>the ratio of distribution required for success (default `1`)</td></tr><tr><td><code>--timeout <duration></code></td><td></td><td>the duration to wait before failing (default `30s`)</td></tr></tbody></table><h3 id="istioctl-experimental-wait Examples">Examples</h3><pre class=language-bash><code>
|
||
# Wait until the bookinfo virtual service has been distributed to all proxies in the mesh
|
||
istioctl experimental wait --for=distribution virtualservice bookinfo.default
|
||
|
||
# Wait until 99% of the proxies receive the distribution, timing out after 5 minutes
|
||
istioctl experimental wait --for=distribution --threshold=.99 --timeout=300 virtualservice bookinfo.default
|
||
|
||
</code></pre><h2 id=istioctl-kube-inject>istioctl kube-inject</h2><p></p><p>kube-inject manually injects the Envoy sidecar into Kubernetes
|
||
workloads. Unsupported resources are left unmodified so it is safe to
|
||
run kube-inject over a single file that contains multiple Service,
|
||
ConfigMap, Deployment, etc. definitions for a complex application. It's
|
||
best to do this when the resource is initially created.</p><p>k8s.io/docs/concepts/workloads/pods/pod-overview/#pod-templates is
|
||
updated for Job, DaemonSet, ReplicaSet, Pod and Deployment YAML resource
|
||
documents. Support for additional pod-based resource types can be
|
||
added as necessary.</p><p>The Istio project is continually evolving so the Istio sidecar
|
||
configuration may change unannounced. When in doubt re-run istioctl
|
||
kube-inject on deployments to get the most up-to-date changes.</p><pre class=language-bash><code>istioctl kube-inject [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Input Kubernetes resource filename (default ``)</td></tr><tr><td><code>--injectConfigFile <string></code></td><td></td><td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td></tr><tr><td><code>--injectConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio sidecar injection, key should be "config". (default `istio-sidecar-injector`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--meshConfigFile <string></code></td><td></td><td>mesh configuration filename. Takes precedence over --meshConfigMapName if set (default ``)</td></tr><tr><td><code>--meshConfigMapName <string></code></td><td></td><td>ConfigMap name for Istio mesh configuration, key should be "mesh" (default `istio`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Modified output Kubernetes resource filename (default ``)</td></tr><tr><td><code>--valuesFile <string></code></td><td></td><td>injection values configuration filename. (default ``)</td></tr></tbody></table><h3 id="istioctl-kube-inject Examples">Examples</h3><pre class=language-bash><code>
|
||
# Update resources on the fly before applying.
|
||
kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)
|
||
|
||
# Create a persistent version of the deployment with Envoy sidecar
|
||
# injected.
|
||
istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml
|
||
|
||
# Update an existing deployment.
|
||
kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -
|
||
|
||
# Capture cluster configuration for later use with kube-inject
|
||
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.config}" > /tmp/inj-template.tmpl
|
||
kubectl -n istio-system get cm istio -o jsonpath="{.data.mesh}" > /tmp/mesh.yaml
|
||
kubectl -n istio-system get cm istio-sidecar-injector -o jsonpath="{.data.values}" > /tmp/values.json
|
||
# Use kube-inject based on captured configuration
|
||
istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \
|
||
--injectConfigFile /tmp/inj-template.tmpl \
|
||
--meshConfigFile /tmp/mesh.yaml \
|
||
--valuesFile /tmp/values.json
|
||
|
||
</code></pre><h2 id=istioctl-manifest>istioctl manifest</h2><p>The manifest subcommand generates, applies, diffs or migrates Istio manifests.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-manifest-apply>istioctl manifest apply</h2><p>The apply subcommand generates an Istio install manifest and applies it to a cluster.</p><pre class=language-bash><code>istioctl manifest apply [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Path to file containing IstioControlPlane CustomResource (default ``)</td></tr><tr><td><code>--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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--readiness-timeout <duration></code></td><td></td><td>Maximum seconds to wait for all Istio resources to be ready. The --wait flag must be set for this flag to apply (default `5m0s`)</td></tr><tr><td><code>--set <stringSlice></code></td><td><code>-s</code></td><td>Set a value in IstioControlPlane CustomResource. e.g. --set policy.enabled=true.
|
||
Overrides the corresponding path value in the selected profile or passed through IstioControlPlane CR
|
||
customization file (default `[]`)</td></tr><tr><td><code>--skip-confirmation</code></td><td></td><td>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></td><td>Verbose output.</td></tr><tr><td><code>--wait</code></td><td><code>-w</code></td><td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds</td></tr></tbody></table><h2 id=istioctl-manifest-diff>istioctl manifest diff</h2><p>The diff subcommand compares manifests from two files or directories.</p><pre class=language-bash><code>istioctl manifest diff <file|dir> <file|dir> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--directory</code></td><td><code>-r</code></td><td>compare directory</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--ignore <string></code></td><td></td><td>ignoreResources ignores all listed items during comparison. It uses the same list format as selectResources (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--rename <string></code></td><td></td><td>renameResources identifies renamed resources before comparison.
|
||
The format of each renaming pair is A->B, all renaming pairs are comma separated.
|
||
e.g. Service:*:istio-pilot->Service:*:istio-control - rename istio-pilot service into istio-control (default ``)</td></tr><tr><td><code>--select <string></code></td><td></td><td>selectResources constrains the list of resources to compare to only the ones in this list, ignoring all others.
|
||
The format of each list item is "::" and the items are comma separated. The "*" character represents wildcard selection.
|
||
e.g.
|
||
Deployment:istio-system:* - compare all deployments in istio-system namespace
|
||
Service:*:istio-pilot - compare Services called "istio-pilot" in all namespaces (default `::`)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-manifest-generate>istioctl manifest generate</h2><p>The generate subcommand generates an Istio install manifest and outputs to the console by default.</p><pre class=language-bash><code>istioctl manifest generate [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Path to file containing IstioControlPlane CustomResource (default ``)</td></tr><tr><td><code>--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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Manifest output directory path (default ``)</td></tr><tr><td><code>--set <stringSlice></code></td><td><code>-s</code></td><td>Set a value in IstioControlPlane CustomResource. e.g. --set policy.enabled=true.
|
||
Overrides the corresponding path value in the selected profile or passed through IstioControlPlane CR
|
||
customization file (default `[]`)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-manifest-migrate>istioctl manifest migrate</h2><p>The migrate subcommand migrates a configuration from Helm values format to IstioControlPlane format.</p><pre class=language-bash><code>istioctl manifest migrate [<filepath>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-manifest-versions>istioctl manifest versions</h2><p>List the versions of Istio recommended for use or supported for upgrade by this version of the operator binary.</p><pre class=language-bash><code>istioctl manifest versions [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr><tr><td><code>--versionsURI <string></code></td><td><code>-u</code></td><td>URI for operator versions to Istio versions map (default `https://raw.githubusercontent.com/istio/operator/master/data/versions.yaml`)</td></tr></tbody></table><h2 id=istioctl-profile>istioctl profile</h2><p>The profile subcommand lists, dumps or diffs Istio configuration profiles.</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-profile-diff>istioctl profile diff</h2><p>The diff subcommand displays the differences between two Istio configuration profiles.</p><pre class=language-bash><code>istioctl profile diff <file1.yaml> <file2.yaml> [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-profile-dump>istioctl profile dump</h2><p>The dump subcommand dumps the values in an Istio configuration profile.</p><pre class=language-bash><code>istioctl profile dump [<profile>] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--config-path <string></code></td><td><code>-p</code></td><td>The path the root of the configuration subtree to dump e.g. trafficManagement.components.pilot. By default, dump whole tree (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--filename <string></code></td><td><code>-f</code></td><td>Path to file containing IstioControlPlane CustomResource (default ``)</td></tr><tr><td><code>--helm-values</code></td><td></td><td>If set, dumps the Helm values that IstioControlPlaceSpec is translated to before manifests are rendered</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-profile-list>istioctl profile list</h2><p>The list subcommand lists the available Istio configuration profiles.</p><pre class=language-bash><code>istioctl profile list [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--dry-run</code></td><td></td><td>Console/log output only, make no changes.</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--logtostderr</code></td><td></td><td>Send logs to stderr.</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--verbose</code></td><td></td><td>Verbose output.</td></tr></tbody></table><h2 id=istioctl-proxy-config>istioctl proxy-config</h2><p>A group of commands used to retrieve information about proxy configuration from the Envoy config dump</p><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr></tbody></table><h3 id="istioctl-proxy-config Examples">Examples</h3><pre class=language-bash><code> # Retrieve information about proxy configuration from an Envoy instance.
|
||
istioctl proxy-config <clusters|listeners|routes|endpoints|bootstrap> <pod-name[.namespace]>
|
||
</code></pre><h2 id=istioctl-proxy-config-bootstrap>istioctl proxy-config bootstrap</h2><p>Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config bootstrap [<pod-name[.namespace]>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config b [<pod-name[.namespace]>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr></tbody></table><h3 id="istioctl-proxy-config-bootstrap Examples">Examples</h3><pre class=language-bash><code> # Retrieve full bootstrap configuration for a given pod from Envoy.
|
||
istioctl proxy-config bootstrap <pod-name[.namespace]>
|
||
|
||
# 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
|
||
|
||
</code></pre><h2 id=istioctl-proxy-config-cluster>istioctl proxy-config cluster</h2><p>Retrieve information about cluster configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config cluster [<pod-name[.namespace]>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config clusters [<pod-name[.namespace]>] [flags]
|
||
istioctl proxy-config c [<pod-name[.namespace]>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--direction <string></code></td><td></td><td>Filter clusters by Direction field (default ``)</td></tr><tr><td><code>--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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter clusters by Port field (default `0`)</td></tr><tr><td><code>--subset <string></code></td><td></td><td>Filter clusters by substring of Subset field (default ``)</td></tr></tbody></table><h3 id="istioctl-proxy-config-cluster Examples">Examples</h3><pre class=language-bash><code> # Retrieve summary about cluster configuration for a given pod from Envoy.
|
||
istioctl proxy-config clusters <pod-name[.namespace]>
|
||
|
||
# Retrieve cluster summary for clusters with port 9080.
|
||
istioctl proxy-config clusters <pod-name[.namespace]> --port 9080
|
||
|
||
# Retrieve full cluster dump for clusters that are inbound with a FQDN of details.default.svc.cluster.local.
|
||
istioctl proxy-config clusters <pod-name[.namespace]> --fqdn details.default.svc.cluster.local --direction inbound -o json
|
||
|
||
# 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><h2 id=istioctl-proxy-config-endpoint>istioctl proxy-config endpoint</h2><p>Retrieve information about endpoint configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config endpoint [<pod-name[.namespace]>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config endpoints [<pod-name[.namespace]>] [flags]
|
||
istioctl proxy-config ep [<pod-name[.namespace]>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <string></code></td><td></td><td>Filter endpoints by address field (default ``)</td></tr><tr><td><code>--cluster <string></code></td><td></td><td>Filter endpoints by cluster name field (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter endpoints by Port field (default `0`)</td></tr><tr><td><code>--status <string></code></td><td></td><td>Filter endpoints by status field (default ``)</td></tr></tbody></table><h3 id="istioctl-proxy-config-endpoint Examples">Examples</h3><pre class=language-bash><code> # Retrieve full endpoint configuration for a given pod from Envoy.
|
||
istioctl proxy-config endpoint <pod-name[.namespace]>
|
||
|
||
# Retrieve endpoint summary for endpoint with port 9080.
|
||
istioctl proxy-config endpoint <pod-name[.namespace]> --port 9080
|
||
|
||
# Retrieve full endpoint with a address (172.17.0.2).
|
||
istioctl proxy-config endpoint <pod-name[.namespace]> --address 172.17.0.2 -o json
|
||
|
||
# Retrieve full endpoint with a cluster name (outbound|9411||zipkin.istio-system.svc.cluster.local).
|
||
istioctl proxy-config endpoint <pod-name[.namespace]> --cluster "outbound|9411||zipkin.istio-system.svc.cluster.local" -o json
|
||
# Retrieve full endpoint with the status (healthy).
|
||
istioctl proxy-config endpoint <pod-name[.namespace]> --status healthy -ojson
|
||
|
||
# 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><h2 id=istioctl-proxy-config-listener>istioctl proxy-config listener</h2><p>Retrieve information about listener configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config listener [<pod-name[.namespace]>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config listeners [<pod-name[.namespace]>] [flags]
|
||
istioctl proxy-config l [<pod-name[.namespace]>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--address <string></code></td><td></td><td>Filter listeners by address field (default ``)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr><tr><td><code>--port <int></code></td><td></td><td>Filter listeners by Port field (default `0`)</td></tr><tr><td><code>--type <string></code></td><td></td><td>Filter listeners by type field (default ``)</td></tr></tbody></table><h3 id="istioctl-proxy-config-listener Examples">Examples</h3><pre class=language-bash><code> # Retrieve summary about listener configuration for a given pod from Envoy.
|
||
istioctl proxy-config listeners <pod-name[.namespace]>
|
||
|
||
# Retrieve listener summary for listeners with port 9080.
|
||
istioctl proxy-config listeners <pod-name[.namespace]> --port 9080
|
||
|
||
# Retrieve full listener dump for HTTP listeners with a wildcard address (0.0.0.0).
|
||
istioctl proxy-config listeners <pod-name[.namespace]> --type HTTP --address 0.0.0.0 -o json
|
||
|
||
# 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><h2 id=istioctl-proxy-config-log>istioctl proxy-config log</h2><p>(experimental) Retrieve information about logging levels of the Envoy instance in the specified pod, and update optionally</p><pre class=language-bash><code>istioctl proxy-config log <pod-name[.namespace]> [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config o <pod-name[.namespace]> [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--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>,... where logger can be one of admin, aws, assert, backtrace, client, config, connection, conn_handler, dubbo, file, filter, forward_proxy, grpc, hc, health_checker, http, http2, hystrix, init, io, jwt, kafka, lua, main, misc, mongo, quic, pool, rbac, redis, router, runtime, stats, secret, tap, testing, thrift, tracing, upstream, udp, wasm and level can be one of [trace, debug, info, warning, error, critical, off] (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr><tr><td><code>--reset</code></td><td><code>-r</code></td><td>Reset levels to default value (warning).</td></tr></tbody></table><h3 id="istioctl-proxy-config-log Examples">Examples</h3><pre class=language-bash><code> # Retrieve information about logging levels for a given pod from Envoy.
|
||
istioctl proxy-config log <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><h2 id=istioctl-proxy-config-route>istioctl proxy-config route</h2><p>Retrieve information about route configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config route [<pod-name[.namespace]>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config routes [<pod-name[.namespace]>] [flags]
|
||
istioctl proxy-config r [<pod-name[.namespace]>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--name <string></code></td><td></td><td>Filter listeners by route name field (default ``)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr></tbody></table><h3 id="istioctl-proxy-config-route Examples">Examples</h3><pre class=language-bash><code> # Retrieve summary about route configuration for a given pod from Envoy.
|
||
istioctl proxy-config routes <pod-name[.namespace]>
|
||
|
||
# Retrieve route summary for route 9080.
|
||
istioctl proxy-config route <pod-name[.namespace]> --name 9080
|
||
|
||
# Retrieve full route dump for route 9080
|
||
istioctl proxy-config route <pod-name[.namespace]> --name 9080 -o json
|
||
|
||
# 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><h2 id=istioctl-proxy-config-secret>istioctl proxy-config secret</h2><p>(experimental) Retrieve information about secret configuration for the Envoy instance in the specified pod.</p><pre class=language-bash><code>istioctl proxy-config secret [<pod-name[.namespace]>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl proxy-config s [<pod-name[.namespace]>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--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>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>Output format: one of json|short (default `short`)</td></tr></tbody></table><h3 id="istioctl-proxy-config-secret Examples">Examples</h3><pre class=language-bash><code> # Retrieve full secret configuration for a given pod from Envoy.
|
||
istioctl proxy-config secret <pod-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
|
||
|
||
THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
|
||
|
||
</code></pre><h2 id=istioctl-proxy-status>istioctl proxy-status</h2><p>Retrieves last sent and last acknowledged xDS sync from Pilot to each Envoy in the mesh</p><p></p><pre class=language-bash><code>istioctl proxy-status [<pod-name[.namespace]>] [flags]
|
||
</code></pre><div class=aliases><pre class=language-bash><code>istioctl ps [<pod-name[.namespace]>] [flags]
|
||
</code></pre></div><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--sds</code></td><td><code>-s</code></td><td>(experimental) Retrieve synchronization between active secrets on Envoy instance with those on corresponding node agents</td></tr><tr><td><code>--sds-json</code></td><td></td><td>Determines whether SDS dump outputs JSON</td></tr></tbody></table><h3 id="istioctl-proxy-status Examples">Examples</h3><pre class=language-bash><code># Retrieve sync status for all Envoys in a mesh
|
||
istioctl proxy-status
|
||
|
||
# Retrieve sync diff for a single Envoy and Pilot
|
||
istioctl proxy-status istio-egressgateway-59585c5b9c-ndc59.istio-system
|
||
|
||
</code></pre><h2 id=istioctl-register>istioctl register</h2><p>Registers a service instance (e.g. VM) joining the mesh</p><pre class=language-bash><code>istioctl register <svcname> <ip> [name1:]port1 [name2:]port2 ... [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--annotations <stringSlice></code></td><td><code>-a</code></td><td>List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,test,x=y (default `[]`)</td></tr><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--labels <stringSlice></code></td><td><code>-l</code></td><td>List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--serviceaccount <string></code></td><td><code>-s</code></td><td>Service account to link to the service (default `default`)</td></tr></tbody></table><h2 id=istioctl-validate>istioctl validate</h2><p>Validate Istio policy and rules (NOTE: validate is deprecated and will be removed in 1.6. Use 'istioctl analyze' to validate configuration.)</p><pre class=language-bash><code>istioctl validate -f FILENAME [options] [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--filename <stringSlice></code></td><td><code>-f</code></td><td>Names of files to validate (default `[]`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--referential</code></td><td><code>-x</code></td><td>Enable structural validation for policy and telemetry</td></tr></tbody></table><h3 id="istioctl-validate Examples">Examples</h3><pre class=language-bash><code>
|
||
# Validate bookinfo-gateway.yaml
|
||
istioctl validate -f bookinfo-gateway.yaml
|
||
|
||
# Validate current deployments under 'default' namespace within the cluster
|
||
kubectl get deployments -o yaml |istioctl validate -f -
|
||
|
||
# Validate current services under 'default' namespace within the cluster
|
||
kubectl get services -o yaml |istioctl validate -f -
|
||
|
||
# Also see the related command 'istioctl analyze'
|
||
istioctl analyze samples/bookinfo/networking/bookinfo-gateway.yaml
|
||
|
||
</code></pre><h2 id=istioctl-verify-install>istioctl verify-install</h2><p>verify-install verifies Istio installation status against the installation file
|
||
you specified when you installed Istio. It loops through all the installation
|
||
resources defined in your installation file and reports whether all of them are
|
||
in ready status. It will report failure when any of them are not ready.</p><p>If you do not specify installation file it will perform pre-check for your cluster
|
||
and report whether the cluster is ready for Istio installation.</p><pre class=language-bash><code>istioctl verify-install [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--enableVerbose</code></td><td></td><td>Enable verbose output</td></tr><tr><td><code>--filename <stringSlice></code></td><td><code>-f</code></td><td>Istio YAML installation file. (default `[]`)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--recursive</code></td><td><code>-R</code></td><td>Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.</td></tr></tbody></table><h3 id="istioctl-verify-install Examples">Examples</h3><pre class=language-bash><code>
|
||
# Verify that Istio can be freshly installed
|
||
istioctl verify-install
|
||
|
||
# Verify the deployment matches a custom Istio deployment configuration
|
||
istioctl verify-install -f $HOME/istio.yaml
|
||
|
||
</code></pre><h2 id=istioctl-version>istioctl version</h2><p>Prints out build version information</p><pre class=language-bash><code>istioctl version [flags]
|
||
</code></pre><table class=command-flags><thead><tr><th>Flags</th><th>Shorthand</th><th>Description</th></tr></thead><tbody><tr><td><code>--context <string></code></td><td></td><td>The name of the kubeconfig context to use (default ``)</td></tr><tr><td><code>--istioNamespace <string></code></td><td><code>-i</code></td><td>Istio system namespace (default `istio-system`)</td></tr><tr><td><code>--kubeconfig <string></code></td><td><code>-c</code></td><td>Kubernetes configuration file (default ``)</td></tr><tr><td><code>--log_output_level <string></code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [ads, all, analysis, attributes, authn, cacheLog, citadelClientLog, configMapController, conversions, default, googleCAClientLog, grpcAdapter, kube, kube-converter, mcp, meshconfig, model, patch, processing, rbac, resource, runtime, sdsServiceLog, secretFetcherLog, source, stsClientLog, tpath, translator, util, validation, vaultClientLog] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info,validation:error,processing:error,source:error,analysis:warn`)</td></tr><tr><td><code>--namespace <string></code></td><td><code>-n</code></td><td>Config namespace (default ``)</td></tr><tr><td><code>--output <string></code></td><td><code>-o</code></td><td>One of 'yaml' or 'json'. (default ``)</td></tr><tr><td><code>--remote</code></td><td></td><td>Use --remote=false to suppress control plane check</td></tr><tr><td><code>--short</code></td><td><code>-s</code></td><td>Use --short=false to generate full version information</td></tr></tbody></table><h2 id=envvars>Environment variables</h2>These environment variables affect the behavior of the <code>istioctl</code> command.<table class=envvars><thead><tr><th>Variable Name</th><th>Type</th><th>Default Value</th><th>Description</th></tr></thead><tbody><tr><td><code>BYPASS_OOP_MTLS_SAN_VERIFICATION</code></td><td>Boolean</td><td><code>false</code></td><td>Whether or not to validate SANs for out-of-process adapters auth.</td></tr><tr><td><code>GKE_CLUSTER_URL</code></td><td>String</td><td><code></code></td><td>The url of GKE cluster</td></tr><tr><td><code>INGRESS_GATEWAY_FALLBACK_SECRET</code></td><td>String</td><td><code>gateway-fallback</code></td><td></td></tr><tr><td><code>INGRESS_GATEWAY_NAMESPACE</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>ISTIOD_ADDR</code></td><td>String</td><td><code></code></td><td>Service name of istiod. If empty the istiod listener, certs will be disabled.</td></tr><tr><td><code>ISTIO_GPRC_MAXSTREAMS</code></td><td>Integer</td><td><code>100000</code></td><td>Sets the maximum number of concurrent grpc streams.</td></tr><tr><td><code>ISTIO_LANG</code></td><td>String</td><td><code></code></td><td>Selects the attribute expression language runtime for Mixer.</td></tr><tr><td><code>K8S_INGRESS_NS</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>NAMESPACE</code></td><td>String</td><td><code>istio-system</code></td><td>namespace that nodeagent/citadel run in</td></tr><tr><td><code>PILOT_BLOCK_HTTP_ON_443</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, any HTTP services will be blocked on HTTPS port (443). If this is disabled, any HTTP service on port 443 could block all external traffic</td></tr><tr><td><code>PILOT_CERT_DIR</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>PILOT_DEBOUNCE_AFTER</code></td><td>Time Duration</td><td><code>100ms</code></td><td>The delay added to config/registry events for debouncing. This will delay the push by at least this internal. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX.</td></tr><tr><td><code>PILOT_DEBOUNCE_MAX</code></td><td>Time Duration</td><td><code>10s</code></td><td>The maximum amount of time to wait for events while debouncing. If events keep showing up with no breaks for this time, we'll trigger a push.</td></tr><tr><td><code>PILOT_DEBUG_ADSZ_CONFIG</code></td><td>Boolean</td><td><code>false</code></td><td></td></tr><tr><td><code>PILOT_DISABLE_XDS_MARSHALING_TO_ANY</code></td><td>Boolean</td><td><code>false</code></td><td></td></tr><tr><td><code>PILOT_DISTRIBUTION_HISTORY_RETENTION</code></td><td>Time Duration</td><td><code>1m0s</code></td><td>If enabled, Pilot will keep track of old versions of distributed config for this duration.</td></tr><tr><td><code>PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, Pilot will assign meaningful nonces to each Envoy configuration message, and allow users to interrogate which envoy has which config from the debug interface.</td></tr><tr><td><code>PILOT_ENABLE_CRD_VALIDATION</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, pilot will validate CRDs while retrieving CRDs from kubernetes cache.Use this flag to enable validation of CRDs in Pilot, especially in deployments that do not have galley installed.</td></tr><tr><td><code>PILOT_ENABLE_EDS_DEBOUNCE</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, Pilot will include EDS pushes in the push debouncing, configured by PILOT_DEBOUNCE_AFTER and PILOT_DEBOUNCE_MAX. EDS pushes may be delayed, but there will be fewer pushes. By default this is enabled</td></tr><tr><td><code>PILOT_ENABLE_FALLTHROUGH_ROUTE</code></td><td>Boolean</td><td><code>true</code></td><td>EnableFallthroughRoute provides an option to add a final wildcard match for routes. When ALLOW_ANY traffic policy is used, a Passthrough cluster is used. When REGISTRY_ONLY traffic policy is used, a 502 error is returned.</td></tr><tr><td><code>PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERS</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.</td></tr><tr><td><code>PILOT_ENABLE_MYSQL_FILTER</code></td><td>Boolean</td><td><code>false</code></td><td>EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain.</td></tr><tr><td><code>PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUND</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, protocol sniffing will be used for inbound listeners whose port protocol is not specified or unsupported</td></tr><tr><td><code>PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_OUTBOUND</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, protocol sniffing will be used for outbound listeners whose port protocol is not specified or unsupported</td></tr><tr><td><code>PILOT_ENABLE_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_UNSAFE_REGEX</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, pilot will generate Envoy configuration that does not use safe_regex but the older, deprecated regex field. This should only be enabled to support legacy deployments that have not yet been migrated to the new safe regular expressions.</td></tr><tr><td><code>PILOT_HTTP10</code></td><td>Boolean</td><td><code>false</code></td><td>Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.</td></tr><tr><td><code>PILOT_INBOUND_PROTOCOL_DETECTION_TIMEOUT</code></td><td>Time Duration</td><td><code>1s</code></td><td>Protocol detection timeout for inbound listener</td></tr><tr><td><code>PILOT_INITIAL_FETCH_TIMEOUT</code></td><td>Time Duration</td><td><code>0s</code></td><td>Specifies the initial_fetch_timeout for config. If this time is reached without a response to the config requested by Envoy, the Envoy will move on with the init phase. This prevents envoy from getting stuck waiting on config during startup.</td></tr><tr><td><code>PILOT_PUSH_THROTTLE</code></td><td>Integer</td><td><code>100</code></td><td>Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes</td></tr><tr><td><code>PILOT_RESPECT_DNS_TTL</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, DNS based clusters will respect the TTL of the DNS, rather than polling at a fixed rate. This option is only provided for backward compatibility purposes and will be removed in the near future.</td></tr><tr><td><code>PILOT_RESTRICT_POD_UP_TRAFFIC_LOOP</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, this will block inbound traffic from matching outbound listeners, which could result in an infinite loop of traffic. This option is only provided for backward compatibility purposes and will be removed in the near future.</td></tr><tr><td><code>PILOT_SCOPE_GATEWAY_TO_NAMESPACE</code></td><td>Boolean</td><td><code>false</code></td><td>If enabled, a gateway workload can only select gateway resources in the same namespace. Gateways with same selectors in different namespaces will not be applicable.</td></tr><tr><td><code>PILOT_SCOPE_PUSHES</code></td><td>Boolean</td><td><code>true</code></td><td>If enabled, pilot will attempt to limit unnecessary pushes by determining what proxies a config or endpoint update will impact.</td></tr><tr><td><code>PILOT_SIDECAR_USE_REMOTE_ADDRESS</code></td><td>Boolean</td><td><code>false</code></td><td>UseRemoteAddress sets useRemoteAddress to true for side car outbound listeners.</td></tr><tr><td><code>PILOT_SKIP_VALIDATE_TRUST_DOMAIN</code></td><td>Boolean</td><td><code>false</code></td><td>Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy</td></tr><tr><td><code>PILOT_TRACE_SAMPLING</code></td><td>Floating-Point</td><td><code>100</code></td><td>Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 100, not recommended for production use.</td></tr><tr><td><code>POD_NAME</code></td><td>String</td><td><code></code></td><td></td></tr><tr><td><code>SECRET_WATCHER_RESYNC_PERIOD</code></td><td>String</td><td><code></code></td><td></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>TERMINATION_DRAIN_DURATION_SECONDS</code></td><td>Integer</td><td><code>5</code></td><td>The amount of time allowed for connections to complete on pilot-agent shutdown. On receiving SIGTERM or SIGINT, pilot-agent tells the active Envoy to start draining, preventing any new connections and allowing existing connections to complete. It then sleeps for the TerminationDrainDuration and then kills any remaining active Envoy processes.</td></tr><tr><td><code>USE_ISTIO_JWT_FILTER</code></td><td>Boolean</td><td><code>false</code></td><td>Use the Istio JWT filter for JWT token verification.</td></tr></tbody></table><h2 id=metrics>Exported metrics</h2><table class=metrics><thead><tr><th>Metric Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>endpoint_no_pod</code></td><td><code>LastValue</code></td><td>Endpoints without an associated pod.</td></tr><tr><td><code>galley_runtime_processor_event_span_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration between each incoming event</td></tr><tr><td><code>galley_runtime_processor_events_processed_total</code></td><td><code>Count</code></td><td>The number of events that have been processed</td></tr><tr><td><code>galley_runtime_processor_snapshot_events_total</code></td><td><code>Distribution</code></td><td>The number of events per snapshot</td></tr><tr><td><code>galley_runtime_processor_snapshot_lifetime_duration_milliseconds</code></td><td><code>Distribution</code></td><td>The duration of each snapshot</td></tr><tr><td><code>galley_runtime_processor_snapshots_published_total</code></td><td><code>Count</code></td><td>The number of snapshots that have been published</td></tr><tr><td><code>galley_runtime_state_type_instances_total</code></td><td><code>LastValue</code></td><td>The number of type instances per type URL</td></tr><tr><td><code>galley_runtime_strategy_on_change_total</code></td><td><code>Count</code></td><td>The number of times the strategy's onChange has been called</td></tr><tr><td><code>galley_runtime_strategy_timer_max_time_reached_total</code></td><td><code>Count</code></td><td>The number of times the max time has been reached</td></tr><tr><td><code>galley_runtime_strategy_timer_quiesce_reached_total</code></td><td><code>Count</code></td><td>The number of times a quiesce has been reached</td></tr><tr><td><code>galley_runtime_strategy_timer_resets_total</code></td><td><code>Count</code></td><td>The number of times the timer has been reset</td></tr><tr><td><code>galley_source_kube_dynamic_converter_failure_total</code></td><td><code>Count</code></td><td>The number of times a dynamnic kubernetes source failed converting a resources</td></tr><tr><td><code>galley_source_kube_dynamic_converter_success_total</code></td><td><code>Count</code></td><td>The number of times a dynamic kubernetes source successfully converted a resource</td></tr><tr><td><code>galley_source_kube_event_error_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source encountered errored while handling an event</td></tr><tr><td><code>galley_source_kube_event_success_total</code></td><td><code>Count</code></td><td>The number of times a kubernetes source successfully handled an event</td></tr><tr><td><code>istio_build</code></td><td><code>LastValue</code></td><td>Istio component build info</td></tr><tr><td><code>istio_mcp_clients_total</code></td><td><code>LastValue</code></td><td>The number of streams currently connected.</td></tr><tr><td><code>istio_mcp_message_sizes_bytes</code></td><td><code>Distribution</code></td><td>Size of messages received from clients.</td></tr><tr><td><code>istio_mcp_reconnections</code></td><td><code>Sum</code></td><td>The number of times the sink has reconnected.</td></tr><tr><td><code>istio_mcp_recv_failures_total</code></td><td><code>Sum</code></td><td>The number of recv failures in the source.</td></tr><tr><td><code>istio_mcp_request_acks_total</code></td><td><code>Sum</code></td><td>The number of request acks received by the source.</td></tr><tr><td><code>istio_mcp_request_nacks_total</code></td><td><code>Sum</code></td><td>The number of request nacks received by the source.</td></tr><tr><td><code>istio_mcp_send_failures_total</code></td><td><code>Sum</code></td><td>The number of send failures in the source.</td></tr><tr><td><code>mixer_config_adapter_info_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the adapter info configuration.</td></tr><tr><td><code>mixer_config_adapter_info_configs_total</code></td><td><code>LastValue</code></td><td>The number of known adapters in the current config.</td></tr><tr><td><code>mixer_config_attributes_total</code></td><td><code>LastValue</code></td><td>The number of known attributes in the current config.</td></tr><tr><td><code>mixer_config_handler_configs_total</code></td><td><code>LastValue</code></td><td>The number of known handlers in the current config.</td></tr><tr><td><code>mixer_config_handler_validation_error_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered because handler validation returned error.</td></tr><tr><td><code>mixer_config_instance_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the instance configuration.</td></tr><tr><td><code>mixer_config_instance_configs_total</code></td><td><code>LastValue</code></td><td>The number of known instances in the current config.</td></tr><tr><td><code>mixer_config_rule_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the rule configuration.</td></tr><tr><td><code>mixer_config_rule_config_match_error_total</code></td><td><code>LastValue</code></td><td>The number of rule conditions that was not parseable.</td></tr><tr><td><code>mixer_config_rule_configs_total</code></td><td><code>LastValue</code></td><td>The number of known rules in the current config.</td></tr><tr><td><code>mixer_config_template_config_errors_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered during processing of the template configuration.</td></tr><tr><td><code>mixer_config_template_configs_total</code></td><td><code>LastValue</code></td><td>The number of known templates in the current config.</td></tr><tr><td><code>mixer_config_unsatisfied_action_handler_total</code></td><td><code>LastValue</code></td><td>The number of actions that failed due to handlers being unavailable.</td></tr><tr><td><code>mixer_dispatcher_destinations_per_request</code></td><td><code>Distribution</code></td><td>Number of handlers dispatched per request by Mixer</td></tr><tr><td><code>mixer_dispatcher_destinations_per_variety_total</code></td><td><code>LastValue</code></td><td>Number of Mixer adapter destinations by template variety type</td></tr><tr><td><code>mixer_dispatcher_instances_per_request</code></td><td><code>Distribution</code></td><td>Number of instances created per request by Mixer</td></tr><tr><td><code>mixer_handler_closed_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were closed during config transition.</td></tr><tr><td><code>mixer_handler_daemons_total</code></td><td><code>LastValue</code></td><td>The current number of active daemon routines in a given adapter environment.</td></tr><tr><td><code>mixer_handler_handler_build_failures_total</code></td><td><code>LastValue</code></td><td>The number of handlers that failed creation during config transition.</td></tr><tr><td><code>mixer_handler_handler_close_failures_total</code></td><td><code>LastValue</code></td><td>The number of errors encountered while closing handlers during config transition.</td></tr><tr><td><code>mixer_handler_new_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were newly created during config transition.</td></tr><tr><td><code>mixer_handler_reused_handlers_total</code></td><td><code>LastValue</code></td><td>The number of handlers that were re-used during config transition.</td></tr><tr><td><code>mixer_handler_workers_total</code></td><td><code>LastValue</code></td><td>The current number of active worker routines in a given adapter environment.</td></tr><tr><td><code>mixer_runtime_dispatch_duration_seconds</code></td><td><code>Distribution</code></td><td>Duration in seconds for adapter dispatches handled by Mixer.</td></tr><tr><td><code>mixer_runtime_dispatches_total</code></td><td><code>Count</code></td><td>Total number of adapter dispatches handled by Mixer.</td></tr><tr><td><code>num_failed_outgoing_requests</code></td><td><code>Sum</code></td><td>Number of failed outgoing requests (e.g. to a token exchange server, CA, etc.)</td></tr><tr><td><code>num_outgoing_requests</code></td><td><code>Sum</code></td><td>Number of total outgoing requests (e.g. to a token exchange server, CA, etc.)</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>outgoing_latency</code></td><td><code>Sum</code></td><td>The latency of outgoing requests (e.g. to a token exchange server, CA, etc.) in milliseconds.</td></tr><tr><td><code>pilot_conflict_inbound_listener</code></td><td><code>LastValue</code></td><td>Number of conflicting inbound listeners.</td></tr><tr><td><code>pilot_conflict_outbound_listener_http_over_current_tcp</code></td><td><code>LastValue</code></td><td>Number of conflicting wildcard http listeners with current wildcard tcp listener.</td></tr><tr><td><code>pilot_conflict_outbound_listener_http_over_https</code></td><td><code>LastValue</code></td><td>Number of conflicting HTTP listeners with well known HTTPS ports</td></tr><tr><td><code>pilot_conflict_outbound_listener_tcp_over_current_http</code></td><td><code>LastValue</code></td><td>Number of conflicting wildcard tcp listeners with current wildcard http listener.</td></tr><tr><td><code>pilot_conflict_outbound_listener_tcp_over_current_tcp</code></td><td><code>LastValue</code></td><td>Number of conflicting tcp listeners with current tcp listener.</td></tr><tr><td><code>pilot_destrule_subsets</code></td><td><code>LastValue</code></td><td>Duplicate subsets across destination rules for same host</td></tr><tr><td><code>pilot_duplicate_envoy_clusters</code></td><td><code>LastValue</code></td><td>Duplicate envoy clusters caused by service entries with same hostname</td></tr><tr><td><code>pilot_eds_no_instances</code></td><td><code>LastValue</code></td><td>Number of clusters without instances.</td></tr><tr><td><code>pilot_endpoint_not_ready</code></td><td><code>LastValue</code></td><td>Endpoint found in unready state.</td></tr><tr><td><code>pilot_inbound_updates</code></td><td><code>Sum</code></td><td>Total number of updates received by pilot.</td></tr><tr><td><code>pilot_invalid_out_listeners</code></td><td><code>LastValue</code></td><td>Number of invalid outbound listeners.</td></tr><tr><td><code>pilot_jwks_resolver_network_fetch_fail_total</code></td><td><code>Sum</code></td><td>Total number of failed network fetch by pilot jwks resolver</td></tr><tr><td><code>pilot_jwks_resolver_network_fetch_success_total</code></td><td><code>Sum</code></td><td>Total number of successfully network fetch by pilot jwks resolver</td></tr><tr><td><code>pilot_k8s_cfg_events</code></td><td><code>Sum</code></td><td>Events from k8s config.</td></tr><tr><td><code>pilot_k8s_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_object_errors</code></td><td><code>LastValue</code></td><td>Errors converting k8s CRDs</td></tr><tr><td><code>pilot_k8s_reg_events</code></td><td><code>Sum</code></td><td>Events from k8s registry.</td></tr><tr><td><code>pilot_no_ip</code></td><td><code>LastValue</code></td><td>Pods not found in the endpoint table, possibly invalid.</td></tr><tr><td><code>pilot_proxy_convergence_time</code></td><td><code>Distribution</code></td><td>Delay 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_rds_expired_nonce</code></td><td><code>Sum</code></td><td>Total number of RDS messages with an expired nonce.</td></tr><tr><td><code>pilot_services</code></td><td><code>LastValue</code></td><td>Total services known to pilot.</td></tr><tr><td><code>pilot_total_rejected_configs</code></td><td><code>Sum</code></td><td>Total number of configs that Pilot had to reject or ignore.</td></tr><tr><td><code>pilot_total_xds_internal_errors</code></td><td><code>Sum</code></td><td>Total number of internal XDS errors in pilot.</td></tr><tr><td><code>pilot_total_xds_rejects</code></td><td><code>Sum</code></td><td>Total number of XDS responses from pilot rejected by proxy.</td></tr><tr><td><code>pilot_virt_services</code></td><td><code>LastValue</code></td><td>Total virtual services known to pilot.</td></tr><tr><td><code>pilot_vservice_dup_domain</code></td><td><code>LastValue</code></td><td>Virtual services with dup domains.</td></tr><tr><td><code>pilot_xds</code></td><td><code>LastValue</code></td><td>Number of endpoints connected to this pilot using XDS.</td></tr><tr><td><code>pilot_xds_cds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected CDS configs.</td></tr><tr><td><code>pilot_xds_eds_all_locality_endpoints</code></td><td><code>LastValue</code></td><td>Network endpoints for each cluster(across all localities), as of last push. Zero endpoints is an error.</td></tr><tr><td><code>pilot_xds_eds_instances</code></td><td><code>LastValue</code></td><td>Instances for each cluster(grouped by locality), as of last push. Zero instances is an error.</td></tr><tr><td><code>pilot_xds_eds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected EDS.</td></tr><tr><td><code>pilot_xds_lds_reject</code></td><td><code>LastValue</code></td><td>Pilot rejected LDS.</td></tr><tr><td><code>pilot_xds_push_context_errors</code></td><td><code>Sum</code></td><td>Number of errors (timeouts) initiating push context.</td></tr><tr><td><code>pilot_xds_push_time</code></td><td><code>Distribution</code></td><td>Total time in 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_write_timeout</code></td><td><code>Sum</code></td><td>Pilot XDS response write timeouts.</td></tr><tr><td><code>sidecar_injection_failure_total</code></td><td><code>Sum</code></td><td>Total number of failed Side car injection requests.</td></tr><tr><td><code>sidecar_injection_requests_total</code></td><td><code>Sum</code></td><td>Total number of Side car injection requests.</td></tr><tr><td><code>sidecar_injection_skip_total</code></td><td><code>Sum</code></td><td>Total number of skipped injection requests.</td></tr><tr><td><code>sidecar_injection_success_total</code></td><td><code>Sum</code></td><td>Total number of successful Side car injection requests.</td></tr><tr><td><code>total_active_connections</code></td><td><code>Sum</code></td><td>The total number of active SDS connections.</td></tr><tr><td><code>total_push_errors</code></td><td><code>Sum</code></td><td>The total number of failed SDS pushes.</td></tr><tr><td><code>total_pushes</code></td><td><code>Sum</code></td><td>The total number of SDS pushes.</td></tr><tr><td><code>total_secret_update_failures</code></td><td><code>Sum</code></td><td>The total number of dynamic secret update failures reported by proxy.</td></tr><tr><td><code>total_stale_connections</code></td><td><code>Sum</code></td><td>The total number of stale SDS connections.</td></tr></tbody></table></article><nav class=pagenav><div class=left><a title="Istio Certificate Authority (CA)." href=/v1.9/zh/docs/reference/commands/istio_ca/><svg class="icon left-arrow"><use xlink:href="/v1.9/img/icons.svg#left-arrow"/></svg>istio_ca</a></div><div class=right><a title="Mixer is Istio's abstraction on top of infrastructure backends." href=/v1.9/zh/docs/reference/commands/mixs/>mixs<svg class="icon right-arrow"><use xlink:href="/v1.9/img/icons.svg#right-arrow"/></svg></a></div></nav><div id=feedback><div id=feedback-initial>这些信息有用吗?<br><button class="btn feedback" onclick="sendFeedback('zh',1)">是的</button>
|
||
<button class="btn feedback" onclick="sendFeedback('zh',0)">没有</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=zh></div><div id=feedback-thankyou>Thanks for your feedback!</div></div><div id=endnotes-container aria-hidden=true><h2>链接</h2><ol id=endnotes></ol></div></div><div class=toc-container><nav class=toc aria-label="Table of Contents"><div id=toc><ol><li role=none aria-label="istioctl analyze"><a href=#istioctl-analyze>analyze</a><li role=none aria-label="istioctl authn"><a href=#istioctl-authn>authn</a><li role=none aria-label="istioctl authn tls-check"><a href=#istioctl-authn-tls-check>authn tls-check</a><li role=none aria-label="istioctl authz"><a href=#istioctl-authz>authz</a><li role=none aria-label="istioctl convert-ingress"><a href=#istioctl-convert-ingress>convert-ingress</a><li role=none aria-label="istioctl dashboard"><a href=#istioctl-dashboard>dashboard</a><li role=none aria-label="istioctl dashboard controlz"><a href=#istioctl-dashboard-controlz>dashboard controlz</a><li role=none aria-label="istioctl dashboard envoy"><a href=#istioctl-dashboard-envoy>dashboard envoy</a><li role=none aria-label="istioctl dashboard grafana"><a href=#istioctl-dashboard-grafana>dashboard grafana</a><li role=none aria-label="istioctl dashboard jaeger"><a href=#istioctl-dashboard-jaeger>dashboard jaeger</a><li role=none aria-label="istioctl dashboard kiali"><a href=#istioctl-dashboard-kiali>dashboard kiali</a><li role=none aria-label="istioctl dashboard prometheus"><a href=#istioctl-dashboard-prometheus>dashboard prometheus</a><li role=none aria-label="istioctl dashboard zipkin"><a href=#istioctl-dashboard-zipkin>dashboard zipkin</a><li role=none aria-label="istioctl deregister"><a href=#istioctl-deregister>deregister</a><li role=none aria-label="istioctl experimental"><a href=#istioctl-experimental>experimental</a><li role=none aria-label="istioctl experimental add-to-mesh"><a href=#istioctl-experimental-add-to-mesh>experimental add-to-mesh</a><li role=none aria-label="istioctl experimental add-to-mesh external-service"><a href=#istioctl-experimental-add-to-mesh-external-service>experimental add-to-mesh external-service</a><li role=none aria-label="istioctl experimental add-to-mesh service"><a href=#istioctl-experimental-add-to-mesh-service>experimental add-to-mesh service</a><li role=none aria-label="istioctl experimental analyze"><a href=#istioctl-experimental-analyze>experimental analyze</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 authz convert"><a href=#istioctl-experimental-authz-convert>experimental authz convert</a><li role=none aria-label="istioctl experimental convert-ingress"><a href=#istioctl-experimental-convert-ingress>experimental convert-ingress</a><li role=none aria-label="istioctl experimental create-remote-secret"><a href=#istioctl-experimental-create-remote-secret>experimental create-remote-secret</a><li role=none aria-label="istioctl experimental dashboard"><a href=#istioctl-experimental-dashboard>experimental dashboard</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 kube-uninject"><a href=#istioctl-experimental-kube-uninject>experimental kube-uninject</a><li role=none aria-label="istioctl experimental metrics"><a href=#istioctl-experimental-metrics>experimental metrics</a><li role=none aria-label="istioctl experimental multicluster"><a href=#istioctl-experimental-multicluster>experimental multicluster</a><li role=none aria-label="istioctl experimental multicluster apply"><a href=#istioctl-experimental-multicluster-apply>experimental multicluster apply</a><li role=none aria-label="istioctl experimental multicluster describe"><a href=#istioctl-experimental-multicluster-describe>experimental multicluster describe</a><li role=none aria-label="istioctl experimental multicluster generate"><a href=#istioctl-experimental-multicluster-generate>experimental multicluster generate</a><li role=none aria-label="istioctl experimental post-install"><a href=#istioctl-experimental-post-install>experimental post-install</a><li role=none aria-label="istioctl experimental post-install webhook"><a href=#istioctl-experimental-post-install-webhook>experimental post-install webhook</a><li role=none aria-label="istioctl experimental post-install webhook disable"><a href=#istioctl-experimental-post-install-webhook-disable>experimental post-install webhook disable</a><li role=none aria-label="istioctl experimental post-install webhook enable"><a href=#istioctl-experimental-post-install-webhook-enable>experimental post-install webhook enable</a><li role=none aria-label="istioctl experimental post-install webhook status"><a href=#istioctl-experimental-post-install-webhook-status>experimental post-install webhook status</a><li role=none aria-label="istioctl experimental remove-from-mesh"><a href=#istioctl-experimental-remove-from-mesh>experimental remove-from-mesh</a><li role=none aria-label="istioctl experimental remove-from-mesh external-service"><a href=#istioctl-experimental-remove-from-mesh-external-service>experimental remove-from-mesh external-service</a><li role=none aria-label="istioctl experimental remove-from-mesh service"><a href=#istioctl-experimental-remove-from-mesh-service>experimental remove-from-mesh service</a><li role=none aria-label="istioctl experimental upgrade"><a href=#istioctl-experimental-upgrade>experimental upgrade</a><li role=none aria-label="istioctl experimental wait"><a href=#istioctl-experimental-wait>experimental wait</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 apply"><a href=#istioctl-manifest-apply>manifest apply</a><li role=none aria-label="istioctl manifest diff"><a href=#istioctl-manifest-diff>manifest diff</a><li role=none aria-label="istioctl manifest generate"><a href=#istioctl-manifest-generate>manifest generate</a><li role=none aria-label="istioctl manifest migrate"><a href=#istioctl-manifest-migrate>manifest migrate</a><li role=none aria-label="istioctl manifest versions"><a href=#istioctl-manifest-versions>manifest versions</a><li role=none aria-label="istioctl profile"><a href=#istioctl-profile>profile</a><li role=none aria-label="istioctl profile diff"><a href=#istioctl-profile-diff>profile diff</a><li role=none aria-label="istioctl profile dump"><a href=#istioctl-profile-dump>profile dump</a><li role=none aria-label="istioctl profile list"><a href=#istioctl-profile-list>profile list</a><li role=none aria-label="istioctl proxy-config"><a href=#istioctl-proxy-config>proxy-config</a><li role=none aria-label="istioctl proxy-config bootstrap"><a href=#istioctl-proxy-config-bootstrap>proxy-config bootstrap</a><li role=none aria-label="istioctl proxy-config cluster"><a href=#istioctl-proxy-config-cluster>proxy-config cluster</a><li role=none aria-label="istioctl proxy-config endpoint"><a href=#istioctl-proxy-config-endpoint>proxy-config endpoint</a><li role=none aria-label="istioctl proxy-config listener"><a href=#istioctl-proxy-config-listener>proxy-config listener</a><li role=none aria-label="istioctl proxy-config log"><a href=#istioctl-proxy-config-log>proxy-config log</a><li role=none aria-label="istioctl proxy-config 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 register"><a href=#istioctl-register>register</a><li role=none aria-label="istioctl validate"><a href=#istioctl-validate>validate</a><li role=none aria-label="istioctl verify-install"><a href=#istioctl-verify-install>verify-install</a><li role=none aria-label="istioctl version"><a href=#istioctl-version>version</a><li role=none aria-label="Environment variables"><a href=#envvars>Environment variables</a><li role=none aria-label="Exported metrics"><a href=#metrics>Exported metrics</a></ol></div></nav></div></main><footer><div class=user-links><a class=channel title="立刻下载 Istio 1.9.5" href=/v1.9/docs/setup/getting-started/#download aria-label="Download Istio"><span>download</span><svg class="icon download"><use xlink:href="/v1.9/img/icons.svg#download"/></svg>
|
||
</a><a class=channel title="加入 Istio discussion board 参与讨论获取帮助" href=https://discuss.istio.io aria-label="Istio discussion board"><span>discuss</span><svg class="icon discourse"><use xlink:href="/v1.9/img/icons.svg#discourse"/></svg></a>
|
||
<a class=channel title="Stack Overflow 中列举了针对实际问题以及部署、配置和使用 Istio 的各项回答" href=https://stackoverflow.com/questions/tagged/istio aria-label="Stack Overflow"><span>stack overflow</span><svg class="icon stackoverflow"><use xlink:href="/v1.9/img/icons.svg#stackoverflow"/></svg></a>
|
||
<a class=channel title="在 Slack 上与 Istio 社区交互讨论开发问题(仅限邀请)" href=https://slack.istio.io aria-label=slack><span>slack</span><svg class="icon slack"><use xlink:href="/v1.9/img/icons.svg#slack"/></svg></a>
|
||
<a class=channel title="关注我们的 Twitter 来获取最新信息" href=https://twitter.com/IstioMesh aria-label=Twitter><span>twitter</span><svg class="icon twitter"><use xlink:href="/v1.9/img/icons.svg#twitter"/></svg></a><div class=tag>对于用户</div></div><div class=info><p class=copyright>中文内容由 ServiceMesher 社区维护,部分文档可能稍微滞后于英文版本,同步工作持续进行中<br>Istio 归档
|
||
1.9.5<br>© 2020 Istio Authors, <a href=https://policies.google.com/privacy>隐私政策</a><br>归档于 2021年5月18日</p></div><div class=dev-links><a class=channel title="Istio 的代码在 GitHub 上开发" href=https://github.com/istio/community aria-label=GitHub><span>github</span><svg class="icon github"><use xlink:href="/v1.9/img/icons.svg#github"/></svg></a>
|
||
<a class=channel title="如果您想深入了解 Istio 的技术细节,请查看我们日益完善的设计文档" href=https://groups.google.com/forum/#!forum/istio-team-drive-access aria-label="team drive"><span>drive</span><svg class="icon drive"><use xlink:href="/v1.9/img/icons.svg#drive"/></svg></a>
|
||
<a class=channel title="如果您想为 Istio 项目做出贡献,请考虑加入我们的工作组" href=https://github.com/istio/community/blob/master/WORKING-GROUPS.md aria-label="working groups"><span>working groups</span><svg class="icon working-groups"><use xlink:href="/v1.9/img/icons.svg#working-groups"/></svg></a><div class=tag>对于开发者</div></div></footer><div id=scroll-to-top-container aria-hidden=true><button id=scroll-to-top title=回到顶部><svg class="icon top"><use xlink:href="/v1.9/img/icons.svg#top"/></svg></button></div></body></html> |