• pilot-discovery
    • pilot-discovery discovery
    • pilot-discovery request
    • pilot-discovery version
    • Environment variables
    • Exported metrics

    pilot-discovery

    Istio Pilot provides fleet-wide traffic management capabilities in the Istio Service Mesh.

    FlagsDescription
    —ctrlz_address <string>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default localhost)
    —ctrlz_port <uint16>The IP port to use for the ControlZ introspection facility (default 9876)
    —keepaliveInterval <duration>The time interval if no activity on the connection it pings the peer to see if the transport is alive (default 30s)
    —keepaliveMaxServerConnectionAge <duration>Maximum duration a connection will be kept open on the server before a graceful close. (default 2562047h47m16.854775807s)
    —keepaliveTimeout <duration>After having pinged for keepalive check, the client/server waits for a duration of keepaliveTimeout and if no activity is seen even after that the connection is closed. (default 10s)
    —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, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] (default )</td></tr><tr><td><code>--log_output_level &lt;string&gt;</code></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--log_rotate &lt;string&gt;</code></td><td>The path for the optional rotating log file (default)
    —log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default 30)
    —log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default 1000)
    —log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default 104857600)
    —log_stacktrace_level <string>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,… where scope can be one of [ads, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] and level can be one of [debug, info, warn, error, fatal, none] (default default:none)
    —log_target <stringArray>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default [stdout])

    pilot-discovery discovery

    Start Istio proxy discovery service.

    1. pilot-discovery discovery [flags]
    FlagsShorthandDescription
    —appNamespace <string>-aRestrict the applications namespace the controller manages; if not set, controller watches all namespaces (default )</td></tr><tr><td><code>--clusterRegistriesNamespace &lt;string&gt;</code></td><td></td><td>Namespace for ConfigMap which stores clusters configs (default)
    —configDir <string>Directory to watch for updates to config yaml files. If specified, the files will be used as the source of config, rather than a CRD client. (default )</td></tr><tr><td><code>--consulserverInterval &lt;duration&gt;</code></td><td></td><td>Interval (in seconds) for polling the Consul service registry (default `2s`)</td></tr><tr><td><code>--consulserverURL &lt;string&gt;</code></td><td></td><td>URL for the Consul server (default)
    —ctrlz_address <string>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default localhost)
    —ctrlz_port <uint16>The IP port to use for the ControlZ introspection facility (default 9876)
    —disable-install-crdsDisable discovery service from verifying the existence of CRDs at startup and then installing if not detected. It is recommended to be disable for highly available setups.
    —discoveryCacheEnable caching discovery service responses
    —domain <string>DNS domain suffix (default cluster.local)
    —grpcAddr <string>Discovery service grpc address (default :15010)
    —httpAddr <string>Discovery service HTTP address (default :8080)
    —keepaliveInterval <duration>The time interval if no activity on the connection it pings the peer to see if the transport is alive (default 30s)
    —keepaliveMaxServerConnectionAge <duration>Maximum duration a connection will be kept open on the server before a graceful close. (default 2562047h47m16.854775807s)
    —keepaliveTimeout <duration>After having pinged for keepalive check, the client/server waits for a duration of keepaliveTimeout and if no activity is seen even after that the connection is closed. (default 10s)
    —kubeconfig <string>Use a Kubernetes configuration file instead of in-cluster configuration (default )</td></tr><tr><td><code>--log_as_json</code></td><td></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></td><td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] (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, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] 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></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></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></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></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, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] 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></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>--mcpInitialConnWindowSize &lt;int&gt;</code></td><td></td><td>Initial connection window size for MCP&#39;s gRPC connection (default `1048576`)</td></tr><tr><td><code>--mcpInitialWindowSize &lt;int&gt;</code></td><td></td><td>Initial window size for MCP&#39;s gRPC connection (default `1048576`)</td></tr><tr><td><code>--mcpMaxMsgSize &lt;int&gt;</code></td><td></td><td>Max message size received by MCP&#39;s grpc client (default `4194304`)</td></tr><tr><td><code>--meshConfig &lt;string&gt;</code></td><td></td><td>File name for Istio mesh configuration. If not specified, a default mesh will be used. (default `/etc/istio/config/mesh`)</td></tr><tr><td><code>--monitoringAddr &lt;string&gt;</code></td><td></td><td>HTTP address to use for pilot&#39;s self-monitoring information (default `:15014`)</td></tr><tr><td><code>--namespace &lt;string&gt;</code></td><td><code>-n</code></td><td>Select a namespace where the controller resides. If not set, uses ${POD_NAMESPACE} environment variable (default)
    —networksConfig <string>File name for Istio mesh networks configuration. If not specified, a default mesh networks will be used. (default /etc/istio/config/meshNetworks)
    —plugins <stringSlice>comma separated list of networking plugins to enable (default [authn,authz,health,mixer])
    —profileEnable profiling via web interface host:port/debug/pprof
    —registries <stringSlice>Comma separated list of platform service registries to read from (choose one or more from {Kubernetes, Consul, MCP, Mock}) (default [Kubernetes])
    —resync <duration>Controller resync interval (default 1m0s)
    —secureGrpcAddr <string>Discovery service grpc address, with https (default :15012)
    —trust-domain <string>The domain serves to identify the system with spiffe (default ``)

    pilot-discovery request

    Makes an HTTP request to Pilot metrics/debug endpoint

    1. pilot-discovery request <method> <path> [<body>] [flags]
    FlagsDescription
    —ctrlz_address <string>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default localhost)
    —ctrlz_port <uint16>The IP port to use for the ControlZ introspection facility (default 9876)
    —keepaliveInterval <duration>The time interval if no activity on the connection it pings the peer to see if the transport is alive (default 30s)
    —keepaliveMaxServerConnectionAge <duration>Maximum duration a connection will be kept open on the server before a graceful close. (default 2562047h47m16.854775807s)
    —keepaliveTimeout <duration>After having pinged for keepalive check, the client/server waits for a duration of keepaliveTimeout and if no activity is seen even after that the connection is closed. (default 10s)
    —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, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] (default )</td></tr><tr><td><code>--log_output_level &lt;string&gt;</code></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--log_rotate &lt;string&gt;</code></td><td>The path for the optional rotating log file (default)
    —log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default 30)
    —log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default 1000)
    —log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default 104857600)
    —log_stacktrace_level <string>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,… where scope can be one of [ads, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] and level can be one of [debug, info, warn, error, fatal, none] (default default:none)
    —log_target <stringArray>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default [stdout])

    pilot-discovery version

    Prints out build version information

    1. pilot-discovery version [flags]
    FlagsShorthandDescription
    —ctrlz_address <string>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default localhost)
    —ctrlz_port <uint16>The IP port to use for the ControlZ introspection facility (default 9876)
    —keepaliveInterval <duration>The time interval if no activity on the connection it pings the peer to see if the transport is alive (default 30s)
    —keepaliveMaxServerConnectionAge <duration>Maximum duration a connection will be kept open on the server before a graceful close. (default 2562047h47m16.854775807s)
    —keepaliveTimeout <duration>After having pinged for keepalive check, the client/server waits for a duration of keepaliveTimeout and if no activity is seen even after that the connection is closed. (default 10s)
    —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, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] (default )</td></tr><tr><td><code>--log_output_level &lt;string&gt;</code></td><td></td><td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td></tr><tr><td><code>--log_rotate &lt;string&gt;</code></td><td></td><td>The path for the optional rotating log file (default)
    —log_rotate_max_age <int>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default 30)
    —log_rotate_max_backups <int>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default 1000)
    —log_rotate_max_size <int>The maximum size in megabytes of a log file beyond which the file is rotated (default 104857600)
    —log_stacktrace_level <string>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,… where scope can be one of [ads, all, authn, caSecretController, configMapController, default, k8sController, mcp, model, pkiCaLog, rbac, rootCertRotator, validation] and level can be one of [debug, info, warn, error, fatal, none] (default default:none)
    —log_target <stringArray>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default [stdout])
    —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-discovery command.

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

    Exported metrics

    Metric NameTypeDescription
    citadel_secret_controller_csr_err_countSumThe number of errors occurred when creating the CSR.
    citadel_secret_controller_csr_sign_err_countSumThe number of errors occurred when signing the CSR.
    citadel_secret_controller_secret_deleted_cert_countSumThe number of certificates recreated due to secret deletion (service account still exists).
    citadel_secret_controller_svc_acc_created_cert_countSumThe number of certificates created due to service account creation.
    citadel_secret_controller_svc_acc_deleted_cert_countSumThe number of certificates deleted due to service account deletion.
    endpoint_no_podLastValueEndpoints without an associated pod.
    istio_buildLastValueIstio component build info
    istio_mcp_clients_totalLastValueThe number of streams currently connected.
    istio_mcp_message_sizes_bytesDistributionSize of messages received from clients.
    istio_mcp_reconnectionsSumThe number of times the sink has reconnected.
    istio_mcp_recv_failures_totalSumThe number of recv failures in the source.
    istio_mcp_request_acks_totalSumThe number of request acks received by the source.
    istio_mcp_request_nacks_totalSumThe number of request nacks received by the source.
    istio_mcp_send_failures_totalSumThe number of send failures in the source.
    pilot_conflict_inbound_listenerLastValueNumber of conflicting inbound listeners.
    pilot_conflict_outbound_listener_http_over_current_tcpLastValueNumber of conflicting wildcard http listeners with current wildcard tcp listener.
    pilot_conflict_outbound_listener_http_over_httpsLastValueNumber of conflicting HTTP listeners with well known HTTPS ports
    pilot_conflict_outbound_listener_tcp_over_current_httpLastValueNumber of conflicting wildcard tcp listeners with current wildcard http listener.
    pilot_conflict_outbound_listener_tcp_over_current_tcpLastValueNumber of conflicting tcp listeners with current tcp listener.
    pilot_destrule_subsetsLastValueDuplicate subsets across destination rules for same host
    pilot_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_inbound_updatesSumTotal number of updates received by pilot.
    pilot_invalid_out_listenersLastValueNumber of invalid outbound listeners.
    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_object_errorsLastValueErrors converting k8s CRDs
    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_rds_expired_nonceSumTotal number of RDS messages with an expired nonce.
    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 CSD configs.
    pilot_xds_eds_instancesLastValueInstances for each cluster, as of last push. Zero instances is an error.
    pilot_xds_eds_rejectLastValuePilot rejected EDS.
    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_write_timeoutSumPilot XDS response write timeouts.