mirror of https://github.com/istio/istio.io.git
283 lines
90 KiB
HTML
283 lines
90 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="Customizable Install with Istioctl"><meta name=description content="Install and customize any Istio configuration profile for in-depth evaluation or production use."><meta name=keywords content="microservices,services,mesh,istioctl,kubernetes"><meta property="og:title" content="Customizable Install with Istioctl"><meta property="og:type" content="website"><meta property="og:description" content="Install and customize any Istio configuration profile for in-depth evaluation or production use."><meta property="og:url" content="/v1.5/docs/setup/install/istioctl/"><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 / Customizable Install with 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.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="Customizable Install with Istioctl";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\/install\/istioctl\/');return false;">Current Release</a>
|
||
<a tabindex=-1 role=menuitem onclick="navigateToUrlOrRoot('https://preliminary.istio.io/docs\/setup\/install\/istioctl\/');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 class=show 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=true><li role=none><span role=treeitem class=current title="Install and customize any Istio configuration profile for in-depth evaluation or production use.">Customizable Install with Istioctl</span></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 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=false 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><a role=treeitem title="Install and use Istio with the Istio CNI plugin, allowing operators to deploy services with lower privilege." href=/v1.5/docs/setup/additional-setup/cni/>Install Istio with the Istio CNI plugin</a></li></ul></li></ul></div></div><div class=card><button class="header dynamic" id=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/install/ title="Choose the guide that best suits your needs and platform.">Install</a></li><li>Customizable Install with Istioctl</li></ol></nav><article aria-labelledby=title><div class=title-area><div style=width:100%><h1 id=title>Customizable Install with Istioctl</h1><p class=byline><span title="1912 words"><svg class="icon"><use xlink:href="/v1.5/img/icons.svg#clock"/></svg><span> </span>9 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="Install Istio using the default profile"><a href=#install-istio-using-the-default-profile>Install Istio using the default profile</a><li role=none aria-label="Install from external charts"><a href=#install-from-external-charts>Install from external charts</a><li role=none aria-label="Install a different profile"><a href=#install-a-different-profile>Install a different profile</a><li role=none aria-label="Display the list of available profiles"><a href=#display-the-list-of-available-profiles>Display the list of available profiles</a><li role=none aria-label="Display the configuration of a profile"><a href=#display-the-configuration-of-a-profile>Display the configuration of a profile</a><li role=none aria-label="Show differences in profiles"><a href=#show-differences-in-profiles>Show differences in profiles</a><li role=none aria-label="Generate a manifest before installation"><a href=#generate-a-manifest-before-installation>Generate a manifest before installation</a><li role=none aria-label="Show differences in manifests"><a href=#show-differences-in-manifests>Show differences in manifests</a><li role=none aria-label="Verify a successful installation"><a href=#verify-a-successful-installation>Verify a successful installation</a><li role=none aria-label="Customizing the configuration"><a href=#customizing-the-configuration>Customizing the configuration</a><ol><li role=none aria-label="Identify an Istio component"><a href=#identify-an-istio-component>Identify an Istio component</a><li role=none aria-label="Configure component settings"><a href=#configure-component-settings>Configure component settings</a><li role=none aria-label="Configure gateways"><a href=#configure-gateways>Configure gateways</a><li role=none aria-label="Customize Kubernetes settings"><a href=#customize-kubernetes-settings>Customize Kubernetes settings</a><li role=none aria-label="Customize Istio settings using the Helm API"><a href=#customize-istio-settings-using-the-helm-api>Customize Istio settings using the Helm API</a></ol></li><li role=none aria-label="Uninstall Istio"><a href=#uninstall-istio>Uninstall Istio</a><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 and configure an Istio mesh for in-depth evaluation or production use.
|
||
If you are new to Istio, and just want to try it out, follow the
|
||
<a href=/v1.5/docs/setup/getting-started>quick start instructions</a> instead.</p><p>This installation guide uses the <a href=/v1.5/docs/reference/commands/istioctl/><code>istioctl</code></a> command line
|
||
tool to provide rich customization of the Istio control plane and of the sidecars for the Istio data plane.
|
||
It has user input validation to help prevent installation errors and customization options to
|
||
override any aspect of the configuration.</p><p>Using these instructions, you can select any one of Istio’s built-in
|
||
<a href=/v1.5/docs/setup/additional-setup/config-profiles/>configuration profiles</a>
|
||
and then further customize the configuration for your specific needs.</p><p>Full customization of the installation can be done through the
|
||
<a href=/v1.5/docs/reference/config/istio.operator.v1alpha1/><code>IstioOperator</code> API</a>.</p><h2 id=prerequisites>Prerequisites</h2><p>Before you begin, check the following prerequisites:</p><ol><li><a href=/v1.5/docs/setup/getting-started/#download>Download the Istio release</a>.</li><li>Perform any necessary <a href=/v1.5/docs/setup/platform-setup/>platform-specific setup</a>.</li><li>Check the <a href=/v1.5/docs/ops/deployment/requirements/>Requirements for Pods and Services</a>.</li></ol><h2 id=install-istio-using-the-default-profile>Install Istio using the default profile</h2><p>The simplest option is to install the <code>default</code> Istio
|
||
<a href=/v1.5/docs/setup/additional-setup/config-profiles/>configuration profile</a>
|
||
using the following command:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply
|
||
</code></pre><p>This command installs the <code>default</code> profile on the cluster defined by your
|
||
Kubernetes configuration. The <code>default</code> profile is a good starting point
|
||
for establishing a production environment, unlike the larger <code>demo</code> profile that
|
||
is intended for evaluating a broad set of Istio features.</p><p>To enable the Grafana dashboard on top of the <code>default</code> profile, set the <code>addonComponents.grafana.enabled</code> configuration parameter with the following command:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply --set addonComponents.grafana.enabled=true
|
||
</code></pre><p>In general, you can use the <code>--set</code> flag in <code>istioctl</code> as you would with
|
||
<a href=/v1.5/docs/setup/install/helm/>Helm</a>. The only difference is you must
|
||
prefix the setting paths with <code>values.</code> because this is the path to the Helm pass-through API in the
|
||
<a href=/v1.5/docs/reference/config/istio.operator.v1alpha1/><code>IstioOperator</code> API</a>.</p><h2 id=install-from-external-charts>Install from external charts</h2><p>By default, <code>istioctl</code> uses compiled-in charts to generate the install manifest. These charts are released together with
|
||
<code>istioctl</code> for auditing and customization purposes and can be found in the release tar in the
|
||
<code>install/kubernetes/operator/charts</code> directory.
|
||
<code>istioctl</code> can also use external charts rather than the compiled-in ones. To select external charts, set
|
||
<code>installPackagePath</code> to a local file system path:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply --set installPackagePath=< path to istio releases >/istio-1.5.4/install/kubernetes/operator/charts \
|
||
--set profile=< path to istio releases >/istio-1.5.4/install/kubernetes/operator/profiles/default.yaml
|
||
</code></pre><p>If using the <code>istioctl</code> 1.5.4 binary, this command will result in the same installation as <code>istioctl manifest apply</code> alone, because it points to the
|
||
same charts as the compiled-in ones.
|
||
Other than for experimenting with or testing new features, we recommend using the compiled-in charts rather than external ones to ensure compatibility of the
|
||
<code>istioctl</code> binary with the charts.</p><h2 id=install-a-different-profile>Install a different profile</h2><p>Other Istio configuration profiles can be installed in a cluster by passing the
|
||
profile name on the command line. For example, the following command can be used
|
||
to install the <code>demo</code> profile:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply --set profile=demo
|
||
</code></pre><h2 id=display-the-list-of-available-profiles>Display the list of available profiles</h2><p>You can display the names of Istio configuration profiles that are
|
||
accessible to <code>istioctl</code> by using this command:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl profile list
|
||
Istio configuration profiles:
|
||
remote
|
||
separate
|
||
default
|
||
demo
|
||
empty
|
||
minimal
|
||
</code></pre><h2 id=display-the-configuration-of-a-profile>Display the configuration of a profile</h2><p>You can view the configuration settings of a profile. For example, to view the setting for the <code>demo</code> profile
|
||
run the following command:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl profile dump demo
|
||
addonComponents:
|
||
grafana:
|
||
enabled: true
|
||
kiali:
|
||
enabled: true
|
||
prometheus:
|
||
enabled: true
|
||
tracing:
|
||
enabled: true
|
||
components:
|
||
egressGateways:
|
||
- enabled: true
|
||
k8s:
|
||
resources:
|
||
requests:
|
||
cpu: 10m
|
||
memory: 40Mi
|
||
name: istio-egressgateway
|
||
|
||
...
|
||
</code></pre><p>To view a subset of the entire configuration, you can use the <code>--config-path</code> flag, which selects only the portion
|
||
of the configuration under the given path:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl profile dump --config-path components.pilot demo
|
||
enabled: true
|
||
k8s:
|
||
env:
|
||
- name: POD_NAME
|
||
valueFrom:
|
||
fieldRef:
|
||
apiVersion: v1
|
||
fieldPath: metadata.name
|
||
- name: POD_NAMESPACE
|
||
valueFrom:
|
||
fieldRef:
|
||
apiVersion: v1
|
||
fieldPath: metadata.namespace
|
||
- name: GODEBUG
|
||
value: gctrace=1
|
||
- name: PILOT_TRACE_SAMPLING
|
||
value: "100"
|
||
- name: CONFIG_NAMESPACE
|
||
value: istio-config
|
||
...
|
||
</code></pre><h2 id=show-differences-in-profiles>Show differences in profiles</h2><p>The <code>profile diff</code> sub-command can be used to show the differences between profiles,
|
||
which is useful for checking the effects of customizations before applying changes to a cluster.</p><p>You can show differences between the default and demo profiles using these commands:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl profile diff default demo
|
||
gateways:
|
||
egressGateways:
|
||
- - enabled: false
|
||
+ - enabled: true
|
||
...
|
||
k8s:
|
||
requests:
|
||
- cpu: 100m
|
||
- memory: 128Mi
|
||
+ cpu: 10m
|
||
+ memory: 40Mi
|
||
strategy:
|
||
...
|
||
</code></pre><h2 id=generate-a-manifest-before-installation>Generate a manifest before installation</h2><p>You can generate the manifest before installing Istio using the <code>manifest generate</code>
|
||
sub-command, instead of <code>manifest apply</code>.
|
||
For example, use the following command to generate a manifest for the <code>default</code> profile:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest generate > $HOME/generated-manifest.yaml
|
||
</code></pre><p>Inspect the manifest as needed, then apply the manifest using this command:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ kubectl apply -f $HOME/generated-manifest.yaml
|
||
</code></pre><div><aside class="callout tip"><div class=type><svg class="large-icon"><use xlink:href="/v1.5/img/icons.svg#callout-tip"/></svg></div><div class=content>This command might show transient errors due to resources not being available in
|
||
the cluster in the correct order.</div></aside></div><h2 id=show-differences-in-manifests>Show differences in manifests</h2><p>You can show the differences in the generated manifests in a YAML style diff between the default profile and a
|
||
customized install using these commands:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest generate > 1.yaml
|
||
$ istioctl manifest generate -f samples/operator/pilot-k8s.yaml > 2.yaml
|
||
$ istioctl manifest diff 1.yam1 2.yaml
|
||
Differences of manifests are:
|
||
|
||
Object Deployment:istio-system:istio-pilot has diffs:
|
||
|
||
spec:
|
||
template:
|
||
spec:
|
||
containers:
|
||
'[0]':
|
||
resources:
|
||
requests:
|
||
cpu: 500m -> 1000m
|
||
memory: 2048Mi -> 4096Mi
|
||
nodeSelector: -> map[master:true]
|
||
tolerations: -> [map[effect:NoSchedule key:dedicated operator:Exists] map[key:CriticalAddonsOnly
|
||
operator:Exists]]
|
||
|
||
|
||
Object HorizontalPodAutoscaler:istio-system:istio-pilot has diffs:
|
||
|
||
spec:
|
||
maxReplicas: 5 -> 10
|
||
minReplicas: 1 -> 2
|
||
</code></pre><h2 id=verify-a-successful-installation>Verify a successful installation</h2><p>You can check if the Istio installation succeeded using the <code>verify-install</code> command
|
||
which compares the installation on your cluster to a manifest you specify.</p><p>If you didn’t generate your manifest prior to deployment, run the following command to
|
||
generate it now:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest generate <your original installation options> > $HOME/generated-manifest.yaml
|
||
</code></pre><p>Then run the following <code>verify-install</code> command to see if the installation was successful:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl verify-install -f $HOME/generated-manifest.yaml
|
||
</code></pre><h2 id=customizing-the-configuration>Customizing the configuration</h2><p>In addition to installing any of Istio’s built-in
|
||
<a href=/v1.5/docs/setup/additional-setup/config-profiles/>configuration profiles</a>,
|
||
<code>istioctl manifest</code> provides a complete API for customizing the configuration.</p><ul><li><a href=/v1.5/docs/reference/config/istio.operator.v1alpha1/>The <code>IstioOperator</code> API</a></li></ul><p>The configuration parameters in this API can be set individually using <code>--set</code> options on the command
|
||
line. For example, to enable the control plane security feature in a default configuration profile, use this command:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply --set values.global.controlPlaneSecurityEnabled=true
|
||
</code></pre><p>Alternatively, the <code>IstioOperator</code> configuration can be specified in a YAML file and passed to
|
||
<code>istioctl</code> using the <code>-f</code> option:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply -f samples/operator/pilot-k8s.yaml
|
||
</code></pre><div><aside class="callout tip"><div class=type><svg class="large-icon"><use xlink:href="/v1.5/img/icons.svg#callout-tip"/></svg></div><div class=content><p>For backwards compatibility, the previous <a href=/v1.5/docs/reference/config/installation-options/>Helm installation options</a>, with the exception of Kubernetes resource settings,
|
||
are also fully supported. To set them on the command line, prepend the option name with “<code>values.</code>”.
|
||
For example, the following command overrides the <code>pilot.traceSampling</code> Helm configuration option:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply --set values.pilot.traceSampling=0.1
|
||
</code></pre><p>Helm values can also be set in an <code>IstioOperator</code> CR (YAML file) as described in
|
||
<a href=#customize-istio-settings-using-the-helm-api>Customize Istio settings using the Helm API</a>, below.</p><p>If you want to set Kubernetes resource settings, use the <code>IstioOperator</code> API as described in
|
||
<a href=#customize-kubernetes-settings>Customize Kubernetes settings</a>.</p></div></aside></div><h3 id=identify-an-istio-component>Identify an Istio component</h3><p>The <code>IstioOperator</code> API defines components as shown in the table below:</p><table><thead><tr><th>Components</th></tr></thead><tbody><tr><td><code>base</code></td></tr><tr><td><code>pilot</code></td></tr><tr><td><code>proxy</code></td></tr><tr><td><code>sidecarInjector</code></td></tr><tr><td><code>telemetry</code></td></tr><tr><td><code>policy</code></td></tr><tr><td><code>citadel</code></td></tr><tr><td><code>nodeagent</code></td></tr><tr><td><code>galley</code></td></tr><tr><td><code>ingressGateways</code></td></tr><tr><td><code>egressGateways</code></td></tr><tr><td><code>cni</code></td></tr></tbody></table><p>In addition to the core Istio components, third-party addon components are also available. These can
|
||
be enabled and configured through the <code>addonComponents</code> spec of the <code>IstioOperator</code> API or using the Helm pass-through API:</p><pre><code class=language-yaml data-expandlinks=true data-repo=istio>apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
spec:
|
||
addonComponents:
|
||
grafana:
|
||
enabled: true
|
||
</code></pre><pre><code class=language-yaml data-expandlinks=true data-repo=istio>apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
spec:
|
||
values:
|
||
grafana:
|
||
enabled: true
|
||
</code></pre><h3 id=configure-component-settings>Configure component settings</h3><p>After you identify the name of the component from the previous table, you can use the API to set the values
|
||
using the <code>--set</code> flag, or create an overlay file and use the <code>--filename</code> flag. The <code>--set</code> flag
|
||
works well for customizing a few parameters. Overlay files are designed for more extensive customization, or
|
||
tracking configuration changes.</p><p>The simplest customization is to turn a component on or off from the configuration profile default.</p><p>To disable the telemetry component in a default configuration profile, use this command:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply --set components.telemetry.enabled=false
|
||
</code></pre><p>Alternatively, you can disable the telemetry component using a configuration overlay file:</p><ol><li>Create this file with the name <code>telemetry_off.yaml</code> and these contents:</li></ol><pre><code class=language-yaml data-expandlinks=true data-repo=istio>apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
spec:
|
||
components:
|
||
telemetry:
|
||
enabled: false
|
||
</code></pre><ol><li>Use the <code>telemetry_off.yaml</code> overlay file with the <code>manifest apply</code> command:</li></ol><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest apply -f telemetry_off.yaml
|
||
</code></pre><p>Another customization is to select different namespaces for features and components. The following is an example
|
||
of installation namespace customization:</p><pre><code class=language-yaml data-expandlinks=true data-repo=istio>apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
metadata:
|
||
namespace: istio-system
|
||
spec:
|
||
components:
|
||
citadel:
|
||
namespace: istio-citadel
|
||
</code></pre><p>Applying this file will cause the default profile to be applied, with components being installed into the following
|
||
namespaces:</p><ul><li>The Citadel component is installed into <code>istio-citadel</code> namespace</li><li>Remaining Istio components installed into istio-system namespace</li></ul><h3 id=configure-gateways>Configure gateways</h3><p>Gateways are a special type of component, since multiple ingress and egress gateways can be defined. In the
|
||
<a href=/v1.5/docs/reference/config/istio.operator.v1alpha1/><code>IstioOperator</code> API</a>, gateways are defined as a list type.
|
||
The <code>default</code> profile installs one ingress gateway, called <code>istio-ingressgateway</code>. You can inspect the default values
|
||
for this gateway:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl profile dump --config-path components.ingressGateways
|
||
$ istioctl profile dump --config-path values.gateways.istio-ingressgateway
|
||
</code></pre><p>These commands show both the <code>IstioOperator</code> and Helm settings for the gateway, which are used together to define the
|
||
generated gateway resources. The built-in gateways can be customized just like any other component.
|
||
A new user gateway can be created by adding a new list entry:</p><pre><code class=language-yaml data-expandlinks=true data-repo=istio>apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
spec:
|
||
components:
|
||
ingressGateways:
|
||
- name: istio-ingressgateway
|
||
enabled: true
|
||
- namespace: user-ingressgateway-ns
|
||
name: ilb-gateway
|
||
enabled: true
|
||
k8s:
|
||
resources:
|
||
requests:
|
||
cpu: 200m
|
||
serviceAnnotations:
|
||
cloud.google.com/load-balancer-type: "internal"
|
||
service:
|
||
ports:
|
||
- port: 8060
|
||
targetPort: 8060
|
||
name: tcp-citadel-grpc-tls
|
||
- port: 5353
|
||
name: tcp-dns
|
||
</code></pre><p>Note that Helm values (<code>spec.values.gateways.istio-ingressgateway/egressgateway</code>) are shared by all ingress/egress
|
||
gateways. If these must be customized per gateway, it is recommended to use a separate IstioOperator CR to generate
|
||
a manifest for the user gateways, separate from the main Istio installation:</p><pre><code class=language-yaml data-expandlinks=true data-repo=istio>apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
spec:
|
||
profile: empty
|
||
components:
|
||
ingressGateways:
|
||
- name: ilb-gateway
|
||
enabled: true
|
||
# Copy settings from istio-ingressgateway as needed.
|
||
values:
|
||
gateways:
|
||
istio-ingressgateway:
|
||
debug: error
|
||
</code></pre><h3 id=customize-kubernetes-settings>Customize Kubernetes settings</h3><p>The <code>IstioOperator</code> API allows each component’s Kubernetes settings to be customized in a consistent way.</p><p>Each component has a <a href=/v1.5/docs/reference/config/istio.operator.v1alpha1/#KubernetesResourcesSpec><code>KubernetesResourceSpec</code></a>,
|
||
which allows the following settings to be changed. Use this list to identify the setting to customize:</p><ol><li><a href=https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container>Resources</a></li><li><a href=https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/>Readiness probes</a></li><li><a href=https://kubernetes.io/docs/concepts/workloads/controllers/deployment/>Replica count</a></li><li><a href=https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/><code>HorizontalPodAutoscaler</code></a></li><li><a href=https://kubernetes.io/docs/concepts/workloads/pods/disruptions/#how-disruption-budgets-work><code>PodDisruptionBudget</code></a></li><li><a href=https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/>Pod annotations</a></li><li><a href=https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/>Service annotations</a></li><li><a href=https://kubernetes.io/docs/concepts/containers/images/><code>ImagePullPolicy</code></a></li><li><a href=https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass>Priority class name</a></li><li><a href=https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector>Node selector</a></li><li><a href=https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity>Affinity and anti-affinity</a></li><li><a href=https://kubernetes.io/docs/concepts/services-networking/service/>Service</a></li><li><a href=https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/>Toleration</a></li><li><a href=https://kubernetes.io/docs/concepts/workloads/controllers/deployment/>Strategy</a></li><li><a href=https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/>Env</a></li></ol><p>All of these Kubernetes settings use the Kubernetes API definitions, so <a href=https://kubernetes.io/docs/concepts/>Kubernetes documentation</a> can be used for reference.</p><p>The following example overlay file adjusts the resources and horizontal pod autoscaling
|
||
settings for Pilot:</p><pre><code class=language-yaml data-expandlinks=true data-repo=istio>apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
spec:
|
||
components:
|
||
pilot:
|
||
k8s:
|
||
resources:
|
||
requests:
|
||
cpu: 1000m # override from default 500m
|
||
memory: 4096Mi # ... default 2048Mi
|
||
hpaSpec:
|
||
maxReplicas: 10 # ... default 5
|
||
minReplicas: 2 # ... default 1
|
||
nodeSelector:
|
||
master: "true"
|
||
tolerations:
|
||
- key: dedicated
|
||
operator: Exists
|
||
effect: NoSchedule
|
||
- key: CriticalAddonsOnly
|
||
operator: Exists
|
||
</code></pre><p>Use <code>manifest apply</code> to apply the modified settings to the cluster:</p><pre><code class=language-bash data-expandlinks=true data-repo=operator>$ istioctl manifest apply -f samples/operator/pilot-k8s.yaml
|
||
</code></pre><h3 id=customize-istio-settings-using-the-helm-api>Customize Istio settings using the Helm API</h3><p>The <code>IstioOperator</code> API includes a pass-through interface to the <a href=/v1.5/docs/reference/config/installation-options/>Helm API</a>
|
||
using the <code>values</code> field.</p><p>The following YAML file configures global and Pilot settings through the Helm API:</p><pre><code class=language-yaml data-expandlinks=true data-repo=istio>apiVersion: install.istio.io/v1alpha1
|
||
kind: IstioOperator
|
||
spec:
|
||
values:
|
||
pilot:
|
||
traceSampling: 0.1 # override from 1.0
|
||
global:
|
||
monitoringPort: 15050
|
||
</code></pre><p>Some parameters will temporarily exist in both the Helm and <code>IstioOperator</code> APIs, including Kubernetes resources,
|
||
namespaces and enablement settings. The Istio community recommends using the <code>IstioOperator</code> API as it is more
|
||
consistent, is validated, and follows the <a href=https://github.com/istio/community/blob/master/FEATURE-LIFECYCLE-CHECKLIST.md#feature-lifecycle-checklist>community graduation process</a>.</p><h2 id=uninstall-istio>Uninstall Istio</h2><p>To uninstall Istio, run the following command:</p><pre><code class=language-bash data-expandlinks=true data-repo=istio>$ istioctl manifest generate <your original installation options> | kubectl delete -f -
|
||
</code></pre><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/ops/diagnostic-tools/istioctl-analyze/>Diagnose your Configuration with Istioctl Analyze</a></p><p class=desc>Shows you how to use istioctl analyze to identify potential issues with your configuration.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/docs/ops/diagnostic-tools/istioctl-describe/>Understand your Mesh with Istioctl Describe</a></p><p class=desc>Shows you how to use istioctl describe to verify the configurations of a pod in your mesh.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/blog/2019/dns-cert/>DNS Certificate Management</a></p><p class=desc>Provision and manage DNS certificates in Istio.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/blog/2019/introducing-istioctl-analyze/>Introducing istioctl analyze</a></p><p class=desc>Analyze your Istio configuration to detect potential issues and get general insights.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/blog/2019/introducing-istio-operator/>Introducing the Istio Operator</a></p><p class=desc>Introduction to Istio's new operator-based installation and control plane management feature.</p></div><div class=entry><p class=link><a data-skipendnotes=true href=/v1.5/blog/2019/webhook/>Secure Webhook Management</a></p><p class=desc>A more secure way to manage Istio webhooks.</p></div></div></nav></article><nav class=pagenav><div class=left></div><div class=right><a title="Install and configure Istio for in-depth evaluation or production use." href=/v1.5/docs/setup/install/helm/>Customizable Install with Helm<svg class="icon"><use xlink:href="/v1.5/img/icons.svg#right-arrow"/></svg></a></div></nav><div id=feedback><div id=feedback-initial>Was this information useful?<br><button class="btn feedback" onclick="sendFeedback('en',1)">Yes</button>
|
||
<button class="btn feedback" onclick="sendFeedback('en',0)">No</button></div><div id=feedback-comment>Do you have any suggestions for improvement?<br><br><input id=feedback-textbox type=text placeholder="Help us improve..." data-lang=en></div><div id=feedback-thankyou>Thanks for your feedback!</div></div><div id=endnotes-container aria-hidden=true><h2>Links</h2><ol id=endnotes></ol></div></div><div class=toc-container><nav class=toc aria-label="Table of Contents"><div id=toc><ol><li role=none aria-label=Prerequisites><a href=#prerequisites>Prerequisites</a><li role=none aria-label="Install Istio using the default profile"><a href=#install-istio-using-the-default-profile>Install Istio using the default profile</a><li role=none aria-label="Install from external charts"><a href=#install-from-external-charts>Install from external charts</a><li role=none aria-label="Install a different profile"><a href=#install-a-different-profile>Install a different profile</a><li role=none aria-label="Display the list of available profiles"><a href=#display-the-list-of-available-profiles>Display the list of available profiles</a><li role=none aria-label="Display the configuration of a profile"><a href=#display-the-configuration-of-a-profile>Display the configuration of a profile</a><li role=none aria-label="Show differences in profiles"><a href=#show-differences-in-profiles>Show differences in profiles</a><li role=none aria-label="Generate a manifest before installation"><a href=#generate-a-manifest-before-installation>Generate a manifest before installation</a><li role=none aria-label="Show differences in manifests"><a href=#show-differences-in-manifests>Show differences in manifests</a><li role=none aria-label="Verify a successful installation"><a href=#verify-a-successful-installation>Verify a successful installation</a><li role=none aria-label="Customizing the configuration"><a href=#customizing-the-configuration>Customizing the configuration</a><ol><li role=none aria-label="Identify an Istio component"><a href=#identify-an-istio-component>Identify an Istio component</a><li role=none aria-label="Configure component settings"><a href=#configure-component-settings>Configure component settings</a><li role=none aria-label="Configure gateways"><a href=#configure-gateways>Configure gateways</a><li role=none aria-label="Customize Kubernetes settings"><a href=#customize-kubernetes-settings>Customize Kubernetes settings</a><li role=none aria-label="Customize Istio settings using the Helm API"><a href=#customize-istio-settings-using-the-helm-api>Customize Istio settings using the Helm API</a></ol></li><li role=none aria-label="Uninstall Istio"><a href=#uninstall-istio>Uninstall Istio</a><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> |