mirror of https://github.com/istio/istio.io.git
362 lines
15 KiB
HTML
362 lines
15 KiB
HTML
---
|
|
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE https://github.com/istio/istio REPO
|
|
source_repo: https://github.com/istio/istio
|
|
title: pilot-agent
|
|
description: Istio Pilot agent.
|
|
generator: pkg-collateral-docs
|
|
number_of_entries: 5
|
|
---
|
|
<p>Istio Pilot agent runs in the sidecar 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 caller information, scopes can be any of [default, 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 [default, 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 [default, 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-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>--applicationPorts <stringSlice></code></td>
|
|
<td>Ports exposed by the application. Used to determine that Envoy is configured and ready to receive traffic. (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>--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>--controlPlaneBootstrap</code></td>
|
|
<td>Process bootstrap provided via templateFile to be used by control plane components. </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--customConfigFile <string></code></td>
|
|
<td>Path to the custom configuration file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--datadogAgentAddress <string></code></td>
|
|
<td>Address of the Datadog Agent (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:15010`)</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 `45s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--envoyMetricsServiceAddress <string></code></td>
|
|
<td>Host and Port of an Envoy Metrics Service API implementation (e.g. metrics-service:15000) (default ``)</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>--lightstepAccessToken <string></code></td>
|
|
<td>Access Token for LightStep Satellite pool (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--lightstepAddress <string></code></td>
|
|
<td>Address of the LightStep Satellite pool (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--lightstepCacertPath <string></code></td>
|
|
<td>Path to the trusted cacert used to authenticate the pool (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--lightstepSecure</code></td>
|
|
<td>Should connection to the LightStep Satellite pool be secure </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 [default, 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 [default, 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 [default, 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>
|
|
<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 `1m0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--proxyAdminPort <uint16></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, warning, error, critical, off}) (default `warning`)</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, 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>--statusPort <uint16></code></td>
|
|
<td>HTTP Port on which to serve pilot agent status. If zero, agent status will not be provided. (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--templateFile <string></code></td>
|
|
<td>Go template bootstrap config (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsClientCertChain <string></code></td>
|
|
<td>Absolute path to client cert-chain file used for istio mTLS (default `/etc/certs/cert-chain.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsClientRootCert <string></code></td>
|
|
<td>Absolute path to client root cert file used for istio mTLS (default `/etc/certs/root-cert.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsSClientKey <string></code></td>
|
|
<td>Absolute path to client key file used for istio mTLS (default `/etc/certs/key.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsServerCertChain <string></code></td>
|
|
<td>Absolute path to server cert-chain file used for istio mTLS (default `/etc/certs/cert-chain.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsServerKey <string></code></td>
|
|
<td>Absolute path to server private key file used for istio mTLS (default `/etc/certs/key.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsServerRootCert <string></code></td>
|
|
<td>Absolute path to server root cert file used for istio mTLS (default `/etc/certs/root-cert.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--trust-domain <string></code></td>
|
|
<td>The domain to use for identities (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-request">pilot-agent request</h2>
|
|
<p>Makes an HTTP request to the Envoy admin API</p>
|
|
<pre class="language-bash"><code>pilot-agent request <method> <path> [<body>] [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 caller information, scopes can be any of [default, 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 [default, 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 [default, 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-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 caller information, scopes can be any of [default, 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 [default, 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 [default, 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>
|