• sidecar-injector
    • sidecar-injector probe
    • sidecar-injector version
    • Environment variables
    • Exported metrics

    sidecar-injector

    Kubernetes webhook for automatic Istio sidecar injection.

    1. sidecar-injector [flags]
    FlagsDescription
    —caCertFile <string>File containing the x509 Certificate for HTTPS. (default /etc/istio/certs/root-cert.pem)
    —healthCheckFile <string>File that should be periodically updated if health checking is enabled (default )</td></tr><tr><td><code>--healthCheckInterval &lt;duration&gt;</code></td><td>Configure how frequently the health check file specified by --healthCheckFile should be updated (default `0s`)</td></tr><tr><td><code>--injectConfig &lt;string&gt;</code></td><td>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)</td></tr><tr><td><code>--injectValues &lt;string&gt;</code></td><td>File containing the Istio sidecar injection values, in yaml format (default `/etc/istio/inject/values`)</td></tr><tr><td><code>--kubeconfig &lt;string&gt;</code></td><td>Specifies path to kubeconfig file. This must be specified when not running inside a Kubernetes pod. (default)
    —log_as_jsonWhether to format output as JSON or in plain console-friendly format
    —log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac, validation] (default )</td></tr><tr><td><code>--log_output_level &lt;string&gt;</code></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [all, default, model, rbac, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--log_rotate &lt;string&gt;</code></td><td>The path for the optional rotating log file (default)
    —log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default 30)
    —log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default 1000)
    —log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default 104857600)
    —log_stacktrace_level <string>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,… where scope can be one of [all, default, model, rbac, validation] and level can be one of [debug, info, warn, error, fatal, none] (default default:none)
    —log_target <stringArray>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default [stdout])
    —meshConfig <string>File containing the Istio mesh configuration (default /etc/istio/config/mesh)
    —monitoringPort <int>Webhook monitoring port (default 15014)
    —port <int>Webhook port (default 443)
    —reconcileWebhookConfigEnable managing webhook configuration.
    —tlsCertFile <string>File containing the x509 Certificate for HTTPS. (default /etc/istio/certs/cert-chain.pem)
    —tlsKeyFile <string>File containing the x509 private key matching —tlsCertFile. (default /etc/istio/certs/key.pem)
    —webhookConfigName <string>Name of the mutatingwebhookconfiguration resource in Kubernetes. (default istio-sidecar-injector)
    —webhookName <string>Name of the webhook entry in the webhook config. (default sidecar-injector.istio.io)

    sidecar-injector probe

    Check the liveness or readiness of a locally-running server

    1. sidecar-injector probe [flags]
    FlagsDescription
    —caCertFile <string>File containing the x509 Certificate for HTTPS. (default /etc/istio/certs/root-cert.pem)
    —healthCheckFile <string>File that should be periodically updated if health checking is enabled (default )</td></tr><tr><td><code>--healthCheckInterval &lt;duration&gt;</code></td><td>Configure how frequently the health check file specified by --healthCheckFile should be updated (default `0s`)</td></tr><tr><td><code>--injectConfig &lt;string&gt;</code></td><td>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)</td></tr><tr><td><code>--injectValues &lt;string&gt;</code></td><td>File containing the Istio sidecar injection values, in yaml format (default `/etc/istio/inject/values`)</td></tr><tr><td><code>--interval &lt;duration&gt;</code></td><td>Duration used for checking the target file&#39;s last modified time. (default `0s`)</td></tr><tr><td><code>--kubeconfig &lt;string&gt;</code></td><td>Specifies path to kubeconfig file. This must be specified when not running inside a Kubernetes pod. (default)
    —log_as_jsonWhether to format output as JSON or in plain console-friendly format
    —log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac, validation] (default )</td></tr><tr><td><code>--log_output_level &lt;string&gt;</code></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [all, default, model, rbac, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--log_rotate &lt;string&gt;</code></td><td>The path for the optional rotating log file (default)
    —log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default 30)
    —log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default 1000)
    —log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default 104857600)
    —log_stacktrace_level <string>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,… where scope can be one of [all, default, model, rbac, validation] and level can be one of [debug, info, warn, error, fatal, none] (default default:none)
    —log_target <stringArray>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default [stdout])
    —meshConfig <string>File containing the Istio mesh configuration (default /etc/istio/config/mesh)
    —monitoringPort <int>Webhook monitoring port (default 15014)
    —port <int>Webhook port (default 443)
    —probe-path <string>Path of the file for checking the availability. (default `)</td></tr><tr><td><code>--reconcileWebhookConfig</code></td><td>Enable managing webhook configuration.</td></tr><tr><td><code>--tlsCertFile &lt;string&gt;</code></td><td>File containing the x509 Certificate for HTTPS. (default/etc/istio/certs/cert-chain.pem)</td></tr><tr><td><code>--tlsKeyFile &lt;string&gt;</code></td><td>File containing the x509 private key matching --tlsCertFile. (default/etc/istio/certs/key.pem)</td></tr><tr><td><code>--webhookConfigName &lt;string&gt;</code></td><td>Name of the mutatingwebhookconfiguration resource in Kubernetes. (defaultistio-sidecar-injector)</td></tr><tr><td><code>--webhookName &lt;string&gt;</code></td><td>Name of the webhook entry in the webhook config. (defaultsidecar-injector.istio.io`)

    sidecar-injector version

    Prints out build version information

    1. sidecar-injector version [flags]
    FlagsShorthandDescription
    —caCertFile <string>File containing the x509 Certificate for HTTPS. (default /etc/istio/certs/root-cert.pem)
    —healthCheckFile <string>File that should be periodically updated if health checking is enabled (default )</td></tr><tr><td><code>--healthCheckInterval &lt;duration&gt;</code></td><td></td><td>Configure how frequently the health check file specified by --healthCheckFile should be updated (default `0s`)</td></tr><tr><td><code>--injectConfig &lt;string&gt;</code></td><td></td><td>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)</td></tr><tr><td><code>--injectValues &lt;string&gt;</code></td><td></td><td>File containing the Istio sidecar injection values, in yaml format (default `/etc/istio/inject/values`)</td></tr><tr><td><code>--kubeconfig &lt;string&gt;</code></td><td></td><td>Specifies path to kubeconfig file. This must be specified when not running inside a Kubernetes pod. (default)
    —log_as_jsonWhether to format output as JSON or in plain console-friendly format
    —log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac, validation] (default )</td></tr><tr><td><code>--log_output_level &lt;string&gt;</code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [all, default, model, rbac, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--log_rotate &lt;string&gt;</code></td><td></td><td>The path for the optional rotating log file (default)
    —log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default 30)
    —log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default 1000)
    —log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default 104857600)
    —log_stacktrace_level <string>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,… where scope can be one of [all, default, model, rbac, validation] and level can be one of [debug, info, warn, error, fatal, none] (default default:none)
    —log_target <stringArray>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default [stdout])
    —meshConfig <string>File containing the Istio mesh configuration (default /etc/istio/config/mesh)
    —monitoringPort <int>Webhook monitoring port (default 15014)
    —output <string>-oOne of 'yaml' or 'json'. (default `)</td></tr><tr><td><code>--port &lt;int&gt;</code></td><td></td><td>Webhook port (default443)</td></tr><tr><td><code>--reconcileWebhookConfig</code></td><td></td><td>Enable managing webhook configuration.</td></tr><tr><td><code>--short</code></td><td><code>-s</code></td><td>Use --short=false to generate full version information</td></tr><tr><td><code>--tlsCertFile &lt;string&gt;</code></td><td></td><td>File containing the x509 Certificate for HTTPS. (default/etc/istio/certs/cert-chain.pem)</td></tr><tr><td><code>--tlsKeyFile &lt;string&gt;</code></td><td></td><td>File containing the x509 private key matching --tlsCertFile. (default/etc/istio/certs/key.pem)</td></tr><tr><td><code>--webhookConfigName &lt;string&gt;</code></td><td></td><td>Name of the mutatingwebhookconfiguration resource in Kubernetes. (defaultistio-sidecar-injector)</td></tr><tr><td><code>--webhookName &lt;string&gt;</code></td><td></td><td>Name of the webhook entry in the webhook config. (defaultsidecar-injector.istio.io`)

    Environment variables

    These environment variables affect the behavior of the sidecar-injector command.

    Variable NameTypeDefault ValueDescription
    ISTIO_GPRC_MAXSTREAMSInteger100000Sets the maximum number of concurrent grpc streams.
    PILOT_BLOCK_HTTP_ON_443BooleantrueIf enabled, any HTTP services will be blocked on HTTPS port (443). If this is disabled, any HTTP service on port 443 could block all external traffic
    PILOT_CERT_DIRString
    PILOT_DEBOUNCE_AFTERTime Duration100msThe delay added to config/registry events for debouncing. This will delay the push by at least this internal. If no change is detected within this period, the push will happen, otherwise we'll keep delaying until things settle, up to a max of PILOT_DEBOUNCE_MAX.
    PILOT_DEBOUNCE_MAXTime Duration10sThe maximum amount of time to wait for events while debouncing. If events keep showing up with no breaks for this time, we'll trigger a push.
    PILOT_DEBUG_ADSZ_CONFIGBooleanfalse
    PILOT_DISABLE_XDS_MARSHALING_TO_ANYBooleanfalse
    PILOT_DISTRIBUTION_HISTORY_RETENTIONTime Duration1m0sIf enabled, Pilot will keep track of old versions of distributed config for this duration.
    PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKINGBooleantrueIf enabled, Pilot will assign meaningful nonces to each Envoy configuration message, and allow users to interrogate which envoy has which config from the debug interface.
    PILOT_ENABLE_EDS_DEBOUNCEBooleantrueIf enabled, Pilot will include EDS pushes in the push debouncing, configured by PILOT_DEBOUNCE_AFTER and PILOT_DEBOUNCE_MAX. EDS pushes may be delayed, but there will be fewer pushes. By default this is enabled
    PILOT_ENABLE_FALLTHROUGH_ROUTEBooleantrueEnableFallthroughRoute provides an option to add a final wildcard match for routes. When ALLOW_ANY traffic policy is used, a Passthrough cluster is used. When REGISTRY_ONLY traffic policy is used, a 502 error is returned.
    PILOT_ENABLE_HEADLESS_SERVICE_POD_LISTENERSBooleantrueIf enabled, for a headless service/stateful set in Kubernetes, pilot will generate an outbound listener for each pod in a headless service. This feature should be disabled if headless services have a large number of pods.
    PILOT_ENABLE_MYSQL_FILTERBooleanfalseEnableMysqlFilter enables injection of envoy.filters.network.mysql_proxy in the filter chain.
    PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUNDBooleanfalseIf enabled, protocol sniffing will be used for inbound listeners whose port protocol is not specified or unsupported
    PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_OUTBOUNDBooleantrueIf enabled, protocol sniffing will be used for outbound listeners whose port protocol is not specified or unsupported
    PILOT_ENABLE_REDIS_FILTERBooleanfalseEnableRedisFilter enables injection of envoy.filters.network.redis_proxy in the filter chain.
    PILOT_ENABLE_UNSAFE_REGEXBooleanfalseIf enabled, pilot will generate Envoy configuration that does not use safe_regex but the older, deprecated regex field. This should only be enabled to support legacy deployments that have not yet been migrated to the new safe regular expressions.
    PILOT_HTTP10BooleanfalseEnables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.
    PILOT_INBOUND_PROTOCOL_DETECTION_TIMEOUTTime Duration1sProtocol detection timeout for inbound listener
    PILOT_INITIAL_FETCH_TIMEOUTTime Duration0sSpecifies the initial_fetch_timeout for config. If this time is reached without a response to the config requested by Envoy, the Envoy will move on with the init phase. This prevents envoy from getting stuck waiting on config during startup.
    PILOT_PUSH_THROTTLEInteger100Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes
    PILOT_RESPECT_DNS_TTLBooleantrueIf enabled, DNS based clusters will respect the TTL of the DNS, rather than polling at a fixed rate. This option is only provided for backward compatibility purposes and will be removed in the near future.
    PILOT_RESTRICT_POD_UP_TRAFFIC_LOOPBooleantrueIf enabled, this will block inbound traffic from matching outbound listeners, which could result in an infinite loop of traffic. This option is only provided for backward compatibility purposes and will be removed in the near future.
    PILOT_SCOPE_GATEWAY_TO_NAMESPACEBooleanfalseIf enabled, a gateway workload can only select gateway resources in the same namespace. Gateways with same selectors in different namespaces will not be applicable.
    PILOT_SCOPE_PUSHESBooleantrueIf enabled, pilot will attempt to limit unnecessary pushes by determining what proxies a config or endpoint update will impact.
    PILOT_SIDECAR_USE_REMOTE_ADDRESSBooleanfalseUseRemoteAddress sets useRemoteAddress to true for side car outbound listeners.
    PILOT_SKIP_VALIDATE_TRUST_DOMAINBooleanfalseSkip validating the peer is from the same trust domain when mTLS is enabled in authentication policy
    PILOT_TRACE_SAMPLINGFloating-Point100Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 100, not recommended for production use.
    TERMINATION_DRAIN_DURATION_SECONDSInteger5The amount of time allowed for connections to complete on pilot-agent shutdown. On receiving SIGTERM or SIGINT, pilot-agent tells the active Envoy to start draining, preventing any new connections and allowing existing connections to complete. It then sleeps for the TerminationDrainDuration and then kills any remaining active Envoy processes.
    USE_ISTIO_JWT_FILTERBooleanfalseUse the Istio JWT filter for JWT token verification.

    Exported metrics

    Metric NameTypeDescription
    endpoint_no_podLastValueEndpoints without an associated pod.
    istio_buildLastValueIstio component build info
    pilot_conflict_inbound_listenerLastValueNumber of conflicting inbound listeners.
    pilot_conflict_outbound_listener_http_over_current_tcpLastValueNumber of conflicting wildcard http listeners with current wildcard tcp listener.
    pilot_conflict_outbound_listener_http_over_httpsLastValueNumber of conflicting HTTP listeners with well known HTTPS ports
    pilot_conflict_outbound_listener_tcp_over_current_httpLastValueNumber of conflicting wildcard tcp listeners with current wildcard http listener.
    pilot_conflict_outbound_listener_tcp_over_current_tcpLastValueNumber of conflicting tcp listeners with current tcp listener.
    pilot_destrule_subsetsLastValueDuplicate subsets across destination rules for same host
    pilot_duplicate_envoy_clustersLastValueDuplicate envoy clusters caused by service entries with same hostname
    pilot_eds_no_instancesLastValueNumber of clusters without instances.
    pilot_endpoint_not_readyLastValueEndpoint found in unready state.
    pilot_jwks_resolver_network_fetch_fail_totalSumTotal number of failed network fetch by pilot jwks resolver
    pilot_jwks_resolver_network_fetch_success_totalSumTotal number of successfully network fetch by pilot jwks resolver
    pilot_no_ipLastValuePods not found in the endpoint table, possibly invalid.
    pilot_total_rejected_configsSumTotal number of configs that Pilot had to reject or ignore.
    pilot_virt_servicesLastValueTotal virtual services known to pilot.
    pilot_vservice_dup_domainLastValueVirtual services with dup domains.
    sidecar_injection_failure_totalSumTotal number of failed Side car injection requests.
    sidecar_injection_requests_totalSumTotal number of Side car injection requests.
    sidecar_injection_skip_totalSumTotal number of skipped injection requests.
    sidecar_injection_success_totalSumTotal number of successful Side car injection requests.