pilot-agent
Istio Pilot agent runs in the sidecar or gateway container and bootstraps Envoy.
| Flags | Description |
|---|---|
--log_as_json | Whether 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, 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, 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 ``) |
--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, 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 istio-clean-iptables
Script responsible for cleaning up iptables rules
pilot-agent istio-clean-iptables [flags]
| Flags | Shorthand | Description |
|---|---|---|
--dry-run | -n | Do not call any external dependencies like iptables |
--log_as_json | Whether 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, 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, 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 ``) | |
--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, 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> | -g | Specify the GID of the user for which the redirection is not applied. (same default value as -u param) (default ``) |
--proxy-uid <string> | -u | Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container (default ``) |
--redirect-dns | Enable capture of dns traffic by istio-agent |
pilot-agent istio-iptables
istio-iptables is responsible for setting up port forwarding for Istio Sidecar.
pilot-agent istio-iptables [flags]
| Flags | Shorthand | Description |
|---|---|---|
--capture-all-dns | Instead 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. | |
--dry-run | -n | Do not call any external dependencies like iptables |
--envoy-port <string> | -p | Specify the envoy port to which redirect all TCP traffic (default $ENVOY_PORT = 15001) (default ``) |
--inbound-capture-port <string> | -z | 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> | -e | Specify the istio tunnel port for inbound tcp traffic (default $INBOUND_TUNNEL_PORT = 15008) (default ``) |
--iptables-probe-port <string> | set listen port for failure detection (default `15002`) | |
--istio-inbound-interception-mode <string> | -m | The mode used to redirect inbound connections to Envoy, either "REDIRECT" or "TPROXY" (default ``) |
--istio-inbound-ports <string> | -b | Comma 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 ``) |
--istio-inbound-tproxy-mark <string> | -t | (default ``) |
--istio-inbound-tproxy-route-table <string> | -r | (default ``) |
--istio-local-exclude-ports <string> | -d | Comma 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 ``) |
--istio-local-outbound-ports-exclude <string> | -o | Comma separated list of outbound ports to be excluded from redirection to Envoy (default ``) |
--istio-outbound-ports <string> | -q | Comma separated list of outbound ports to be explicitly included for redirection to Envoy (default ``) |
--istio-service-cidr <string> | -i | 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> | -x | Comma 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 ``) |
--kube-virt-interfaces <string> | -k | Comma separated list of virtual interfaces whose inbound traffic (from VM) will be treated as outbound (default ``) |
--log_as_json | Whether 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, 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, 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 ``) | |
--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, 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]`) | |
--probe-timeout <duration> | failure detection timeout (default `5s`) | |
--proxy-gid <string> | -g | Specify the GID of the user for which the redirection is not applied. (same default value as -u param) (default ``) |
--proxy-uid <string> | -u | Specify the UID of the user for which the redirection is not applied. Typically, this is the UID of the proxy container (default ``) |
--redirect-dns | Enable capture of dns traffic by istio-agent | |
--restore-format | -f | Print iptables rules in iptables-restore interpretable format |
--run-validation | Validate iptables | |
--skip-rule-apply | Skip iptables apply |
pilot-agent proxy
Envoy proxy agent
pilot-agent proxy [flags]
| Flags | Description |
|---|---|
--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 ``) |
--log_as_json | Whether 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, 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, 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 ``) |
--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, 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]`) |
--meshConfig <string> | 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`) |
--outlierLogPath <string> | The log path for outlier detection (default ``) |
--proxyComponentLogLevel <string> | The component log level used to start the Envoy proxy. Deprecated, use proxyLogLevel instead (default ``) |
--proxyLogLevel <string> | 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`) |
--serviceCluster <string> | Service cluster (default `istio-proxy`) |
--stsPort <int> | HTTP Port on which to serve Security Token Service (STS). If zero, STS service will not be provided. (default `0`) |
--templateFile <string> | 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
pilot-agent request <method> <path> [<body>] [flags]
| Flags | Description |
|---|---|
--debug-port <int32> | Set the port to make a local request to. The default points to the Envoy admin API. (default `15000`) |
--log_as_json | Whether 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, 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, 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 ``) |
--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, 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
pilot-agent version [flags]
| Flags | Shorthand | Description |
|---|---|---|
--log_as_json | Whether 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, 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, 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 ``) | |
--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, 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> | -o | One of 'yaml' or 'json'. (default ``) |
--short | -s | Use --short=false to generate full version information |
pilot-agent wait
Waits until the Envoy proxy is ready
pilot-agent wait [flags]
| Flags | Description |
|---|---|
--log_as_json | Whether 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, 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, 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 ``) |
--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, 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 thepilot-agent command. Please use with caution as these environment variables are experimental and can change anytime.| Variable Name | Type | Default Value | Description |
|---|---|---|---|
BOOTSTRAP_XDS_AGENT | Boolean | false | If set to true, agent retrieves the bootstrap configuration prior to starting Envoy |
CA_ADDR | String | | Address of the spiffe certificate provider. Defaults to discoveryAddress |
CA_PROVIDER | String | Citadel | name of authentication provider |
CA_ROOT_CA | String | | Explicitly set the root CA to expect for the CA connection. |
CLUSTER_ID | String | Kubernetes | Defines the cluster and service registry that this Istiod instance is belongs to |
CREDENTIAL_FETCHER_TYPE | String | | The type of the credential fetcher. Currently supported types include GoogleComputeEngine |
CREDENTIAL_IDENTITY_PROVIDER | String | GoogleComputeEngine | The identity provider for credential. Currently default supported identity provider is GoogleComputeEngine |
ECC_SIGNATURE_ALGORITHM | String | | The type of ECC signature algorithm to use when generating private keys |
ENABLE_CA_SERVER | Boolean | true | If this is set to false, will not create CA server in istiod. |
ENABLE_DEBUG_ON_HTTP | Boolean | true | If this is set to false, the debug interface will not be ebabled on Http, recommended for production |
ENABLE_LEGACY_FSGROUP_INJECTION | Boolean | true | If 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_MULTICLUSTER_HEADLESS | Boolean | false | If true, the DNS name table for a headless service will resolve to same-network endpoints in any cluster. |
ENABLE_WASM_TELEMETRY | Boolean | false | If enabled, Wasm-based telemetry will be enabled. |
ENVOY_PROMETHEUS_PORT | Integer | 15090 | Envoy prometheus redirection port value |
ENVOY_STATUS_PORT | Integer | 15021 | Envoy health status port value |
ENVOY_USER | String | istio-proxy | Envoy proxy username |
EXTERNAL_ISTIOD | Boolean | false | If this is set to true, one Istiod will control remote clusters including CA. |
FILE_MOUNTED_CERTS | Boolean | false | |
GCP_METADATA | String | | Pipe separted GCP metadata, schemed as PROJECT_ID|PROJECT_NUMBER|CLUSTER_NAME|CLUSTER_ZONE |
GKE_CLUSTER_URL | String | | The url of GKE cluster |
INJECTION_WEBHOOK_CONFIG_NAME | String | istio-sidecar-injector | Name of the mutatingwebhookconfiguration to patch, if istioctl is not used. |
INSTANCE_IP | String | | |
ISTIOD_CUSTOM_HOST | String | | Custom host name of istiod that istiod signs the server cert. |
ISTIO_AGENT_ENABLE_WASM_REMOTE_LOAD_CONVERSION | Boolean | true | If enabled, Istio agent will intercept ECDS resource update, downloads Wasm module, and replaces Wasm module remote load with downloaded local module file. |
ISTIO_BOOTSTRAP | String | | |
ISTIO_BOOTSTRAP_OVERRIDE | String | | |
ISTIO_DEFAULT_REQUEST_TIMEOUT | Time Duration | 0s | Default Http and gRPC Request timeout |
ISTIO_DELTA_XDS | Boolean | false | If enabled, pilot will only send the delta configs as opposed to the state of the world on a Resource Request |
ISTIO_GATEWAY_STRIP_HOST_PORT | Boolean | false | If enabled, Gateway will remove any port from host/authority header before any processing of request by HTTP filters or routing. |
ISTIO_GPRC_MAXRECVMSGSIZE | Integer | 4194304 | Sets the max receive buffer size of gRPC stream in bytes. |
ISTIO_GPRC_MAXSTREAMS | Integer | 100000 | Sets the maximum number of concurrent grpc streams. |
ISTIO_KUBE_APP_PROBERS | String | | |
ISTIO_META_CLUSTER_ID | String | | |
ISTIO_META_DNS_CAPTURE | Boolean | false | If set to true, enable the capture of outgoing DNS packets on port 53, redirecting to istio-agent on :15053 |
ISTIO_MULTIROOT_MESH | Boolean | false | If enabled, mesh will support certificates signed by more than one trustAnchor for ISTIO_MUTUAL mTLS |
ISTIO_PROMETHEUS_ANNOTATIONS | String | | |
JWT_POLICY | String | third-party-jwt | The JWT validation policy. |
K8S_INGRESS_NS | String | | |
KUBERNETES_SERVICE_HOST | String | | Kuberenetes service host, set automatically when running in-cluster |
K_REVISION | String | | KNative revision, set if running in knative |
OUTPUT_CERTS | String | | The 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_PROVIDER | String | istiod | The provider of Pilot DNS certificate. |
PILOT_DEBOUNCE_AFTER | Time Duration | 100ms | The 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_MAX | Time Duration | 10s | The 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_RETENTION | Time Duration | 1m0s | If enabled, Pilot will keep track of old versions of distributed config for this duration. |
PILOT_ENABLED_SERVICE_APIS | Boolean | true | If 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_ANALYSIS | Boolean | false | If enabled, pilot will run istio analyzers and write analysis errors to the Status field of any Istio Resources |
PILOT_ENABLE_CONFIG_DISTRIBUTION_TRACKING | Boolean | true | If 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_ENTRY | Boolean | false | If enabled, pilot will read WorkloadEntry from other clusters, selectable by Services in that cluster. |
PILOT_ENABLE_DESTINATION_RULE_INHERITANCE | Boolean | false | If set, workload specific DestinationRules will inherit configurations settings from mesh and namespace level rules |
PILOT_ENABLE_EDS_DEBOUNCE | Boolean | true | If 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_SERVICES | Boolean | false | If 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_CONTROL | Boolean | false | If 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_HEADLESS_SERVICE_POD_LISTENERS | Boolean | true | If 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_PASSTHROUGH | Boolean | true | If 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_TAGS | Boolean | true | Determines whether or not trace spans generated by Envoy will include Istio-specific tags. |
PILOT_ENABLE_K8S_SELECT_WORKLOAD_ENTRIES | Boolean | true | If 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_PASSTHROUGH | Boolean | false | If 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_MCS_SERVICEEXPORT | Boolean | false | If enabled, Pilot will generate MCS ServiceExport objects for every non cluster-local service in the cluster |
PILOT_ENABLE_MONGO_FILTER | Boolean | true | EnableMongoFilter enables injection of `envoy.filters.network.mongo_proxy` in the filter chain. |
PILOT_ENABLE_MYSQL_FILTER | Boolean | false | EnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain. |
PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_INBOUND | Boolean | true | If enabled, protocol sniffing will be used for inbound listeners whose port protocol is not specified or unsupported |
PILOT_ENABLE_PROTOCOL_SNIFFING_FOR_OUTBOUND | Boolean | true | If enabled, protocol sniffing will be used for outbound listeners whose port protocol is not specified or unsupported |
PILOT_ENABLE_REDIS_FILTER | Boolean | false | EnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain. |
PILOT_ENABLE_ROUTE_COLLAPSE_OPTIMIZATION | Boolean | true | If true, Pilot will merge virtual hosts with the same routes into a single virtual host, as an optimization. |
PILOT_ENABLE_SERVICEENTRY_SELECT_PODS | Boolean | true | If 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_STATUS | Boolean | false | If enabled, pilot will update the CRD Status field of all istio resources with reconciliation status. |
PILOT_ENABLE_VIRTUAL_SERVICE_DELEGATE | Boolean | true | If set to false, virtualService delegate will not be supported. |
PILOT_ENABLE_WORKLOAD_ENTRY_AUTOREGISTRATION | Boolean | true | Enables auto-registering WorkloadEntries based on associated WorkloadGroups upon XDS connection by the workload. |
PILOT_ENABLE_WORKLOAD_ENTRY_HEALTHCHECKS | Boolean | true | Enables automatic health checks of WorkloadEntries based on the config provided in the associated WorkloadGroup |
PILOT_ENABLE_XDS_CACHE | Boolean | true | If true, Pilot will cache XDS responses. |
PILOT_ENABLE_XDS_IDENTITY_CHECK | Boolean | true | If enabled, pilot will authorize XDS clients, to ensure they are acting only as namespaces they have permissions for. |
PILOT_ENDPOINT_TELEMETRY_LABEL | Boolean | true | If true, pilot will add telemetry related metadata to Endpoint resource, which will be consumed by telemetry filter. |
PILOT_ENVOY_FILTER_STATS | Boolean | false | If true, Pilot will collect metrics for envoy filter operations. |
PILOT_FILTER_GATEWAY_CLUSTER_CONFIG | Boolean | false | |
PILOT_FLOW_CONTROL_TIMEOUT | Time Duration | 15s | If set, the max amount of time to delay a push by. Depends on PILOT_ENABLE_FLOW_CONTROL. |
PILOT_HTTP10 | Boolean | false | Enables the use of HTTP 1.0 in the outbound HTTP listeners, to support legacy applications. |
PILOT_HTTP_DELAYED_CLOSE_TIMEOUT | Time Duration | 1s | The 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_TIMEOUT | Time Duration | 1s | Protocol detection timeout for inbound listener |
PILOT_JWT_ENABLE_REMOTE_JWKS | Boolean | false | If 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_INTERVAL | Time Duration | 20m0s | The interval for istiod to fetch the jwks_uri for the jwks public key. |
PILOT_PUSH_THROTTLE | Integer | 100 | Limits the number of concurrent pushes allowed. On larger machines this can be increased for faster pushes |
PILOT_REMOTE_CLUSTER_TIMEOUT | Time Duration | 30s | After 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_NAMESPACE | Boolean | false | If 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_ADDRESS | Boolean | false | UseRemoteAddress sets useRemoteAddress to true for side car outbound listeners. |
PILOT_SKIP_VALIDATE_TRUST_DOMAIN | Boolean | false | Skip validating the peer is from the same trust domain when mTLS is enabled in authentication policy |
PILOT_STATUS_BURST | Integer | 500 | If 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_WORKERS | Integer | 100 | The 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_QPS | Floating-Point | 100 | If status is enabled, controls the QPS with which status will be updated. See https://godoc.org/k8s.io/client-go/rest#Config QPS |
PILOT_TRACE_SAMPLING | Floating-Point | 1 | Sets the mesh-wide trace sampling percentage. Should be 0.0 - 100.0. Precision to 0.01. Default is 1.0. |
PILOT_USE_ENDPOINT_SLICE | Boolean | false | If 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_ROUTES | Boolean | true | If true, routes will use the target port of the gateway service in the route name, not the service port. |
PILOT_WORKLOAD_ENTRY_GRACE_PERIOD | Time Duration | 10s | The amount of time an auto-registered workload can remain disconnected from all Pilot instances before the associated WorkloadEntry is cleaned up. |
PILOT_XDS_CACHE_SIZE | Integer | 20000 | The maximum number of cache entries for the XDS cache. |
PILOT_XDS_CACHE_STATS | Boolean | false | If true, Pilot will collect metrics for XDS cache efficiency. |
PILOT_XDS_SEND_TIMEOUT | Time Duration | 0s | The timeout to send the XDS configuration to proxies. After this timeout is reached, Pilot will discard that push. |
PKCS8_KEY | Boolean | false | Whether to generate PKCS#8 private keys |
POD_NAME | String | | |
POD_NAMESPACE | String | | |
PROV_CERT | String | | Set to a directory containing provisioned certs, for VMs |
PROXY_CONFIG | String | | The proxy configuration. This will be set by the injection - gateways will use file mounts. |
PROXY_CONFIG_XDS_AGENT | Boolean | false | If set to true, agent retrieves dynamic proxy-config updates via xds channel |
PROXY_XDS_DEBUG_VIA_AGENT | Boolean | true | If set to true, the agent will listen on 15004 and offer pilot's XDS istio.io/debug debug API there. |
PROXY_XDS_VIA_AGENT | Boolean | true | If 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_TOKEN | Boolean | false | Reject k8s default tokens, without audience. If false, default K8S token will be accepted |
REWRITE_PROBE_LEGACY_LOCALHOST_DESTINATION | Boolean | false | If enabled, readiness probes will be sent to 'localhost'. Otherwise, they will be sent to the Pod's IP, matching Kubernetes' behavior. |
SECRET_GRACE_PERIOD_RATIO | Floating-Point | 0.5 | The grace period ratio for the cert rotation, by default 0.5. |
SECRET_TTL | Time Duration | 24h0m0s | The cert lifetime requested by istio agent |
SERVICE_ACCOUNT | String | | Name of service account |
SHARED_MESH_CONFIG | String | | Additional config map to load for shared MeshConfig settings. The standard mesh config will take precedence. |
SPIFFE_BUNDLE_ENDPOINTS | String | | The 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_AUDIENCES | String | istio-ca | A 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_DOMAIN | String | cluster.local | The trust domain for spiffe certificates |
UNSAFE_ENABLE_ADMIN_ENDPOINTS | Boolean | false | If this is set to true, dangerous admin endpoins will be exposed on the debug interface. Not recommended for production. |
UNSAFE_PILOT_ENABLE_RUNTIME_ASSERTIONS | Boolean | false | If 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. |
XDS_AUTH | Boolean | true | If true, will authenticate XDS clients. |
XDS_AUTH_PLAINTEXT | Boolean | false | Authenticate plain text requests - used if Istiod is behind a gateway handling TLS |
XDS_AUTH_PROVIDER | String | | Provider for XDS auth |
XDS_ROOT_CA | String | | Explicitly set the root CA to expect for the XDS connection. |
Exported metrics
| Metric Name | Type | Description |
|---|---|---|
auto_registration_deletes_total | Sum | Total number of auto registration cleaned up by periodic timer. |
auto_registration_errors_total | Sum | Total number of auto registration errors. |
auto_registration_success_total | Sum | Total number of successful auto registrations. |
auto_registration_unregister_total | Sum | Total number of unregistrations. |
auto_registration_updates_total | Sum | Total number of auto registration updates. |
controller_sync_errors_total | Sum | Total number of errorMetric syncing controllers. |
endpoint_no_pod | LastValue | Endpoints without an associated pod. |
envoy_connection_terminations | Sum | The total number of connection errors from envoy |
galley_validation_config_delete_error | Count | k8s webhook configuration delete error |
galley_validation_config_load | Count | k8s webhook configuration (re)loads |
galley_validation_config_load_error | Count | k8s webhook configuration (re)load error |
galley_validation_config_update_error | Count | k8s webhook configuration update error |
galley_validation_config_updates | Count | k8s webhook configuration updates |
istio_build | LastValue | Istio component build info |
istiod_connection_failures | Sum | The total number of connection failures to Istiod |
istiod_connection_terminations | Sum | The total number of connection errors to Istiod |
istiod_managed_clusters | LastValue | Number of clusters managed by istiod |
num_failed_outgoing_requests | Sum | Number of failed outgoing requests (e.g. to a token exchange server, CA, etc.) |
num_file_secret_failures_total | Sum | Number of times secret generation failed for files |
num_file_watcher_failures_total | Sum | Number of times file watcher failed to add watchers |
num_outgoing_requests | Sum | Number of total outgoing requests (e.g. to a token exchange server, CA, etc.) |
num_outgoing_retries | Sum | Number of outgoing retry requests (e.g. to a token exchange server, CA, etc.) |
outgoing_latency | Sum | The latency of outgoing requests (e.g. to a token exchange server, CA, etc.) in milliseconds. |
pilot_conflict_inbound_listener | LastValue | Number of conflicting inbound listeners. |
pilot_conflict_outbound_listener_http_over_current_tcp | LastValue | Number of conflicting wildcard http listeners with current wildcard tcp listener. |
pilot_conflict_outbound_listener_tcp_over_current_http | LastValue | Number of conflicting wildcard tcp listeners with current wildcard http listener. |
pilot_conflict_outbound_listener_tcp_over_current_tcp | LastValue | Number of conflicting tcp listeners with current tcp listener. |
pilot_destrule_subsets | LastValue | Duplicate subsets across destination rules for same host |
pilot_duplicate_envoy_clusters | LastValue | Duplicate envoy clusters caused by service entries with same hostname |
pilot_eds_no_instances | LastValue | Number of clusters without instances. |
pilot_endpoint_not_ready | LastValue | Endpoint found in unready state. |
pilot_inbound_updates | Sum | Total number of updates received by pilot. |
pilot_jwks_resolver_network_fetch_fail_total | Sum | Total number of failed network fetch by pilot jwks resolver |
pilot_jwks_resolver_network_fetch_success_total | Sum | Total number of successfully network fetch by pilot jwks resolver |
pilot_k8s_cfg_events | Sum | Events from k8s config. |
pilot_k8s_endpoints_pending_pod | LastValue | Number of endpoints that do not currently have any corresponding pods. |
pilot_k8s_endpoints_with_no_pods | Sum | Endpoints that does not have any corresponding pods. |
pilot_k8s_reg_events | Sum | Events from k8s registry. |
pilot_no_ip | LastValue | Pods not found in the endpoint table, possibly invalid. |
pilot_proxy_convergence_time | Distribution | Delay in seconds between config change and a proxy receiving all required configuration. |
pilot_proxy_queue_time | Distribution | Time in seconds, a proxy is in the push queue before being dequeued. |
pilot_push_triggers | Sum | Total number of times a push was triggered, labeled by reason for the push. |
pilot_sds_certificate_errors_total | Sum | Total number of failures to fetch SDS key and certificate. |
pilot_services | LastValue | Total services known to pilot. |
pilot_total_rejected_configs | Sum | Total number of configs that Pilot had to reject or ignore. |
pilot_total_xds_internal_errors | Sum | Total number of internal XDS errors in pilot. |
pilot_total_xds_rejects | Sum | Total number of XDS responses from pilot rejected by proxy. |
pilot_virt_services | LastValue | Total virtual services known to pilot. |
pilot_vservice_dup_domain | LastValue | Virtual services with dup domains. |
pilot_xds | LastValue | Number of endpoints connected to this pilot using XDS. |
pilot_xds_cds_reject | LastValue | Pilot rejected CDS configs. |
pilot_xds_config_size_bytes | Distribution | Distribution of configuration sizes pushed to clients |
pilot_xds_delayed_push_timeouts_total | Sum | Total number of XDS pushes that are delayed and timed out |
pilot_xds_delayed_pushes_total | Sum | Total number of XDS pushes that are delayed. |
pilot_xds_eds_reject | LastValue | Pilot rejected EDS. |
pilot_xds_expired_nonce | Sum | Total number of XDS requests with an expired nonce. |
pilot_xds_lds_reject | LastValue | Pilot rejected LDS. |
pilot_xds_push_context_errors | Sum | Number of errors (timeouts) initiating push context. |
pilot_xds_push_time | Distribution | Total time in seconds Pilot takes to push lds, rds, cds and eds. |
pilot_xds_pushes | Sum | Pilot build and send errors for lds, rds, cds and eds. |
pilot_xds_rds_reject | LastValue | Pilot rejected RDS. |
pilot_xds_send_time | Distribution | Total time in seconds Pilot takes to send generated configuration. |
pilot_xds_write_timeout | Sum | Pilot XDS response write timeouts. |
remote_cluster_sync_timeouts_total | Sum | Number of times remote clusters took too long to sync, causing slow startup that excludes remote clusters. |
scrape_failures_total | Sum | The total number of failed scrapes. |
scrapes_total | Sum | The total number of scrapes. |
startup_duration_seconds | LastValue | The time from the process starting to being marked ready. |
total_active_connections | Sum | The total number of active SDS connections. |
total_push_errors | Sum | The total number of failed SDS pushes. |
total_pushes | Sum | The total number of SDS pushes. |
total_secret_update_failures | Sum | The total number of dynamic secret update failures reported by proxy. |
total_stale_connections | Sum | The total number of stale SDS connections. |
wasm_cache_entries | LastValue | number of Wasm remote fetch cache entries. |
wasm_cache_lookup_count | Sum | number of Wasm remote fetch cache lookups. |
wasm_config_conversion_count | Sum | number of Wasm config conversion count and results, including success, no remote load, marshal failure, remote fetch failure, miss remote fetch hint. |
wasm_config_conversion_duration | Distribution | Total time in milliseconds istio-agent spends on converting remote load in Wasm config. |
wasm_remote_fetch_count | Sum | number of Wasm remote fetches and results, including success, download failure, and checksum mismatch. |
xds_cache_evictions | Sum | Total number of xds cache evictions. |
xds_cache_reads | Sum | Total number of xds cache xdsCacheReads. |
xds_cache_size | LastValue | Current size of xds cache |