pilot-agent

Istio Pilot agent runs in the sidecar or gateway container and bootstraps Envoy.

FlagsDescription
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])

pilot-agent completion

Generate the autocompletion script for pilot-agent for the specified shell. See each sub-command’s help for details on how to use the generated script.

FlagsDescription
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])

pilot-agent completion bash

Generate the autocompletion script for the bash shell.

This script depends on the ‘bash-completion’ package. If it is not installed already, you can install it via your OS’s package manager.

To load completions in your current shell session: $ source <(pilot-agent completion bash)

To load completions for every new session, execute once: Linux: $ pilot-agent completion bash > /etc/bash_completion.d/pilot-agent MacOS: $ pilot-agent completion bash > /usr/local/etc/bash_completion.d/pilot-agent

You will need to start a new shell for this setup to take effect.

  1. pilot-agent completion bash
FlagsDescription
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])
—no-descriptionsdisable completion descriptions

pilot-agent completion fish

Generate the autocompletion script for the fish shell.

To load completions in your current shell session: $ pilot-agent completion fish | source

To load completions for every new session, execute once: $ pilot-agent completion fish > ~/.config/fish/completions/pilot-agent.fish

You will need to start a new shell for this setup to take effect.

  1. pilot-agent completion fish [flags]
FlagsDescription
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])
—no-descriptionsdisable completion descriptions

pilot-agent completion powershell

Generate the autocompletion script for powershell.

To load completions in your current shell session: PS C:\> pilot-agent completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command to your powershell profile.

  1. pilot-agent completion powershell [flags]
FlagsDescription
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])
—no-descriptionsdisable completion descriptions

pilot-agent completion zsh

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

$ echo “autoload -U compinit; compinit” >> ~/.zshrc

To load completions for every new session, execute once: # Linux: $ pilot-agent completion zsh > “${fpath[1]}/_pilot-agent” # macOS: $ pilot-agent completion zsh > /usr/local/share/zsh/site-functions/_pilot-agent

You will need to start a new shell for this setup to take effect.

  1. pilot-agent completion zsh [flags]
FlagsDescription
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])
—no-descriptionsdisable completion descriptions

pilot-agent istio-clean-iptables

Script responsible for cleaning up iptables rules

  1. pilot-agent istio-clean-iptables [flags]
FlagsShorthandDescription
—dry-run-nDo not call any external dependencies like iptables
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])
—proxy-gid <string>-gSpecify the GID of the user for which the redirection is not applied. (same default value as -u param) (default )</td></tr><tr><td><code>--proxy-uid &lt;string&gt;</code></td><td><code>-u</code></td><td>Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container (default)
—redirect-dnsEnable capture of dns traffic by istio-agent

pilot-agent istio-iptables

istio-iptables is responsible for setting up port forwarding for Istio Sidecar.

  1. pilot-agent istio-iptables [flags]
