mirror of https://github.com/istio/istio.io.git
418 lines
17 KiB
HTML
418 lines
17 KiB
HTML
---
|
|
title: pilot-discovery
|
|
description: Istio Pilot.
|
|
generator: pkg-collateral-docs
|
|
number_of_entries: 5
|
|
---
|
|
<p>Istio Pilot provides fleet-wide traffic management capabilities in the Istio Service Mesh.</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--ctrlz_address <string></code></td>
|
|
<td>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `127.0.0.1`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_port <uint16></code></td>
|
|
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--keepaliveInterval <duration></code></td>
|
|
<td>The time interval if no activity on the connection it pings the peer to see if the transport is alive (default `30s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--keepaliveTimeout <duration></code></td>
|
|
<td>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`)</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 <string></code></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default, mcp, model, rbac] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td>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, default, mcp, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></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 <int></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 <int></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 <string></code></td>
|
|
<td>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, default, mcp, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></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>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="pilot-discovery-discovery">pilot-discovery discovery</h2>
|
|
<p>Start Istio proxy discovery service.</p>
|
|
<pre class="language-bash"><code>pilot-discovery discovery [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--appNamespace <string></code></td>
|
|
<td><code>-a</code></td>
|
|
<td>Restrict the applications namespace the controller manages; if not set, controller watches all namespaces (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--caCertFile <string></code></td>
|
|
<td></td>
|
|
<td>The location of the certificate file for the root certificate authority (default `/etc/certs/root-cert.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--certFile <string></code></td>
|
|
<td></td>
|
|
<td>The location of the certificate file for mutual TLS (default `/etc/certs/cert-chain.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--clusterRegistriesNamespace <string></code></td>
|
|
<td></td>
|
|
<td>Namespace for ConfigMap which stores clusters configs (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--configDir <string></code></td>
|
|
<td></td>
|
|
<td>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 <duration></code></td>
|
|
<td></td>
|
|
<td>Interval (in seconds) for polling the Consul service registry (default `2s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--consulserverURL <string></code></td>
|
|
<td></td>
|
|
<td>URL for the Consul server (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_address <string></code></td>
|
|
<td></td>
|
|
<td>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `127.0.0.1`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_port <uint16></code></td>
|
|
<td></td>
|
|
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--disable-install-crds</code></td>
|
|
<td></td>
|
|
<td>Disable 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. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--discoveryCache</code></td>
|
|
<td></td>
|
|
<td>Enable caching discovery service responses </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--domain <string></code></td>
|
|
<td></td>
|
|
<td>DNS domain suffix (default `cluster.local`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--grpcAddr <string></code></td>
|
|
<td></td>
|
|
<td>Discovery service grpc address (default `:15010`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--httpAddr <string></code></td>
|
|
<td></td>
|
|
<td>Discovery service HTTP address (default `:8080`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--keepaliveInterval <duration></code></td>
|
|
<td></td>
|
|
<td>The time interval if no activity on the connection it pings the peer to see if the transport is alive (default `30s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--keepaliveTimeout <duration></code></td>
|
|
<td></td>
|
|
<td>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`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--keyFile <string></code></td>
|
|
<td></td>
|
|
<td>The location of the key file for mutual TLS (default `/etc/certs/key.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--kubeconfig <string></code></td>
|
|
<td></td>
|
|
<td>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 <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default, mcp, model, rbac] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>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, default, mcp, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></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 <int></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 <int></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 <string></code></td>
|
|
<td></td>
|
|
<td>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, default, mcp, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></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>--mcpMaxMsgSize <int></code></td>
|
|
<td></td>
|
|
<td>Max message size received by MCP's grpc client (default `4194304`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--meshConfig <string></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 <string></code></td>
|
|
<td></td>
|
|
<td>HTTP address to use for the exposing pilot self-monitoring information (default `:9093`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--namespace <string></code></td>
|
|
<td><code>-n</code></td>
|
|
<td>Select a namespace where the controller resides. If not set, uses ${POD_NAMESPACE} environment variable (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--networksConfig <string></code></td>
|
|
<td></td>
|
|
<td>File name for Istio mesh networks configuration. If not specified, a default mesh networks will be used. (default `/etc/istio/config/meshNetworks`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--plugins <stringSlice></code></td>
|
|
<td></td>
|
|
<td>comma separated list of networking plugins to enable (default `[authn,authz,health,mixer]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--profile</code></td>
|
|
<td></td>
|
|
<td>Enable profiling via web interface host:port/debug/pprof </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--registries <stringSlice></code></td>
|
|
<td></td>
|
|
<td>Comma separated list of platform service registries to read from (choose one or more from {Kubernetes, Consul, Mock}) (default `[Kubernetes]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--resync <duration></code></td>
|
|
<td></td>
|
|
<td>Controller resync interval (default `1m0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--secureGrpcAddr <string></code></td>
|
|
<td></td>
|
|
<td>Discovery service grpc address, with https (default `:15012`)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="pilot-discovery-request">pilot-discovery request</h2>
|
|
<p>Makes an HTTP request to Pilot metrics/debug endpoint</p>
|
|
<pre class="language-bash"><code>pilot-discovery request <method> <path> [<body>] [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--ctrlz_address <string></code></td>
|
|
<td>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `127.0.0.1`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_port <uint16></code></td>
|
|
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--keepaliveInterval <duration></code></td>
|
|
<td>The time interval if no activity on the connection it pings the peer to see if the transport is alive (default `30s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--keepaliveTimeout <duration></code></td>
|
|
<td>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`)</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 <string></code></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default, mcp, model, rbac] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td>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, default, mcp, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></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 <int></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 <int></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 <string></code></td>
|
|
<td>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, default, mcp, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></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>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="pilot-discovery-version">pilot-discovery version</h2>
|
|
<p>Prints out build version information</p>
|
|
<pre class="language-bash"><code>pilot-discovery version [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--ctrlz_address <string></code></td>
|
|
<td></td>
|
|
<td>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `127.0.0.1`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_port <uint16></code></td>
|
|
<td></td>
|
|
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--keepaliveInterval <duration></code></td>
|
|
<td></td>
|
|
<td>The time interval if no activity on the connection it pings the peer to see if the transport is alive (default `30s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--keepaliveTimeout <duration></code></td>
|
|
<td></td>
|
|
<td>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`)</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 <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default, mcp, model, rbac] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>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, default, mcp, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></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 <int></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 <int></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 <string></code></td>
|
|
<td></td>
|
|
<td>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, default, mcp, model, rbac] and level can be one of [debug, info, warn, error, fatal, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></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>--output <string></code></td>
|
|
<td><code>-o</code></td>
|
|
<td>One of 'yaml' or 'json'. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Displays a short form of the version information </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|