mirror of https://github.com/istio/istio.io.git
255 lines
9.2 KiB
HTML
255 lines
9.2 KiB
HTML
---
|
|
title: mixs
|
|
description: Mixer is Istio's abstraction on top of infrastructure backends.
|
|
generator: pkg-collateral-docs
|
|
number_of_entries: 9
|
|
---
|
|
<p>Mixer is Istio's point of integration with infrastructure backends and is the
|
|
nexus for policy evaluation and telemetry reporting.</p>
|
|
<h2 id="mixs crd">mixs crd</h2>
|
|
<p>CRDs (CustomResourceDefinition) available in Mixer</p>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>Description</th>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>--interval <duration></code></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>Whether to format output as JSON or in plain console-friendly format </td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_caller <string></code></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [adapters, api, attributes, default] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [adapters, api, attributes, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></code></td>
|
|
<td>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_backups <int></code></td>
|
|
<td>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_size <int></code></td>
|
|
<td>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_stacktrace_level <string></code></td>
|
|
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [adapters, api, attributes, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></code></td>
|
|
<td>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--probe-path <string></code></td>
|
|
<td>Path of the file for checking the availability. (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>--address <string></code></td>
|
|
<td></td>
|
|
<td>Address to use for Mixer's gRPC API, e.g. tcp://127.0.0.1:9092 or unix:///path/to/file (default ``)</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>--ctrlz_address <string></code></td>
|
|
<td></td>
|
|
<td>The IP Address to listen on for the ControlZ introspection facility. Use '*' to indicate all addresses. (default `127.0.0.1`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--ctrlz_port <uint16></code></td>
|
|
<td></td>
|
|
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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_caller <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [adapters, api, attributes, default] (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_output_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of <scope>:<level>,<scope>:<level>,... where scope can be one of [adapters, api, attributes, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate <string></code></td>
|
|
<td></td>
|
|
<td>The path for the optional rotating log file (default ``)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_age <int></code></td>
|
|
<td></td>
|
|
<td>The maximum age in days of a log file beyond which the file is rotated (0 indicates no limit) (default `30`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_backups <int></code></td>
|
|
<td></td>
|
|
<td>The maximum number of log file backups to keep before older files are deleted (0 indicates no limit) (default `1000`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_rotate_max_size <int></code></td>
|
|
<td></td>
|
|
<td>The maximum size in megabytes of a log file beyond which the file is rotated (default `104857600`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_stacktrace_level <string></code></td>
|
|
<td></td>
|
|
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of <scope>:<level>,<scope:level>,... where scope can be one of [adapters, api, attributes, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--log_target <stringArray></code></td>
|
|
<td></td>
|
|
<td>The set of paths where to output the log. This can be any path as well as the special values stdout and stderr (default `[stdout]`)</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>--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, if the address option is not specified (default `9091`)</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>--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>--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="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>--short</code></td>
|
|
<td><code>-s</code></td>
|
|
<td>Displays a short form of the version information </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|