FlagsShorthandDescription
—capture-all-dnsInstead of only capturing DNS traffic to DNS server IP, capture all DNS traffic at port 53. This setting is only effective when redirect dns is enabled.
—cni-modeWhether to run as CNI plugin.
—dry-run-nDo not call any external dependencies like iptables
—envoy-port <string>-pSpecify the envoy port to which redirect all TCP traffic (default $ENVOY_PORT = 15001) (default )</td></tr><tr><td><code>--inbound-capture-port &lt;string&gt;</code></td><td><code>-z</code></td><td>Port to which all inbound TCP traffic to the pod/VM should be redirected to (default $INBOUND_CAPTURE_PORT = 15006) (default)
—inbound-tunnel-port <string>-eSpecify the istio tunnel port for inbound tcp traffic (default $INBOUND_TUNNEL_PORT = 15008) (default )</td></tr><tr><td><code>--iptables-probe-port &lt;string&gt;</code></td><td></td><td>set listen port for failure detection (default `15002`)</td></tr><tr><td><code>--istio-inbound-interception-mode &lt;string&gt;</code></td><td><code>-m</code></td><td>The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" (default)
—istio-inbound-ports <string>-bComma separated list of inbound ports for which traffic is to be redirected to Envoy (optional). The wildcard character ““ can be used to configure redirection for all ports. An empty list will disable (default )</td></tr><tr><td><code>--istio-inbound-tproxy-mark &lt;string&gt;</code></td><td><code>-t</code></td><td>(default)
—istio-inbound-tproxy-route-table <string>-r(default ``)
—istio-local-exclude-ports <string>-dComma separated list of inbound ports to be excluded from redirection to Envoy (optional). Only applies when all inbound traffic (i.e. ““) is being redirected (default to $ISTIO_LOCAL_EXCLUDE_PORTS) (default )</td></tr><tr><td><code>--istio-local-outbound-ports-exclude &lt;string&gt;</code></td><td><code>-o</code></td><td>Comma separated list of outbound ports to be excluded from redirection to Envoy (default)
—istio-outbound-ports <string>-qComma separated list of outbound ports to be explicitly included for redirection to Envoy (default )</td></tr><tr><td><code>--istio-service-cidr &lt;string&gt;</code></td><td><code>-i</code></td><td>Comma separated list of IP ranges in CIDR form to redirect to envoy (optional). The wildcard character "*" can be used to redirect all outbound traffic. An empty list will disable all outbound (default)
—istio-service-exclude-cidr <string>-xComma separated list of IP ranges in CIDR form to be excluded from redirection. Only applies when all outbound traffic (i.e. “*”) is being redirected (default to $ISTIO_SERVICE_EXCLUDE_CIDR) (default )</td></tr><tr><td><code>--kube-virt-interfaces &lt;string&gt;</code></td><td><code>-k</code></td><td>Comma separated list of virtual interfaces whose inbound traffic (from VM) will be treated as outbound (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])
—network-namespace <string>The network namespace that iptables rules should be applied to. (default )</td></tr><tr><td><code>--output-paths &lt;string&gt;</code></td><td></td><td>A file path to write the applied iptables rules to. (default)
—probe-timeout <duration>failure detection timeout (default 5s)
—proxy-gid <string>-gSpecify the GID of the user for which the redirection is not applied. (same default value as -u param) (default )</td></tr><tr><td><code>--proxy-uid &lt;string&gt;</code></td><td><code>-u</code></td><td>Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container (default)
—redirect-dnsEnable capture of dns traffic by istio-agent
—restore-format-fPrint iptables rules in iptables-restore interpretable format
—run-validationValidate iptables
—skip-rule-applySkip iptables apply

pilot-agent proxy

XDS proxy agent

  1. pilot-agent proxy [flags]
