mirror of https://github.com/istio/istio.io.git
Regenerate docs with latest tooling. (#926)
This commit is contained in:
Martin Taillefer
GitHub
parent
e3573dd142
commit
e795a779c4
|
|
@ -97,7 +97,7 @@ To start the application, follow the instructions below corresponding to your Is
|
|||
```
|
||||
|
||||
The `istioctl kube-inject` command is used to manually modify the `bookinfo.yaml`
|
||||
file before creating the deployments as documented [here]({{home}}/docs/reference/commands/istioctl.html#istioctl-kube-inject).
|
||||
file before creating the deployments as documented [here]({{home}}/docs/reference/commands/istioctl.html#istioctl kube-inject).
|
||||
|
||||
Either of the above commands launches all four microservices and creates the gateway
|
||||
ingress resource as illustrated in the above diagram.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ redirect_from: /docs/reference/api/mixer/mixer.html
|
|||
<section>
|
||||
<p>How an attribute’s value was matched</p>
|
||||
|
||||
<table>
|
||||
<table class="enum-values">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
|
|
@ -84,7 +84,7 @@ Following places may use this message:
|
|||
2) Service IDL definition to extract api attributes for active requests.
|
||||
3) Forward attributes from client proxy to server proxy for HTTP requests.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -104,7 +104,7 @@ Following places may use this message:
|
|||
<section>
|
||||
<p>Specifies one attribute value with different type.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -164,7 +164,7 @@ Following places may use this message:
|
|||
<section>
|
||||
<p>Defines a string map.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -182,7 +182,7 @@ Following places may use this message:
|
|||
<section>
|
||||
<p>Used to get a thumbs-up/thumbs-down before performing an action.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -232,7 +232,7 @@ per call, where the same UUID is used for retries of the same call.</p>
|
|||
<section>
|
||||
<p>parameters for a quota allocation</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -258,7 +258,7 @@ per call, where the same UUID is used for retries of the same call.</p>
|
|||
</section>
|
||||
<h3 id="CheckResponse">CheckResponse</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -284,7 +284,7 @@ per call, where the same UUID is used for retries of the same call.</p>
|
|||
</section>
|
||||
<h3 id="CheckResponse.PreconditionResult">CheckResponse.PreconditionResult</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -341,7 +341,7 @@ along with matching conditions.</p>
|
|||
</section>
|
||||
<h3 id="CheckResponse.QuotaResult">CheckResponse.QuotaResult</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -385,7 +385,7 @@ dictionary instead. The message-level dictionary is carried by the
|
|||
<code>words</code> field of this message, the deployment-wide dictionary is determined via
|
||||
configuration.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -459,7 +459,7 @@ the message-level dictionary.</p>
|
|||
<p>Describes the attributes that were used to determine the response.
|
||||
This can be used to construct a response cache.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -486,7 +486,7 @@ on using dictionaries.</p>
|
|||
</section>
|
||||
<h3 id="ReferencedAttributes.AttributeMatch">ReferencedAttributes.AttributeMatch</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -541,7 +541,7 @@ entire STRING_MAP will be used.</p>
|
|||
<section>
|
||||
<p>Used to report telemetry after performing one or more actions.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -602,7 +602,7 @@ To detect global dictionary out of sync between client and server.</p>
|
|||
<p>A map of string to string. The keys and values in this map are dictionary
|
||||
indices (see the <a href="#Attributes">Attributes</a> message for an explanation)</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -675,7 +675,7 @@ represented directly using the <code>Status</code> message.</p></li>
|
|||
be used directly after any stripping needed for security/privacy reasons.</p></li>
|
||||
</ul>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,265 @@
|
|||
---
|
||||
title: istio_ca
|
||||
overview: Istio Certificate Authority (CA)
|
||||
layout: pkg-collateral-docs
|
||||
---
|
||||
<p>Istio Certificate Authority (CA)</p>
|
||||
<pre class="language-bash"><code>istio_ca [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--ca-cert-ttl <duration></code></td>
|
||||
<td></td>
|
||||
<td>The TTL of self-signed CA root certificate (default `8760h0m0s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--cert-chain <string></code></td>
|
||||
<td></td>
|
||||
<td>Speicifies path to the certificate chain file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--grpc-hostname <string></code></td>
|
||||
<td></td>
|
||||
<td>Specifies the hostname for GRPC server. (default `localhost`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--grpc-port <int></code></td>
|
||||
<td></td>
|
||||
<td>Specifies the port number for GRPC server. If unspecified, Istio CA will not server GRPC request. (default `0`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istio-ca-storage-namespace <string></code></td>
|
||||
<td></td>
|
||||
<td>Namespace where the Istio CA pods is running. Will not be used if explicit file or other storage mechanism is specified. (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kube-config <string></code></td>
|
||||
<td></td>
|
||||
<td>Specifies path to kubeconfig file. This must be specified when not running inside a Kubernetes pod. (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_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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (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", 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>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--max-workload-cert-ttl <duration></code></td>
|
||||
<td></td>
|
||||
<td>The max TTL of issued workload certificates (default `168h0m0s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td></td>
|
||||
<td>Select a namespace for the CA to listen to. If unspecified, Istio CA tries to use the ${NAMESPACE} environment variable. If neither is set, Istio CA listens to all namespaces. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--root-cert <string></code></td>
|
||||
<td></td>
|
||||
<td>Specifies path to the root certificate file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--self-signed-ca</code></td>
|
||||
<td></td>
|
||||
<td>Indicates whether to use auto-generated self-signed CA certificate. When set to true, the '--signing-cert' and '--signing-key' options are ignored. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--self-signed-ca-org <string></code></td>
|
||||
<td></td>
|
||||
<td>The issuer organization used in self-signed CA certificate (default to k8s.cluster.local) (default `k8s.cluster.local`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--signing-cert <string></code></td>
|
||||
<td></td>
|
||||
<td>Specifies path to the CA signing certificate file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--signing-key <string></code></td>
|
||||
<td></td>
|
||||
<td>Specifies path to the CA signing key file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</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>
|
||||
<tr>
|
||||
<td><code>--workload-cert-ttl <duration></code></td>
|
||||
<td></td>
|
||||
<td>The TTL of issued workload certificates (default `1h0m0s`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istio_ca version">istio_ca version</h2>
|
||||
<p>Prints out build version information</p>
|
||||
<pre class="language-bash"><code>istio_ca version [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (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", 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>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </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>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</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>
|
||||
|
|
@ -1,73 +0,0 @@
|
|||
---
|
||||
title: istio_ca
|
||||
overview: Istio Certificate Authority (CA)
|
||||
layout: docs
|
||||
---
|
||||
Istio Certificate Authority (CA)
|
||||
```bash
|
||||
istio_ca [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--ca-cert-ttl <duration>`||The TTL of self-signed CA root certificate (default `8760h0m0s`)
|
||||
|`--cert-chain <string>`||Speicifies path to the certificate chain file (default `""`)
|
||||
|`--grpc-hostname <string>`||Specifies the hostname for GRPC server. (default `"localhost"`)
|
||||
|`--grpc-port <int>`||Specifies the port number for GRPC server. If unspecified, Istio CA will not server GRPC request. (default `0`)
|
||||
|`--istio-ca-storage-namespace <string>`||Namespace where the Istio CA pods is running. Will not be used if explicit file or other storage mechanism is specified. (default `"istio-system"`)
|
||||
|`--kube-config <string>`||Specifies path to kubeconfig file. This must be specified when not running inside a Kubernetes pod. (default `""`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--max-workload-cert-ttl <duration>`||The max TTL of issued workload certificates (default `168h0m0s`)
|
||||
|`--namespace <string>`||Select a namespace for the CA to listen to. If unspecified, Istio CA tries to use the ${NAMESPACE} environment variable. If neither is set, Istio CA listens to all namespaces. (default `""`)
|
||||
|`--root-cert <string>`||Specifies path to the root certificate file (default `""`)
|
||||
|`--self-signed-ca-org <string>`||The issuer organization used in self-signed CA certificate (default to k8s.cluster.local) (default `"k8s.cluster.local"`)
|
||||
|`--self-signed-ca`||Indicates whether to use auto-generated self-signed CA certificate. When set to true, the '--signing-cert' and '--signing-key' options are ignored.
|
||||
|`--signing-cert <string>`||Specifies path to the CA signing certificate file (default `""`)
|
||||
|`--signing-key <string>`||Specifies path to the CA signing key file (default `""`)
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|`--workload-cert-ttl <duration>`||The TTL of issued workload certificates (default `1h0m0s`)
|
||||
|
||||
|
||||
## istio_ca version
|
||||
|
||||
Prints out build version information
|
||||
```bash
|
||||
istio_ca version [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--short`|`-s`|Displays a short form of the version information
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,442 +0,0 @@
|
|||
---
|
||||
title: istioctl
|
||||
overview: Istio control interface
|
||||
layout: docs
|
||||
---
|
||||
|
||||
Istio configuration command line utility.
|
||||
|
||||
Create, list, modify, and delete configuration resources in the Istio
|
||||
system.
|
||||
|
||||
Available routing and traffic management configuration types:
|
||||
|
||||
[routerule ingressrule egressrule destinationpolicy]
|
||||
|
||||
See https://istio.io/docs/reference/ for an overview of routing rules
|
||||
and destination policies.
|
||||
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## istioctl context-create
|
||||
|
||||
Create a kubeconfig file suitable for use with istioctl in a non kubernetes environment
|
||||
```bash
|
||||
istioctl context-create --api-server http://<ip>:<port> [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--api-server <string>`||URL for Istio api server (default `""`)
|
||||
|`--context <string>`||Kubernetes configuration file context name (default `"istio"`)
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Create a config file for the api server.
|
||||
istioctl context-create --api-server http://127.0.0.1:8080
|
||||
|
||||
```
|
||||
|
||||
|
||||
## istioctl create
|
||||
|
||||
Create policies and rules
|
||||
```bash
|
||||
istioctl create [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--file <string>`|`-f`|Input file with the content of the configuration objects (if not set, command reads from the standard input) (default `""`)
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
istioctl create -f example-routing.yaml
|
||||
```
|
||||
|
||||
|
||||
## istioctl delete
|
||||
|
||||
Delete policies or rules
|
||||
```bash
|
||||
istioctl delete <type> <name> [<name2> ... <nameN>] [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--file <string>`|`-f`|Input file with the content of the configuration objects (if not set, command reads from the standard input) (default `""`)
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# Delete a rule using the definition in example-routing.yaml.
|
||||
istioctl delete -f example-routing.yaml
|
||||
|
||||
# Delete the rule productpage-default
|
||||
istioctl delete routerule productpage-default
|
||||
|
||||
```
|
||||
|
||||
|
||||
## istioctl deregister
|
||||
|
||||
De-registers a service instance
|
||||
```bash
|
||||
istioctl deregister <svcname> <ip> [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## istioctl gen-deploy
|
||||
|
||||
istioctl gen-deploy produces deployment files to run the minimum Istio control for the set of features requested by the --feature flag. If no features are provided, we create deployments for the default control plane: Pilot, Mixer, CA, and Ingress Proxies, with mTLS enabled.
|
||||
```bash
|
||||
istioctl gen-deploy [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--debug`||If true, uses debug images instead of release images
|
||||
|`--features <stringArray>`|`-f`|List of Istio features to enable. Accepts any combination of "mtls", "telemetry", "routing", "ingress", "policy", "sidecar-injector". (default `[]`)
|
||||
|`--helm-chart-dir <string>`||The directory to find the helm charts used to render Istio deployments. -o yaml uses these to render the helm chart locally. (default `"."`)
|
||||
|`--hyperkube-hub <string>`||The container registry to pull Hyperkube images from (default `"quay.io/coreos/hyperkube"`)
|
||||
|`--hyperkube-tag <Hyperkube>`||The tag to use to pull the Hyperkube container (default `"0.4.0"`)
|
||||
|`--ingress-node-port <uint16>`||If provided, Istio ingress proxies will run as a NodePort service mapped to the port provided by this flag. Note that this flag is ignored unless the "ingress" feature flag is provided too. (default `0`)
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--out <string>`|`-o`|Output format. Acceptable values are'helm' to produce contents of values.yaml or 'helm' to produces Kubernetes deployments (default `"helm"`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--values <string>`||Path to the Helm values.yaml file used to render YAML deployments locally when --out=yaml. Flag values are ignored in favor of using the file directly. (default `""`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
istioctl gen-deploy --features routing,policy,sidecar-injector -o helm
|
||||
```
|
||||
|
||||
|
||||
## istioctl get
|
||||
|
||||
Retrieve policies and rules
|
||||
```bash
|
||||
istioctl get <type> [<name>] [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--output <string>`|`-o`|Output format. One of:yaml|short (default `"short"`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# List all route rules
|
||||
istioctl get routerules
|
||||
|
||||
# List all destination policies
|
||||
istioctl get destinationpolicies
|
||||
|
||||
# Get a specific rule named productpage-default
|
||||
istioctl get routerule productpage-default
|
||||
|
||||
```
|
||||
|
||||
|
||||
## istioctl kube-inject
|
||||
|
||||
|
||||
|
||||
kube-inject manually injects envoy sidecar into kubernetes
|
||||
workloads. Unsupported resources are left unmodified so it is safe to
|
||||
run kube-inject over a single file that contains multiple Service,
|
||||
ConfigMap, Deployment, etc. definitions for a complex application. Its
|
||||
best to do this when the resource is initially created.
|
||||
|
||||
k8s.io/docs/concepts/workloads/pods/pod-overview/#pod-templates is
|
||||
updated for Job, DaemonSet, ReplicaSet, and Deployment YAML resource
|
||||
documents. Support for additional pod-based resource types can be
|
||||
added as necessary.
|
||||
|
||||
The Istio project is continually evolving so the Istio sidecar
|
||||
configuration may change unannounced. When in doubt re-run istioctl
|
||||
kube-inject on deployments to get the most up-to-date changes.
|
||||
|
||||
```bash
|
||||
istioctl kube-inject [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--coreDump`||Enable/Disable core dumps in injected Envoy sidecar (--coreDump=true affects all pods in a node and should only be used the cluster admin)
|
||||
|`--debug`||Use debug images and settings for the sidecar
|
||||
|`--emitTemplate`||Emit sidecar template based on parameterized flags
|
||||
|`--filename <string>`|`-f`|Input Kubernetes resource filename (default `""`)
|
||||
|`--hub <string>`||Docker hub (default `"unknown"`)
|
||||
|`--imagePullPolicy <string>`||Sets the container image pull policy. Valid options are Always,IfNotPresent,Never.The default policy is IfNotPresent. (default `"IfNotPresent"`)
|
||||
|`--includeIPRanges <string>`||Comma separated list of IP ranges in CIDR form. If set, only redirect outbound traffic to Envoy for IP ranges. Otherwise all outbound traffic is redirected (default `""`)
|
||||
|`--injectConfigFile <string>`||injection configuration filename (default `""`)
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--meshConfigFile <string>`||mesh configuration filename. Takes precedence over --meshConfigMapName if set (default `""`)
|
||||
|`--meshConfigMapName <string>`||ConfigMap name for Istio mesh configuration, key should be "mesh" (default `"istio"`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--output <string>`|`-o`|Modified output Kubernetes resource filename (default `""`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--setVersionString <string>`||Override version info injected into resource (default `""`)
|
||||
|`--sidecarProxyUID <uint>`||Envoy sidecar UID (default `1337`)
|
||||
|`--tag <string>`||Docker tag (default `"unknown"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--verbosity <int>`||Runtime verbosity (default `2`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
|
||||
# Update resources on the fly before applying.
|
||||
kubectl apply -f <(istioctl kube-inject -f <resource.yaml>)
|
||||
|
||||
# Create a persistent version of the deployment with Envoy sidecar
|
||||
# injected.
|
||||
istioctl kube-inject -f deployment.yaml -o deployment-injected.yaml
|
||||
|
||||
# Update an existing deployment.
|
||||
kubectl get deployment -o yaml | istioctl kube-inject -f - | kubectl apply -f -
|
||||
|
||||
```
|
||||
|
||||
|
||||
## istioctl register
|
||||
|
||||
Registers a service instance (e.g. VM) joining the mesh
|
||||
```bash
|
||||
istioctl register <svcname> <ip> [name1:]port1 [name2:]port2 ... [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--annotations <stringSlice>`|`-a`|List of string annotations to apply if creating a service/endpoint; e.g. -a foo=bar,test,x=y (default `[]`)
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--labels <stringSlice>`|`-l`|List of labels to apply if creating a service/endpoint; e.g. -l env=prod,vers=2 (default `[]`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--serviceaccount <string>`|`-s`|Service account to link to the service (default `"default"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## istioctl replace
|
||||
|
||||
Replace existing policies and rules
|
||||
```bash
|
||||
istioctl replace [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--file <string>`|`-f`|Input file with the content of the configuration objects (if not set, command reads from the standard input) (default `""`)
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
istioctl replace -f example-routing.yaml
|
||||
```
|
||||
|
||||
|
||||
## istioctl version
|
||||
|
||||
Prints out build version information
|
||||
```bash
|
||||
istioctl version [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--istioNamespace <string>`|`-i`|Istio system namespace (default `"istio-system"`)
|
||||
|`--kubeconfig <string>`|`-c`|Kubernetes configuration file (default `"/Users/mtail/.kube/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--namespace <string>`|`-n`|Config namespace (default `""`)
|
||||
|`--platform <string>`|`-p`|Istio host platform (default `"kube"`)
|
||||
|`--short`|`-s`|Displays a short form of the version information
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
|
@ -0,0 +1,242 @@
|
|||
---
|
||||
title: mixc
|
||||
overview: Utility to trigger direct calls to Mixer's API.
|
||||
layout: pkg-collateral-docs
|
||||
---
|
||||
<p>This command lets you interact with a running instance of
|
||||
Mixer. Note that you need a pretty good understanding of Mixer's
|
||||
API in order to use this command.</p>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--trace_jaeger_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_log_spans</code></td>
|
||||
<td></td>
|
||||
<td>Whether or not to log trace spans. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_zipkin_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="mixc check">mixc check</h2>
|
||||
<p>The Check method is used to perform precondition checks and quota allocations. Mixer
|
||||
expects a set of attributes as input, which it uses, along with
|
||||
its configuration, to determine which adapters to invoke and with
|
||||
which parameters in order to perform the checks and allocations.</p>
|
||||
<pre class="language-bash"><code>mixc check [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--attributes <string></code></td>
|
||||
<td><code>-a</code></td>
|
||||
<td>List of name/value auto-sensed attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--bool_attributes <string></code></td>
|
||||
<td><code>-b</code></td>
|
||||
<td>List of name/value bool attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--bytes_attributes <string></code></td>
|
||||
<td></td>
|
||||
<td>List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--double_attributes <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>List of name/value float64 attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--duration_attributes <string></code></td>
|
||||
<td></td>
|
||||
<td>List of name/value duration attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--int64_attributes <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>List of name/value int64 attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--mixer <string></code></td>
|
||||
<td><code>-m</code></td>
|
||||
<td>Address and port of a running Mixer instance (default `localhost:9091`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--quotas <string></code></td>
|
||||
<td><code>-q</code></td>
|
||||
<td>List of quotas to allocate specified as name1=amount1,name2=amount2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--repeat <int></code></td>
|
||||
<td><code>-r</code></td>
|
||||
<td>Sends the specified number of requests in quick succession (default `1`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--string_attributes <string></code></td>
|
||||
<td><code>-s</code></td>
|
||||
<td>List of name/value string attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stringmap_attributes <string></code></td>
|
||||
<td></td>
|
||||
<td>List of name/value string map attributes specified as name1=k1:v1;k2:v2,name2=k3:v3... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--timestamp_attributes <string></code></td>
|
||||
<td><code>-t</code></td>
|
||||
<td>List of name/value timestamp attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_jaeger_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_log_spans</code></td>
|
||||
<td></td>
|
||||
<td>Whether or not to log trace spans. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_zipkin_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="mixc report">mixc report</h2>
|
||||
<p>The Report method is used to produce telemetry. Mixer
|
||||
expects a set of attributes as input, which it uses, along with
|
||||
its configuration, to determine which adapters to invoke and with
|
||||
which parameters in order to output the telemetry.</p>
|
||||
<pre class="language-bash"><code>mixc report [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--attributes <string></code></td>
|
||||
<td><code>-a</code></td>
|
||||
<td>List of name/value auto-sensed attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--bool_attributes <string></code></td>
|
||||
<td><code>-b</code></td>
|
||||
<td>List of name/value bool attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--bytes_attributes <string></code></td>
|
||||
<td></td>
|
||||
<td>List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--double_attributes <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>List of name/value float64 attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--duration_attributes <string></code></td>
|
||||
<td></td>
|
||||
<td>List of name/value duration attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--int64_attributes <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>List of name/value int64 attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--mixer <string></code></td>
|
||||
<td><code>-m</code></td>
|
||||
<td>Address and port of a running Mixer instance (default `localhost:9091`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--repeat <int></code></td>
|
||||
<td><code>-r</code></td>
|
||||
<td>Sends the specified number of requests in quick succession (default `1`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--string_attributes <string></code></td>
|
||||
<td><code>-s</code></td>
|
||||
<td>List of name/value string attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stringmap_attributes <string></code></td>
|
||||
<td></td>
|
||||
<td>List of name/value string map attributes specified as name1=k1:v1;k2:v2,name2=k3:v3... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--timestamp_attributes <string></code></td>
|
||||
<td><code>-t</code></td>
|
||||
<td>List of name/value timestamp attributes specified as name1=value1,name2=value2,... (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_jaeger_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_log_spans</code></td>
|
||||
<td></td>
|
||||
<td>Whether or not to log trace spans. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_zipkin_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="mixc version">mixc version</h2>
|
||||
<p>Prints out build version information</p>
|
||||
<pre class="language-bash"><code>mixc version [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<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>--trace_jaeger_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_log_spans</code></td>
|
||||
<td></td>
|
||||
<td>Whether or not to log trace spans. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_zipkin_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1,90 +0,0 @@
|
|||
---
|
||||
title: mixc
|
||||
overview: Utility to trigger direct calls to Mixer's API.
|
||||
layout: docs
|
||||
---
|
||||
This command lets you interact with a running instance of
|
||||
Mixer. Note that you need a pretty good understanding of Mixer's
|
||||
API in order to use this command.
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--trace_jaeger_url <string>`||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`)
|
||||
|`--trace_log_spans`||Whether or not to log trace spans.
|
||||
|`--trace_zipkin_url <string>`||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`)
|
||||
|
||||
|
||||
## mixc check
|
||||
|
||||
The Check method is used to perform precondition checks and quota allocations. Mixer
|
||||
expects a set of attributes as input, which it uses, along with
|
||||
its configuration, to determine which adapters to invoke and with
|
||||
which parameters in order to perform the checks and allocations.
|
||||
```bash
|
||||
mixc check [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--attributes <string>`|`-a`|List of name/value auto-sensed attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--bool_attributes <string>`|`-b`|List of name/value bool attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--bytes_attributes <string>`||List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default `""`)
|
||||
|`--double_attributes <string>`|`-d`|List of name/value float64 attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--duration_attributes <string>`||List of name/value duration attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--int64_attributes <string>`|`-i`|List of name/value int64 attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--mixer <string>`|`-m`|Address and port of a running Mixer instance (default `"localhost:9091"`)
|
||||
|`--quotas <string>`|`-q`|List of quotas to allocate specified as name1=amount1,name2=amount2,... (default `""`)
|
||||
|`--repeat <int>`|`-r`|Sends the specified number of requests in quick succession (default `1`)
|
||||
|`--string_attributes <string>`|`-s`|List of name/value string attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--stringmap_attributes <string>`||List of name/value string map attributes specified as name1=k1:v1;k2:v2,name2=k3:v3... (default `""`)
|
||||
|`--timestamp_attributes <string>`|`-t`|List of name/value timestamp attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--trace_jaeger_url <string>`||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`)
|
||||
|`--trace_log_spans`||Whether or not to log trace spans.
|
||||
|`--trace_zipkin_url <string>`||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`)
|
||||
|
||||
|
||||
## mixc report
|
||||
|
||||
The Report method is used to produce telemetry. Mixer
|
||||
expects a set of attributes as input, which it uses, along with
|
||||
its configuration, to determine which adapters to invoke and with
|
||||
which parameters in order to output the telemetry.
|
||||
```bash
|
||||
mixc report [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--attributes <string>`|`-a`|List of name/value auto-sensed attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--bool_attributes <string>`|`-b`|List of name/value bool attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--bytes_attributes <string>`||List of name/value bytes attributes specified as name1=b0:b1:b3,name2=b4:b5:b6,... (default `""`)
|
||||
|`--double_attributes <string>`|`-d`|List of name/value float64 attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--duration_attributes <string>`||List of name/value duration attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--int64_attributes <string>`|`-i`|List of name/value int64 attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--mixer <string>`|`-m`|Address and port of a running Mixer instance (default `"localhost:9091"`)
|
||||
|`--repeat <int>`|`-r`|Sends the specified number of requests in quick succession (default `1`)
|
||||
|`--string_attributes <string>`|`-s`|List of name/value string attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--stringmap_attributes <string>`||List of name/value string map attributes specified as name1=k1:v1;k2:v2,name2=k3:v3... (default `""`)
|
||||
|`--timestamp_attributes <string>`|`-t`|List of name/value timestamp attributes specified as name1=value1,name2=value2,... (default `""`)
|
||||
|`--trace_jaeger_url <string>`||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`)
|
||||
|`--trace_log_spans`||Whether or not to log trace spans.
|
||||
|`--trace_zipkin_url <string>`||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`)
|
||||
|
||||
|
||||
## mixc version
|
||||
|
||||
Prints out build version information
|
||||
```bash
|
||||
mixc version [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--short`|`-s`|Displays a short form of the version information
|
||||
|`--trace_jaeger_url <string>`||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`)
|
||||
|`--trace_log_spans`||Whether or not to log trace spans.
|
||||
|`--trace_zipkin_url <string>`||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`)
|
||||
|
||||
|
|
@ -0,0 +1,663 @@
|
|||
---
|
||||
title: mixs
|
||||
overview: Mixer is Istio's abstraction on top of infrastructure backends.
|
||||
layout: pkg-collateral-docs
|
||||
---
|
||||
<p>Mixer is Istio's point of integration with infrastructure backends and is the
|
||||
nexus for policy evaluation and telemetry reporting.</p>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</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="mixs crd">mixs crd</h2>
|
||||
<p>CRDs (CustomResourceDefinition) available in Mixer</p>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</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="mixs crd adapter">mixs crd adapter</h2>
|
||||
<p>List CRDs for available adapters</p>
|
||||
<pre class="language-bash"><code>mixs crd adapter [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</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="mixs crd all">mixs crd all</h2>
|
||||
<p>List all CRDs</p>
|
||||
<pre class="language-bash"><code>mixs crd all [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</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="mixs crd instance">mixs crd instance</h2>
|
||||
<p>List CRDs for available instance kinds (mesh functions)</p>
|
||||
<pre class="language-bash"><code>mixs crd instance [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</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="mixs probe">mixs probe</h2>
|
||||
<p>Check the liveness or readiness of a locally-running server</p>
|
||||
<pre class="language-bash"><code>mixs probe [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (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", 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>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </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>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</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="mixs server">mixs server</h2>
|
||||
<p>Starts Mixer as a server</p>
|
||||
<pre class="language-bash"><code>mixs server [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--adapterWorkerPoolSize <int></code></td>
|
||||
<td></td>
|
||||
<td>Max number of goroutines in the adapter worker pool (default `1024`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--apiWorkerPoolSize <int></code></td>
|
||||
<td></td>
|
||||
<td>Max number of goroutines in the API worker pool (default `1024`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--configDefaultNamespace <string></code></td>
|
||||
<td></td>
|
||||
<td>Namespace used to store mesh wide configuration. (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--configStoreURL <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of the config store. Use k8s://path_to_kubeconfig or fs:// for file system. If path_to_kubeconfig is empty, in-cluster kubeconfig is used. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--expressionEvalCacheSize <int></code></td>
|
||||
<td></td>
|
||||
<td>Number of entries in the expression cache (default `1024`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--livenessProbeInterval <duration></code></td>
|
||||
<td></td>
|
||||
<td>Interval of updating file for the liveness probe. (default `0s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--livenessProbePath <string></code></td>
|
||||
<td></td>
|
||||
<td>Path to the file for the liveness probe. (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_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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (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", 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>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--maxConcurrentStreams <uint></code></td>
|
||||
<td></td>
|
||||
<td>Maximum number of outstanding RPCs per connection (default `1024`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--maxMessageSize <uint></code></td>
|
||||
<td></td>
|
||||
<td>Maximum size of individual gRPC messages (default `1048576`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--monitoringPort <uint16></code></td>
|
||||
<td></td>
|
||||
<td>HTTP port to use for the exposing mixer self-monitoring information (default `9093`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--port <uint16></code></td>
|
||||
<td><code>-p</code></td>
|
||||
<td>TCP port to use for Mixer's gRPC API (default `9091`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--readinessProbeInterval <duration></code></td>
|
||||
<td></td>
|
||||
<td>Interval of updating file for the readiness probe. (default `0s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--readinessProbePath <string></code></td>
|
||||
<td></td>
|
||||
<td>Path to the file for the readiness probe. (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--singleThreaded</code></td>
|
||||
<td></td>
|
||||
<td>If true, each request to Mixer will be executed in a single go routine (useful for debugging) </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_jaeger_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_log_spans</code></td>
|
||||
<td></td>
|
||||
<td>Whether or not to log trace spans. </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--trace_zipkin_url <string></code></td>
|
||||
<td></td>
|
||||
<td>URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default ``)</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="mixs validator">mixs validator</h2>
|
||||
<p>Runs an https server for validations. Works as an external admission webhook for k8s</p>
|
||||
<pre class="language-bash"><code>mixs validator [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--external-admission-webook-name <string></code></td>
|
||||
<td></td>
|
||||
<td>the name of the external admission webhook registration. Needs to be a domain with at least three segments separated by dots. (default `mixer-webhook.istio.io`)</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_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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td></td>
|
||||
<td>the namespace where this webhook is deployed (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--port <int></code></td>
|
||||
<td><code>-p</code></td>
|
||||
<td>the port number of the webhook (default `9099`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--registration-delay <duration></code></td>
|
||||
<td></td>
|
||||
<td>Time to delay webhook registration after starting webhook server (default `5s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--secret-name <string></code></td>
|
||||
<td></td>
|
||||
<td>The name of k8s secret where the certificates are stored (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--target-namespaces <stringArray></code></td>
|
||||
<td></td>
|
||||
<td>the list of namespaces where changes should be validated. Empty means to validate everything. Used for test only. (default `[]`)</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>
|
||||
<tr>
|
||||
<td><code>--webhook-name <string></code></td>
|
||||
<td></td>
|
||||
<td>the name of the webhook (default `istio-mixer-webhook`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="mixs version">mixs version</h2>
|
||||
<p>Prints out build version information</p>
|
||||
<pre class="language-bash"><code>mixs version [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--alsologtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error as well as files </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_dir <string></code></td>
|
||||
<td></td>
|
||||
<td>If non-empty, write log files in this directory (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--logtostderr</code></td>
|
||||
<td></td>
|
||||
<td>log to standard error instead of files </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>--stderrthreshold <severity></code></td>
|
||||
<td></td>
|
||||
<td>logs at or above this threshold go to stderr (default `2`)</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>
|
||||
|
|
@ -1,212 +0,0 @@
|
|||
---
|
||||
title: mixs
|
||||
overview: Mixer is Istio's abstraction on top of infrastructure backends.
|
||||
layout: docs
|
||||
---
|
||||
Mixer is Istio's point of integration with infrastructure backends and is the
|
||||
nexus for policy evaluation and telemetry reporting.
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## mixs crd
|
||||
|
||||
CRDs (CustomResourceDefinition) available in Mixer
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## mixs crd adapter
|
||||
|
||||
List CRDs for available adapters
|
||||
```bash
|
||||
mixs crd adapter [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## mixs crd all
|
||||
|
||||
List all CRDs
|
||||
```bash
|
||||
mixs crd all [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## mixs crd instance
|
||||
|
||||
List CRDs for available instance kinds (mesh functions)
|
||||
```bash
|
||||
mixs crd instance [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## mixs probe
|
||||
|
||||
Check the liveness or readiness of a locally-running server
|
||||
```bash
|
||||
mixs probe [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--interval <duration>`||Duration used for checking the target file's last modified time. (default `0s`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--probe-path <string>`||Path of the file for checking the availability. (default `""`)
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## mixs server
|
||||
|
||||
Starts Mixer as a server
|
||||
```bash
|
||||
mixs server [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--adapterWorkerPoolSize <int>`||Max number of goroutines in the adapter worker pool (default `1024`)
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--apiWorkerPoolSize <int>`||Max number of goroutines in the API worker pool (default `1024`)
|
||||
|`--configDefaultNamespace <string>`||Namespace used to store mesh wide configuration. (default `"istio-system"`)
|
||||
|`--configStoreURL <string>`||URL of the config store. Use k8s://path_to_kubeconfig or fs:// for file system. If path_to_kubeconfig is empty, in-cluster kubeconfig is used. (default `""`)
|
||||
|`--expressionEvalCacheSize <int>`||Number of entries in the expression cache (default `1024`)
|
||||
|`--livenessProbeInterval <duration>`||Interval of updating file for the liveness probe. (default `0s`)
|
||||
|`--livenessProbePath <string>`||Path to the file for the liveness probe. (default `""`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--maxConcurrentStreams <uint>`||Maximum number of outstanding RPCs per connection (default `1024`)
|
||||
|`--maxMessageSize <uint>`||Maximum size of individual gRPC messages (default `1048576`)
|
||||
|`--monitoringPort <uint16>`||HTTP port to use for the exposing mixer self-monitoring information (default `9093`)
|
||||
|`--port <uint16>`|`-p`|TCP port to use for Mixer's gRPC API (default `9091`)
|
||||
|`--readinessProbeInterval <duration>`||Interval of updating file for the readiness probe. (default `0s`)
|
||||
|`--readinessProbePath <string>`||Path to the file for the readiness probe. (default `""`)
|
||||
|`--singleThreaded`||If true, each request to Mixer will be executed in a single go routine (useful for debugging)
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--trace_jaeger_url <string>`||URL of Jaeger HTTP collector (example: 'http://jaeger:14268/api/traces?format=jaeger.thrift'). (default `""`)
|
||||
|`--trace_log_spans`||Whether or not to log trace spans.
|
||||
|`--trace_zipkin_url <string>`||URL of Zipkin collector (example: 'http://zipkin:9411/api/v1/spans'). (default `""`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## mixs validator
|
||||
|
||||
Runs an https server for validations. Works as an external admission webhook for k8s
|
||||
```bash
|
||||
mixs validator [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--external-admission-webook-name <string>`||the name of the external admission webhook registration. Needs to be a domain with at least three segments separated by dots. (default `"mixer-webhook.istio.io"`)
|
||||
|`--kubeconfig <string>`||Use a Kubernetes configuration file instead of in-cluster configuration (default `""`)
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--namespace <string>`||the namespace where this webhook is deployed (default `"istio-system"`)
|
||||
|`--port <int>`|`-p`|the port number of the webhook (default `9099`)
|
||||
|`--registration-delay <duration>`||Time to delay webhook registration after starting webhook server (default `5s`)
|
||||
|`--secret-name <string>`||The name of k8s secret where the certificates are stored (default `""`)
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--target-namespaces <stringArray>`||the list of namespaces where changes should be validated. Empty means to validate everything. Used for test only. (default `[]`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|`--webhook-name <string>`||the name of the webhook (default `"istio-mixer-webhook"`)
|
||||
|
||||
|
||||
## mixs version
|
||||
|
||||
Prints out build version information
|
||||
```bash
|
||||
mixs version [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--alsologtostderr`||log to standard error as well as files
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_dir <string>`||If non-empty, write log files in this directory (default `""`)
|
||||
|`--logtostderr`||log to standard error instead of files
|
||||
|`--short`|`-s`|Displays a short form of the version information
|
||||
|`--stderrthreshold <severity>`||logs at or above this threshold go to stderr (default `2`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
|
@ -0,0 +1,180 @@
|
|||
---
|
||||
title: node_agent
|
||||
overview: Istio security per-node agent
|
||||
layout: pkg-collateral-docs
|
||||
---
|
||||
<p>Istio security per-node agent</p>
|
||||
<pre class="language-bash"><code>node_agent [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--aws-root-cert <string></code></td>
|
||||
<td></td>
|
||||
<td>Root Certificate file in AWS environment (default `/etc/certs/root-cert.pem`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--ca-address <string></code></td>
|
||||
<td></td>
|
||||
<td>Istio CA address (default `istio-ca:8060`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--env <string></code></td>
|
||||
<td></td>
|
||||
<td>Node Environment : onprem | gcp | aws (default `onprem`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--gcp-ca-address <string></code></td>
|
||||
<td></td>
|
||||
<td>Istio CA address in GCP environment (default `istio-ca:8060`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--gcp-root-cert <string></code></td>
|
||||
<td></td>
|
||||
<td>Root Certificate file in GCP environment (default `/etc/certs/root-cert.pem`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--key-size <int></code></td>
|
||||
<td></td>
|
||||
<td>Size of generated private key (default `2048`)</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_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>--onprem-cert-chain <string></code></td>
|
||||
<td></td>
|
||||
<td>Node Agent identity cert file in on premise environment (default `/etc/certs/cert-chain.pem`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--onprem-key <string></code></td>
|
||||
<td></td>
|
||||
<td>Node identity private key file in on premise environment (default `/etc/certs/key.pem`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--onprem-root-cert <string></code></td>
|
||||
<td></td>
|
||||
<td>Root Certificate file in on premise environment (default `/etc/certs/root-cert.pem`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--org <string></code></td>
|
||||
<td></td>
|
||||
<td>Organization for the cert (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--workload-cert-ttl <duration></code></td>
|
||||
<td></td>
|
||||
<td>The requested TTL for the workload (default `12h0m0s`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="node_agent version">node_agent version</h2>
|
||||
<p>Prints out build version information</p>
|
||||
<pre class="language-bash"><code>node_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_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>--short</code></td>
|
||||
<td><code>-s</code></td>
|
||||
<td>Displays a short form of the version information </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1,56 +0,0 @@
|
|||
---
|
||||
title: node_agent
|
||||
overview: Istio security per-node agent
|
||||
layout: docs
|
||||
---
|
||||
Istio security per-node agent
|
||||
```bash
|
||||
node_agent [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--aws-root-cert <string>`||Root Certificate file in AWS environment (default `"/etc/certs/root-cert.pem"`)
|
||||
|`--ca-address <string>`||Istio CA address (default `"istio-ca:8060"`)
|
||||
|`--env <string>`||Node Environment : onprem | gcp | aws (default `"onprem"`)
|
||||
|`--gcp-ca-address <string>`||Istio CA address in GCP environment (default `"istio-ca:8060"`)
|
||||
|`--gcp-root-cert <string>`||Root Certificate file in GCP environment (default `"/etc/certs/root-cert.pem"`)
|
||||
|`--key-size <int>`||Size of generated private key (default `2048`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--onprem-cert-chain <string>`||Node Agent identity cert file in on premise environment (default `"/etc/certs/cert-chain.pem"`)
|
||||
|`--onprem-key <string>`||Node identity private key file in on premise environment (default `"/etc/certs/key.pem"`)
|
||||
|`--onprem-root-cert <string>`||Root Certificate file in on premise environment (default `"/etc/certs/root-cert.pem"`)
|
||||
|`--org <string>`||Organization for the cert (default `""`)
|
||||
|`--workload-cert-ttl <duration>`||The requested TTL for the workload (default `12h0m0s`)
|
||||
|
||||
|
||||
## node_agent version
|
||||
|
||||
Prints out build version information
|
||||
```bash
|
||||
node_agent version [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--short`|`-s`|Displays a short form of the version information
|
||||
|
||||
|
|
@ -0,0 +1,321 @@
|
|||
---
|
||||
title: pilot-agent
|
||||
overview: Istio Pilot agent
|
||||
layout: pkg-collateral-docs
|
||||
---
|
||||
<p>Istio Pilot provides management plane functionality to the Istio service mesh and Istio Mixer.</p>
|
||||
<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_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>--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="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>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--availabilityZone <string></code></td>
|
||||
<td></td>
|
||||
<td>Availability zone (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--binaryPath <string></code></td>
|
||||
<td></td>
|
||||
<td>Path to the proxy binary (default `/usr/local/bin/envoy`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--configPath <string></code></td>
|
||||
<td></td>
|
||||
<td>Path to the generated configuration file directory (default `/etc/istio/proxy`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--connectTimeout <duration></code></td>
|
||||
<td></td>
|
||||
<td>Connection timeout used by Envoy for supporting services (default `1s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--controlPlaneAuthPolicy <string></code></td>
|
||||
<td></td>
|
||||
<td>Control Plane Authentication Policy (default `NONE`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--customConfigFile <string></code></td>
|
||||
<td></td>
|
||||
<td>Path to the generated configuration file directory (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--discoveryAddress <string></code></td>
|
||||
<td></td>
|
||||
<td>Address of the discovery service exposing xDS (e.g. istio-pilot:8080) (default `istio-pilot:15003`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--discoveryRefreshDelay <duration></code></td>
|
||||
<td></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></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></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></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></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></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>--parentShutdownDuration <duration></code></td>
|
||||
<td></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></td>
|
||||
<td>Port on which Envoy should listen for administrative commands (default `15000`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--proxyLogLevel <string></code></td>
|
||||
<td></td>
|
||||
<td>The log level used to start the Envoy proxy (choose from {trace, debug, info, warn, err, critical, off}) (default `info`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--serviceCluster <string></code></td>
|
||||
<td></td>
|
||||
<td>Service cluster (default `istio-proxy`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--serviceregistry <string></code></td>
|
||||
<td></td>
|
||||
<td>Select the platform for service registry, options are {Kubernetes, Consul, Eureka} (default `Kubernetes`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--statsdUdpAddress <string></code></td>
|
||||
<td></td>
|
||||
<td>IP Address and Port of a statsd UDP listener (e.g. 10.75.241.127:9125) (default ``)</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>
|
||||
<tr>
|
||||
<td><code>--zipkinAddress <string></code></td>
|
||||
<td></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_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>--short</code></td>
|
||||
<td><code>-s</code></td>
|
||||
<td>Displays a short form of the version information </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>
|
||||
|
|
@ -1,90 +0,0 @@
|
|||
---
|
||||
title: pilot-agent
|
||||
overview: Istio Pilot agent
|
||||
layout: docs
|
||||
---
|
||||
Istio Pilot provides management plane functionality to the Istio service mesh and Istio Mixer.
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## pilot-agent proxy
|
||||
|
||||
Envoy proxy agent
|
||||
```bash
|
||||
pilot-agent proxy [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--availabilityZone <string>`||Availability zone (default `""`)
|
||||
|`--binaryPath <string>`||Path to the proxy binary (default `"/usr/local/bin/envoy"`)
|
||||
|`--configPath <string>`||Path to the generated configuration file directory (default `"/etc/istio/proxy"`)
|
||||
|`--connectTimeout <duration>`||Connection timeout used by Envoy for supporting services (default `1s`)
|
||||
|`--controlPlaneAuthPolicy <string>`||Control Plane Authentication Policy (default `"NONE"`)
|
||||
|`--customConfigFile <string>`||Path to the generated configuration file directory (default `""`)
|
||||
|`--discoveryAddress <string>`||Address of the discovery service exposing xDS (e.g. istio-pilot:8080) (default `"istio-pilot:15003"`)
|
||||
|`--discoveryRefreshDelay <duration>`||Polling interval for service discovery (used by EDS, CDS, LDS, but not RDS) (default `1s`)
|
||||
|`--domain <string>`||DNS domain suffix. If not provided uses ${POD_NAMESPACE}.svc.cluster.local (default `""`)
|
||||
|`--drainDuration <duration>`||The time in seconds that Envoy will drain connections during a hot restart (default `2s`)
|
||||
|`--id <string>`||Proxy unique ID. If not provided uses ${POD_NAME}.${POD_NAMESPACE} from environment variables (default `""`)
|
||||
|`--ip <string>`||Proxy IP address. If not provided uses ${INSTANCE_IP} environment variable. (default `""`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--parentShutdownDuration <duration>`||The time in seconds that Envoy will wait before shutting down the parent process during a hot restart (default `3s`)
|
||||
|`--proxyAdminPort <int>`||Port on which Envoy should listen for administrative commands (default `15000`)
|
||||
|`--proxyLogLevel <string>`||The log level used to start the Envoy proxy (choose from {trace, debug, info, warn, err, critical, off}) (default `"info"`)
|
||||
|`--serviceCluster <string>`||Service cluster (default `"istio-proxy"`)
|
||||
|`--serviceregistry <string>`||Select the platform for service registry, options are {Kubernetes, Consul, Eureka} (default `"Kubernetes"`)
|
||||
|`--statsdUdpAddress <string>`||IP Address and Port of a statsd UDP listener (e.g. 10.75.241.127:9125) (default `""`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|`--zipkinAddress <string>`||Address of the Zipkin service (e.g. zipkin:9411) (default `""`)
|
||||
|
||||
|
||||
## pilot-agent version
|
||||
|
||||
Prints out build version information
|
||||
```bash
|
||||
pilot-agent version [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--short`|`-s`|Displays a short form of the version information
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
|
@ -0,0 +1,346 @@
|
|||
---
|
||||
title: pilot-discovery
|
||||
overview: Istio Pilot
|
||||
layout: pkg-collateral-docs
|
||||
---
|
||||
<p>Istio Pilot provides fleet-wide traffic management capabilities in the Istio Service Mesh.</p>
|
||||
<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_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>--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="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>--admission-registration-delay <duration></code></td>
|
||||
<td></td>
|
||||
<td>Time to delay webhook registration after starting webhook server (default `0s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--admission-secret <string></code></td>
|
||||
<td></td>
|
||||
<td>Name of k8s secret for pilot webhook certs (default `pilot-webhook`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--admission-service <string></code></td>
|
||||
<td></td>
|
||||
<td>Service name the admission controller uses during registration (default `istio-pilot`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--admission-service-port <int></code></td>
|
||||
<td></td>
|
||||
<td>HTTPS port of the admission service. Must be 443 if service has more than one port (default `443`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--admission-webhook-name <string></code></td>
|
||||
<td></td>
|
||||
<td>Webhook name for Pilot admission controller (default `pilot-webhook.istio.io`)</td>
|
||||
</tr>
|
||||
<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>--cfConfig <string></code></td>
|
||||
<td></td>
|
||||
<td>Cloud Foundry config file (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>--consulconfig <string></code></td>
|
||||
<td></td>
|
||||
<td>Consul Config file for discovery (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>--discovery_cache</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>--eurekaserverInterval <duration></code></td>
|
||||
<td></td>
|
||||
<td>Interval (in seconds) for polling the Eureka service registry (default `2s`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--eurekaserverURL <string></code></td>
|
||||
<td></td>
|
||||
<td>URL for the Eureka server (default ``)</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_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 name for Istio mesh configuration. If not specified, a default mesh will be used. (default `/etc/istio/config/mesh`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--monitoringPort <int></code></td>
|
||||
<td></td>
|
||||
<td>HTTP port 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>--port <int></code></td>
|
||||
<td></td>
|
||||
<td>Discovery service port (default `8080`)</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, Eureka, CloudFoundry, 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>--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>
|
||||
<tr>
|
||||
<td><code>--webhookEndpoint <string></code></td>
|
||||
<td></td>
|
||||
<td>Webhook API endpoint (supports DNS, IP, and unix domain socket. (default ``)</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>--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>--short</code></td>
|
||||
<td><code>-s</code></td>
|
||||
<td>Displays a short form of the version information </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>
|
||||
|
|
@ -1,95 +0,0 @@
|
|||
---
|
||||
title: pilot-discovery
|
||||
overview: Istio Pilot
|
||||
layout: docs
|
||||
---
|
||||
Istio Pilot provides fleet-wide traffic management capabilities in the Istio Service Mesh.
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## pilot-discovery discovery
|
||||
|
||||
Start Istio proxy discovery service
|
||||
```bash
|
||||
pilot-discovery discovery [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--admission-registration-delay <duration>`||Time to delay webhook registration after starting webhook server (default `0s`)
|
||||
|`--admission-secret <string>`||Name of k8s secret for pilot webhook certs (default `"pilot-webhook"`)
|
||||
|`--admission-service <string>`||Service name the admission controller uses during registration (default `"istio-pilot"`)
|
||||
|`--admission-service-port <int>`||HTTPS port of the admission service. Must be 443 if service has more than one port (default `443`)
|
||||
|`--admission-webhook-name <string>`||Webhook name for Pilot admission controller (default `"pilot-webhook.istio.io"`)
|
||||
|`--appNamespace <string>`|`-a`|Restrict the applications namespace the controller manages; if not set, controller watches all namespaces (default `""`)
|
||||
|`--cfConfig <string>`||Cloud Foundry config file (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 `""`)
|
||||
|`--consulconfig <string>`||Consul Config file for discovery (default `""`)
|
||||
|`--consulserverInterval <duration>`||Interval (in seconds) for polling the Consul service registry (default `2s`)
|
||||
|`--consulserverURL <string>`||URL for the Consul server (default `""`)
|
||||
|`--discovery_cache`||Enable caching discovery service responses
|
||||
|`--domain <string>`||DNS domain suffix (default `"cluster.local"`)
|
||||
|`--eurekaserverInterval <duration>`||Interval (in seconds) for polling the Eureka service registry (default `2s`)
|
||||
|`--eurekaserverURL <string>`||URL for the Eureka server (default `""`)
|
||||
|`--kubeconfig <string>`||Use a Kubernetes configuration file instead of in-cluster configuration (default `""`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--meshConfig <string>`||File name for Istio mesh configuration. If not specified, a default mesh will be used. (default `"/etc/istio/config/mesh"`)
|
||||
|`--monitoringPort <int>`||HTTP port to use for the exposing pilot self-monitoring information (default `9093`)
|
||||
|`--namespace <string>`|`-n`|Select a namespace where the controller resides. If not set, uses ${POD_NAMESPACE} environment variable (default `""`)
|
||||
|`--port <int>`||Discovery service port (default `8080`)
|
||||
|`--profile`||Enable 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, Eureka, CloudFoundry, Mock}) (default `[Kubernetes]`)
|
||||
|`--resync <duration>`||Controller resync interval (default `1m0s`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|`--webhookEndpoint <string>`||Webhook API endpoint (supports DNS, IP, and unix domain socket. (default `""`)
|
||||
|
||||
|
||||
## pilot-discovery version
|
||||
|
||||
Prints out build version information
|
||||
```bash
|
||||
pilot-discovery version [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--short`|`-s`|Displays a short form of the version information
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
|
@ -0,0 +1,205 @@
|
|||
---
|
||||
title: sidecar-injector
|
||||
overview: Kubernetes webhook for automatic Istio sidecar injection
|
||||
layout: pkg-collateral-docs
|
||||
---
|
||||
<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>--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 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>--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>
|
||||
|
|
@ -1,61 +0,0 @@
|
|||
---
|
||||
title: sidecar-injector
|
||||
overview: Kubernetes webhook for automatic Istio sidecar injection
|
||||
layout: docs
|
||||
---
|
||||
Kubernetes webhook for automatic Istio sidecar injection
|
||||
```bash
|
||||
sidecar-injector [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--injectConfig <string>`||File containing the Istio sidecar injection configuration and template (default `"/etc/istio/inject/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--meshConfig <string>`||File containing the Istio mesh configuration (default `"/etc/istio/config/mesh"`)
|
||||
|`--port <int>`||Webhook port (default `443`)
|
||||
|`--tlsCertFile <string>`||File containing the x509 Certificate for HTTPS. (default `"/etc/istio/certs/cert.pem"`)
|
||||
|`--tlsKeyFile <string>`||File containing the x509 private key matching --tlsCertFile. (default `"/etc/istio/certs/key.pem"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
||||
## sidecar-injector version
|
||||
|
||||
Prints out build version information
|
||||
```bash
|
||||
sidecar-injector version [flags]
|
||||
```
|
||||
|
||||
|
||||
|Option|Shorthand|Description
|
||||
|------|---------|-----------
|
||||
|`--injectConfig <string>`||File containing the Istio sidecar injection configuration and template (default `"/etc/istio/inject/config"`)
|
||||
|`--log_as_json`||Whether to format output as JSON or in plain console-friendly format
|
||||
|`--log_backtrace_at <traceLocation>`||when logging hits line file:N, emit a stack trace (default `:0`)
|
||||
|`--log_callers`||Include caller information, useful for debugging
|
||||
|`--log_output_level <string>`||The minimum logging level of messages to output, can be one of "debug", "info", "warn", "error", or "none" (default `"info"`)
|
||||
|`--log_rotate <string>`||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>`||The minimum logging level at which stack traces are captured, can be one of "debug", "info", "warn", "error", or "none" (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]`)
|
||||
|`--meshConfig <string>`||File containing the Istio mesh configuration (default `"/etc/istio/config/mesh"`)
|
||||
|`--port <int>`||Webhook port (default `443`)
|
||||
|`--short`|`-s`|Displays a short form of the version information
|
||||
|`--tlsCertFile <string>`||File containing the x509 Certificate for HTTPS. (default `"/etc/istio/certs/cert.pem"`)
|
||||
|`--tlsKeyFile <string>`||File containing the x509 private key matching --tlsCertFile. (default `"/etc/istio/certs/key.pem"`)
|
||||
|`--v <Level>`|`-v`|log level for V logs (default `0`)
|
||||
|`--vmodule <moduleSpec>`||comma-separated list of pattern=N settings for file-filtered logging (default ``)
|
||||
|
||||
|
|
@ -13,7 +13,7 @@ different scopes (mesh, service …), and the most narrow scope with
|
|||
non-INHERIT value will be used.
|
||||
Mesh policy cannot be INHERIT.</p>
|
||||
|
||||
<table>
|
||||
<table class="enum-values">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
|
|
@ -46,7 +46,7 @@ policy.</p>
|
|||
<section>
|
||||
<p>TODO AuthPolicy needs to be removed and merged with AuthPolicy defined above</p>
|
||||
|
||||
<table>
|
||||
<table class="enum-values">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
|
|
@ -69,7 +69,7 @@ policy.</p>
|
|||
</section>
|
||||
<h3 id="MeshConfig.IngressControllerMode">MeshConfig.IngressControllerMode</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="enum-values">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
|
|
@ -111,7 +111,7 @@ cloud-provided ingress controller).</p>
|
|||
<p>MeshConfig defines mesh-wide variables shared by all Envoy instances in the
|
||||
Istio service mesh.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -262,7 +262,7 @@ Instead, use service-level annotations to overwrite the authentication policy.</
|
|||
<section>
|
||||
<p>ProxyConfig defines variables for individual Envoy instances.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -412,13 +412,11 @@ Increase the value of this field if you find that the metrics from Envoys are tr
|
|||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr id="ProxyConfig.concurrency">
|
||||
<td><code>concurrency</code></td>
|
||||
<td><code>int32</code></td>
|
||||
<td>
|
||||
<p>The number of worker threads to run in Envoy. Default value is number of cores on the machine.</p>
|
||||
<p>The number of worker threads to run. Default value is number of cores on the machine.</p>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ layout: protoc-gen-docs
|
|||
<h2 id="Enumerations">Enumerations</h2>
|
||||
<h3 id="TransportConfig.NetworkFailPolicy">TransportConfig.NetworkFailPolicy</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="enum-values">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
|
|
@ -37,7 +37,7 @@ layout: protoc-gen-docs
|
|||
<p>See https://swagger.io/docs/specification/authentication/api-keys
|
||||
for a general overview of API keys as defined by OpenAPI.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -96,7 +96,7 @@ Cookie: X-API-KEY=abcdef12345
|
|||
<section>
|
||||
<p>Specifies a match clause to match Istio attributes</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -125,7 +125,7 @@ Each map element specifies one condition to match.</p>
|
|||
<section>
|
||||
<p>Determines how to apply auth policies for individual requests.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -168,7 +168,7 @@ include a JWT.</p>
|
|||
<p>EndUserAuthenticationPolicySpecBinding defines the binding between
|
||||
EndUserAuthenticationPolicySpecs and one or more IstioService.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -196,7 +196,7 @@ that should be mapped to the specified service(s).</p>
|
|||
</section>
|
||||
<h3 id="EndUserAuthenticationPolicySpecReference">EndUserAuthenticationPolicySpecReference</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -270,7 +270,7 @@ spec:
|
|||
- query: api-key
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -332,7 +332,7 @@ spec:
|
|||
namespace: default
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -373,7 +373,7 @@ generated.</p>
|
|||
uriTemplate: /foo/bar
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -443,7 +443,7 @@ HTTPAPISpecReference for service <code>foo</code> in namespace <code>bar</code>.
|
|||
namespace: bar
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -473,7 +473,7 @@ HTTPAPISpecBinding’s metadata namespace field.</p>
|
|||
<section>
|
||||
<p>Defines the client config for HTTP.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -533,7 +533,7 @@ includes the “source.ip” and “source.uid” attributes.</p
|
|||
The FQDN of the service is composed from the name, namespace, and implementation-specific domain suffix
|
||||
(e.g. on Kubernetes, “reviews” + “default” + “svc.cluster.local” -> “reviews.default.svc.cluster.local”).</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -600,7 +600,7 @@ audiences:
|
|||
jwks_uri: https://example.com/.well-known/jwks.json
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -706,7 +706,7 @@ locations are tried in order:</p>
|
|||
https://tools.ietf.org/html/rfc6750#section-2.3)
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -741,7 +741,7 @@ query parameter name.</p>
|
|||
<section>
|
||||
<p>Specifies a quota to use with quota name and amount.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -770,7 +770,7 @@ query parameter name.</p>
|
|||
<p>Specifies a rule with list of matches and list of quotas.
|
||||
If any clause matched, the list of quotas will be used.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -799,7 +799,7 @@ If any of match is true, it is matched.</p>
|
|||
<section>
|
||||
<p>Determines the quotas used for individual requests.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -820,7 +820,7 @@ If any of match is true, it is matched.</p>
|
|||
<p>QuotaSpecBinding defines the binding between QuotaSpecs and one or more
|
||||
IstioService.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -848,7 +848,7 @@ conditions defined in the QuotaSpecs should not overlap.</p>
|
|||
</section>
|
||||
<h3 id="QuotaSpecBinding.QuotaSpecReference">QuotaSpecBinding.QuotaSpecReference</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -878,7 +878,7 @@ metadata namespace field.</p>
|
|||
<section>
|
||||
<p>Defines the per-service client configuration.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -940,7 +940,7 @@ typically includes the “destination.service” attribute.</p>
|
|||
<p>Describes how to match a given string in HTTP headers. Match is
|
||||
case-sensitive.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -976,7 +976,7 @@ case-sensitive.</p>
|
|||
<section>
|
||||
<p>Defines the client config for TCP.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1041,7 +1041,7 @@ should not be less than 1 second, otherwise it will be reset to 1 second.</p>
|
|||
<section>
|
||||
<p>Defines the transport config on how to call Mixer.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ constructed using the instance ‘RequestCountByService’</p>
|
|||
- RequestCountByService
|
||||
</code></p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -51,7 +51,7 @@ The constructed objects are then passed to the <code>handler</code> referenced w
|
|||
<p>AttributeManifest describes a set of Attributes produced by some component
|
||||
of an Istio deployment.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -142,7 +142,7 @@ REST APIs. The design is to map one attribute to one HTTP header, the
|
|||
attribute name and value becomes the HTTP header name and value. The actual
|
||||
encoding scheme will be decided later.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -180,7 +180,7 @@ adapter: prometheus
|
|||
params:
|
||||
</code></p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -238,7 +238,7 @@ Instances produced with this instance can be referenced by <a href="#Action">Act
|
|||
destination_ip: destination.ip
|
||||
</code></p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -291,7 +291,7 @@ instance constructed using the ‘RequestCountByService’ instance.</p>
|
|||
- RequestCountByService
|
||||
</code></p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -338,7 +338,7 @@ with the proto support for the language.</p>
|
|||
|
||||
<p>The JSON representation for <code>Struct</code> is JSON object.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
|
|||
|
|
@ -92,7 +92,7 @@ spec:
|
|||
<section>
|
||||
<p>AccessRule defines a permission to access a list of services.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -152,7 +152,7 @@ The above ServiceRole examples shows an example of constraint “version&rdq
|
|||
one of the “properties” in the “action” part of the “authorization” template
|
||||
(https://github.com/istio/istio/blob/master/mixer/template/authorization/template.proto).</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -184,7 +184,7 @@ or “</em>alpha2” (suffix match).</p>
|
|||
<section>
|
||||
<p>RoleRef refers to a role object.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -217,7 +217,7 @@ object.</p>
|
|||
This represent the “Spec” part of the ServiceRole object. The name and namespace
|
||||
of the ServiceRole is specified in “metadata” section of the ServiceRole object.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -240,7 +240,7 @@ This represents the “Spec” part of the ServiceRoleBinding object. Th
|
|||
of the ServiceRoleBinding is specified in “metadata” section of the ServiceRoleBinding
|
||||
object.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -271,7 +271,7 @@ a group or identified by a set of “properties”. The name of the &ldq
|
|||
the “properties” in the “subject” part of the “authorization” template
|
||||
(https://github.com/istio/istio/blob/master/mixer/template/authorization/template.proto).</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ decouple itself from the evolution of dependent services.</p>
|
|||
<section>
|
||||
<p>Load balancing algorithms supported by Envoy.</p>
|
||||
|
||||
<table>
|
||||
<table class="enum-values">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
|
|
@ -85,7 +85,7 @@ See Envoy’s
|
|||
and <a href="https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/outlier">outlier detection</a>
|
||||
for more details.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -151,7 +151,7 @@ spec:
|
|||
httpDetectionInterval: 5m
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -269,7 +269,7 @@ spec:
|
|||
maxAge: "1d"
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -383,7 +383,7 @@ tagged instances are explicitly routed to. In other words, for every
|
|||
destination policy defined, at least one route rule must refer to the
|
||||
service version indicated in the destination policy.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -457,7 +457,7 @@ spec:
|
|||
weight: 75
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -523,7 +523,7 @@ spec:
|
|||
protocol: https
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -570,7 +570,7 @@ These dedicated egress nodes could then be more closely monitored for security v
|
|||
<section>
|
||||
<p>Port describes the properties of a specific TCP port of an external service.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -606,7 +606,7 @@ proxying of requests. A fault rule MUST HAVE delay or abort or both.</p>
|
|||
<p><em>Note:</em> Delay and abort faults are independent of one another, even if
|
||||
both are specified simultaneously.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -657,7 +657,7 @@ return to the caller. The optional <em>percent</em> field, a value between 0
|
|||
and 100, is used to only abort a certain percentage of requests. If
|
||||
not specified, all requests are aborted.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -728,7 +728,7 @@ seconds. An optional <em>percent</em> field, a value between 0 and 100, can
|
|||
be used to only delay a certain percentage of requests. If left
|
||||
unspecified, all request will be delayed.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -794,7 +794,7 @@ spec:
|
|||
authority: bookratings.default.svc.cluster.local
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -842,7 +842,7 @@ spec:
|
|||
perTryTimeout: 2s
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -866,7 +866,7 @@ spec:
|
|||
</section>
|
||||
<h3 id="HTTPRetry.SimpleRetryPolicy">HTTPRetry.SimpleRetryPolicy</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -927,7 +927,7 @@ spec:
|
|||
version: v1
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -972,7 +972,7 @@ spec:
|
|||
timeout: 10s
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -996,7 +996,7 @@ spec:
|
|||
</section>
|
||||
<h3 id="HTTPTimeout.SimpleTimeoutPolicy">HTTPTimeout.SimpleTimeoutPolicy</h3>
|
||||
<section>
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1039,7 +1039,7 @@ also effective.</p>
|
|||
|
||||
<p>WARNING: This API is experimental and under active development</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1117,7 +1117,7 @@ of the service and therefore the IstioService’s labels field MUST be empty
|
|||
The FQDN of the service is composed from the name, namespace, and implementation-specific domain suffix
|
||||
(e.g. on Kubernetes, “reviews” + “default” + “svc.cluster.local” -> “reviews.default.svc.cluster.local”).</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1178,7 +1178,7 @@ end). Bandwidth throttling for failure testing should not be confused
|
|||
with the rate limiting policy enforcement provided by the Mixer
|
||||
component. L4 fault injection is not supported at the moment. –)</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1209,7 +1209,7 @@ We first throttle (if set) and then terminate the connection.</p>
|
|||
<p>Abruptly reset (terminate) the Tcp connection after it has been
|
||||
established, emulating remote server crash or link failure.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1238,7 +1238,7 @@ express time interval related configs.</p>
|
|||
<section>
|
||||
<p>Bandwidth throttling for Tcp and Udp connections</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1304,7 +1304,7 @@ will be throttled for its lifetime.</p>
|
|||
<p>(– L4 connection match attributes. Note that L4 connection matching
|
||||
support is incomplete. –)</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1348,7 +1348,7 @@ spec:
|
|||
name: RANDOM
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1405,7 +1405,7 @@ spec:
|
|||
<p>MatchCondition CANNOT be empty. At least one source or
|
||||
request header must be specified.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1449,7 +1449,7 @@ request header must be specified.</p>
|
|||
<section>
|
||||
<p>MatchRequest specifies the attributes of an HTTP request to be used for matching a request.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1511,7 +1511,7 @@ spec:
|
|||
weight: 100
|
||||
</code></pre>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
@ -1665,7 +1665,7 @@ destnation service.</p>
|
|||
<section>
|
||||
<p>Describes how to match a given string in HTTP headers. Match is case-sensitive.</p>
|
||||
|
||||
<table>
|
||||
<table class="message-fields">
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ are used to describe the type of Attributes at run time, describe the type of
|
|||
the result of evaluating an expression, and to describe the runtime type of
|
||||
fields of other descriptors.</p>
|
||||
|
||||
<table>
|
||||
<table class="enum-values">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ field datatype to express the equivalent ValueType for the expressions the field
|
|||
<section>
|
||||
<p>Specifies the varity of the the Template.</p>
|
||||
|
||||
<table>
|
||||
<table class="enum-values">
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
|
|
|
|||
|
|
@ -174,7 +174,7 @@ kubectl create -n <namspace> -f <your-app-spec>.yaml
|
|||
```
|
||||
|
||||
If you do not have the Istio-sidecar-injector installed, you must
|
||||
use [istioctl kube-inject]({{home}}/docs/reference/commands/istioctl.html#istioctl-kube-inject) to
|
||||
use [istioctl kube-inject]({{home}}/docs/reference/commands/istioctl.html#istioctl kube-inject) to
|
||||
manuallly inject Envoy containers in your application pods before deploying them:
|
||||
```bash
|
||||
kubectl create -f <(istioctl kube-inject -f <your-app-spec>.yaml)
|
||||
|
|
|
|||
|
|
@ -165,7 +165,7 @@ or if you want to completely bypass Istio for a specific IP range,
|
|||
you will need to configure the source service's Envoy sidecar to prevent it from
|
||||
[intercepting]({{home}}/docs/concepts/traffic-management/request-routing.html#communication-between-services)
|
||||
the external requests. This can be done using the `--includeIPRanges` option of
|
||||
[istioctl kube-inject]({{home}}/docs/reference/commands/istioctl.html#istioctl-kube-inject)
|
||||
[istioctl kube-inject]({{home}}/docs/reference/commands/istioctl.html#istioctl kube-inject)
|
||||
when starting the service.
|
||||
|
||||
The simplest way to use the `--includeIPRanges` option is to pass it the IP range(s)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,4 @@
|
|||
---
|
||||
layout: docs
|
||||
---
|
||||
{{content}}
|
||||
|
|
@ -49,9 +49,10 @@ get_command_doc() {
|
|||
COMMAND_PATH=$1
|
||||
COMMAND=$2
|
||||
|
||||
cd $COMMAND_PATH
|
||||
pushd $COMMAND_PATH
|
||||
go build
|
||||
./$COMMAND collateral -o $COMMAND_DIR --markdown
|
||||
./$COMMAND collateral -o $COMMAND_DIR --jekyll_html
|
||||
popd
|
||||
}
|
||||
|
||||
# First delete all the current generated files so that any stale files are removed
|
||||
|
|
|
|||
Loading…
Reference in New Issue