mirror of https://github.com/istio/istio.io.git
121 lines
61 KiB
HTML
121 lines
61 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="Installing Istio Sidecar"><meta name="description" content="Instructions for installing the Istio sidecar in application pods automatically using the sidecar injector webhook or manually using istioctl CLI."><meta name="og:title" content="Installing Istio Sidecar"><meta name="og:description" content="Instructions for installing the Istio sidecar in application pods automatically using the sidecar injector webhook or manually using istioctl CLI."><meta name="og:url" content="/docs/setup/kubernetes/sidecar-injection.html"><meta name="og.site_name" content="Istio"><title>Istioldie 0.6 / Installing Istio Sidecar</title><script> window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; ga('create', 'UA-98480406-2', 'auto'); ga('send', 'pageview'); </script> <script async src='https://www.google-analytics.com/analytics.js'></script><link rel="alternate" type="application/rss+xml" title="Istio Blog RSS" href="/v0.6/feed.xml"><link rel="shortcut icon" href="/v0.6/favicons/favicon.ico" ><link rel="apple-touch-icon" href="/v0.6/favicons/apple-touch-icon-180x180.png" sizes="180x180"><link rel="icon" type="image/png" href="/v0.6/favicons/favicon-16x16.png" sizes="16x16"><link rel="icon" type="image/png" href="/v0.6/favicons/favicon-32x32.png" sizes="32x32"><link rel="icon" type="image/png" href="/v0.6/favicons/android-36x36.png" sizes="36x36"><link rel="icon" type="image/png" href="/v0.6/favicons/android-48x48.png" sizes="48x48"><link rel="icon" type="image/png" href="/v0.6/favicons/android-72x72.png" sizes="72x72"><link rel="icon" type="image/png" href="/v0.6/favicons/android-96x196.png" sizes="96x196"><link rel="icon" type="image/png" href="/v0.6/favicons/android-144x144.png" sizes="144x144"><link rel="icon" type="image/png" href="/v0.6/favicons/android-192x192.png" sizes="192x192"><link rel="manifest" href="/v0.6/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=Roboto:400,100,100italic,300,300italic,400italic,500,500italic,700,700italic,900,900italic"><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous"><link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.6/css/all.css"><link rel="stylesheet" href="/v0.6/css/light_theme.css" title="light"><link rel="alternate stylesheet" href="/v0.6/css/dark_theme.css" title="dark"> <script src="/v0.6/js/styleSwitcher.min.js"></script></head><body class="language-unknown theme-unknown"><header role="banner"><nav class="navbar navbar-expand-md navbar-dark fixed-top bg-dark"> <a class="navbar-brand" href="/v0.6/" style="visibility: visible"> <img class="logo" src="/v0.6/img/istio-logo.svg" alt="Istio Logo"/> <span class="brand-name">Istioldie 0.6</span> </a> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse" aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button><div class="collapse navbar-collapse justify-content-end" id="navbarCollapse"><ul class="navbar-nav"><li class="nav-item"> <a class="nav-link " href="/v0.6/about/intro.html">About</a></li><li class="nav-item"> <a class="nav-link " href="/v0.6/blog/2018/traffic-mirroring.html">Blog</a></li><li class="nav-item"> <a class="nav-link active" href="/v0.6/docs/">Docs</a></li><li class="nav-item"> <a class="nav-link " href="/v0.6/help/">Help</a></li><li class="nav-item"> <a class="nav-link " href="/v0.6/community.html">Community</a></li><li class="nav-item dropdown" id="gearDropdown" style="white-space: nowrap"> <a href="" class="nav-link dropdown-toggle" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false"> <i style="width: 1em" class='fa fa-lg fa-cog'></i> </a><ul class="dropdown-menu" aria-labelledby="gearDropdown"><h6 class="dropdown-header">Other versions of this site</h6><li> <a href="https://istio.io">Current Release</a></li><li> <a href="https://preliminary.istio.io">Next Release</a></li><li> <a href="https://archive.istio.io">Older Releases</a></li><li class="dropdown-divider"></li><li> <i class='fa fa-check light'></i> <a href="" onclick="setActiveStyleSheet('light');return false;">Light Theme</a></li><li> <i class='fa fa-check dark'></i> <a href="" onclick="setActiveStyleSheet('dark');return false;">Dark Theme</a></li></ul></li></ul><form name="cse" id="searchbox" class="form-inline justify-content-end" role="search"> <input type="hidden" name="cx" value="013699703217164175118:iwwf17ikgf4" /> <input type="hidden" name="ie" value="utf-8" /> <input type="hidden" name="hl" value="en" /><div class="input-group"> <input name="q" class="form-control search-box" type="text" size="30" /> <button class="btn btn-search input-group-addon my-2 my-sm-0 fa fa-search" type="submit"></button></div></form></div></nav></header><div class="container-fluid"><div class="row row-offcanvas row-offcanvas-left"><div class="col-6 col-md-3 col-xl-2 sidebar-offcanvas"><nav class="sidebar"><div class="spacer"></div><div class="directory" role="tablist"><div class="card"><div class="card-header" role="tab" id="header1"> <a data-toggle="collapse" href="#collapse1" title="Concepts help you learn about the different parts of the Istio system and the abstractions it uses." role="button" aria-controls="collapse1"><div> Concepts</div></a></div><div id="collapse1" class="collapse" data-parent="#sidebar" role="tabpanel" aria-labelledby="header1"><div class="card-body"><ul class="tree"><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="A broad overview of the Istio system." href="/v0.6/docs/concepts/what-is-istio">What is Istio?</a> </label><ul class="tree collapse"><li> <a title="Provides a conceptual introduction to Istio, including the problems it solves and its high-level architecture." href="/v0.6/docs/concepts/what-is-istio/overview.html">Overview</a></li><li> <a title="Describes the core principles that Istio's design adheres to." href="/v0.6/docs/concepts/what-is-istio/goals.html">Design Goals</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Describes the various Istio features focused on traffic routing and control." href="/v0.6/docs/concepts/traffic-management">Traffic Management</a> </label><ul class="tree collapse"><li> <a title="Provides a conceptual overview of traffic management in Istio and the features it enables." href="/v0.6/docs/concepts/traffic-management/overview.html">Overview</a></li><li> <a title="Introduces Pilot, the component responsible for managing a distributed deployment of Envoy proxies in the service mesh." href="/v0.6/docs/concepts/traffic-management/pilot.html">Pilot</a></li><li> <a title="Describes how requests are routed between services in an Istio service mesh." href="/v0.6/docs/concepts/traffic-management/request-routing.html">Request Routing</a></li><li> <a title="Describes how traffic is load balanced across instances of a service in the mesh." href="/v0.6/docs/concepts/traffic-management/load-balancing.html">Discovery & Load Balancing</a></li><li> <a title="An overview of failure recovery capabilities in Envoy that can be leveraged by unmodified applications to improve robustness and prevent cascading failures." href="/v0.6/docs/concepts/traffic-management/handling-failures.html">Handling Failures</a></li><li> <a title="Introduces the idea of systematic fault injection that can be used to uncover conflicting failure recovery policies across services." href="/v0.6/docs/concepts/traffic-management/fault-injection.html">Fault Injection</a></li><li> <a title="Provides a high-level overview of the domain-specific language used by Istio to configure traffic management rules in the service mesh." href="/v0.6/docs/concepts/traffic-management/rules-configuration.html">Rules Configuration</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Describes Istio's authorization and authentication functionality." href="/v0.6/docs/concepts/security">Security</a> </label><ul class="tree collapse"><li> <a title="Describes Istio's mutual TLS authentication architecture which provides a strong service identity and secure communication channels between services." href="/v0.6/docs/concepts/security/mutual-tls.html">Mutual TLS Authentication</a></li><li> <a title="Describes Istio RBAC which provides access control for services in Istio Mesh." href="/v0.6/docs/concepts/security/rbac.html">Istio Role-Based Access Control (RBAC)</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Introduces the policy control mechanisms." href="/v0.6/docs/concepts/policy-and-control">Policies and Control</a> </label><ul class="tree collapse"><li> <a title="Explains the important notion of attributes, which is a central mechanism for how policies and control are applied to services within the mesh." href="/v0.6/docs/concepts/policy-and-control/attributes.html">Attributes</a></li><li> <a title="Architectural deep-dive into the design of Mixer, which provides the policy and control mechanisms within the service mesh." href="/v0.6/docs/concepts/policy-and-control/mixer.html">Mixer</a></li><li> <a title="An overview of the key concepts used to configure Mixer." href="/v0.6/docs/concepts/policy-and-control/mixer-config.html">Mixer Configuration</a></li></ul></li></ul></div></div></div><div class="card"><div class="card-header" role="tab" id="header20"> <a data-toggle="collapse" href="#collapse20" title="Setup contains instructions for installing the Istio control plane in various environments (e.g., Kubernetes, Consul, etc.), as well as instructions for installing the sidecar in the application deployment." role="button" aria-controls="collapse20"><div> Setup</div></a></div><div id="collapse20" class="collapse show" data-parent="#sidebar" role="tabpanel" aria-labelledby="header20"><div class="card-body"><ul class="tree"><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-down'></i> <a class="" title="Instructions for installing the Istio control plane on Kubernetes and adding VMs into the mesh." href="/v0.6/docs/setup/kubernetes">Kubernetes</a> </label><ul class="tree"><li> <a title="Quick Start instructions to setup the Istio service mesh in a Kubernetes cluster." href="/v0.6/docs/setup/kubernetes/quick-start.html">Quick Start</a></li><li> <a title="Quick Start instructions to setup the Istio service using Google Kubernetes Engine (GKE)" href="/v0.6/docs/setup/kubernetes/quick-start-gke-dm.html">Quick Start with Google Kubernetes Engine</a></li><li> <a title="Instructions for the setup and configuration of Istio using the Helm package manager." href="/v0.6/docs/setup/kubernetes/helm.html">Istio Helm Chart Instructions</a></li><li> <a title="Instructions on using the included Ansible playbook to perform installation." href="/v0.6/docs/setup/kubernetes/ansible-install.html">Installing with Ansible</a></li><li> <span class="current" title="Instructions for installing the Istio sidecar in application pods automatically using the sidecar injector webhook or manually using istioctl CLI.">Installing Istio Sidecar</span></li><li> <a title="Instructions for integrating VMs and bare metal hosts into an Istio mesh deployed on Kubernetes." href="/v0.6/docs/setup/kubernetes/mesh-expansion.html">Istio Mesh Expansion</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Instructions for installing the Istio control plane in a Consul based environment, with or without Nomad." href="/v0.6/docs/setup/consul">Nomad & Consul</a> </label><ul class="tree collapse"><li> <a title="Quick Start instructions to setup the Istio service mesh with Docker Compose." href="/v0.6/docs/setup/consul/quick-start.html">Quick Start on Docker</a></li><li> <a title="Instructions for installing the Istio control plane in a Consul based environment, with or without Nomad." href="/v0.6/docs/setup/consul/install.html">Installation</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Instructions for installing the Istio control plane in a Eureka based environment." href="/v0.6/docs/setup/eureka">Eureka</a> </label><ul class="tree collapse"><li> <a title="Quick Start instructions to setup the Istio service mesh with Docker Compose." href="/v0.6/docs/setup/eureka/quick-start.html">Quick Start on Docker</a></li><li> <a title="Instructions for installing the Istio control plane in an Eureka based environment." href="/v0.6/docs/setup/eureka/install.html">Installation</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Instructions for installing the Istio control plane in Cloud Foundry." href="/v0.6/docs/setup/cloudfoundry">Cloud Foundry</a> </label><ul class="tree collapse"><li> <a title="Instructions for installing the Istio control plane in Cloud Foundry." href="/v0.6/docs/setup/cloudfoundry/install.html">Installation</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Instructions for installing the Istio control plane in Apache Mesos." href="/v0.6/docs/setup/mesos">Mesos</a> </label><ul class="tree collapse"><li> <a title="Instructions for installing the Istio control plane in Apache Mesos." href="/v0.6/docs/setup/mesos/install.html">Installation</a></li></ul></li></ul></div></div></div><div class="card"><div class="card-header" role="tab" id="header38"> <a data-toggle="collapse" href="#collapse38" title="Tasks show you how to do a single specific targeted activity with the Istio system." role="button" aria-controls="collapse38"><div> Tasks</div></a></div><div id="collapse38" class="collapse" data-parent="#sidebar" role="tabpanel" aria-labelledby="header38"><div class="card-body"><ul class="tree"><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Describes tasks that demonstrate traffic routing features of Istio service mesh." href="/v0.6/docs/tasks/traffic-management">Traffic Management</a> </label><ul class="tree collapse"><li> <a title="This task shows you how to configure dynamic request routing based on weights and HTTP headers." href="/v0.6/docs/tasks/traffic-management/request-routing.html">Configuring Request Routing</a></li><li> <a title="This task shows how to inject delays and test the resiliency of your application." href="/v0.6/docs/tasks/traffic-management/fault-injection.html">Fault Injection</a></li><li> <a title="This task shows you how to migrate traffic from an old to new version of a service." href="/v0.6/docs/tasks/traffic-management/traffic-shifting.html">Traffic Shifting</a></li><li> <a title="This task shows you how to setup request timeouts in Envoy using Istio." href="/v0.6/docs/tasks/traffic-management/request-timeouts.html">Setting Request Timeouts</a></li><li> <a title="Describes how to configure Istio Ingress on Kubernetes." href="/v0.6/docs/tasks/traffic-management/ingress.html">Istio Ingress</a></li><li> <a title="Describes how to configure Istio to route traffic from services in the mesh to external services." href="/v0.6/docs/tasks/traffic-management/egress.html">Control Egress Traffic</a></li><li> <a title="Describes how to configure Istio to route TCP traffic from services in the mesh to external services." href="/v0.6/docs/tasks/traffic-management/egress-tcp.html">Control Egress TCP Traffic</a></li><li> <a title="This task demonstrates the circuit-breaking capability for resilient applications" href="/v0.6/docs/tasks/traffic-management/circuit-breaking.html">Circuit Breaking</a></li><li> <a title="Demonstrates Istio's traffic shadowing/mirroring capabilities" href="/v0.6/docs/tasks/traffic-management/mirroring.html">Mirroring</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Describes tasks that demonstrate policy enforcement features." href="/v0.6/docs/tasks/policy-enforcement">Policy Enforcement</a> </label><ul class="tree collapse"><li> <a title="This task shows you how to use Istio to dynamically limit the traffic to a service." href="/v0.6/docs/tasks/policy-enforcement/rate-limiting.html">Enabling Rate Limits</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Describes tasks that demonstrate how to collect telemetry information from the service mesh." href="/v0.6/docs/tasks/telemetry">Metrics, Logs, and Traces</a> </label><ul class="tree collapse"><li> <a title="How to configure the proxies to send tracing requests to Zipkin or Jaeger" href="/v0.6/docs/tasks/telemetry/distributed-tracing.html">Distributed Tracing</a></li><li> <a title="This task shows you how to configure Istio to collect metrics and logs." href="/v0.6/docs/tasks/telemetry/metrics-logs.html">Collecting Metrics and Logs</a></li><li> <a title="This task shows you how to configure Istio to collect metrics for TCP services." href="/v0.6/docs/tasks/telemetry/tcp-metrics.html">Collecting Metrics for TCP services</a></li><li> <a title="This task shows you how to query for Istio Metrics using Prometheus." href="/v0.6/docs/tasks/telemetry/querying-metrics.html">Querying Metrics from Prometheus</a></li><li> <a title="This task shows you how to setup and use the Istio Dashboard to monitor mesh traffic." href="/v0.6/docs/tasks/telemetry/using-istio-dashboard.html">Visualizing Metrics with Grafana</a></li><li> <a title="This task shows you how to generate a graph of services within an Istio mesh." href="/v0.6/docs/tasks/telemetry/servicegraph.html">Generating a Service Graph</a></li><li> <a title="This task shows you how to configure Istio to log to a Fluentd daemon" href="/v0.6/docs/tasks/telemetry/fluentd.html">Logging with Fluentd</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Describes tasks that help securing the service mesh traffic." href="/v0.6/docs/tasks/security">Security</a> </label><ul class="tree collapse"><li> <a title="This task shows you how to verify and test Istio's automatic mutual TLS authentication." href="/v0.6/docs/tasks/security/mutual-tls.html">Testing Istio mutual TLS authentication</a></li><li> <a title="This task shows how to control access to a service using the Kubernetes labels." href="/v0.6/docs/tasks/security/basic-access-control.html">Setting up Basic Access Control</a></li><li> <a title="This task shows how to securely control access to a service using service accounts." href="/v0.6/docs/tasks/security/secure-access-control.html">Setting up Secure Access Control</a></li><li> <a title="This task shows how to set up role-based access control for services in Istio mesh." href="/v0.6/docs/tasks/security/role-based-access-control.html">Setting up Istio Role-Based Access Control</a></li><li> <a title="This task shows how to change mutual TLS authentication for a single service." href="/v0.6/docs/tasks/security/per-service-mtls.html">Per-service mutual TLS authentication enablement</a></li><li> <a title="This task shows how operators can plug existing certificate and key into Istio CA." href="/v0.6/docs/tasks/security/plugin-ca-cert.html">Plugging in CA certificate and key</a></li><li> <a title="This task shows how to enable Istio CA health check." href="/v0.6/docs/tasks/security/health-check.html">Enabling Istio CA health check</a></li></ul></li></ul></div></div></div><div class="card"><div class="card-header" role="tab" id="header67"> <a data-toggle="collapse" href="#collapse67" title="Guides include a variety of fully working example uses for Istio that you can experiment with." role="button" aria-controls="collapse67"><div> Guides</div></a></div><div id="collapse67" class="collapse" data-parent="#sidebar" role="tabpanel" aria-labelledby="header67"><div class="card-body"><ul class="tree"><li> <a title="This guide deploys a sample application composed of four separate microservices which will be used to demonstrate various features of the Istio service mesh." href="/v0.6/docs/guides/bookinfo.html">Bookinfo</a></li><li> <a title="This guide demonstrates how to use various traffic management capabilities of an Istio service mesh." href="/v0.6/docs/guides/intelligent-routing.html">Intelligent Routing</a></li><li> <a title="This sample demonstrates how to obtain uniform metrics, logs, traces across different services using Istio Mixer and Istio sidecar." href="/v0.6/docs/guides/telemetry.html">In-Depth Telemetry</a></li><li> <a title="This sample deploys the Bookinfo services across Kubernetes and a set of virtual machines, and illustrates how to use the Istio service mesh to control this infrastructure as a single mesh." href="/v0.6/docs/guides/integrating-vms.html">Integrating Virtual Machines</a></li></ul></div></div></div><div class="card"><div class="card-header" role="tab" id="header72"> <a data-toggle="collapse" href="#collapse72" title="The Reference section contains detailed authoritative reference material such as command-line options, configuration options, and API calling parameters." role="button" aria-controls="collapse72"><div> Reference</div></a></div><div id="collapse72" class="collapse" data-parent="#sidebar" role="tabpanel" aria-labelledby="header72"><div class="card-body"><ul class="tree"><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Detailed information on API parameters." href="/v0.6/docs/reference/api">API</a> </label><ul class="tree collapse"><li> <a title="API definitions to interact with Mixer" href="/v0.6/docs/reference/api/istio.mixer.v1.html">Mixer</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Detailed information on configuration options." href="/v0.6/docs/reference/config">Configuration</a> </label><ul class="tree collapse"><li> <a title="Configuration affecting the service mesh as a whole" href="/v0.6/docs/reference/config/istio.mesh.v1alpha1.html">Service Mesh</a></li><li> <a title="Configuration state for the Mixer client library" href="/v0.6/docs/reference/config/istio.mixer.v1.config.client.html">Mixer Client</a></li><li> <a title="Describes the rules used to configure Mixer's policy and telemetry features." href="/v0.6/docs/reference/config/istio.mixer.v1.config.html">Policy and Telemetry Rules</a></li><li> <a title="Configuration affecting resource-based access control" href="/v0.6/docs/reference/config/istio.rbac.v1alpha1.html">RBAC</a></li><li> <a title="Configuration affecting traffic routing" href="/v0.6/docs/reference/config/istio.routing.v1alpha1.html">Route Rules Alpha 1</a></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Detailed information on configuration and API exposed by Mixer." href="/v0.6/docs/reference/config/mixer">Mixer</a> </label><ul class="tree collapse"><li> <a title="Definitions used when creating Mixer templates" href="/v0.6/docs/reference/config/mixer/istio.mixer.adapter.model.v1beta1.html">Mixer Adapter Model</a></li><li> <a title="Value types used with templates" href="/v0.6/docs/reference/config/mixer/istio.mixer.v1.config.descriptor.html">Value Type</a></li><li> <a title="Definitions used when creating Mixer templates" href="/v0.6/docs/reference/config/mixer/istio.mixer.v1.template.html">Template Metadata</a></li><li> <a title="Describes the base attribute vocabulary used for policy and control." href="/v0.6/docs/reference/config/mixer/attribute-vocabulary.html">Attribute Vocabulary</a></li><li> <a title="Mixer config expression language reference." href="/v0.6/docs/reference/config/mixer/expression-language.html">Expression Language</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Generated documentation for Mixer's adapters." href="/v0.6/docs/reference/config/adapters">Adapters</a> </label><ul class="tree collapse"><li> <a title="Adapter for circonus.com's monitoring solution." href="/v0.6/docs/reference/config/adapters/circonus.html">Circonus</a></li><li> <a title="Adapter to deliver metrics to a dogstatsd agent for delivery to DataDog" href="/v0.6/docs/reference/config/adapters/datadog.html">Datadog</a></li><li> <a title="Adapter that always returns a precondition denial." href="/v0.6/docs/reference/config/adapters/denier.html">Denier</a></li><li> <a title="Adapter that delivers logs to a fluentd daemon." href="/v0.6/docs/reference/config/adapters/fluentd.html">Fluentd</a></li><li> <a title="Adapter that extracts information from a Kubernetes environment." href="/v0.6/docs/reference/config/adapters/kubernetesenv.html">Kubernetes Env</a></li><li> <a title="Adapter that performs whitelist or blacklist checks" href="/v0.6/docs/reference/config/adapters/list.html">List</a></li><li> <a title="Adapter for a simple in-memory quota management system." href="/v0.6/docs/reference/config/adapters/memquota.html">Memory quota</a></li><li> <a title="Adapter that implements an Open Policy Agent engine" href="/v0.6/docs/reference/config/adapters/opa.html">OPA</a></li><li> <a title="Adapter that exposes Istio metrics for ingestion by a Prometheus harvester." href="/v0.6/docs/reference/config/adapters/prometheus.html">Prometheus</a></li><li> <a title="Adapter that exposes Istio's Role-Based Access Control model." href="/v0.6/docs/reference/config/adapters/rbac.html">RBAC</a></li><li> <a title="Adapter for a Redis-based quota management system." href="/v0.6/docs/reference/config/adapters/redisquota.html">Redis Quota</a></li><li> <a title="Adapter that delivers logs and metrics to Google Service Control" href="/v0.6/docs/reference/config/adapters/servicecontrol.html">Service Control</a></li><li> <a title="Adapter to deliver logs and metrics to Papertrail and AppOptics backends" href="/v0.6/docs/reference/config/adapters/solarwinds.html">SolarWinds</a></li><li> <a title="Adapter to deliver logs and metrics to Stackdriver" href="/v0.6/docs/reference/config/adapters/stackdriver.html">Stackdriver</a></li><li> <a title="Adapter to deliver metrics to a StatsD backend" href="/v0.6/docs/reference/config/adapters/statsd.html">StatsD</a></li><li> <a title="Adapter for outputting logs and metrics locally." href="/v0.6/docs/reference/config/adapters/stdio.html">Stdio</a></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Generated documentation for Mixer's Templates." href="/v0.6/docs/reference/config/template">Templates</a> </label><ul class="tree collapse"><li> <a title="A template that represents a single API key." href="/v0.6/docs/reference/config/template/apikey.html">API Key</a></li><li> <a title="A template used to represent an access control query." href="/v0.6/docs/reference/config/template/authorization.html">Authorization</a></li><li> <a title="A template that carries no data, useful for testing." href="/v0.6/docs/reference/config/template/checknothing.html">Check Nothing</a></li><li> <a title="A template that is used to control the production of Kubernetes-specific attributes." href="/v0.6/docs/reference/config/template/kubernetes.html">Kubernetes</a></li><li> <a title="A template designed to let you perform list checking operations." href="/v0.6/docs/reference/config/template/listentry.html">List Entry</a></li><li> <a title="A template that represents a single runtime log entry." href="/v0.6/docs/reference/config/template/logentry.html">Log Entry</a></li><li> <a title="A template that represents a single runtime metric." href="/v0.6/docs/reference/config/template/metric.html">Metric</a></li><li> <a title="A template that represents a quota allocation request" href="/v0.6/docs/reference/config/template/quota.html">Quota</a></li><li> <a title="A template that carries no data, useful for testing." href="/v0.6/docs/reference/config/template/reportnothing.html">Report Nothing</a></li><li> <a title="A template used by the Google Service Control adapter." href="/v0.6/docs/reference/config/template/servicecontrolreport.html">Service Control Report</a></li></ul></li></ul></li><li class="sublist"> <label class='tree-toggle'> <i class='fa fa-lg fa-caret-right'></i> <a class="" title="Describes usage and options of the Istio commands and utilities." href="/v0.6/docs/reference/commands">Commands</a> </label><ul class="tree collapse"><li> <a title="Istio Certificate Authority (CA)" href="/v0.6/docs/reference/commands/istio_ca.html">istio_ca</a></li><li> <a title="Istio control interface" href="/v0.6/docs/reference/commands/istioctl.html">istioctl</a></li><li> <a title="Utility to trigger direct calls to Mixer's API." href="/v0.6/docs/reference/commands/mixc.html">mixc</a></li><li> <a title="Mixer is Istio's abstraction on top of infrastructure backends." href="/v0.6/docs/reference/commands/mixs.html">mixs</a></li><li> <a title="Istio security per-node agent" href="/v0.6/docs/reference/commands/node_agent.html">node_agent</a></li><li> <a title="Istio Pilot agent" href="/v0.6/docs/reference/commands/pilot-agent.html">pilot-agent</a></li><li> <a title="Istio Pilot" href="/v0.6/docs/reference/commands/pilot-discovery.html">pilot-discovery</a></li><li> <a title="Kubernetes webhook for automatic Istio sidecar injection" href="/v0.6/docs/reference/commands/sidecar-injector.html">sidecar-injector</a></li></ul></li><li> <a title="How to write Istio config YAML content." href="/v0.6/docs/reference/writing-config.html">Writing Configuration</a></li></ul></div></div></div></div></nav></div><div class="col-12 col-md-9 col-lg-7 col-xl-8"><p class="d-md-none"> <label class="sidebar-toggler" data-toggle="offcanvas"> <i class="fa fa-chevron-right"></i> </label></p><main role="main"><h1>Installing Istio Sidecar</h1><p><em>NOTE</em>: The following requires Istio 0.5.0 or greater. See <a href="https://archive.istio.io/v0.4/docs/setup/kubernetes/sidecar-injection">https://archive.istio.io/v0.4/docs/setup/kubernetes/sidecar-injection</a> for Istio versions 0.4.0 or older.</p><p><em>NOTE</em>: In previous releases, the Kubernetes initializer feature was used for automatic proxy injection. This was an Alpha feature, subject to change/removal, and not enabled by default in Kubernetes. Starting in Kubernetes 1.9 it was replaced by a beta feature called <a href="https://kubernetes.io/docs/admin/admission-controllers/#mutatingadmissionwebhook-beta-in-19">mutating webhooks</a>, which is now enabled by default in Kubernetes 1.9 and beyond. Starting in Istio 0.5.0 the automatic proxy injection uses mutating webhooks, and support for injection by initializer has been removed. Users who cannot uprade to Kubernetes 1.9 should use manual injection.</p><h1 id="pod-spec-requirements">Pod Spec Requirements</h1><p>In order to be a part of the service mesh, each pod in the Kubernetes cluster must satisfy the following requirements:</p><ol><li><p><em><strong>Service association</strong>:</em> The pod must belong to a <em>single</em> <a href="https://kubernetes.io/docs/concepts/services-networking/service/">Kubernetes Service</a> (pods that belong to multiple services are not supported as of now).</p></li><li><p><em><strong>Named ports</strong>:</em> Service ports must be named. The port names must be of the form <code class="highlighter-rouge"><protocol>[-<suffix>]</code> with <em>http</em>, <em>http2</em>, <em>grpc</em>, <em>mongo</em>, or <em>redis</em> as the <code class="highlighter-rouge"><protocol></code> in order to take advantage of Istio’s routing features. For example, <code class="highlighter-rouge">name: http2-foo</code> or <code class="highlighter-rouge">name: http</code> are valid port names, but <code class="highlighter-rouge">name: http2foo</code> is not. If the port name does not begin with a recognized prefix or if the port is unnamed, traffic on the port will be treated as plain TCP traffic (unless the port explicitly uses <code class="highlighter-rouge">Protocol: UDP</code> to signify a UDP port).</p></li><li><p><em><strong>Deployments with app label</strong>:</em> It is recommended that Pods deployed using the Kubernetes <code class="highlighter-rouge">Deployment</code> have an explicit <code class="highlighter-rouge">app</code> label in the Deployment specification. Each deployment specification should have a distinct <code class="highlighter-rouge">app</code> label with a value indicating something meaningful. The <code class="highlighter-rouge">app</code> label is used to add contextual information in distributed tracing.</p></li><li><p><em><strong>Sidecar in every pod in mesh</strong>:</em> Finally, each pod in the mesh must be running an Istio compatible sidecar. The following sections describe two ways of injecting the Istio sidecar into a pod: manually using <code class="highlighter-rouge">istioctl</code> CLI tool or automatically using the Istio Initializer. Note that the sidecar is not involved in traffic between containers in the same pod.</p></li></ol><h1 id="injection">Injection</h1><p>Manual injection modifies the controller configuration, e.g. deployment. It does this by modifying the pod template spec such that <em>all</em> pods for that deployment are created with the injected sidecar. Adding/Updating/Removing the sidecar requires modifying the entire deployment.</p><p>Automatic injection injects at pod creation time. The controller resource is unmodified. Sidecars can be updated selectively by manually deleting a pods or systematically with a deployment rolling update.</p><p>Manual and automatic injection use the same templated configuration. Automatic injection loads the configuration from the <code class="highlighter-rouge">istio-inject</code> ConfigMap in the <code class="highlighter-rouge">istio-system</code> namespace. Manual injection can load from a local file or from the ConfigMap.</p><p>Two variants of the injection configuration are provided with the default install: <code class="highlighter-rouge">istio-sidecar-injector-configmap-release.yaml</code> and <code class="highlighter-rouge">istio-sidecar-injector-configmap-debug.yaml</code>. The injection configmap includes the default injection policy and sidecar injection template. The debug version includes debug proxy images and additional logging and core dump functionality using for debugging the sidecar proxy.</p><h2 id="manual-sidecar-injection">Manual sidecar injection</h2><p>Use the built-in defaults template and dynamically fetch the mesh configuration from the <code class="highlighter-rouge">istio</code> ConfigMap. Additional parameter overrides are available via flags (see <code class="highlighter-rouge">istioctl kube-inject --help</code>).</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl apply <span class="nt">-f</span> <<span class="o">(</span>~istioctl kube-inject <span class="nt">-f</span> samples/sleep/sleep.yaml<span class="o">)</span>
|
||
</code></pre></div></div><p><code class="highlighter-rouge">kube-inject</code> can also be run without access to a running Kubernetes cluster. Create local copies of the injection and mesh configmap.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl create <span class="nt">-f</span> install/kubernetes/istio-sidecar-injector-configmap-release.yaml <span class="se">\</span>
|
||
<span class="nt">--dry-run</span> <span class="se">\</span>
|
||
<span class="nt">-o</span><span class="o">=</span><span class="nv">jsonpath</span><span class="o">=</span><span class="s1">'{.data.config}'</span> <span class="o">></span> inject-config.yaml
|
||
|
||
kubectl <span class="nt">-n</span> istio-system get configmap istio <span class="nt">-o</span><span class="o">=</span><span class="nv">jsonpath</span><span class="o">=</span><span class="s1">'{.data.mesh}'</span> <span class="o">></span> mesh-config.yaml
|
||
</code></pre></div></div><p><code class="highlighter-rouge"> Run </code>kube-inject` over the input file.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>istioctl kube-inject <span class="se">\</span>
|
||
<span class="nt">--injectConfigFile</span> inject-config.yaml <span class="se">\</span>
|
||
<span class="nt">--meshConfigFile</span> mesh-config.yaml <span class="se">\</span>
|
||
<span class="nt">--filename</span> samples/sleep/sleep.yaml <span class="se">\</span>
|
||
<span class="nt">--output</span> sleep-injected.yaml
|
||
</code></pre></div></div><p>Deploy the injected YAML file.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl apply <span class="nt">-f</span> sleep-injected.yaml
|
||
</code></pre></div></div><p>Verify that the sidecar has been injected into the deployment.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl get deployment sleep <span class="nt">-o</span> wide
|
||
</code></pre></div></div><div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE CONTAINERS IMAGES SELECTOR
|
||
sleep 1 1 1 1 2h sleep,istio-proxy tutum/curl,unknown/proxy:unknown app=sleep
|
||
</code></pre></div></div><h2 id="automatic-sidecar-injection">Automatic sidecar injection</h2><p>Sidecars can be automatically added to applicable Kubernetes pods using a <a href="https://kubernetes.io/docs/admin/admission-controllers/#validatingadmissionwebhook-alpha-in-18-beta-in-19">mutating webhook admission controller</a>. This feature requires Kubernetes 1.9 or later. Verify that the kube-apiserver process has the <code class="highlighter-rouge">admission-control</code> flag set with the <code class="highlighter-rouge">MutatingAdmissionWebhook</code> and <code class="highlighter-rouge">ValidatingAdmissionWebhook</code> admission controllers added and listed in the correct order and the admissionregistration API is enabled.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl api-versions | <span class="nb">grep </span>admissionregistration
|
||
</code></pre></div></div><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>admissionregistration.k8s.io/v1beta1
|
||
</code></pre></div></div><p>See the Kubernetes <a href="/v0.6/docs/setup/kubernetes/quick-start.html">quick start</a> guide for instructions on installing Kubernetes version >= 1.9.</p><p>Note that unlike manual injection, automatic injection occurs at the pod-level. You won’t see any change to the deployment itself. Instead you’ll want to check individual pods (via <code class="highlighter-rouge">kubectl describe</code>) to see the injected proxy.</p><h3 id="installing-the-webhook">Installing the Webhook</h3><p><em>NOTE</em>: The <a href="https://github.com/istio/istio/releases/tag/0.5.0">0.5.0</a> and <a href="https://github.com/istio/istio/releases/tag/0.5.1">0.5.1</a> releases are missing scripts to provision webhook certificates. Download the missing files from <a href="https://raw.githubusercontent.com/istio/istio/master/install/kubernetes/webhook-create-signed-cert.sh">here</a> and <a href="https://raw.githubusercontent.com/istio/istio/master/install/kubernetes/webhook-patch-ca-bundle.sh">here</a>. Subsqeuent releases (> 0.5.1) should include these missing files.</p><p>Install base Istio.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl apply <span class="nt">-f</span> install/kubernetes/istio.yaml
|
||
</code></pre></div></div><p>Webhooks requires a signed cert/key pair. Use <code class="highlighter-rouge">install/kubernetes/webhook-create-signed-cert.sh</code> to generate a cert/key pair signed by the Kubernetes’ CA. The resulting cert/key file is stored as a Kubernetes secret for the sidecar injector webhook to consume.</p><p><em>Note</em>: Kubernetes CA approval requires permissions to create and approve CSR. See <a href="https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster/">https://kubernetes.io/docs/tasks/tls/managing-tls-in-a-cluster </a> and <a href="https://raw.githubusercontent.com/istio/istio/master/install/kubernetes/webhook-create-signed-cert.sh">install/kubernetes/webhook-create-signed-cert.sh</a> for more information.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>./install/kubernetes/webhook-create-signed-cert.sh <span class="se">\</span>
|
||
<span class="nt">--service</span> istio-sidecar-injector <span class="se">\</span>
|
||
<span class="nt">--namespace</span> istio-system <span class="se">\</span>
|
||
<span class="nt">--secret</span> sidecar-injector-certs
|
||
</code></pre></div></div><p>Install the sidecar injection configmap.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl apply <span class="nt">-f</span> install/kubernetes/istio-sidecar-injector-configmap-release.yaml
|
||
</code></pre></div></div><p>Set the <code class="highlighter-rouge">caBundle</code> in the webhook install YAML that the Kubernetes api-server uses to invoke the webhook.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">cat </span>install/kubernetes/istio-sidecar-injector.yaml | <span class="se">\</span>
|
||
./install/kubernetes/webhook-patch-ca-bundle.sh <span class="o">></span> <span class="se">\</span>
|
||
install/kubernetes/istio-sidecar-injector-with-ca-bundle.yaml
|
||
</code></pre></div></div><p>Install the sidecar injector webhook.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl apply <span class="nt">-f</span> install/kubernetes/istio-sidecar-injector-with-ca-bundle.yaml
|
||
</code></pre></div></div><p>The sidecar injector webhook should now be running.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl <span class="nt">-n</span> istio-system get deployment <span class="nt">-listio</span><span class="o">=</span>sidecar-injector
|
||
</code></pre></div></div><div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
|
||
istio-sidecar-injector 1 1 1 1 1d
|
||
</code></pre></div></div><p>NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector (see https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors). The default webhook configuration uses <code class="highlighter-rouge">istio-injection=enabled</code>.</p><p>View namespaces showing <code class="highlighter-rouge">istio-injection</code> label and verify the <code class="highlighter-rouge">default</code> namespace is not labeled.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl get namespace <span class="nt">-L</span> istio-injection
|
||
</code></pre></div></div><div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>NAME STATUS AGE ISTIO-INJECTION
|
||
default Active 1h
|
||
istio-system Active 1h
|
||
kube-public Active 1h
|
||
kube-system Active 1h
|
||
</code></pre></div></div><h4 id="deploying-an-app">Deploying an app</h4><p>Deploy sleep app. Verify both deployment and pod have a single container.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl apply <span class="nt">-f</span> samples/sleep/sleep.yaml
|
||
</code></pre></div></div><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl get deployment <span class="nt">-o</span> wide
|
||
</code></pre></div></div><div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE CONTAINERS IMAGES SELECTOR
|
||
sleep 1 1 1 1 12m sleep tutum/curl app=sleep
|
||
</code></pre></div></div><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl get pod
|
||
</code></pre></div></div><div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>NAME READY STATUS RESTARTS AGE
|
||
sleep-776b7bcdcd-7hpnk 1/1 Running 0 4
|
||
</code></pre></div></div><p>Label the <code class="highlighter-rouge">default</code> namespace with <code class="highlighter-rouge">istio-injection=enabled</code></p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl label namespace default istio-injection<span class="o">=</span>enabled
|
||
</code></pre></div></div><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl get namespace <span class="nt">-L</span> istio-injection
|
||
</code></pre></div></div><div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>NAME STATUS AGE ISTIO-INJECTION
|
||
default Active 1h enabled
|
||
istio-system Active 1h
|
||
kube-public Active 1h
|
||
kube-system Active 1h
|
||
</code></pre></div></div><p>Injection occurs at pod creation time. Kill the running pod and verify a new pod is created with the injected sidecar. The original pod has 1/1 READY containers and the pod with injected sidecar has 2/2 READY containers.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl delete pod sleep-776b7bcdcd-7hpnk
|
||
</code></pre></div></div><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl get pod
|
||
</code></pre></div></div><div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>NAME READY STATUS RESTARTS AGE
|
||
sleep-776b7bcdcd-7hpnk 1/1 Terminating 0 1m
|
||
sleep-776b7bcdcd-bhn9m 2/2 Running 0 7s
|
||
</code></pre></div></div><p>View detailed state of the injected pod. You should see the injected <code class="highlighter-rouge">istio-proxy</code> container and corresponding volumes. Be sure to substitute the correct name for the <code class="highlighter-rouge">Running</code> pod below.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl describe pod sleep-776b7bcdcd-bhn9m
|
||
</code></pre></div></div><p>Disable injection for the <code class="highlighter-rouge">default</code> namespace and verify new pods are created without the sidecar.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl label namespace default istio-injection-
|
||
</code></pre></div></div><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl delete pod sleep-776b7bcdcd-bhn9m
|
||
</code></pre></div></div><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl get pod
|
||
</code></pre></div></div><div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>NAME READY STATUS RESTARTS AGE
|
||
sleep-776b7bcdcd-bhn9m 2/2 Terminating 0 2m
|
||
sleep-776b7bcdcd-gmvnr 1/1 Running 0 2s
|
||
</code></pre></div></div><h4 id="understanding-what-happened">Understanding what happened</h4><p><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.9/#mutatingwebhookconfiguration-v1beta1-admissionregistration">admissionregistration.k8s.io/v1alpha1#MutatingWebhookConfiguration</a> configures when the webhook is invoked by Kubernetes. The default supplied with Istio selects pods in namespaces with label <code class="highlighter-rouge">istio-injection=enabled</code>. This can be changed by modifying the MutatingWebhookConfiguration in <code class="highlighter-rouge">install/kubernetes/istio-sidecar-injector-with-ca-bundle.yaml</code>.</p><p>The <code class="highlighter-rouge">istio-inject</code> ConfigMap in the <code class="highlighter-rouge">istio-system</code> namespace the default injection policy and sidecar injection template.</p><h5 id="policy"><em><strong>policy</strong></em></h5><p><code class="highlighter-rouge">disabled</code> - The sidecar injector will not inject the sidecar into pods by default. Add the <code class="highlighter-rouge">sidecar.istio.io/inject</code> annotation with value <code class="highlighter-rouge">true</code> to the pod template spec to enable injection.</p><p><code class="highlighter-rouge">enabled</code> - The sidecar injector will inject the sidecar into pods by default. Add the <code class="highlighter-rouge">sidecar.istio.io/inject</code> annotation with value <code class="highlighter-rouge">false</code> to the pod template spec to disable injection.</p><p>The following example uses the <code class="highlighter-rouge">sidecar.istio.io/inject</code> annotation to disable sidecar injection.</p><div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">apiVersion</span><span class="pi">:</span> <span class="s">extensions/v1beta1</span>
|
||
<span class="na">kind</span><span class="pi">:</span> <span class="s">Deployment</span>
|
||
<span class="na">metadata</span><span class="pi">:</span>
|
||
<span class="na">name</span><span class="pi">:</span> <span class="s">ignored</span>
|
||
<span class="na">spec</span><span class="pi">:</span>
|
||
<span class="na">template</span><span class="pi">:</span>
|
||
<span class="na">metadata</span><span class="pi">:</span>
|
||
<span class="na">annotations</span><span class="pi">:</span>
|
||
<span class="s">sidecar.istio.io/inject</span><span class="pi">:</span> <span class="s2">"</span><span class="s">false"</span>
|
||
<span class="na">spec</span><span class="pi">:</span>
|
||
<span class="na">containers</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">ignored</span>
|
||
<span class="na">image</span><span class="pi">:</span> <span class="s">tutum/curl</span>
|
||
<span class="na">command</span><span class="pi">:</span> <span class="pi">[</span><span class="s2">"</span><span class="s">/bin/sleep"</span><span class="pi">,</span><span class="s2">"</span><span class="s">infinity"</span><span class="pi">]</span>
|
||
</code></pre></div></div><h5 id="template"><em><strong>template</strong></em></h5><p>The sidecar injection template uses <a href="https://golang.org/pkg/text/template">https://golang.org/pkg/text/template</a> which, when parsed and exectuted, is decoded to the following struct containing the list of containers and volumes to inject into the pod.</p><div class="language-golang highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">type</span><span class="x"> </span><span class="n">SidecarInjectionSpec</span><span class="x"> </span><span class="k">struct</span><span class="x"> </span><span class="p">{</span><span class="x">
|
||
</span><span class="n">InitContainers</span><span class="x"> </span><span class="p">[]</span><span class="n">v1</span><span class="o">.</span><span class="n">Container</span><span class="x"> </span><span class="s">`yaml:"initContainers"`</span><span class="x">
|
||
</span><span class="n">Containers</span><span class="x"> </span><span class="p">[]</span><span class="n">v1</span><span class="o">.</span><span class="n">Container</span><span class="x"> </span><span class="s">`yaml:"containers"`</span><span class="x">
|
||
</span><span class="n">Volumes</span><span class="x"> </span><span class="p">[]</span><span class="n">v1</span><span class="o">.</span><span class="n">Volume</span><span class="x"> </span><span class="s">`yaml:"volumes"`</span><span class="x">
|
||
</span><span class="p">}</span><span class="x">
|
||
</span></code></pre></div></div><p>The template is applied to the following data structure at runtime.</p><div class="language-golang highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">type</span><span class="x"> </span><span class="n">SidecarTemplateData</span><span class="x"> </span><span class="k">struct</span><span class="x"> </span><span class="p">{</span><span class="x">
|
||
</span><span class="n">ObjectMeta</span><span class="x"> </span><span class="o">*</span><span class="n">metav1</span><span class="o">.</span><span class="n">ObjectMeta</span><span class="x">
|
||
</span><span class="n">Spec</span><span class="x"> </span><span class="o">*</span><span class="n">v1</span><span class="o">.</span><span class="n">PodSpec</span><span class="x">
|
||
</span><span class="n">ProxyConfig</span><span class="x"> </span><span class="o">*</span><span class="n">meshconfig</span><span class="o">.</span><span class="n">ProxyConfig</span><span class="x"> </span><span class="c">// Defined by https://istio.io/docs/reference/config/service-mesh.html#proxyconfig</span><span class="x">
|
||
</span><span class="n">MeshConfig</span><span class="x"> </span><span class="o">*</span><span class="n">meshconfig</span><span class="o">.</span><span class="n">MeshConfig</span><span class="x"> </span><span class="c">// Defined by https://istio.io/docs/reference/config/service-mesh.html#meshconfig </span><span class="x">
|
||
</span><span class="p">}</span><span class="x">
|
||
</span></code></pre></div></div><p><code class="highlighter-rouge">ObjectMeta</code> and <code class="highlighter-rouge">Spec</code> are from the pod. <code class="highlighter-rouge">ProxyConfig</code> and <code class="highlighter-rouge">MeshConfig</code> are from the <code class="highlighter-rouge">istio</code> ConfigMap in the <code class="highlighter-rouge">istio-system</code> namespace. Templates can conditional define injected containers and volumes with this data.</p><p>For example, the following template snippet from <code class="highlighter-rouge">install/kubernetes/istio-sidecar-injector-configmap-release.yaml</code></p><div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">containers</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">istio-proxy</span>
|
||
<span class="na">image</span><span class="pi">:</span> <span class="s">istio.io/proxy:0.5.0</span>
|
||
<span class="na">args</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">proxy</span>
|
||
<span class="pi">-</span> <span class="s">sidecar</span>
|
||
<span class="pi">-</span> <span class="s">--configPath</span>
|
||
<span class="pi">-</span> <span class="pi">{{</span> <span class="nv">.ProxyConfig.ConfigPath</span> <span class="pi">}}</span>
|
||
<span class="pi">-</span> <span class="s">--binaryPath</span>
|
||
<span class="pi">-</span> <span class="pi">{{</span> <span class="nv">.ProxyConfig.BinaryPath</span> <span class="pi">}}</span>
|
||
<span class="pi">-</span> <span class="s">--serviceCluster</span>
|
||
<span class="pi">{{</span> <span class="nv">if ne "" (index .ObjectMeta.Labels "app") -</span><span class="pi">}}</span>
|
||
<span class="pi">-</span> <span class="pi">{{</span> <span class="nv">index .ObjectMeta.Labels "app"</span> <span class="pi">}}</span>
|
||
<span class="pi">{{</span> <span class="nv">else -</span><span class="pi">}}</span>
|
||
<span class="pi">-</span> <span class="s2">"</span><span class="s">istio-proxy"</span>
|
||
<span class="pi">{{</span> <span class="nv">end -</span><span class="pi">}}</span>
|
||
</code></pre></div></div><p>expands to</p><div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">containers</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="na">name</span><span class="pi">:</span> <span class="s">istio-proxy</span>
|
||
<span class="na">image</span><span class="pi">:</span> <span class="s">istio.io/proxy:0.5.0</span>
|
||
<span class="na">args</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">proxy</span>
|
||
<span class="pi">-</span> <span class="s">sidecar</span>
|
||
<span class="pi">-</span> <span class="s">--configPath</span>
|
||
<span class="pi">-</span> <span class="s">/etc/istio/proxy</span>
|
||
<span class="pi">-</span> <span class="s">--binaryPath</span>
|
||
<span class="pi">-</span> <span class="s">/usr/local/bin/envoy</span>
|
||
<span class="pi">-</span> <span class="s">--serviceCluster</span>
|
||
<span class="pi">-</span> <span class="s">sleep</span>
|
||
</code></pre></div></div><p>when applied over a pod defined by the pod template spec in <a href="https://raw.githubusercontent.com/istio/istio/master/samples/sleep/sleep.yaml">samples/sleep/sleep.yaml</a>.</p><h3 id="uninstalling-the-webhook">Uninstalling the webhook</h3><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl delete <span class="nt">-f</span> install/kubernetes/istio-sidecar-injector-with-ca-bundle.yaml
|
||
</code></pre></div></div><p>The above command will not remove the injected sidecars from Pods. A rolling update or simply deleting the pods and forcing the deployment to create them is required.</p><p>Optionally, if may be also be desirable to clean-up other resources that were created in this task. This includes the secret holding the cert/key and CSR used to sign them, as well as any namespace that was labeled for injection.</p><div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>kubectl <span class="nt">-n</span> istio-system delete secret sidecar-injector-certs
|
||
kubectl delete csr istio-sidecar-injector.istio-system
|
||
kubectl label namespace default istio-injection-
|
||
</code></pre></div></div></main></div><div class="col-12 col-md-2 d-none d-lg-block"><nav class="toc"><div class="spacer"></div><div class="directory" role="directory"><ul><li><a href="#manual-sidecar-injection">Manual sidecar injection</a></li><li><a href="#automatic-sidecar-injection">Automatic sidecar injection</a><ul><li><a href="#installing-the-webhook">Installing the Webhook</a><ul><li><a href="#deploying-an-app">Deploying an app</a></li><li><a href="#understanding-what-happened">Understanding what happened</a></li></ul></li><li><a href="#uninstalling-the-webhook">Uninstalling the webhook</a></li></ul></li></ul></div></nav></div></div></div><div class="footer"><footer><div class="container-fluid"><div class="row"><div class="col-sm-2"></div><nav class=" col-12 col-sm-3" role="navigation"><ul class="first"><li><a class="header" href="/v0.6/docs/">Docs</a></li><li><a href="/v0.6/docs/concepts/">Concepts</a></li><li><a href="/v0.6/docs/setup/">Setup</a></li><li><a href="/v0.6/docs/tasks/">Tasks</a></li><li><a href="/v0.6/docs/guides/">Guides</a></li><li><a href="/v0.6/docs/reference/">Reference</a></li></ul></nav><nav class="col-12 col-sm-3" role="navigation"><ul><li><a class="header" href="/v0.6/help/">Help</a></li><li><a href="/v0.6/help/faq/index.html">FAQ</a></li><li><a href="/v0.6/help/glossary.html">Glossary</a></li><li><a href="/v0.6/help/troubleshooting.html">Troubleshooting</a></li><li><a href="/v0.6/help/bugs.html">Report Bugs</a></li><li><a href="https://github.com/istio/istio.github.io/issues/new?title=Issue with _docs/setup/kubernetes/sidecar-injection.md" target="_blank" rel="noopener">Doc Bugs & Gaps</a></li><li><a href="https://github.com/istio/istio.github.io/edit/master/_docs/setup/kubernetes/sidecar-injection.md" target="_blank" rel="noopener">Edit This Page</a></li></ul></nav><nav class="col-12 col-sm-3" role="navigation"><ul><li><a class="header" href="/v0.6/community.html">Community</a></li><li> <a href="https://groups.google.com/forum/#!forum/istio-users" target="_blank" rel="noopener">User</a> | <a href="https://groups.google.com/forum/#!forum/istio-dev" target="_blank" rel="noopener">Dev Mailing Lists</a></li><li><a href="https://twitter.com/IstioMesh" target="_blank" rel="noopener">Twitter</a></li><li><a href="https://stackoverflow.com/questions/tagged/istio" target="_blank" rel="noopener">Stack Overflow</a></li><li><a href="https://github.com/istio/community/" target="_blank" rel="noopener">GitHub</a></li><li><a href="https://github.com/istio/community/blob/master/WORKING-GROUPS.md" target="_blank" rel="noopener">Working Groups</a></li></ul></nav></div><div class="row"><div class="col-12"><p class="description text-center" role="contentinfo"> Istio Archive 0.6, Copyright © 2018 Istio Authors<br> Archived on 02-Apr-2018</p></div></div></div></footer></div><script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"></script> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script> <script src="https://www.google.com/cse/brand?form=searchbox"></script> <script src="/v0.6/js/misc.min.js"></script></body></html>
|