FlagsDescription
—concurrency <int>number of worker threads to run (default 0)
—domain <string>DNS domain suffix. If not provided uses ${POD_NAMESPACE}.svc.cluster.local (default )</td></tr><tr><td><code>--log_as_json</code></td><td>Whether to format output as JSON or in plain console-friendly format</td></tr><tr><td><code>--log_caller &lt;string&gt;</code></td><td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (default)
—log_output_level <string>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,… where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default default:info)
—log_rotate <string>The path for the optional rotating log file (default )</td></tr><tr><td><code>--log_rotate_max_age &lt;int&gt;</code></td><td>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)</td></tr><tr><td><code>--log_rotate_max_backups &lt;int&gt;</code></td><td>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)</td></tr><tr><td><code>--log_rotate_max_size &lt;int&gt;</code></td><td>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)</td></tr><tr><td><code>--log_stacktrace_level &lt;string&gt;</code></td><td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td></tr><tr><td><code>--log_target &lt;stringArray&gt;</code></td><td>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]`)</td></tr><tr><td><code>--meshConfig &lt;string&gt;</code></td><td>File name for Istio mesh configuration. If not specified, a default mesh will be used. This may be overridden by PROXY_CONFIG environment variable or proxy.istio.io/config annotation. (default `./etc/istio/config/mesh`)</td></tr><tr><td><code>--outlierLogPath &lt;string&gt;</code></td><td>The log path for outlier detection (default)
—proxyComponentLogLevel <string>The component log level used to start the Envoy proxy. Deprecated, use proxyLogLevel instead (default )</td></tr><tr><td><code>--proxyLogLevel &lt;string&gt;</code></td><td>The log level used to start the Envoy proxy (choose from {trace, debug, info, warning, error, critical, off}).Level may also include one or more scopes, such as 'info,misc:error,upstream:debug' (default `warning,misc:error`)</td></tr><tr><td><code>--serviceCluster &lt;string&gt;</code></td><td>Service cluster (default `istio-proxy`)</td></tr><tr><td><code>--stsPort &lt;int&gt;</code></td><td>HTTP Port on which to serve Security Token Service (STS). If zero, STS service will not be provided. (default `0`)</td></tr><tr><td><code>--templateFile &lt;string&gt;</code></td><td>Go template bootstrap config (default)
—tokenManagerPlugin <string>Token provider specific plugin name. (default GoogleTokenExchange)

pilot-agent request

Makes an HTTP request to the Envoy admin API

  1. pilot-agent request <method> <path> [<body>] [flags]
FlagsDescription
—debug-port <int32>Set the port to make a local request to. The default points to the Envoy admin API. (default 15000)
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])

pilot-agent version

Prints out build version information

  1. pilot-agent version [flags]
FlagsShorthandDescription
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])
—output <string>-oOne of ‘yaml’ or ‘json’. (default ``)
—short-sUse —short=false to generate full version information

pilot-agent wait

Waits until the Envoy proxy is ready

  1. pilot-agent wait [flags]
FlagsDescription
—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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] (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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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 [ads, adsc, all, authn, authorization, ca, cache, citadelclient, default, dns, gcecred, googleca, googlecas, grpcgen, healthcheck, klog, kube, mockcred, model, sds, spiffe, stsclient, stsserver, telemetry, token, trustBundle, validation, validationController, wasm, wle, xdsproxy] 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])
—periodMillis <int>number of milliseconds to wait between attempts (default 500)
—requestTimeoutMillis <int>number of milliseconds to wait for response (default 500)
—timeoutSeconds <int>maximum number of seconds to wait for Envoy to be ready (default 60)
—url <string>URL to use in requests (default http://localhost:15021/healthz/ready)

Environment variables

These environment variables affect the behavior of the pilot-agent command. Please use with caution as these environment variables are experimental and can change anytime.

Variable NameTypeDefault ValueDescription
BOOTSTRAP_XDS_AGENTBooleanfalseIf set to true, agent retrieves the bootstrap configuration prior to starting Envoy
CA_ADDRStringAddress of the spiffe certificate provider. Defaults to discoveryAddress
CA_PROVIDERStringCitadelname of authentication provider
CA_ROOT_CAStringExplicitly set the root CA to expect for the CA connection.
CLUSTER_IDStringKubernetesDefines the cluster and service registry that this Istiod instance is belongs to
CREDENTIAL_FETCHER_TYPEStringThe type of the credential fetcher. Currently supported types include GoogleComputeEngine
CREDENTIAL_IDENTITY_PROVIDERStringGoogleComputeEngineThe identity provider for credential. Currently default supported identity provider is GoogleComputeEngine
DISABLE_ENVOYBooleanfalseDisables all Envoy agent features.
DNS_PROXY_ADDRStringlocalhost:15053Custom address for the DNS proxy. If it ends with :53 and running as root allows running without iptable DNS capture
ECC_SIGNATURE_ALGORITHMStringThe type of ECC signature algorithm to use when generating private keys
ENABLE_CA_SERVERBooleantrueIf this is set to false, will not create CA server in istiod.
ENABLE_DEBUG_ON_HTTPBooleantrueIf this is set to false, the debug interface will not be ebabled on Http, recommended for production
ENABLE_LEGACY_FSGROUP_INJECTIONBooleantrueIf true, Istiod will set the pod fsGroup to 1337 on injection. This is required for Kubernetes 1.18 and older (see https://github.com/kubernetes/kubernetes/issues/57923 for details) unless JWT_POLICY is “first-party-jwt”.
ENABLE_MCS_AUTOEXPORTBooleanfalseIf enabled, istiod will automatically generate MCS ServiceExport objects for each service in each cluster. Services defined to be cluster-local in MeshConfig are excluded.
ENABLE_MCS_HOSTBooleanfalseIf enabled, istiod will provide an alias <svc>.<namespace>.svc.clusterset.local for each Kubernetes service. Clients must, however, be able to successfully lookup these DNS hosts. That means that either Istio DNS interception must be enabled or an MCS controller must be used.
ENABLE_MCS_SERVICE_DISCOVERYBooleanfalseIf enabled, istiod will enable Kubernetes MCS service discovery mode. In this mode, service endpoints in a cluster will only discoverable within the same cluster unless explicitly exported (via the ServiceExport CR).
ENABLE_MULTICLUSTER_HEADLESSBooleanfalseIf true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster.
ENABLE_WASM_TELEMETRYBooleanfalseIf enabled, Wasm-based telemetry will be enabled.
ENVOY_PROMETHEUS_PORTInteger15090Envoy prometheus redirection port value
ENVOY_STATUS_PORTInteger15021Envoy health status port value
ENVOY_USERStringistio-proxyEnvoy proxy username
EXTERNAL_ISTIODBooleanfalseIf this is set to true, one Istiod will control remote clusters including CA.
FILE_MOUNTED_CERTSBooleanfalse
GCP_METADATAStringPipe separted GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE
GCP_QUOTA_PROJECTStringAllows specification of a quota project to be used in requests to GCP APIs.
GKE_CLUSTER_URLStringThe url of GKE cluster
GRPC_XDS_BOOTSTRAPStringPath where gRPC expects to read a bootstrap file. Agent will generate one if set.
INJECTION_WEBHOOK_CONFIG_NAMEStringistio-sidecar-injectorName of the mutatingwebhookconfiguration to patch, if istioctl is not used.
INSTANCE_IPString
ISTIOD_CUSTOM_HOSTStringCustom host name of istiod that istiod signs the server cert.
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSIONBooleantrueIf enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file.
ISTIO_BOOTSTRAPString
ISTIO_BOOTSTRAP_OVERRIDEString
ISTIO_DEFAULT_REQUEST_TIMEOUTTime Duration0sDefault Http and gRPC Request timeout
ISTIO_DELTA_XDSBooleanfalseIf enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request. This feature uses the delta xds api, but does not currently send the actual deltas.
ISTIO_GATEWAY_STRIP_HOST_PORTBooleanfalseIf enabled, Gateway will remove any port from host/authority header before any processing of request by HTTP filters or routing.
ISTIO_GPRC_MAXRECVMSGSIZEInteger4194304Sets the max receive buffer size of gRPC stream in bytes.
ISTIO_GPRC_MAXSTREAMSInteger100000Sets the maximum number of concurrent grpc streams.
ISTIO_KUBE_APP_PROBERSString
ISTIO_META_CLUSTER_IDString
ISTIO_META_DNS_CAPTUREBooleanfalseIf set to true, enable the capture of outgoing DNS packets on port 53, redirecting to istio-agent on :15053
ISTIO_MULTIROOT_MESHBooleanfalseIf enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS
ISTIO_PROMETHEUS_ANNOTATIONSString
JWT_POLICYStringthird-party-jwtThe JWT validation policy.
K8S_INGRESS_NSString
KUBERNETES_SERVICE_HOSTStringKuberenetes service host, set automatically when running in-cluster
K_REVISIONStringKNative revision, set if running in knative
OUTPUT_CERTSStringThe output directory for the key and certificate. If empty, key and certificate will not be saved. Must be set for VMs using provisioning certificates.
PILOT_CERT_PROVIDERStringistiodThe provider of Pilot DNS certificate.
PILOT_DEBOUNCE_AFTERTime Duration100msThe delay added to config/registry events for debouncing. This will delay the push by at least this interval. 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_DISTRIBUTION_HISTORY_RETENTIONTime Duration1m0sIf enabled, Pilot will keep track of old versions of distributed config for this duration.
PILOT_ENABLED_SERVICE_APISBooleantrueIf this is set to true, support for Kubernetes gateway-api (github.com/kubernetes-sigs/gateway-api) will be enabled. In addition to this being enabled, the gateway-api CRDs need to be installed.
PILOT_ENABLE_ANALYSISBooleanfalseIf enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources
PILOT_ENABLE_CDS_CACHEBooleanfalseIf true, Pilot will cache CDS responses. Note: this depends on PILOT_ENABLE_XDS_CACHE.
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_CROSS_CLUSTER_WORKLOAD_ENTRYBooleanfalseIf enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster.
PILOT_ENABLE_DESTINATION_RULE_INHERITANCEBooleanfalseIf set, workload specific DestinationRules will inherit configurations settings from mesh and namespace level rules
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_EDS_FOR_HEADLESS_SERVICESBooleanfalseIf enabled, for headless service in Kubernetes, pilot will send endpoints over EDS, allowing the sidecar to load balance among pods in the headless service. This feature should be enabled if applications access all services explicitly via a HTTP proxy port in the sidecar.
PILOT_ENABLE_FLOW_CONTROLBooleanfalseIf enabled, pilot will wait for the completion of a receive operation beforeexecuting a push operation. This is a form of flow control and is useful inenvironments with high rates of push requests to each gateway. By default,this is false.
PILOT_ENABLE_GATEWAY_API_STATUSBooleantrueIf this is set to true, gateway-api resources will have status written to them
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_INBOUND_PASSTHROUGHBooleantrueIf enabled, inbound clusters will be configured as ORIGINAL_DST clusters. When disabled, requests are always sent to localhost. The primary implication of this is that when enabled, binding to POD_IP will work while localhost will not; when disable, bind to POD_IP will not work, while localhost will. The enabled behavior matches the behavior without Istio enabled at all; this flag exists only for backwards compatibility. Regardless of this setting, the configuration can be overridden with the Sidecar.Ingress.DefaultEndpoint configuration.
PILOT_ENABLE_ISTIO_TAGSBooleantrueDetermines whether or not trace spans generated by Envoy will include Istio-specific tags.
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIESBooleantrueIf enabled, Kubernetes services with selectors will select workload entries with matching labels. It is safe to disable it if you are quite sure you don’t need this feature
PILOT_ENABLE_LEGACY_AUTO_PASSTHROUGHBooleanfalseIf enabled, pilot will allow any upstream cluster to be used with AUTO_PASSTHROUGH. This option is intended for backwards compatibility only and is not secure with untrusted downstreams; it will be removed in the future.
PILOT_ENABLE_MONGO_FILTERBooleantrueEnableMongoFilter enables injection of envoy.filters.network.mongo_proxy in the filter chain.
PILOT_ENABLE_MYSQL_FILTERBooleanfalseEnableMysqlFilter enables injection of envoy.filters.network.mysql_proxy in the filter chain.
PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUNDBooleantrueIf 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_ROUTE_COLLAPSE_OPTIMIZATIONBooleantrueIf true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization.
PILOT_ENABLE_SERVICEENTRY_SELECT_PODSBooleantrueIf enabled, service entries with selectors will select pods from the cluster. It is safe to disable it if you are quite sure you don’t need this feature
PILOT_ENABLE_STATUSBooleanfalseIf enabled, pilot will update the CRD Status field of all istio resources with reconciliation status.
PILOT_ENABLE_VIRTUAL_SERVICE_DELEGATEBooleantrueIf set to false, virtualService delegate will not be supported.
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATIONBooleantrueEnables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload.
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKSBooleantrueEnables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup
PILOT_ENABLE_XDS_CACHEBooleantrueIf true, Pilot will cache XDS responses.
PILOT_ENABLE_XDS_IDENTITY_CHECKBooleantrueIf enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for.
PILOT_ENDPOINT_TELEMETRY_LABELBooleantrueIf true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter.
PILOT_ENVOY_FILTER_STATSBooleanfalseIf true, Pilot will collect metrics for envoy filter operations.
PILOT_FILTER_GATEWAY_CLUSTER_CONFIGBooleanfalse
PILOT_FLOW_CONTROL_TIMEOUTTime Duration15sIf set, the max amount of time to delay a push by. Depends on PILOT_ENABLE_FLOW_CONTROL.
PILOT_HTTP10BooleanfalseEnables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications.
PILOT_HTTP_DELAYED_CLOSE_TIMEOUTTime Duration1sThe delayed close timeout is for downstream HTTP connections. This should be set to a high value or disable it when peer is reading large chunk of data and to give an opportunity to initiate the close sequence properly. A value of 0s disables this
PILOT_INBOUND_PROTOCOL_DETECTION_TIMEOUTTime Duration1sProtocol detection timeout for inbound listener
PILOT_JWT_ENABLE_REMOTE_JWKSBooleanfalseIf enabled, checks to see if the configured JwksUri in RequestAuthentication is a mesh cluster URL and configures Remote Jwks to let Envoy fetch the Jwks instead of Istiod.
PILOT_JWT_PUB_KEY_REFRESH_INTERVALTime Duration20m0sThe interval for istiod to fetch the jwks_uri for the jwks public key.
PILOT_PUSH_THROTTLEInteger100Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes
PILOT_REMOTE_CLUSTER_TIMEOUTTime Duration30sAfter this timeout expires, pilot can become ready without syncing data from clusters added via remote-secrets. Setting the timeout to 0 disables this behavior.
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_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_STATUS_BURSTInteger500If status is enabled, controls the Burst rate with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config Burst
PILOT_STATUS_MAX_WORKERSInteger100The maximum number of workers Pilot will use to keep configuration status up to date. Smaller numbers will result in higher status latency, but larger numbers may impact CPU in high scale environments.
PILOT_STATUS_QPSFloating-Point100If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS
PILOT_STATUS_UPDATE_INTERVALTime Duration500msInterval to update the XDS distribution status.
PILOT_TRACE_SAMPLINGFloating-Point1Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0.
PILOT_USE_ENDPOINT_SLICEBooleanfalseIf enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used
PILOT_USE_TARGET_PORT_FOR_GATEWAY_ROUTESBooleantrueIf true, routes will use the target port of the gateway service in the route name, not the service port.
PILOT_WORKLOAD_ENTRY_GRACE_PERIODTime Duration10sThe amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up.
PILOT_XDS_CACHE_SIZEInteger60000The maximum number of cache entries for the XDS cache.
PILOT_XDS_CACHE_STATSBooleanfalseIf true, Pilot will collect metrics for XDS cache efficiency.
PILOT_XDS_SEND_TIMEOUTTime Duration0sThe timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push.
PKCS8_KEYBooleanfalseWhether to generate PKCS#8 private keys
POD_NAMEString
POD_NAMESPACEString
PROV_CERTStringSet to a directory containing provisioned certs, for VMs
PROXY_CONFIGStringThe proxy configuration. This will be set by the injection - gateways will use file mounts.
PROXY_CONFIG_XDS_AGENTBooleanfalseIf set to true, agent retrieves dynamic proxy-config updates via xds channel
PROXY_XDS_DEBUG_VIA_AGENTBooleantrueIf set to true, the agent will listen on 15004 and offer pilot’s XDS istio.io/debug debug API there.
PROXY_XDS_VIA_AGENTBooleantrueIf set to true, envoy will proxy XDS calls via the agent instead of directly connecting to istiod. This option will be removed once the feature is stabilized.
REQUIRE_3P_TOKENBooleanfalseReject k8s default tokens, without audience. If false, default K8S token will be accepted
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATIONBooleanfalseIf enabled, readiness probes will be sent to ‘localhost’. Otherwise, they will be sent to the Pod’s IP, matching Kubernetes’ behavior.
SECRET_GRACE_PERIOD_RATIOFloating-Point0.5The grace period ratio for the cert rotation, by default 0.5.
SECRET_TTLTime Duration24h0m0sThe cert lifetime requested by istio agent
SERVICE_ACCOUNTStringName of service account
SHARED_MESH_CONFIGStringAdditional config map to load for shared MeshConfig settings. The standard mesh config will take precedence.
SPIFFE_BUNDLE_ENDPOINTSStringThe SPIFFE bundle trust domain to endpoint mappings. Istiod retrieves the root certificate from each SPIFFE bundle endpoint and uses it to verify client certifiates from that trust domain. The endpoint must be compliant to the SPIFFE Bundle Endpoint standard. For details, please refer to https://github.com/spiffe/spiffe/blob/master/standards/SPIFFE_Trust_Domain_and_Bundle.md . No need to configure this for root certificates issued via Istiod or web-PKI based root certificates. Use || between <trustdomain, endpoint> tuples. Use | as delimiter between trust domain and endpoint in each tuple. For example: foo|https://url/for/foo||bar|https://url/for/bar
TOKEN_AUDIENCESStringistio-caA list of comma separated audiences to check in the JWT token before issuing a certificate. The token is accepted if it matches with one of the audiences
TRUST_DOMAINStringcluster.localThe trust domain for spiffe certificates
UNSAFE_ENABLE_ADMIN_ENDPOINTSBooleanfalseIf this is set to true, dangerous admin endpoins will be exposed on the debug interface. Not recommended for production.
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONSBooleanfalseIf enabled, addition runtime asserts will be performed. These checks are both expensive and panic on failure. As a result, this should be used only for testing.
VALIDATION_WEBHOOK_CONFIG_NAMEStringistio-istio-systemName of the validatingwebhookconfiguration to patch. Empty will skip using cluster admin to patch.
XDS_AUTHBooleantrueIf true, will authenticate XDS clients.
XDS_AUTH_PLAINTEXTBooleanfalseAuthenticate plain text requests - used if Istiod is behind a gateway handling TLS
XDS_AUTH_PROVIDERStringProvider for XDS auth
XDS_ROOT_CAStringExplicitly set the root CA to expect for the XDS connection.

Exported metrics

Metric NameTypeDescription
auto_registration_deletes_totalSumTotal number of auto registration cleaned up by periodic timer.
auto_registration_errors_totalSumTotal number of auto registration errors.
auto_registration_success_totalSumTotal number of successful auto registrations.
auto_registration_unregister_totalSumTotal number of unregistrations.
auto_registration_updates_totalSumTotal number of auto registration updates.
controller_sync_errors_totalSumTotal number of errorMetric syncing controllers.
endpoint_no_podLastValueEndpoints without an associated pod.
envoy_connection_terminationsSumThe total number of connection errors from envoy
galley_validation_config_delete_errorCountk8s webhook configuration delete error
galley_validation_config_loadCountk8s webhook configuration (re)loads
galley_validation_config_load_errorCountk8s webhook configuration (re)load error
galley_validation_config_update_errorCountk8s webhook configuration update error
galley_validation_config_updatesCountk8s webhook configuration updates
istio_buildLastValueIstio component build info
istiod_connection_failuresSumThe total number of connection failures to Istiod
istiod_connection_terminationsSumThe total number of connection errors to Istiod
istiod_managed_clustersLastValueNumber of clusters managed by istiod
num_failed_outgoing_requestsSumNumber of failed outgoing requests (e.g. to a token exchange server, CA, etc.)
num_file_secret_failures_totalSumNumber of times secret generation failed for files
num_file_watcher_failures_totalSumNumber of times file watcher failed to add watchers
num_outgoing_requestsSumNumber of total outgoing requests (e.g. to a token exchange server, CA, etc.)
num_outgoing_retriesSumNumber of outgoing retry requests (e.g. to a token exchange server, CA, etc.)
outgoing_latencySumThe latency of outgoing requests (e.g. to a token exchange server, CA, etc.) in milliseconds.
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_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_inbound_updatesSumTotal number of updates received by pilot.
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_k8s_cfg_eventsSumEvents from k8s config.
pilot_k8s_endpoints_pending_podLastValueNumber of endpoints that do not currently have any corresponding pods.
pilot_k8s_endpoints_with_no_podsSumEndpoints that does not have any corresponding pods.
pilot_k8s_reg_eventsSumEvents from k8s registry.
pilot_no_ipLastValuePods not found in the endpoint table, possibly invalid.
pilot_proxy_convergence_timeDistributionDelay in seconds between config change and a proxy receiving all required configuration.
pilot_proxy_queue_timeDistributionTime in seconds, a proxy is in the push queue before being dequeued.
pilot_push_triggersSumTotal number of times a push was triggered, labeled by reason for the push.
pilot_sds_certificate_errors_totalSumTotal number of failures to fetch SDS key and certificate.
pilot_servicesLastValueTotal services known to pilot.
pilot_total_rejected_configsSumTotal number of configs that Pilot had to reject or ignore.
pilot_total_xds_internal_errorsSumTotal number of internal XDS errors in pilot.
pilot_total_xds_rejectsSumTotal number of XDS responses from pilot rejected by proxy.
pilot_virt_servicesLastValueTotal virtual services known to pilot.
pilot_vservice_dup_domainLastValueVirtual services with dup domains.
pilot_xdsLastValueNumber of endpoints connected to this pilot using XDS.
pilot_xds_cds_rejectLastValuePilot rejected CDS configs.
pilot_xds_config_size_bytesDistributionDistribution of configuration sizes pushed to clients
pilot_xds_delayed_push_timeouts_totalSumTotal number of XDS pushes that are delayed and timed out
pilot_xds_delayed_pushes_totalSumTotal number of XDS pushes that are delayed.
pilot_xds_eds_rejectLastValuePilot rejected EDS.
pilot_xds_expired_nonceSumTotal number of XDS requests with an expired nonce.
pilot_xds_lds_rejectLastValuePilot rejected LDS.
pilot_xds_push_context_errorsSumNumber of errors (timeouts) initiating push context.
pilot_xds_push_timeDistributionTotal time in seconds Pilot takes to push lds, rds, cds and eds.
pilot_xds_pushesSumPilot build and send errors for lds, rds, cds and eds.
pilot_xds_rds_rejectLastValuePilot rejected RDS.
pilot_xds_send_timeDistributionTotal time in seconds Pilot takes to send generated configuration.
pilot_xds_write_timeoutSumPilot XDS response write timeouts.
remote_cluster_sync_timeouts_totalSumNumber of times remote clusters took too long to sync, causing slow startup that excludes remote clusters.
scrape_failures_totalSumThe total number of failed scrapes.
scrapes_totalSumThe total number of scrapes.
sidecar_injection_failure_totalSumTotal number of failed sidecar injection requests.
sidecar_injection_requests_totalSumTotal number of sidecar injection requests.
sidecar_injection_skip_totalSumTotal number of skipped sidecar injection requests.
sidecar_injection_success_totalSumTotal number of successful sidecar injection requests.
startup_duration_secondsLastValueThe time from the process starting to being marked ready.
total_active_connectionsSumThe total number of active SDS connections.
total_push_errorsSumThe total number of failed SDS pushes.
total_pushesSumThe total number of SDS pushes.
total_secret_update_failuresSumThe total number of dynamic secret update failures reported by proxy.
total_stale_connectionsSumThe total number of stale SDS connections.
wasm_cache_entriesLastValuenumber of Wasm remote fetch cache entries.
wasm_cache_lookup_countSumnumber of Wasm remote fetch cache lookups.
wasm_config_conversion_countSumnumber of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint.
wasm_config_conversion_durationDistributionTotal time in milliseconds istio-agent spends on converting remote load in Wasm config.
wasm_remote_fetch_countSumnumber of Wasm remote fetches and results, including success, download failure, and checksum mismatch.
xds_cache_evictionsSumTotal number of xds cache evictions.
xds_cache_readsSumTotal number of xds cache xdsCacheReads.
xds_cache_sizeLastValueCurrent size of xds cache