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 [all, default, model, rbac] (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 [all, default, model, rbac] 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 [all, default, model, rbac] 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 proxy

Envoy proxy agent

pilot-agent proxy [flags]
FlagsDescription
--applicationPorts <stringSlice>Ports exposed by the application. Used to determine that Envoy is configured and ready to receive traffic. (default `[]`)
--binaryPath <string>Path to the proxy binary (default `/usr/local/bin/envoy`)
--concurrency <int>number of worker threads to run (default `0`)
--configPath <string>Path to the generated configuration file directory (default `/etc/istio/proxy`)
--connectTimeout <duration>Connection timeout used by Envoy for supporting services (default `1s`)
--controlPlaneAuthPolicy <string>Control Plane Authentication Policy (default `NONE`)
--controlPlaneBootstrapProcess bootstrap provided via templateFile to be used by control plane components.
--customConfigFile <string>Path to the custom configuration file (default ``)
--datadogAgentAddress <string>Address of the Datadog Agent (default ``)
--disableInternalTelemetryDisable internal telemetry
--discoveryAddress <string>Address of the discovery service exposing xDS (e.g. istio-pilot:8080) (default `istio-pilot:15010`)
--dnsRefreshRate <string>The dns_refresh_rate for bootstrap STRICT_DNS clusters (default `300s`)
--domain <string>DNS domain suffix. If not provided uses ${POD_NAMESPACE}.svc.cluster.local (default ``)
--drainDuration <duration>The time in seconds that Envoy will drain connections during a hot restart (default `45s`)
--envoyAccessLogServiceAddress <string>Host and Port of an Envoy gRPC Access Log Service API implementation (e.g. accesslog-service.istio-system:15000) (default ``)
--envoyMetricsServiceAddress <string>Host and Port of an Envoy Metrics Service API implementation (e.g. metrics-service:15000) (default ``)
--id <string>Proxy unique ID. If not provided uses ${POD_NAME}.${POD_NAMESPACE} from environment variables (default ``)
--ip <string>Proxy IP address. If not provided uses ${INSTANCE_IP} environment variable. (default ``)
--lightstepAccessToken <string>Access Token for LightStep Satellite pool (default ``)
--lightstepAddress <string>Address of the LightStep Satellite pool (default ``)
--lightstepCacertPath <string>Path to the trusted cacert used to authenticate the pool (default ``)
--lightstepSecureShould connection to the LightStep Satellite pool be secure
--log_as_jsonWhether to format output as JSON or in plain console-friendly format
--log_caller <string>Comma-separated list of scopes for which to include caller information, scopes can be any of [all, default, model, rbac] (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 [all, default, model, rbac] 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 [all, default, model, rbac] 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]`)
--mixerIdentity <string>The identity used as the suffix for mixer's spiffe SAN. This would only be used by pilot all other proxy would get this value from pilot (default ``)
--parentShutdownDuration <duration>The time in seconds that Envoy will wait before shutting down the parent process during a hot restart (default `1m0s`)
--pilotIdentity <string>The identity used as the suffix for pilot's spiffe SAN (default ``)
--proxyAdminPort <uint16>Port on which Envoy should listen for administrative commands (default `15000`)
--proxyComponentLogLevel <string>The component log level used to start the Envoy proxy (default `misc:error`)
--proxyLogLevel <string>The log level used to start the Envoy proxy (choose from {trace, debug, info, warning, error, critical, off}) (default `warning`)
--serviceCluster <string>Service cluster (default `istio-proxy`)
--serviceregistry <string>Select the platform for service registry, options are {Kubernetes, Consul, Mock} (default `Kubernetes`)
--statsdUdpAddress <string>IP Address and Port of a statsd UDP listener (e.g. 10.75.241.127:9125) (default ``)
--statusPort <uint16>HTTP Port on which to serve pilot agent status. If zero, agent status will not be provided. (default `0`)
--templateFile <string>Go template bootstrap config (default ``)
--trust-domain <string>The domain to use for identities (default ``)
--zipkinAddress <string>Address of the Zipkin service (e.g. zipkin:9411) (default ``)

pilot-agent request

Makes an HTTP request to the Envoy admin API

pilot-agent request <method> <path> [<body>] [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 [all, default, model, rbac] (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 [all, default, model, rbac] 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 [all, default, model, rbac] 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]
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 [all, default, model, rbac] (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 [all, default, model, rbac] 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 [all, default, model, rbac] 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

Environment variables

These environment variables affect the behavior of the pilot-agent command.
Variable NameTypeDefault ValueDescription
INSTANCE_IPString
ISTIO_BOOTSTRAPString
ISTIO_BOOTSTRAP_OVERRIDEString
ISTIO_GPRC_MAXSTREAMSInteger100000
ISTIO_KUBE_APP_PROBERSString
ISTIO_META_TLS_CLIENT_CERT_CHAINString/etc/certs/cert-chain.pem
ISTIO_META_TLS_CLIENT_KEYString/etc/certs/key.pem
ISTIO_META_TLS_CLIENT_ROOT_CERTString/etc/certs/root-cert.pem
ISTIO_META_TLS_SERVER_CERT_CHAINString/etc/certs/cert-chain.pem
ISTIO_META_TLS_SERVER_KEYString/etc/certs/key.pem
ISTIO_META_TLS_SERVER_ROOT_CERTString/etc/certs/root-cert.pem
ISTIO_NAMESPACEString
PILOT_CERT_DIRString
PILOT_DEBOUNCE_AFTERTime Duration100ms
PILOT_DEBOUNCE_MAXTime Duration10s
PILOT_DEBUG_ADSZ_CONFIGBooleanfalse
PILOT_DISABLE_EDS_ISOLATIONString
PILOT_DISABLE_EMPTY_ROUTE_RESPONSEBooleanfalseDisableEmptyRouteResponse provides an option to disable a partial route response. This will cause Pilot to ignore a route request if Pilot generates a nil route (due to an error). This may cause Envoy to wait forever for the route, blocking listeners from receiving traffic. The default behavior (without this flag set) is to explicitly send an empty route. This will break routing for that particular route, but allow others on the same listener to work.
PILOT_DISABLE_PARTIAL_ROUTE_RESPONSEBooleanfalseDisablePartialRouteResponse provides an option to disable a partial route response. This will cause Pilot to send an error if any routes are invalid. The default behavior (without this flag) is to just skip the invalid route.
PILOT_DISABLE_XDS_MARSHALING_TO_ANYString
PILOT_ENABLE_FALLTHROUGH_ROUTEBooleantrueEnableFallthroughRoute provides an option to add a final wildcard match for routes. When ALLOW_ANY traffic policy is used, a Passthrough cluster is used. When REGISTRY_ONLY traffic policy is used, a 502 error is returned.
PILOT_ENABLE_LOCALITY_LOAD_BALANCINGString
PILOT_ENABLE_MYSQL_FILTERBooleanfalseEnableMysqlFilter enables injection of `envoy.filters.network.mysql_proxy` in the filter chain.
PILOT_ENABLE_REDIS_FILTERBooleanfalseEnableRedisFilter enables injection of `envoy.filters.network.redis_proxy` in the filter chain.
PILOT_ENABLE_WAIT_CACHE_SYNCString
PILOT_HTTP10Booleanfalse
PILOT_INITIAL_FETCH_TIMEOUTTime Duration0sSpecifies the initial_fetch_timeout for config. If this time is reached without a response to the config requested by Envoy, the Envoy will move on with the init phase. This prevents envoy from getting stuck waiting on config during startup.
PILOT_PUSH_BURSTInteger100
PILOT_PUSH_THROTTLEInteger10
PILOT_SIDECAR_USE_REMOTE_ADDRESSBooleanfalseUseRemoteAddress sets useRemoteAddress to true for side car outbound listeners.
PILOT_TRACE_SAMPLINGFloating-Point100
POD_NAMEString
POD_NAMESPACEString
TERMINATION_DRAIN_DURATION_SECONDSString
V2_REFRESHTime Duration0s

Annotations

These resource annotations are used by the pilot-agent command.
Annotation NameDescription
policy.istio.io/checkDetermines the policy for behavior when unable to connect to Mixer. If not set, FAIL_CLOSE is set, rejecting requests.
policy.istio.io/checkBaseRetryWaitTimeBase time to wait between retries, will be adjusted by backoff and jitter. In duration format. If not set, this will be 80ms.
policy.istio.io/checkMaxRetryWaitTimeMaximum time to wait between retries to Mixer. In duration format. If not set, this will be 1000ms.
policy.istio.io/checkRetriesThe maximum number of retries on transport errors to Mixer. If not set, this will be 0, indicating no retries.
sidecar.istio.io/statsInclusionPrefixesSpecifies the comma separated list of prefixes of the stats to be emitted by Envoy.
sidecar.istio.io/statsInclusionRegexpsSpecifies the comma separated list of regexes the stats should match to be emitted by Envoy.
sidecar.istio.io/statsInclusionSuffixesSpecifies the comma separated list of suffixes of the stats to be emitted by Envoy.

Exported metrics

Metric NameTypeDescription
endpoint_no_podLastValueEndpoints without an associated pod.
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_discovery_callsSumIndividual method calls in Pilot
pilot_discovery_errorsSumErrors encountered during a given method call within Pilot
pilot_discovery_resourcesDistributionReturned resource counts per method by Pilot
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_no_ipLastValuePods not found in the endpoint table, possibly invalid.
pilot_total_rejected_configsSumTotal number of configs that Pilot had to reject or ignore.
pilot_vservice_dup_domainLastValueVirtual services with dup domains.