mirror of https://github.com/istio/istio.io.git
345 lines
11 KiB
HTML
345 lines
11 KiB
HTML
---
|
|
title: sidecar-injector
|
|
overview: Kubernetes webhook for automatic Istio sidecar injection
|
|
layout: pkg-collateral-docs
|
|
number_of_entries: 4
|
|
---
|
|
<p>Kubernetes webhook for automatic Istio sidecar injection</p>
|
|
<pre class="language-bash"><code>sidecar-injector [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--healthCheckFile <string></code></td>
|
|
<td></td>
|
|
<td>File that should be periodically updated if health checking is enabled (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--healthCheckInterval <duration></code></td>
|
|
<td></td>
|
|
<td>Configure how frequently the health check file specified by --healhCheckFile should be updated (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfig <string></code></td>
|
|
<td></td>
|
|
<td>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)</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_backtrace_at <traceLocation></code></td>
|
|
<td></td>
|
|
<td>when logging hits line file:N, emit a stack trace (default `:0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_callers</code></td>
|
|
<td></td>
|
|
<td>Include caller information, useful for debugging </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", or "none" (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", or "none" (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>--meshConfig <string></code></td>
|
|
<td></td>
|
|
<td>File containing the Istio mesh configuration (default `/etc/istio/config/mesh`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Webhook port (default `443`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsCertFile <string></code></td>
|
|
<td></td>
|
|
<td>File containing the x509 Certificate for HTTPS. (default `/etc/istio/certs/cert.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsKeyFile <string></code></td>
|
|
<td></td>
|
|
<td>File containing the x509 private key matching --tlsCertFile. (default `/etc/istio/certs/key.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--v <Level></code></td>
|
|
<td><code>-v</code></td>
|
|
<td>log level for V logs (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vmodule <moduleSpec></code></td>
|
|
<td></td>
|
|
<td>comma-separated list of pattern=N settings for file-filtered logging (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="sidecar-injector probe">sidecar-injector probe</h2>
|
|
<p>Check the liveness or readiness of a locally-running server</p>
|
|
<pre class="language-bash"><code>sidecar-injector probe [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--healthCheckFile <string></code></td>
|
|
<td></td>
|
|
<td>File that should be periodically updated if health checking is enabled (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--healthCheckInterval <duration></code></td>
|
|
<td></td>
|
|
<td>Configure how frequently the health check file specified by --healhCheckFile should be updated (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfig <string></code></td>
|
|
<td></td>
|
|
<td>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--interval <duration></code></td>
|
|
<td></td>
|
|
<td>Duration used for checking the target file's last modified time. (default `0s`)</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_backtrace_at <traceLocation></code></td>
|
|
<td></td>
|
|
<td>when logging hits line file:N, emit a stack trace (default `:0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_callers</code></td>
|
|
<td></td>
|
|
<td>Include caller information, useful for debugging </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", or "none" (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", or "none" (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>--meshConfig <string></code></td>
|
|
<td></td>
|
|
<td>File containing the Istio mesh configuration (default `/etc/istio/config/mesh`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Webhook port (default `443`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--probe-path <string></code></td>
|
|
<td></td>
|
|
<td>Path of the file for checking the availability. (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsCertFile <string></code></td>
|
|
<td></td>
|
|
<td>File containing the x509 Certificate for HTTPS. (default `/etc/istio/certs/cert.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsKeyFile <string></code></td>
|
|
<td></td>
|
|
<td>File containing the x509 private key matching --tlsCertFile. (default `/etc/istio/certs/key.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--v <Level></code></td>
|
|
<td><code>-v</code></td>
|
|
<td>log level for V logs (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vmodule <moduleSpec></code></td>
|
|
<td></td>
|
|
<td>comma-separated list of pattern=N settings for file-filtered logging (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="sidecar-injector version">sidecar-injector version</h2>
|
|
<p>Prints out build version information</p>
|
|
<pre class="language-bash"><code>sidecar-injector version [flags]
|
|
</code></pre>
|
|
<table class="command-flags">
|
|
<thead>
|
|
<th>Flags</th>
|
|
<th>Shorthand</th>
|
|
<th>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--healthCheckFile <string></code></td>
|
|
<td></td>
|
|
<td>File that should be periodically updated if health checking is enabled (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--healthCheckInterval <duration></code></td>
|
|
<td></td>
|
|
<td>Configure how frequently the health check file specified by --healhCheckFile should be updated (default `0s`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--injectConfig <string></code></td>
|
|
<td></td>
|
|
<td>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)</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_backtrace_at <traceLocation></code></td>
|
|
<td></td>
|
|
<td>when logging hits line file:N, emit a stack trace (default `:0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_callers</code></td>
|
|
<td></td>
|
|
<td>Include caller information, useful for debugging </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", or "none" (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", or "none" (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>--meshConfig <string></code></td>
|
|
<td></td>
|
|
<td>File containing the Istio mesh configuration (default `/etc/istio/config/mesh`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--port <int></code></td>
|
|
<td></td>
|
|
<td>Webhook port (default `443`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Displays a short form of the version information </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsCertFile <string></code></td>
|
|
<td></td>
|
|
<td>File containing the x509 Certificate for HTTPS. (default `/etc/istio/certs/cert.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--tlsKeyFile <string></code></td>
|
|
<td></td>
|
|
<td>File containing the x509 private key matching --tlsCertFile. (default `/etc/istio/certs/key.pem`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--v <Level></code></td>
|
|
<td><code>-v</code></td>
|
|
<td>log level for V logs (default `0`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--vmodule <moduleSpec></code></td>
|
|
<td></td>
|
|
<td>comma-separated list of pattern=N settings for file-filtered logging (default ``)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|