mirror of https://github.com/istio/istio.io.git
303 lines
11 KiB
HTML
303 lines
11 KiB
HTML
---
|
|
title: pilot-agent
|
|
description: Istio Pilot agent
|
|
generator: pkg-collateral-docs
|
|
number_of_entries: 5
|
|
---
|
|
<p>Istio Pilot agent runs in the side car or gateway container and bootstraps envoy.</p>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<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 called information, scopes can be any of [default] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td>The minimum logging level of messages to output, can be one of [debug, info, warn, error, 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>The minimum logging level at which stack traces are captured, can be one of [debug, info, warn, error, 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-agent debug">pilot-agent debug</h2>
|
|
<p>Debug local envoy</p>
|
|
<pre class="language-bash"><code>pilot-agent debug <configuration-type> [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<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 called information, scopes can be any of [default] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td>The minimum logging level of messages to output, can be one of [debug, info, warn, error, 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>The minimum logging level at which stack traces are captured, can be one of [debug, info, warn, error, 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-agent proxy">pilot-agent proxy</h2>
|
|
<p>Envoy proxy agent</p>
|
|
<pre class="language-bash"><code>pilot-agent proxy [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--availabilityZone <string></code></td>
|
|
<td>Availability zone (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--binaryPath <string></code></td>
|
|
<td>Path to the proxy binary (default `/usr/local/bin/envoy`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--bootstrapv2</code></td>
|
|
<td>Use bootstrap v2 </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--concurrency <int></code></td>
|
|
<td>number of worker threads to run (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--configPath <string></code></td>
|
|
<td>Path to the generated configuration file directory (default `/etc/istio/proxy`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--connectTimeout <duration></code></td>
|
|
<td>Connection timeout used by Envoy for supporting services (default `1s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--controlPlaneAuthPolicy <string></code></td>
|
|
<td>Control Plane Authentication Policy (default `NONE`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--customConfigFile <string></code></td>
|
|
<td>Path to the custom configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--disableInternalTelemetry</code></td>
|
|
<td>Disable internal telemetry </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--discoveryAddress <string></code></td>
|
|
<td>Address of the discovery service exposing xDS (e.g. istio-pilot:8080) (default `istio-pilot:15007`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--discoveryRefreshDelay <duration></code></td>
|
|
<td>Polling interval for service discovery (used by EDS, CDS, LDS, but not RDS) (default `1s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--domain <string></code></td>
|
|
<td>DNS domain suffix. If not provided uses ${POD_NAMESPACE}.svc.cluster.local (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--drainDuration <duration></code></td>
|
|
<td>The time in seconds that Envoy will drain connections during a hot restart (default `2s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--id <string></code></td>
|
|
<td>Proxy unique ID. If not provided uses ${POD_NAME}.${POD_NAMESPACE} from environment variables (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ip <string></code></td>
|
|
<td>Proxy IP address. If not provided uses ${INSTANCE_IP} environment variable. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_as_json</code></td>
|
|
<td>Whether to format output as JSON or in plain console-friendly format </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_caller <string></code></td>
|
|
<td>Comma-separated list of scopes for which to include called information, scopes can be any of [default] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td>The minimum logging level of messages to output, can be one of [debug, info, warn, error, 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>The minimum logging level at which stack traces are captured, can be one of [debug, info, warn, error, 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>
|
|
<tr>
|
|
<td><code>--parentShutdownDuration <duration></code></td>
|
|
<td>The time in seconds that Envoy will wait before shutting down the parent process during a hot restart (default `3s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxyAdminPort <int></code></td>
|
|
<td>Port on which Envoy should listen for administrative commands (default `15000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxyLogLevel <string></code></td>
|
|
<td>The log level used to start the Envoy proxy (choose from {trace, debug, info, warn, err, critical, off}) (default `warn`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--serviceCluster <string></code></td>
|
|
<td>Service cluster (default `istio-proxy`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--serviceregistry <string></code></td>
|
|
<td>Select the platform for service registry, options are {Kubernetes, Consul, Eureka, CloudFoundry, Mock} (default `Kubernetes`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--statsdUdpAddress <string></code></td>
|
|
<td>IP Address and Port of a statsd UDP listener (e.g. 10.75.241.127:9125) (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--templateFile <string></code></td>
|
|
<td>Go template bootstrap config (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--zipkinAddress <string></code></td>
|
|
<td>Address of the Zipkin service (e.g. zipkin:9411) (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="pilot-agent version">pilot-agent version</h2>
|
|
<p>Prints out build version information</p>
|
|
<pre class="language-bash"><code>pilot-agent version [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<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 called information, scopes can be any of [default] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>The minimum logging level of messages to output, can be one of [debug, info, warn, error, 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>The minimum logging level at which stack traces are captured, can be one of [debug, info, warn, error, 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>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Displays a short form of the version information </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|