mirror of https://github.com/istio/istio.io.git
115 lines
89 KiB
HTML
115 lines
89 KiB
HTML
<!doctype html><html lang=en itemscope itemtype=https://schema.org/WebPage><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta name=theme-color content="#466BB0"><meta name=title content="Install Istio with the Istio CNI plugin"><meta name=description content="Install and use Istio with the Istio CNI plugin, allowing operators to deploy services with lower privilege."><meta name=keywords content="microservices,services,mesh,kubernetes,cni,sidecar,proxy,network,helm"><meta property="og:title" content="Install Istio with the Istio CNI plugin"><meta property="og:type" content="website"><meta property="og:description" content="Install and use Istio with the Istio CNI plugin, allowing operators to deploy services with lower privilege."><meta property="og:url" content="/v1.5/docs/setup/additional-setup/cni/"><meta property="og:image" content="/v1.5/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.5 / Install Istio with the Istio CNI plugin</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.5/blog/feed.xml><link rel=alternate type=application/rss+xml title="Istio News" href=/v1.5/news/feed.xml><link rel=alternate type=application/rss+xml title="Istio Blog and News" href=/v1.5/feed.xml><link rel="shortcut icon" href=/v1.5/favicons/favicon.ico><link rel=apple-touch-icon href=/v1.5/favicons/apple-touch-icon-180x180.png sizes=180x180><link rel=icon type=image/png href=/v1.5/favicons/favicon-16x16.png sizes=16x16><link rel=icon type=image/png href=/v1.5/favicons/favicon-32x32.png sizes=32x32><link rel=icon type=image/png href=/v1.5/favicons/android-36x36.png sizes=36x36><link rel=icon type=image/png href=/v1.5/favicons/android-48x48.png sizes=48x48><link rel=icon type=image/png href=/v1.5/favicons/android-72x72.png sizes=72x72><link rel=icon type=image/png href=/v1.5/favicons/android-96x96.png sizes=96xW96><link rel=icon type=image/png href=/v1.5/favicons/android-144x144.png sizes=144x144><link rel=icon type=image/png href=/v1.5/favicons/android-192x192.png sizes=192x192><link rel=manifest href=/v1.5/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.5/css/all.css><script src=/v1.5/js/themes_init.min.js></script></head><body class="language-unknown archive-site"><script>const branchName="release-1.5";const docTitle="Install Istio with the Istio CNI plugin";const iconFile="\/v1.5/img/icons.svg";const buttonCopy='Copy to clipboard';const buttonPrint='Print';const buttonDownload='Download';</script><script src="https://www.google.com/cse/brand?form=search-form" defer></script><script src=/v1.5/js/all.min.js data-manual defer></script><header><nav><a id=brand href=/v1.5/><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.5</span></a><div id=hamburger><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#hamburger"/></svg></div><div id=header-links><a class=current title="Learn how to deploy, use, and operate Istio." href=/v1.5/docs/>Docs</a>
|
||
<a title="Posts about using Istio." href=/v1.5/blog/2020/>Blog<i class=dot data-prefix=/blog></i></a>
|
||
<a title="Timely news about the Istio project." href=/v1.5/news/>News<i class=dot data-prefix=/news></i></a>
|
||
<a title="Frequently Asked Questions about Istio." href=/v1.5/faq/>FAQ</a>
|
||
<a title="Get a bit more in-depth info about the Istio project." href=/v1.5/about/>About</a><div class=menu><button id=gearDropdownButton class=menu-trigger title="Options and settings" aria-label="Options and Settings" aria-controls=gearDropdownContent><svg class="icon"><use xlink:href="/v1.5/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 class=active>English</a>
|
||
<a tabindex=-1 role=menuitem lang=zh id=switch-lang-zh>中文</a><div role=separator></div><a tabindex=-1 role=menuitem class=active id=light-theme-item>Light Theme</a>
|
||
<a tabindex=-1 role=menuitem id=dark-theme-item>Dark Theme</a><div role=separator></div><a tabindex=-1 role=menuitem id=syntax-coloring-item>Color Examples</a><div role=separator></div><h6>Other versions of this site</h6><a tabindex=-1 role=menuitem onclick="navigateToUrlOrRoot('https://istio.io/docs\/setup\/additional-setup\/cni\/');return false;">Current Release</a>
|
||
<a tabindex=-1 role=menuitem onclick="navigateToUrlOrRoot('https://preliminary.istio.io/docs\/setup\/additional-setup\/cni\/');return false;">Next Release</a>
|
||
<a tabindex=-1 role=menuitem href=https://istio.io/archive>Older Releases</a></div></div><button id=search-show title="Search this site" aria-label=Search><svg class="icon"><use xlink:href="/v1.5/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.5/search>
|
||
<input id=search-textbox class=form-control name=q type=search aria-label="Search this site">
|
||
<button id=search-close title="Cancel search" type=reset aria-label="Cancel search"><svg class="icon"><use xlink:href="/v1.5/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=card24 title="Learn about the different parts of the Istio system and the abstractions it uses." aria-controls=card24-body><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#concepts"/></svg>Concepts</button><div class=body aria-labelledby=card24 role=region id=card24-body><ul role=tree aria-expanded=true class=leaf-section aria-labelledby=card24><li role=none><a role=treeitem title="Introduces Istio, the problems it solves, its high-level architecture, and its design goals." href=/v1.5/docs/concepts/what-is-istio/>What is Istio?</a></li><li role=none><a role=treeitem title="Describes the various Istio features focused on traffic routing and control." href=/v1.5/docs/concepts/traffic-management/>Traffic Management</a></li><li role=none><a role=treeitem title="Describes Istio's authorization and authentication functionality." href=/v1.5/docs/concepts/security/>Security</a></li><li role=none><a role=treeitem title="Describes the telemetry and monitoring features provided by Istio." href=/v1.5/docs/concepts/observability/>Observability</a></li><li role=none><a role=treeitem title="Describes Istio's WebAssembly Plugin system." href=/v1.5/docs/concepts/wasm/>Extensibility</a></li></ul></div></div><div class=card><button class="header dynamic" id=card47 title="Instructions for installing the Istio control plane on Kubernetes." aria-controls=card47-body><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#setup"/></svg>Setup</button><div class="body default" aria-labelledby=card47 role=region id=card47-body><ul role=tree aria-expanded=true aria-labelledby=card47><li role=none><a role=treeitem title="Try Istio’s features quickly and easily." href=/v1.5/docs/setup/getting-started/>Getting Started</a></li><li role=treeitem aria-label="Platform Setup"><button aria-hidden=true></button><a title="How to prepare various Kubernetes platforms before installing Istio." href=/v1.5/docs/setup/platform-setup/>Platform Setup</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Instructions to setup an Alibaba Cloud Kubernetes cluster for Istio." href=/v1.5/docs/setup/platform-setup/alicloud/>Alibaba Cloud</a></li><li role=none><a role=treeitem title="Instructions to setup an Azure cluster for Istio." href=/v1.5/docs/setup/platform-setup/azure/>Azure</a></li><li role=none><a role=treeitem title="Instructions to setup Docker Desktop for Istio." href=/v1.5/docs/setup/platform-setup/docker/>Docker Desktop</a></li><li role=none><a role=treeitem title="Instructions to setup a Google Kubernetes Engine cluster for Istio." href=/v1.5/docs/setup/platform-setup/gke/>Google Kubernetes Engine</a></li><li role=none><a role=treeitem title="Instructions to setup an IBM Cloud cluster for Istio." href=/v1.5/docs/setup/platform-setup/ibm/>IBM Cloud</a></li><li role=none><a role=treeitem title="Instructions to setup kind for Istio." href=/v1.5/docs/setup/platform-setup/kind/>kind</a></li><li role=none><a role=treeitem title="Instructions to setup a Gardener cluster for Istio." href=/v1.5/docs/setup/platform-setup/gardener/>Kubernetes Gardener</a></li><li role=none><a role=treeitem title="Instructions to setup a KubeSphere Container Platform for Istio." href=/v1.5/docs/setup/platform-setup/kubesphere/>KubeSphere Container Platform</a></li><li role=none><a role=treeitem title="Instructions to setup MicroK8s for use with Istio." href=/v1.5/docs/setup/platform-setup/microk8s/>MicroK8s</a></li><li role=none><a role=treeitem title="Instructions to setup minikube for Istio." href=/v1.5/docs/setup/platform-setup/minikube/>Minikube</a></li><li role=none><a role=treeitem title="Instructions to setup an OpenShift cluster for Istio." href=/v1.5/docs/setup/platform-setup/openshift/>OpenShift</a></li><li role=none><a role=treeitem title="Instructions to setup an OKE cluster for Istio." href=/v1.5/docs/setup/platform-setup/oci/>Oracle Cloud Infrastructure</a></li></ul></li><li role=treeitem aria-label=Install><button aria-hidden=true></button><a title="Choose the guide that best suits your needs and platform." href=/v1.5/docs/setup/install/>Install</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Install and customize any Istio configuration profile for in-depth evaluation or production use." href=/v1.5/docs/setup/install/istioctl/>Customizable Install with Istioctl</a></li><li role=none><a role=treeitem title="Install and configure Istio for in-depth evaluation or production use." href=/v1.5/docs/setup/install/helm/>Customizable Install with Helm</a></li><li role=none><a role=treeitem title="Instructions to install Istio in a Kubernetes cluster using the Istio operator." href=/v1.5/docs/setup/install/standalone-operator/>Standalone Operator Install</a></li><li role=treeitem aria-label="Multicluster Installation"><button aria-hidden=true></button><a title="Configure an Istio mesh spanning multiple Kubernetes clusters." href=/v1.5/docs/setup/install/multicluster/>Multicluster Installation</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Install an Istio mesh across multiple Kubernetes clusters with replicated control plane instances." href=/v1.5/docs/setup/install/multicluster/gateways/>Replicated control planes</a></li><li role=none><a role=treeitem title="Install an Istio mesh across multiple Kubernetes clusters with a shared control plane." href=/v1.5/docs/setup/install/multicluster/shared/>Shared control plane (single and multiple networks)</a></li></ul></li></ul></li><li role=treeitem aria-label=Upgrade><button aria-hidden=true></button><a title="Choose the upgrade guide that corresponds to the approach you previously used to install Istio." href=/v1.5/docs/setup/upgrade/>Upgrade</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Upgrade or downgrade Istio using the istioctl upgrade command." href=/v1.5/docs/setup/upgrade/istioctl-upgrade/>Upgrade Istio using istioctl</a></li><li role=none><a role=treeitem title="Upgrade the Istio control plane, and optionally, the CNI plug-in using Helm." href=/v1.5/docs/setup/upgrade/cni-helm-upgrade/>Upgrade using Helm</a></li></ul></li><li role=treeitem aria-label="More Guides"><button class=show aria-hidden=true></button><a title="More information on additional setup tasks." href=/v1.5/docs/setup/additional-setup/>More Guides</a><ul role=group aria-expanded=true class=leaf-section><li role=none><a role=treeitem title="Describes the built-in Istio installation configuration profiles." href=/v1.5/docs/setup/additional-setup/config-profiles/>Installation Configuration Profiles</a></li><li role=none><a role=treeitem title="Install the Istio sidecar in application pods automatically using the sidecar injector webhook or manually using istioctl CLI." href=/v1.5/docs/setup/additional-setup/sidecar-injection/>Installing the Sidecar</a></li><li role=none><span role=treeitem class=current title="Install and use Istio with the Istio CNI plugin, allowing operators to deploy services with lower privilege.">Install Istio with the Istio CNI plugin</span></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card77 title="How to do single specific targeted activities with the Istio system." aria-controls=card77-body><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#tasks"/></svg>Tasks</button><div class=body aria-labelledby=card77 role=region id=card77-body><ul role=tree aria-expanded=true aria-labelledby=card77><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true></button><a title="Tasks that demonstrate Istio's traffic routing features." href=/v1.5/docs/tasks/traffic-management/>Traffic Management</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="This task shows you how to configure dynamic request routing to multiple versions of a microservice." href=/v1.5/docs/tasks/traffic-management/request-routing/>Request Routing</a></li><li role=none><a role=treeitem title="This task shows you how to inject faults to test the resiliency of your application." href=/v1.5/docs/tasks/traffic-management/fault-injection/>Fault Injection</a></li><li role=none><a role=treeitem title="Shows you how to migrate traffic from an old to new version of a service." href=/v1.5/docs/tasks/traffic-management/traffic-shifting/>Traffic Shifting</a></li><li role=none><a role=treeitem title="Shows you how to migrate TCP traffic from an old to new version of a TCP service." href=/v1.5/docs/tasks/traffic-management/tcp-traffic-shifting/>TCP Traffic Shifting</a></li><li role=none><a role=treeitem title="This task shows you how to setup request timeouts in Envoy using Istio." href=/v1.5/docs/tasks/traffic-management/request-timeouts/>Request Timeouts</a></li><li role=none><a role=treeitem title="This task shows you how to configure circuit breaking for connections, requests, and outlier detection." href=/v1.5/docs/tasks/traffic-management/circuit-breaking/>Circuit Breaking</a></li><li role=none><a role=treeitem title="This task demonstrates the traffic mirroring/shadowing capabilities of Istio." href=/v1.5/docs/tasks/traffic-management/mirroring/>Mirroring</a></li><li role=treeitem aria-label=Ingress><button aria-hidden=true></button><a title="Controlling ingress traffic for an Istio service mesh." href=/v1.5/docs/tasks/traffic-management/ingress/>Ingress</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes how to configure an Istio gateway to expose a service outside of the service mesh." href=/v1.5/docs/tasks/traffic-management/ingress/ingress-control/>Ingress Gateways</a></li><li role=none><a role=treeitem title="Expose a service outside of the service mesh over TLS or mTLS using file-mounted certificates." href=/v1.5/docs/tasks/traffic-management/ingress/secure-ingress-mount/>Secure Gateways (File Mount)</a></li><li role=none><a role=treeitem title="Expose a service outside of the service mesh over TLS or mTLS using the secret discovery service (SDS)." href=/v1.5/docs/tasks/traffic-management/ingress/secure-ingress-sds/>Secure Gateways (SDS)</a></li><li role=none><a role=treeitem title="Describes how to configure SNI passthrough for an ingress gateway." href=/v1.5/docs/tasks/traffic-management/ingress/ingress-sni-passthrough/>Ingress Gateway without TLS Termination</a></li><li role=none><a role=treeitem title="Demonstrates how to obtain Let's Encrypt TLS certificates for Kubernetes Ingress automatically using Cert-Manager." href=/v1.5/docs/tasks/traffic-management/ingress/ingress-certmgr/>Kubernetes Ingress with Cert-Manager</a></li></ul></li><li role=treeitem aria-label=Egress><button aria-hidden=true></button><a title="Controlling egress traffic for an Istio service mesh." href=/v1.5/docs/tasks/traffic-management/egress/>Egress</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes how to configure Istio to route traffic from services in the mesh to external services." href=/v1.5/docs/tasks/traffic-management/egress/egress-control/>Accessing External Services</a></li><li role=none><a role=treeitem title="Describes how to configure Istio to perform TLS origination for traffic to external services." href=/v1.5/docs/tasks/traffic-management/egress/egress-tls-origination/>Egress TLS Origination</a></li><li role=none><a role=treeitem title="Describes how to configure Istio to direct traffic to external services through a dedicated gateway." href=/v1.5/docs/tasks/traffic-management/egress/egress-gateway/>Egress Gateways</a></li><li role=none><a role=treeitem title="Describes how to configure an Egress Gateway to perform TLS origination to external services." href=/v1.5/docs/tasks/traffic-management/egress/egress-gateway-tls-origination/>Egress Gateways with TLS Origination</a></li><li role=none><a role=treeitem title="Describes how to enable egress traffic for a set of hosts in a common domain, instead of configuring each and every host separately." href=/v1.5/docs/tasks/traffic-management/egress/wildcard-egress-hosts/>Egress using Wildcard Hosts</a></li><li role=none><a role=treeitem title="Describes how to configure SNI monitoring and apply policies on TLS egress traffic." href=/v1.5/docs/tasks/traffic-management/egress/egress_sni_monitoring_and_policies/>Monitoring and Policies for TLS Egress with Mixer (Deprecated)</a></li><li role=none><a role=treeitem title="Describes how to configure Istio to let applications use an external HTTPS proxy." href=/v1.5/docs/tasks/traffic-management/egress/http-proxy/>Using an External HTTPS Proxy</a></li><li role=none><a role=treeitem title="Shows how to configure Istio for Kubernetes External Services." href=/v1.5/docs/tasks/traffic-management/egress/egress-kubernetes-services/>Kubernetes Services for Egress Traffic</a></li></ul></li></ul></li><li role=treeitem aria-label=Security><button aria-hidden=true></button><a title="Demonstrates how to secure the mesh." href=/v1.5/docs/tasks/security/>Security</a><ul role=group aria-expanded=false><li role=treeitem aria-label=Authentication><button aria-hidden=true></button><a title="Controlling mutual TLS and end-user authentication for mesh services." href=/v1.5/docs/tasks/security/authentication/>Authentication</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Shows you how to use Istio authentication policy to setup mutual TLS and basic end-user authentication." href=/v1.5/docs/tasks/security/authentication/authn-policy/>Authentication Policy</a></li><li role=none><a role=treeitem title="Shows you how to incrementally migrate your Istio services to mutual TLS." href=/v1.5/docs/tasks/security/authentication/mtls-migration/>Mutual TLS Migration</a></li></ul></li><li role=treeitem aria-label=Authorization><button aria-hidden=true></button><a title="Shows how to control access to Istio services." href=/v1.5/docs/tasks/security/authorization/>Authorization</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Shows how to set up access control for HTTP traffic." href=/v1.5/docs/tasks/security/authorization/authz-http/>Authorization for HTTP traffic</a></li><li role=none><a role=treeitem title="How to set up access control for TCP traffic." href=/v1.5/docs/tasks/security/authorization/authz-tcp/>Authorization for TCP traffic</a></li><li role=none><a role=treeitem title="How to set up access control with JWT in Istio." href=/v1.5/docs/tasks/security/authorization/authz-jwt/>Authorization with JWT</a></li><li role=none><a role=treeitem title="Shows how to set up access control to deny traffic explicitly." href=/v1.5/docs/tasks/security/authorization/authz-deny/>Authorization policies with a deny action</a></li><li role=none><a role=treeitem title="How to set up access control on an ingress gateway." href=/v1.5/docs/tasks/security/authorization/authz-ingress/>Authorization on Ingress Gateway</a></li><li role=none><a role=treeitem title="Shows how to migrate from one trust domain to another without changing authorization policy." href=/v1.5/docs/tasks/security/authorization/authz-td-migration/>Authorization Policy Trust Domain Migration</a></li></ul></li><li role=none><a role=treeitem title="Shows how system administrators can configure Istio's CA with an existing root certificate, signing certificate and key." href=/v1.5/docs/tasks/security/plugin-ca-cert/>Plugging in existing CA Certificates</a></li><li role=none><a role=treeitem title="Shows how to provision and manage DNS certificates in Istio." href=/v1.5/docs/tasks/security/dns-cert/>Istio DNS Certificate Management</a></li></ul></li><li role=treeitem aria-label=Policies><button aria-hidden=true></button><a title="Demonstrates policy enforcement features." href=/v1.5/docs/tasks/policy-enforcement/>Policies</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="This task shows you how to enable Istio policy enforcement." href=/v1.5/docs/tasks/policy-enforcement/enabling-policy/>Enabling Policy Enforcement (Deprecated)</a></li><li role=none><a role=treeitem title="This task shows you how to use Istio to dynamically limit the traffic to a service." href=/v1.5/docs/tasks/policy-enforcement/rate-limiting/>Enabling Rate Limits (Deprecated)</a></li><li role=none><a role=treeitem title="Shows how to control access to a service using simple denials or white/black listing." href=/v1.5/docs/tasks/policy-enforcement/denial-and-list/>Denials and White/Black Listing (Deprecated)</a></li><li role=none><a role=treeitem title="Shows how to modify request headers and routing using policy adapters." href=/v1.5/docs/tasks/policy-enforcement/control-headers/>Control Headers and Routing (Deprecated)</a></li></ul></li><li role=treeitem aria-label=Observability><button aria-hidden=true></button><a title="Demonstrates how to collect telemetry information from the mesh." href=/v1.5/docs/tasks/observability/>Observability</a><ul role=group aria-expanded=false><li role=treeitem aria-label=Metrics><button aria-hidden=true></button><a title="Demonstrates the collection and querying of metrics within Istio." href=/v1.5/docs/tasks/observability/metrics/>Metrics</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="This task shows you how to configure Istio to collect metrics for TCP services." href=/v1.5/docs/tasks/observability/metrics/tcp-metrics/>Collecting Metrics for TCP Services</a></li><li role=none><a role=treeitem title="This task shows you how to query for Istio Metrics using Prometheus." href=/v1.5/docs/tasks/observability/metrics/querying-metrics/>Querying Metrics from Prometheus</a></li><li role=none><a role=treeitem title="This task shows you how to setup and use the Istio Dashboard to monitor mesh traffic." href=/v1.5/docs/tasks/observability/metrics/using-istio-dashboard/>Visualizing Metrics with Grafana</a></li></ul></li><li role=treeitem aria-label=Logs><button aria-hidden=true></button><a title="Demonstrates the collection of logs within Istio." href=/v1.5/docs/tasks/observability/logs/>Logs</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="This task shows you how to configure Envoy proxies to print access logs to their standard output." href=/v1.5/docs/tasks/observability/logs/access-log/>Getting Envoy's Access Logs</a></li></ul></li><li role=treeitem aria-label="Distributed Tracing"><button aria-hidden=true></button><a title="This task shows you how to configure Istio-enabled applications to collect trace spans." href=/v1.5/docs/tasks/observability/distributed-tracing/>Distributed Tracing</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Overview of distributed tracing in Istio." href=/v1.5/docs/tasks/observability/distributed-tracing/overview/>Overview</a></li><li role=none><a role=treeitem title="Learn how to configure the proxies to send tracing requests to Jaeger." href=/v1.5/docs/tasks/observability/distributed-tracing/jaeger/>Jaeger</a></li><li role=none><a role=treeitem title="Learn how to configure the proxies to send tracing requests to Zipkin." href=/v1.5/docs/tasks/observability/distributed-tracing/zipkin/>Zipkin</a></li><li role=none><a role=treeitem title="How to configure the proxies to send tracing requests to LightStep." href=/v1.5/docs/tasks/observability/distributed-tracing/lightstep/>LightStep</a></li></ul></li><li role=none><a role=treeitem title="This task shows you how to visualize your services within an Istio mesh." href=/v1.5/docs/tasks/observability/kiali/>Visualizing Your Mesh</a></li><li role=none><a role=treeitem title="This task shows you how to configure external access to the set of Istio telemetry addons." href=/v1.5/docs/tasks/observability/gateways/>Remotely Accessing Telemetry Addons</a></li><li role=treeitem aria-label="Using Mixer for Telemetry (deprecated)"><button aria-hidden=true></button><a title="Demonstrates how to collect telemetry information from the mesh using Mixer." href=/v1.5/docs/tasks/observability/mixer/>Using Mixer for Telemetry (deprecated)</a><ul role=group aria-expanded=false><li role=treeitem aria-label=Metrics><button aria-hidden=true></button><a title="Demonstrates the configuration, collection, and processing of Istio mesh metrics using Mixer." href=/v1.5/docs/tasks/observability/mixer/metrics/>Metrics</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="This task shows you how to configure Istio's Mixer to collect and customize metrics." href=/v1.5/docs/tasks/observability/mixer/metrics/collecting-metrics/>Collecting Metrics With Mixer</a></li><li role=none><a role=treeitem title="This task shows you how to configure Istio's Mixer to collect metrics for TCP services." href=/v1.5/docs/tasks/observability/mixer/metrics/tcp-metrics/>Collecting Metrics for TCP services with Mixer</a></li></ul></li><li role=treeitem aria-label=Logs><button aria-hidden=true></button><a title="Demonstrates the configuration, collection, and processing of Istio mesh logs." href=/v1.5/docs/tasks/observability/mixer/logs/>Logs</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="This task shows you how to configure Istio's Mixer to collect and customize logs." href=/v1.5/docs/tasks/observability/mixer/logs/collecting-logs/>Collecting Logs with Mixer</a></li><li role=none><a role=treeitem title="This task shows you how to configure Istio's Mixer to log to a Fluentd daemon." href=/v1.5/docs/tasks/observability/mixer/logs/fluentd/>Logging with Mixer and Fluentd</a></li></ul></li></ul></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card92 title="A variety of fully working example uses for Istio that you can experiment with." aria-controls=card92-body><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#examples"/></svg>Examples</button><div class=body aria-labelledby=card92 role=region id=card92-body><ul role=tree aria-expanded=true aria-labelledby=card92><li role=none><a role=treeitem title="Deploys a sample application composed of four separate microservices used to demonstrate various Istio features." href=/v1.5/docs/examples/bookinfo/>Bookinfo Application</a></li><li role=treeitem aria-label="Virtual Machines"><button aria-hidden=true></button><a title="Examples that add workloads running on virtual machines to an Istio mesh." href=/v1.5/docs/examples/virtual-machines/>Virtual Machines</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Learn how to add a service running on a virtual machine to your single network Istio mesh." href=/v1.5/docs/examples/virtual-machines/single-network/>Virtual Machines in Single-Network Meshes</a></li><li role=none><a role=treeitem title="Learn how to add a service running on a virtual machine to your multi-network Istio mesh." href=/v1.5/docs/examples/virtual-machines/multi-network/>Virtual Machines in Multi-Network Meshes</a></li><li role=none><a role=treeitem title="Run the Bookinfo application with a MySQL service running on a virtual machine within your mesh." href=/v1.5/docs/examples/virtual-machines/bookinfo/>Bookinfo with a Virtual Machine</a></li></ul></li><li role=treeitem aria-label="Learn Microservices using Kubernetes and Istio"><button aria-hidden=true></button><a title="This modular tutorial provides new users with hands-on experience using Istio for common microservices scenarios, one step at a time." href=/v1.5/docs/examples/microservices-istio/>Learn Microservices using Kubernetes and Istio</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/prereq/>Prerequisites</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/setup-kubernetes-cluster/>Setup a Kubernetes Cluster</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/setup-local-computer/>Setup a Local Computer</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/single/>Run a Microservice Locally</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/package-service/>Run ratings in Docker</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/bookinfo-kubernetes/>Run Bookinfo with Kubernetes</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/production-testing/>Test in production</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/add-new-microservice-version/>Add a new version of reviews</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/add-istio/>Enable Istio on productpage</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/enable-istio-all-microservices/>Enable Istio on all the microservices</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/istio-ingress-gateway/>Configure Istio Ingress Gateway</a></li><li role=none><a role=treeitem href=/v1.5/docs/examples/microservices-istio/logs-istio/>Monitoring with Istio</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card113 title="Concepts, tools, and techniques to deploy and manage an Istio mesh." aria-controls=card113-body><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#guide"/></svg>Operations</button><div class=body aria-labelledby=card113 role=region id=card113-body><ul role=tree aria-expanded=true aria-labelledby=card113><li role=treeitem aria-label=Deployment><button aria-hidden=true></button><a title="Requirements, concepts, and considerations for setting up an Istio deployment." href=/v1.5/docs/ops/deployment/>Deployment</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Describes Istio's high-level architecture and design goals." href=/v1.5/docs/ops/deployment/architecture/>Architecture</a></li><li role=none><a role=treeitem title="Describes the options and considerations when configuring your Istio deployment." href=/v1.5/docs/ops/deployment/deployment-models/>Deployment Models</a></li><li role=none><a role=treeitem title="Istio performance and scalability summary." href=/v1.5/docs/ops/deployment/performance-and-scalability/>Performance and Scalability</a></li><li role=none><a role=treeitem title="Prepare your Kubernetes pods and services to run in an Istio-enabled cluster." href=/v1.5/docs/ops/deployment/requirements/>Pods and Services</a></li></ul></li><li role=treeitem aria-label=Configuration><button aria-hidden=true></button><a title="Advanced concepts and features for configuring a running Istio mesh." href=/v1.5/docs/ops/configuration/>Configuration</a><ul role=group aria-expanded=false><li role=treeitem aria-label="Mesh Configuration"><button aria-hidden=true></button><a title="Helps you manage the global mesh configuration." href=/v1.5/docs/ops/configuration/mesh/>Mesh Configuration</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Provides a general overview of Istio's use of Kubernetes webhooks and the related issues that can arise." href=/v1.5/docs/ops/configuration/mesh/webhook/>Dynamic Admission Webhooks Overview</a></li><li role=none><a role=treeitem title="Describes Istio's use of Kubernetes webhooks for automatic sidecar injection." href=/v1.5/docs/ops/configuration/mesh/injection-concepts/>Automatic Sidecar Injection</a></li><li role=none><a role=treeitem title="Describes how Citadel determines whether to create service account secrets." href=/v1.5/docs/ops/configuration/mesh/secret-creation/>Service Account Secret Creation</a></li><li role=none><a role=treeitem title="Shows how to do health checking for Istio services." href=/v1.5/docs/ops/configuration/mesh/app-health-check/>Health Checking of Istio Services</a></li></ul></li><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true></button><a title="Helps you manage the networking aspects of a running mesh." href=/v1.5/docs/ops/configuration/traffic-management/>Traffic Management</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Information on how to specify protocols." href=/v1.5/docs/ops/configuration/traffic-management/protocol-selection/>Protocol Selection</a></li><li role=none><a role=treeitem title="Information on how to enable and understand Locality Load Balancing." href=/v1.5/docs/ops/configuration/traffic-management/locality-load-balancing/>Locality Load Balancing</a></li></ul></li><li role=treeitem aria-label=Security><button aria-hidden=true></button><a title="Helps you manage the security aspects of a running mesh." href=/v1.5/docs/ops/configuration/security/>Security</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Use hardened container images to reduce Istio's attack surface." href=/v1.5/docs/ops/configuration/security/harden-docker-images/>Harden Docker Container Images</a></li><li role=none><a role=treeitem title="Learn how to extend the lifetime of the Istio self-signed root certificate." href=/v1.5/docs/ops/configuration/security/root-transition/>Extending Self-Signed Certificate Lifetime</a></li></ul></li><li role=treeitem aria-label=Observability><button aria-hidden=true></button><a title="Helps you manage telemetry collection and visualization in a running mesh." href=/v1.5/docs/ops/configuration/telemetry/>Observability</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Fine-grained control of Envoy statistics." href=/v1.5/docs/ops/configuration/telemetry/envoy-stats/>Envoy Statistics</a></li></ul></li></ul></li><li role=treeitem aria-label="Best Practices"><button aria-hidden=true></button><a title="Best practices for setting up and managing an Istio service mesh." href=/v1.5/docs/ops/best-practices/>Best Practices</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="General best practices when setting up an Istio service mesh." href=/v1.5/docs/ops/best-practices/deployment/>Deployment Best Practices</a></li><li role=none><a role=treeitem title="Configuration best practices to avoid networking or traffic management issues." href=/v1.5/docs/ops/best-practices/traffic-management/>Traffic Management Best Practices</a></li><li role=none><a role=treeitem title="Best practices for securing applications using Istio." href=/v1.5/docs/ops/best-practices/security/>Security Best Practices</a></li><li role=none><a role=treeitem title="Best practices for observing applications using Istio." href=/v1.5/docs/ops/best-practices/observability/>Observability Best Practices</a></li></ul></li><li role=treeitem aria-label="Common Problems"><button aria-hidden=true></button><a title="Describes how to identify and resolve common problems in Istio." href=/v1.5/docs/ops/common-problems/>Common Problems</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Techniques to address common Istio traffic management and network problems." href=/v1.5/docs/ops/common-problems/network-issues/>Traffic Management Problems</a></li><li role=none><a role=treeitem title="Techniques to address common Istio authentication, authorization, and general security-related problems." href=/v1.5/docs/ops/common-problems/security-issues/>Security Problems</a></li><li role=none><a role=treeitem title="Dealing with telemetry collection issues." href=/v1.5/docs/ops/common-problems/observability-issues/>Observability Problems</a></li><li role=none><a role=treeitem title="Resolve common problems with Istio's use of Kubernetes webhooks for automatic sidecar injection." href=/v1.5/docs/ops/common-problems/injection/>Sidecar Injection Problems</a></li><li role=none><a role=treeitem title="Describes how to resolve configuration validation problems." href=/v1.5/docs/ops/common-problems/validation/>Configuration Validation Problems</a></li></ul></li><li role=treeitem aria-label="Diagnostic Tools"><button aria-hidden=true></button><a title="Tools and techniques to help troubleshoot an Istio mesh." href=/v1.5/docs/ops/diagnostic-tools/>Diagnostic Tools</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Istio includes a supplemental tool that provides debugging and diagnosis for Istio service mesh deployments." href=/v1.5/docs/ops/diagnostic-tools/istioctl/>Using the Istioctl Command-line Tool</a></li><li role=none><a role=treeitem title="Describes tools and techniques to diagnose Envoy configuration issues related to traffic management." href=/v1.5/docs/ops/diagnostic-tools/proxy-cmd/>Debugging Envoy and Istiod</a></li><li role=none><a role=treeitem title="Shows you how to use istioctl describe to verify the configurations of a pod in your mesh." href=/v1.5/docs/ops/diagnostic-tools/istioctl-describe/>Understand your Mesh with Istioctl Describe</a></li><li role=none><a role=treeitem title="Shows you how to use istioctl analyze to identify potential issues with your configuration." href=/v1.5/docs/ops/diagnostic-tools/istioctl-analyze/>Diagnose your Configuration with Istioctl Analyze</a></li><li role=none><a role=treeitem title="Describes how to use ControlZ to get insight into individual running components." href=/v1.5/docs/ops/diagnostic-tools/controlz/>Component Introspection</a></li><li role=none><a role=treeitem title="Describes how to use component-level logging to get insights into a running component's behavior." href=/v1.5/docs/ops/diagnostic-tools/component-logging/>Component Logging</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=card161 title="Detailed authoritative reference material such as command-line options, configuration options, and API calling parameters." aria-controls=card161-body><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#reference"/></svg>Reference</button><div class=body aria-labelledby=card161 role=region id=card161-body><ul role=tree aria-expanded=true aria-labelledby=card161><li role=treeitem aria-label=Configuration><button aria-hidden=true></button><a title="Detailed information on configuration options." href=/v1.5/docs/reference/config/>Configuration</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Describes the options available when installing Istio using Helm charts." href=/v1.5/docs/reference/config/installation-options/>Installation Options (Helm)</a></li><li role=none><a role=treeitem title="Configuration affecting the service mesh as a whole." href=/v1.5/docs/reference/config/istio.mesh.v1alpha1/>Global Mesh Options</a></li><li role=none><a role=treeitem title="Configuration affecting Istio control plane installation version and shape." href=/v1.5/docs/reference/config/istio.operator.v1alpha1/>IstioOperator Options</a></li><li role=treeitem aria-label="Traffic Management"><button aria-hidden=true></button><a title="Describes how to configure HTTP/TCP routing features." href=/v1.5/docs/reference/config/networking/>Traffic Management</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Configuration affecting load balancing, outlier detection, etc." href=/v1.5/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.5/docs/reference/config/networking/envoy-filter/>Envoy Filter</a></li><li role=none><a role=treeitem title="Configuration affecting edge load balancer." href=/v1.5/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.5/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.5/docs/reference/config/networking/sidecar/>Sidecar</a></li><li role=none><a role=treeitem title="Configuration affecting service registry." href=/v1.5/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="Describes how to configure Istio's security features." href=/v1.5/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.5/docs/reference/config/security/jwt/>JWTRule</a></li><li role=none><a role=treeitem title="Request authentication configuration for workloads." href=/v1.5/docs/reference/config/security/request_authentication/>RequestAuthentication</a></li><li role=none><a role=treeitem title="Peer authentication configuration for workloads." href=/v1.5/docs/reference/config/security/peer_authentication/>PeerAuthentication</a></li><li role=none><a role=treeitem title="Authentication policy for Istio services." href=/v1.5/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.5/docs/reference/config/security/authorization-policy/>Authorization Policy</a></li><li role=none><a role=treeitem title="Describes the supported conditions in authorization policies." href=/v1.5/docs/reference/config/security/conditions/>Authorization Policy Conditions</a></li><li role=none><a role=treeitem title="Configuration for Role Based Access Control." href=/v1.5/docs/reference/config/security/istio.rbac.v1alpha1/>RBAC (deprecated)</a></li><li role=none><a role=treeitem title="Describes the supported constraints and properties." href=/v1.5/docs/reference/config/security/constraints-and-properties/>RBAC Constraints and Properties (deprecated)</a></li></ul></li><li role=treeitem aria-label="Telemetry V2"><button aria-hidden=true></button><a title="Describes how to configure Istio telemetry V2." href=/v1.5/docs/reference/config/telemetry/>Telemetry V2</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Istio standard metrics exported by Istio telemetry." href=/v1.5/docs/reference/config/telemetry/metrics/>Istio Standard Metrics</a></li><li role=none><a role=treeitem title="How to configure v2 metrics (experimental)." href=/v1.5/docs/reference/config/telemetry/configurable_metrics/>Configurable Metrics (Experimental)</a></li><li role=none><a role=treeitem title="How to enable Telemetry V2 with Wasm runtime (experimental)." href=/v1.5/docs/reference/config/telemetry/telemetry_v2_with_wasm/>Telemetry V2 with Wasm runtime (Experimental)</a></li></ul></li><li role=none><a role=treeitem title="Resource annotations used by Istio." href=/v1.5/docs/reference/config/annotations/>Resource Annotations</a></li><li role=treeitem aria-label="Configuration Analysis Messages"><button aria-hidden=true></button><a title="Documents the individual error and warning messages produced during configurarion analysis." href=/v1.5/docs/reference/config/analysis/>Configuration Analysis Messages</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/message-format/>Analyzer Message Format</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0109/>ConflictingMeshGatewayVirtualServiceHosts</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0110/>ConflictingSidecarWorkloadSelectors</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0002/>Deprecated</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0107/>MisplacedAnnotation</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0104/>GatewayPortNotOnWorkload</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0001/>InternalError</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0105/>IstioProxyImageMismatch</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0119/>JwtFailureDueToInvalidServicePortPrefix</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0113/>MTLSPolicyConflict</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0111/>MultipleSidecarsWithoutWorkloadSelectors</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0102/>NamespaceNotInjected</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0112/>VirtualServiceDestinationPortSelectorRequired</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0108/>UnknownAnnotation</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0106/>SchemaValidationError</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0101/>ReferencedResourceNotFound</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0118/>PortNameIsNotUnderNamingConvention</a></li><li role=none><a role=treeitem href=/v1.5/docs/reference/config/analysis/ist0103/>PodMissingProxy</a></li></ul></li><li role=treeitem aria-label="Mixer Policies and Telemetry (Deprecated)"><button aria-hidden=true></button><a title="Describes how to configure Mixer's policy and telemetry features." href=/v1.5/docs/reference/config/policy-and-telemetry/>Mixer Policies and Telemetry (Deprecated)</a><ul role=group aria-expanded=false><li role=none><a role=treeitem title="Configuration state for the Mixer client library." href=/v1.5/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.5/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1/>Rules</a></li><li role=none><a role=treeitem title="Describes the configuration model for Istio's policy enforcement and telemetry mechanisms." href=/v1.5/docs/reference/config/policy-and-telemetry/mixer-overview/>Mixer Configuration Model (Deprecated)</a></li><li role=none><a role=treeitem title="Describes the base attribute vocabulary used for policy and control." href=/v1.5/docs/reference/config/policy-and-telemetry/attribute-vocabulary/>Attribute Vocabulary (Deprecated)</a></li><li role=none><a role=treeitem title="Mixer configuration expression language reference." href=/v1.5/docs/reference/config/policy-and-telemetry/expression-language/>Expression Language</a></li><li role=treeitem aria-label="Mixer Adapters (Deprecated)"><button aria-hidden=true></button><a title="Mixer adapters allow Istio to interface to a variety of infrastructure backends for such things as metrics and logs." href=/v1.5/docs/reference/config/policy-and-telemetry/adapters/>Mixer Adapters (Deprecated)</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.5/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.5/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.5/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.5/docs/reference/config/policy-and-telemetry/adapters/circonus/>Circonus</a></li><li role=none><a role=treeitem title="Adapter for cloudmonitor metrics." href=/v1.5/docs/reference/config/policy-and-telemetry/adapters/cloudmonitor/>CloudMonitor</a></li><li role=none><a role=treeitem title="Adapter for cloudwatch metrics." href=/v1.5/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.5/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.5/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.5/docs/reference/config/policy-and-telemetry/adapters/denier/>Denier</a></li><li role=none><a role=treeitem title="An Istio Mixer adapter to send telemetry data to New Relic." href=/v1.5/docs/reference/config/policy-and-telemetry/adapters/newrelic/>New Relic</a></li><li role=none><a role=treeitem title="Adapter that delivers logs to a Fluentd daemon." href=/v1.5/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.5/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv/>Kubernetes Env</a></li><li role=none><a role=treeitem title="Adapter to deliver metrics to Layer5." href=/v1.5/docs/reference/config/policy-and-telemetry/adapters/layer5/>Layer5</a></li><li role=none><a role=treeitem title="Adapter that performs whitelist or blacklist checks." href=/v1.5/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.5/docs/reference/config/policy-and-telemetry/adapters/memquota/>Memory quota</a></li><li role=none><a role=treeitem title="Adapter that implements an Open Policy Agent engine." href=/v1.5/docs/reference/config/policy-and-telemetry/adapters/opa/>OPA</a></li><li role=none><a role=treeitem title="Adapter to deliver metrics to Wavefront by VMware." href=/v1.5/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.5/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.5/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.5/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.5/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.5/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.5/docs/reference/config/policy-and-telemetry/adapters/prometheus/>Prometheus</a></li></ul></li><li role=none><a role=treeitem title="Default Metrics exported from Istio through Mixer." href=/v1.5/docs/reference/config/policy-and-telemetry/metrics/>Default Metrics</a></li><li role=treeitem aria-label=Templates><button aria-hidden=true></button><a title="Mixer templates are used to send data to individual adapters." href=/v1.5/docs/reference/config/policy-and-telemetry/templates/>Templates</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="A template that represents a single API key." href=/v1.5/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.5/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.5/docs/reference/config/policy-and-telemetry/templates/checknothing/>Check Nothing</a></li><li role=none><a role=treeitem title="A template that is used to control the production of Kubernetes-specific attributes." href=/v1.5/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.5/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.5/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.5/docs/reference/config/policy-and-telemetry/templates/metric/>Metric</a></li><li role=none><a role=treeitem title="The Analytics template is used to dispatch runtime telemetry to Apigee." href=/v1.5/docs/reference/config/policy-and-telemetry/templates/analytics/>Analytics</a></li><li role=none><a role=treeitem title="A template that represents an individual span within a distributed trace." href=/v1.5/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.5/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.5/docs/reference/config/policy-and-telemetry/templates/quota/>Quota</a></li><li role=none><a role=treeitem title="A template designed to report observed communication edges between workloads." href=/v1.5/docs/reference/config/policy-and-telemetry/templates/edge/>Edge</a></li></ul></li></ul></li></ul></li><li role=treeitem aria-label=Commands><button aria-hidden=true></button><a title="Describes usage and options of the Istio commands and utilities." href=/v1.5/docs/reference/commands/>Commands</a><ul role=group aria-expanded=false class=leaf-section><li role=none><a role=treeitem title="Galley provides configuration management services for Istio." href=/v1.5/docs/reference/commands/galley/>galley</a></li><li role=none><a role=treeitem title="Istio Certificate Authority (CA)." href=/v1.5/docs/reference/commands/istio_ca/>istio_ca</a></li><li role=none><a role=treeitem title="Istio control interface." href=/v1.5/docs/reference/commands/istioctl/>istioctl</a></li><li role=none><a role=treeitem title="Mixer is Istio's abstraction on top of infrastructure backends." href=/v1.5/docs/reference/commands/mixs/>mixs</a></li><li role=none><a role=treeitem title="Kubernetes webhook for automatic Istio sidecar injection." href=/v1.5/docs/reference/commands/sidecar-injector/>sidecar-injector</a></li><li role=none><a role=treeitem title="Istio Pilot." href=/v1.5/docs/reference/commands/pilot-discovery/>pilot-discovery</a></li><li role=none><a role=treeitem title="Istio Pilot agent." href=/v1.5/docs/reference/commands/pilot-agent/>pilot-agent</a></li><li role=none><a role=treeitem title="The Istio operator." href=/v1.5/docs/reference/commands/operator/>operator</a></li><li role=none><a role=treeitem title="Istio security per-node agent." href=/v1.5/docs/reference/commands/node_agent/>node_agent</a></li></ul></li><li role=none><a role=treeitem title="A glossary of common Istio terms." href=/v1.5/docs/reference/glossary/>Glossary</a></li></ul></div></div></div></nav></div><div class=article-container><button tabindex=-1 id=sidebar-toggler title="Toggle the navigation bar"><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#pull"/></svg></button><nav aria-label=Breadcrumb><ol><li><a href=/v1.5/ title="Connect, secure, control, and observe services.">Istio</a></li><li><a href=/v1.5/docs/ title="Learn how to deploy, use, and operate Istio.">Docs</a></li><li><a href=/v1.5/docs/setup/ title="Instructions for installing the Istio control plane on Kubernetes.">Setup</a></li><li><a href=/v1.5/docs/setup/additional-setup/ title="More information on additional setup tasks.">More Guides</a></li><li>Install Istio with the Istio CNI plugin</li></ol></nav><article aria-labelledby=title><div class=title-area><div style=width:100%><h1 id=title>Install Istio with the Istio CNI plugin</h1><p class=byline><span title="1932 words"><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#clock"/></svg><span> </span>10 minute read</span></p></div></div><nav class=toc-inlined aria-label="Table of Contents"><div><hr><ol><li role=none aria-label=Prerequisites><a href=#prerequisites>Prerequisites</a><li role=none aria-label=Installation><a href=#installation>Installation</a><ol><li role=none aria-label="Helm chart parameters"><a href=#helm-chart-parameters>Helm chart parameters</a><li role=none aria-label="Excluding specific Kubernetes namespaces"><a href=#excluding-specific-kubernetes-namespaces>Excluding specific Kubernetes namespaces</a><li role=none aria-label="Hosted Kubernetes settings"><a href=#hosted-kubernetes-settings>Hosted Kubernetes settings</a><ol><li role=none aria-label="Instructions for Istio 1.4.x and OpenShift"><a href=#instructions-for-istio-1-4-x-and-openshift>Instructions for Istio 1.4.x and OpenShift</a></ol></li><li role=none aria-label="GKE setup"><a href=#gke-setup>GKE setup</a></ol></li><li role=none aria-label="Sidecar injection compatibility"><a href=#sidecar-injection-compatibility>Sidecar injection compatibility</a><li role=none aria-label="Operational details"><a href=#operational-details>Operational details</a><ol><li role=none aria-label="Identifying pods requiring traffic redirection"><a href=#identifying-pods-requiring-traffic-redirection>Identifying pods requiring traffic redirection</a><li role=none aria-label="Traffic redirection parameters"><a href=#traffic-redirection-parameters>Traffic redirection parameters</a><li role=none aria-label=Logging><a href=#logging>Logging</a><li role=none aria-label="Compatibility with application init containers"><a href=#compatibility-with-application-init-containers>Compatibility with application init containers</a><li role=none aria-label="Compatibility with other CNI plugins"><a href=#compatibility-with-other-cni-plugins>Compatibility with other CNI plugins</a></ol></li><li role=none aria-label="See also"><a href=#see-also>See also</a></li></ol><hr></div></nav><p>Follow this guide to install, configure, and use an Istio mesh using the Istio Container Network Interface
|
||
(<a href=https://github.com/containernetworking/cni#cni---the-container-network-interface>CNI</a>)
|
||
plugin.</p><p>By default Istio injects an <code>initContainer</code>, <code>istio-init</code>, in pods deployed in
|
||
the mesh. The <code>istio-init</code> container sets up the pod network traffic
|
||
redirection to/from the Istio sidecar proxy. This requires the user or
|
||
service-account deploying pods to the mesh to have sufficient Kubernetes RBAC
|
||
permissions to deploy <a href=https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container>containers with the <code>NET_ADMIN</code> and <code>NET_RAW</code> capabilities</a>.
|
||
Requiring Istio users to have elevated Kubernetes RBAC permissions is
|
||
problematic for some organizations’ security compliance. The Istio CNI plugin
|
||
is a replacement for the <code>istio-init</code> container that performs the same
|
||
networking functionality but without requiring Istio users to enable elevated
|
||
Kubernetes RBAC permissions.</p><p>The Istio CNI plugin performs the Istio mesh pod traffic redirection in the Kubernetes pod lifecycle’s network
|
||
setup phase, thereby removing the <a href=/v1.5/docs/ops/deployment/requirements/>requirement for the <code>NET_ADMIN</code> and <code>NET_RAW</code> capabilities</a>
|
||
for users deploying pods into the Istio mesh. The Istio CNI plugin
|
||
replaces the functionality provided by the <code>istio-init</code> container.</p><h2 id=prerequisites>Prerequisites</h2><ol><li><p>Install Kubernetes with the container runtime supporting CNI and <code>kubelet</code> configured
|
||
with the main <a href=https://github.com/containernetworking/cni>CNI</a> plugin enabled via <code>--network-plugin=cni</code>.</p><ul><li>AWS EKS, Azure AKS, and IBM Cloud IKS clusters have this capability.</li><li>Google Cloud GKE clusters require that the
|
||
<a href=https://cloud.google.com/kubernetes-engine/docs/how-to/network-policy>network-policy</a> feature
|
||
is enabled to have Kubernetes configured with <code>network-plugin=cni</code>.</li><li>OpenShift has CNI enabled by default.</li></ul></li><li><p>Install Kubernetes with the <a href=https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#serviceaccount>ServiceAccount admission controller</a> enabled.</p><ul><li>The Kubernetes documentation highly recommends this for all Kubernetes installations
|
||
where <code>ServiceAccounts</code> are utilized.</li></ul></li></ol><h2 id=installation>Installation</h2><ol><li><p>Determine the Kubernetes environment’s CNI plugin <code>--cni-bin-dir</code> and <code>--cni-conf-dir</code> settings.
|
||
Refer to <a href=#hosted-kubernetes-settings>Hosted Kubernetes settings</a> for any non-default settings required.</p></li><li><p>Install Istio CNI and Istio using <code>istioctl</code>.
|
||
Refer to the <a href=/v1.5/docs/setup/install/istioctl/>Istio install</a> instructions and pass <code>--set components.cni.enabled=true</code> option.
|
||
Pass <code>--set values.cni.cniBinDir=...</code> and/or <code>--set values.cni.cniConfDir=...</code> options when installing <code>istio-cni</code> if non-default,
|
||
as determined in the previous step.</p></li></ol><h3 id=helm-chart-parameters>Helm chart parameters</h3><p>The following table shows all the options that the <code>istio-cni</code> configuration supports:</p><table><thead><tr><th>Option</th><th>Values</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>hub</code></td><td></td><td></td><td>The container registry to pull the <code>install-cni</code> image.</td></tr><tr><td><code>tag</code></td><td></td><td></td><td>The container tag to use to pull the <code>install-cni</code> image.</td></tr><tr><td><code>pullPolicy</code></td><td></td><td><code>Always</code></td><td>The image pull policy for the <code>install-cni</code> image.</td></tr><tr><td><code>logLevel</code></td><td><code>panic</code>, <code>fatal</code>, <code>error</code>, <code>warn</code>, <code>info</code>, <code>debug</code></td><td><code>warn</code></td><td>Logging level for CNI binary.</td></tr><tr><td><code>excludeNamespaces</code></td><td><code>[]string</code></td><td><code>[ istio-system ]</code></td><td>List of namespaces to exclude from Istio pod check.</td></tr><tr><td><code>cniBinDir</code></td><td></td><td><code>/opt/cni/bin</code></td><td>Must be the same as the environment’s <code>--cni-bin-dir</code> setting (<code>kubelet</code> parameter).</td></tr><tr><td><code>cniConfDir</code></td><td></td><td><code>/etc/cni/net.d</code></td><td>Must be the same as the environment’s <code>--cni-conf-dir</code> setting (<code>kubelet</code> parameter).</td></tr><tr><td><code>cniConfFileName</code></td><td></td><td></td><td>Leave unset to auto-find the first file in the <code>cni-conf-dir</code> (as <code>kubelet</code> does). Primarily used for testing <code>install-cni</code> plugin configuration. If set, <code>install-cni</code> will inject the plugin configuration into this file in the <code>cni-conf-dir</code>.</td></tr><tr><td><code>psp_cluster_role</code></td><td></td><td></td><td>This value refers to a <code>ClusterRole</code> and can be used to create a <code>RoleBinding</code> in the namespace of <code>istio-cni</code>. This is useful if you use <a href=https://kubernetes.io/docs/concepts/policy/pod-security-policy>Pod Security Policies</a> and want to allow <code>istio-cni</code> to run as <code>priviliged</code> Pods.</td></tr><tr><td><code>podAnnotations</code></td><td></td><td><code>{}</code></td><td>Additional custom annotations to be set on pod level.</td></tr><tr><td><code>repair.enabled</code></td><td><code>boolean</code></td><td><code>true</code></td><td>Enable or disable the <a href=https://github.com/istio/istio/issues/14327>CNI Race Condition</a> detection and repair functionality. This injects an <code>istio-validation</code> init container into every injected pod, which checks if Istio CNI correctly initialized the pod’s networking configuration. It also enables a new container in the CNI <code>DaemonSet</code> which monitors for pods and either labels or deletes them, per the values below.</td></tr><tr><td><code>repair.hub</code></td><td></td><td></td><td>The container registry to pull the <code>install-cni</code> image for the repair container. Defaults to the same as <code>hub</code>.</td></tr><tr><td><code>repair.tag</code></td><td></td><td></td><td>The container tag to use to pull the <code>install-cni</code> image for the repair container. Defaults to the same as <code>tag</code>.</td></tr><tr><td><code>repair.initContainerName</code></td><td></td><td><code>istio-validation</code></td><td>An override for the init container name inspected by the repair controller, if you are using a non-standard pod injection configuration.</td></tr><tr><td><code>repair.labelPods</code></td><td><code>boolean</code></td><td><code>true</code></td><td>Enable the repair controller to label pods it detects as uninitialized. Ignored if <code>deletePods</code> is true.</td></tr><tr><td><code>repair.deletePods</code></td><td><code>boolean</code></td><td><code>true</code></td><td>Enable the repair controller to delete pods it detects as uninitialized. It will continue deleting those pods until CNI initializes them correctly.</td></tr><tr><td><code>repair.brokenPodLabelKey</code></td><td></td><td><code>cni.istio.io/uninitialized</code></td><td>The key portion of the label to add to broken pods when <code>labelPods</code> is true.</td></tr><tr><td><code>repair.brokenPodLabelValue</code></td><td></td><td><code>true</code></td><td>The value portion of the label to add to broken pods when <code>labelPods</code> is true.</td></tr><tr><td><code>chained</code></td><td><code>true</code> or <code>false</code></td><td><code>true</code></td><td>Whether to deploy the configuration file as a plugin chain or as a standalone file in <code>cni-conf-dir</code>. Some Kubernetes flavors (e.g. OpenShift) do not support the chain approach, set to <code>false</code> if this is the case.</td></tr></tbody></table><p>These options are accessed through <code>values.cni.<option-name></code> in <code>istioctl manifest</code> commands, either as a <code>--set</code> flag,
|
||
or the corresponding path in a custom overlay file.</p><h3 id=excluding-specific-kubernetes-namespaces>Excluding specific Kubernetes namespaces</h3><p>This example uses <code>istioctl</code> to perform the following tasks:</p><ul><li>Install the Istio CNI plugin.</li><li>Configure its log level.</li><li>Ignore the pods in the following namespaces:<ul><li><code>istio-system</code></li><li><code>foo_ns</code></li><li><code>bar_ns</code></li></ul></li></ul><p>Refer to the <a href=/v1.5/docs/setup/install/istioctl>Customizable Install with <code>Istioctl</code></a> for complete instructions.</p><p>Use the following command to render and apply Istio CNI components and override the default configuration of the
|
||
<code>logLevel</code> and <code>excludeNamespaces</code> parameters for <code>istio-cni</code>:</p><p>Create a <code>IstioControlPlane</code> CR yaml locally with your override to install <code>istio</code>, e.g. <code>cni.yaml</code></p><pre><code class=language-yaml data-expandlinks=true data-repo=istio>apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
spec:
|
||
components:
|
||
cni:
|
||
enabled: true
|
||
values:
|
||
cni:
|
||
excludeNamespaces:
|
||
- istio-system
|
||
- kube-system
|
||
- foo_ns
|
||
- bar_ns
|
||
logLevel: info
|
||
</code></pre><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply -f cni.yaml
|
||
</code></pre><h3 id=hosted-kubernetes-settings>Hosted Kubernetes settings</h3><p>The Istio CNI solution is not ubiquitous. Some platforms, especially hosted Kubernetes environments, do not enable the
|
||
CNI plugin in the <code>kubelet</code> configuration.
|
||
The <code>istio-cni</code> plugin is expected to work with any hosted Kubernetes leveraging CNI plugins.
|
||
The following table shows the required settings for many common Kubernetes environments.</p><table><thead><tr><th>Hosted Cluster Type</th><th>Required Istio CNI Setting Overrides</th><th>Required Platform Setting Overrides</th></tr></thead><tbody><tr><td>GKE 1.9+ (see <a href=#gke-setup>GKE setup</a> below for details)</td><td><code>--set components.cni.namespace=kube-system --set values.cni.cniBinDir=/home/kubernetes/bin</code></td><td>enable <a href=https://cloud.google.com/kubernetes-engine/docs/how-to/network-policy>network-policy</a></td></tr><tr><td>IKS (IBM cloud)</td><td><em>(none)</em></td><td><em>(none)</em></td></tr><tr><td>EKS (AWS)</td><td><em>(none)</em></td><td><em>(none)</em></td></tr><tr><td>AKS (Azure)</td><td><em>(none)</em></td><td><em>(none)</em></td></tr><tr><td>Red Hat OpenShift 3.10+</td><td><em>(none)</em></td><td><em>(none)</em></td></tr><tr><td>Red Hat OpenShift 4.2+</td><td><code>--set components.cni.namespace=kube-system --set values.cni.cniBinDir=/var/lib/cni/bin --set values.cni.cniConfDir=/etc/cni/multus/net.d --set values.cni.chained=false --set values.cni.cniConfFileName="istio-cni.conf" --set values.sidecarInjectorWebhook.injectedAnnotations."k8s\.v1\.cni\.cncf\.io/networks"=istio-cni</code></td><td><em>(none)</em></td></tr></tbody></table><h4 id=instructions-for-istio-1-4-x-and-openshift>Instructions for Istio 1.4.x and OpenShift</h4><p>Due to a <a href=https://github.com/istio/istio/issues/19196>limitation</a> in <code>istioctl</code> 1.4.x using <code>--set</code> with
|
||
escaped strings, a YAML file is necessary to set <code>values.sidecarInjectorWebhook.injectedAnnotations</code> to install Istio on OpenShift. Create the YAML file:</p><pre><code class=language-yaml data-expandlinks=true data-repo=istio>cat <<'EOF' > cni-annotations.yaml
|
||
apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
spec:
|
||
cni:
|
||
enabled: true
|
||
components:
|
||
cni:
|
||
namespace: kube-system
|
||
values:
|
||
cni:
|
||
chained: false
|
||
cniBinDir: /var/lib/cni/bin
|
||
cniConfDir: /etc/cni/multus/net.d
|
||
cniConfFileName: istio-cni.conf
|
||
sidecarInjectorWebhook:
|
||
injectedAnnotations:
|
||
"k8s.v1.cni.cncf.io/networks": istio-cni
|
||
EOF
|
||
</code></pre><p>Then pass this file as an argument to <code>istioctl</code>, for example:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply -f cni-annotations.yaml
|
||
</code></pre><p>You can pass other command line arguments with <code>--set</code> if necessary.</p><div><aside class="callout warning"><div class=type><svg class="large-icon"><use xlink:href="/v1.5/img/icons.svg#callout-warning"/></svg></div><div class=content>In order to deploy Istio 1.4 on OpenShift with CNI you need to use at least Istio 1.4.8.</div></aside></div><h3 id=gke-setup>GKE setup</h3><ol><li><p>Refer to the procedure to <a href=/v1.5/docs/setup/platform-setup/gke/>prepare a GKE cluster for Istio</a> and
|
||
enable <a href=https://cloud.google.com/kubernetes-engine/docs/how-to/network-policy>network-policy</a> in your cluster.</p><div><aside class="callout warning"><div class=type><svg class="large-icon"><use xlink:href="/v1.5/img/icons.svg#callout-warning"/></svg></div><div class=content>For existing clusters, this redeploys all nodes.</div></aside></div></li><li><p>Install Istio CNI via <code>Istioctl</code> including the <code>--set values.cni.cniBinDir=/home/kubernetes/bin</code> option.
|
||
For example, the following <code>istioctl manifest</code> command sets the <code>values.cni.cniBinDir</code> value for a GKE cluster:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply --set values.cni.cniBinDir=/home/kubernetes/bin \
|
||
--set components.cni.enabled=true \
|
||
--set components.cni.namespace=kube-system
|
||
</code></pre></li></ol><h2 id=sidecar-injection-compatibility>Sidecar injection compatibility</h2><p>The use of the Istio CNI plugin requires Kubernetes pods to be deployed with a sidecar injection method
|
||
that uses the <code>istio-sidecar-injector</code> configmap created from the installation with the
|
||
<code>--set cni.enabled=true</code> option. Refer to <a href=/v1.5/docs/setup/additional-setup/sidecar-injection/>Istio sidecar injection</a>
|
||
for details about Istio sidecar injection methods.</p><p>The following sidecar injection methods are supported for use with the Istio CNI plugin:</p><ol><li><a href=/v1.5/docs/setup/additional-setup/sidecar-injection/#automatic-sidecar-injection>Automatic sidecar injection</a></li><li><p>Manual sidecar injection with the <code>istio-sidecar-injector</code> configmap</p><ol><li><p><a href=/v1.5/docs/reference/commands/istioctl/#istioctl-kube-inject><code>istioctl kube-inject</code></a> using the configmap directly:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml --injectConfigMapName istio-sidecar-injector
|
||
$ kubectl apply -f deployment-injected.yaml
|
||
</code></pre></li><li><p><code>istioctl kube-inject</code> using a file created from the configmap:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ kubectl -n istio-system get configmap istio-sidecar-injector -o=jsonpath='{.data.config}' > inject-config.yaml
|
||
$ istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml --injectConfigFile inject-config.yaml
|
||
$ kubectl apply -f deployment-injected.yaml
|
||
</code></pre></li></ol></li></ol><h2 id=operational-details>Operational details</h2><p>The Istio CNI plugin handles Kubernetes pod create and delete events and does the following:</p><ol><li>Identify Istio user application pods with Istio sidecars requiring traffic redirection</li><li>Perform pod network namespace configuration to redirect traffic to/from the Istio sidecar</li></ol><h3 id=identifying-pods-requiring-traffic-redirection>Identifying pods requiring traffic redirection</h3><p>The Istio CNI plugin identifies pods requiring traffic redirection to/from the
|
||
accompanying Istio proxy sidecar by checking that the pod meets all of the following conditions:</p><ol><li>The pod is NOT in a Kubernetes namespace in the configured <code>exclude_namespaces</code> list.</li><li>The pod has a container named <code>istio-proxy</code>.</li><li>The pod has more than 1 container.</li><li>The pod has no annotation with key <code>sidecar.istio.io/inject</code> OR the value of the annotation is <code>true</code>.</li></ol><h3 id=traffic-redirection-parameters>Traffic redirection parameters</h3><p>To redirect traffic in the application pod’s network namespace to/from the Istio proxy sidecar, the Istio
|
||
CNI plugin configures the namespace’s iptables. The following table describes the parameters to the
|
||
redirect functionality. To override the default values for the parameters, set the corresponding
|
||
application pod annotation key.</p><table><thead><tr><th>Annotation Key</th><th>Values</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>sidecar.istio.io/inject</code></td><td><code>true</code>, <code>false</code></td><td><code>true</code></td><td>Indicates whether the Istio proxy sidecar should be injected. If present and <code>false</code>, the Istio CNI plugin doesn’t configure the namespace’s iptables for the pod.</td></tr><tr><td><code>sidecar.istio.io/status</code></td><td></td><td></td><td>Annotation created by Istio’s sidecar injection. If missing, the Istio CNI plugin doesn’t configure the pod namespace’s iptables.</td></tr><tr><td><code>sidecar.istio.io/interceptionMode</code></td><td><code>REDIRECT</code>, <code>TPROXY</code></td><td><code>REDIRECT</code></td><td>The iptables redirect mode to use.</td></tr><tr><td><code>traffic.sidecar.istio.io/includeOutboundIPRanges</code></td><td><code><IPCidr1>,<IPCidr2>,...</code></td><td><code>"*"</code></td><td>Comma separated list of IP ranges in CIDR form to redirect to the sidecar proxy. The default value of <code>"*"</code> redirects all traffic.</td></tr><tr><td><code>traffic.sidecar.istio.io/excludeOutboundIPRanges</code></td><td><code><IPCidr1>,<IPCidr2>,...</code></td><td></td><td>Comma separated list of IP ranges in CIDR form to be excluded from redirection. Only applies when <code>includeOutboundIPRanges</code> is <code>"*"</code>.</td></tr><tr><td><code>traffic.sidecar.istio.io/includeInboundPorts</code></td><td><code><port1>,<port2>,...</code></td><td>Pod’s list of <code>containerPorts</code></td><td>Comma separated list of inbound ports for which traffic is to be redirected to the Istio proxy sidecar. The value of <code>"*"</code> redirects all ports.</td></tr><tr><td><code>traffic.sidecar.istio.io/excludeInboundPorts</code></td><td><code><port1>,<port2>,...</code></td><td></td><td>Comma separated list of inbound ports to be excluded from redirection to the Istio sidecar proxy. Only valid when <code>includeInboundPorts</code> is <code>"*"</code>.</td></tr><tr><td><code>traffic.sidecar.istio.io/excludeOutboundPorts</code></td><td><code><port1>,<port2>,...</code></td><td></td><td>Comma separated list of outbound ports to be excluded from redirection to Envoy.</td></tr><tr><td><code>traffic.sidecar.istio.io/kubevirtInterfaces</code></td><td><code><ethX>,<ethY>,...</code></td><td></td><td>Comma separated list of virtual interfaces whose inbound traffic (from VM) will be treated as outbound.</td></tr></tbody></table><h3 id=logging>Logging</h3><p>The Istio CNI plugin runs in the container runtime process space.
|
||
Due to this, the <code>kubelet</code> process writes the plugin’s log entries into its log.</p><h3 id=compatibility-with-application-init-containers>Compatibility with application init containers</h3><p>The Istio CNI plugin may cause networking connectivity problems for any application <code>initContainers</code>. When using Istio CNI, <code>kubelet</code>
|
||
starts an injected pod with the following steps:</p><ol><li>The Istio CNI plugin sets up traffic redirection to the Istio sidecar proxy within the pod.</li><li>All init containers execute and complete successfully.</li><li>The Istio sidecar proxy starts in the pod along with the pod’s other containers.</li></ol><p>Init containers execute before the sidecar proxy starts, which can result in traffic loss during their execution.
|
||
Avoid this traffic loss with one or both of the following settings:</p><ul><li>Set the <code>traffic.sidecar.istio.io/excludeOutboundIPRanges</code> annotation to disable redirecting traffic to any
|
||
CIDRs the init containers communicate with.</li><li>Set the <code>traffic.sidecar.istio.io/excludeOutboundPorts</code> annotation to disable redirecting traffic to the
|
||
specific outbound ports the init containers use.</li></ul><h3 id=compatibility-with-other-cni-plugins>Compatibility with other CNI plugins</h3><p>The Istio CNI plugin maintains compatibility with the same set of CNI plugins as the current
|
||
<code>istio-init</code> container which requires the <code>NET_ADMIN</code> and <code>NET_RAW</code> capabilities.</p><p>The Istio CNI plugin operates as a chained CNI plugin. This means its configuration is added to the existing
|
||
CNI plugins configuration as a new configuration list element. See the
|
||
<a href=https://github.com/containernetworking/cni/blob/master/SPEC.md#network-configuration-lists>CNI specification reference</a> for further details.
|
||
When a pod is created or deleted, the container runtime invokes each plugin in the list in order. The Istio
|
||
CNI plugin only performs actions to setup the application pod’s traffic redirection to the injected Istio proxy
|
||
sidecar (using <code>iptables</code> in the pod’s network namespace).</p><div><aside class="callout warning"><div class=type><svg class="large-icon"><use xlink:href="/v1.5/img/icons.svg#callout-warning"/></svg></div><div class=content>The Istio CNI plugin should not interfere with the operations of the base CNI plugin that configures the pod’s
|
||
networking setup, although not all CNI plugins have been validated.</div></aside></div><nav id=see-also><h2>See also</h2><div class=see-also><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/docs/setup/install/helm/>Customizable Install with Helm</a></p><p class=desc>Install and configure Istio for in-depth evaluation or production use.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/news/releases/1.3.x/announcing-1.3/helm-changes/>Helm Changes</a></p><p class=desc>Details the Helm chart installation options differences between Istio 1.2 and Istio 1.3.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/news/releases/1.2.x/announcing-1.2/helm-changes/>Helm Changes</a></p><p class=desc>Details the Helm chart installation options differences between Istio 1.1 and Istio 1.2.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/news/releases/1.1.x/announcing-1.1/helm-changes/>Helm Changes</a></p><p class=desc>Details the Helm chart installation options differences between Istio 1.0 and Istio 1.1.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/docs/reference/config/installation-options/>Installation Options (Helm)</a></p><p class=desc>Describes the options available when installing Istio using Helm charts.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/docs/setup/additional-setup/sidecar-injection/>Installing the Sidecar</a></p><p class=desc>Install the Istio sidecar in application pods automatically using the sidecar injector webhook or manually using istioctl CLI.</p></div></div></nav></article><nav class=pagenav><div class=left><a title="Install the Istio sidecar in application pods automatically using the sidecar injector webhook or manually using istioctl CLI." href=/v1.5/docs/setup/additional-setup/sidecar-injection/><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#left-arrow"/></svg>Installing the Sidecar</a></div><div class=right></div></nav><div id=feedback><div id=feedback-initial>Was this information useful?<br><button class="btn feedback" onclick="sendFeedback('en',1)">Yes</button>
|
||
<button class="btn feedback" onclick="sendFeedback('en',0)">No</button></div><div id=feedback-comment>Do you have any suggestions for improvement?<br><br><input id=feedback-textbox type=text placeholder="Help us improve..." data-lang=en></div><div id=feedback-thankyou>Thanks for your feedback!</div></div><div id=endnotes-container aria-hidden=true><h2>Links</h2><ol id=endnotes></ol></div></div><div class=toc-container><nav class=toc aria-label="Table of Contents"><div id=toc><ol><li role=none aria-label=Prerequisites><a href=#prerequisites>Prerequisites</a><li role=none aria-label=Installation><a href=#installation>Installation</a><ol><li role=none aria-label="Helm chart parameters"><a href=#helm-chart-parameters>Helm chart parameters</a><li role=none aria-label="Excluding specific Kubernetes namespaces"><a href=#excluding-specific-kubernetes-namespaces>Excluding specific Kubernetes namespaces</a><li role=none aria-label="Hosted Kubernetes settings"><a href=#hosted-kubernetes-settings>Hosted Kubernetes settings</a><ol><li role=none aria-label="Instructions for Istio 1.4.x and OpenShift"><a href=#instructions-for-istio-1-4-x-and-openshift>Instructions for Istio 1.4.x and OpenShift</a></ol></li><li role=none aria-label="GKE setup"><a href=#gke-setup>GKE setup</a></ol></li><li role=none aria-label="Sidecar injection compatibility"><a href=#sidecar-injection-compatibility>Sidecar injection compatibility</a><li role=none aria-label="Operational details"><a href=#operational-details>Operational details</a><ol><li role=none aria-label="Identifying pods requiring traffic redirection"><a href=#identifying-pods-requiring-traffic-redirection>Identifying pods requiring traffic redirection</a><li role=none aria-label="Traffic redirection parameters"><a href=#traffic-redirection-parameters>Traffic redirection parameters</a><li role=none aria-label=Logging><a href=#logging>Logging</a><li role=none aria-label="Compatibility with application init containers"><a href=#compatibility-with-application-init-containers>Compatibility with application init containers</a><li role=none aria-label="Compatibility with other CNI plugins"><a href=#compatibility-with-other-cni-plugins>Compatibility with other CNI plugins</a></ol></li><li role=none aria-label="See also"><a href=#see-also>See also</a></li></ol></div></nav></div></main><footer><div class=user-links><a class=channel title="Go download Istio 1.5.4 now" href=/v1.5/docs/setup/getting-started/#download aria-label="Download Istio"><span>download</span><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#download"/></svg>
|
||
</a><a class=channel title="Join the Istio discussion board to participate in discussions and get help troubleshooting problems" href=https://discuss.istio.io aria-label="Istio discussion board"><span>discuss</span><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#discourse"/></svg></a>
|
||
<a class=channel title="Stack Overflow is where you can ask questions and find curated answers on deploying, configuring, and using Istio" href=https://stackoverflow.com/questions/tagged/istio aria-label="Stack Overflow"><span>stack overflow</span><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#stackoverflow"/></svg></a>
|
||
<a class=channel title="Interactively discuss issues with the Istio community on Slack" href=https://istio.slack.com aria-label=slack><span>slack</span><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#slack"/></svg></a>
|
||
<a class=channel title="Follow us on Twitter to get the latest news" href=https://twitter.com/IstioMesh aria-label=Twitter><span>twitter</span><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#twitter"/></svg></a><div class=tag>for everyone</div></div><div class=info><p class=copyright>Istio Archive
|
||
1.5.4<br>© 2020 Istio Authors, <a href=https://policies.google.com/privacy>Privacy Policy</a><br>Archived on May 21, 2020</p></div><div class=dev-links><a class=channel title="GitHub is where development takes place on Istio code" href=https://github.com/istio/community aria-label=GitHub><span>github</span><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#github"/></svg></a>
|
||
<a class=channel title="Access our team drive if you'd like to take a look at the Istio technical design documents" href=https://groups.google.com/forum/#!forum/istio-team-drive-access aria-label="team drive"><span>drive</span><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#drive"/></svg></a>
|
||
<a class=channel title="If you'd like to contribute to the Istio project, consider participating in our working groups" href=https://github.com/istio/community/blob/master/WORKING-GROUPS.md aria-label="working groups"><span>working groups</span><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#working-groups"/></svg></a><div class=tag>for developers</div></div></footer><div id=scroll-to-top-container aria-hidden=true><button id=scroll-to-top title="Back to top"><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#top"/></svg></button></div></body></html> |