Latest reference docs.

This commit is contained in:
mtail 2018-02-09 14:48:02 -08:00
parent e1da4d25bf
commit b7bbafa70a
22 changed files with 231 additions and 58 deletions

View File

@ -170,9 +170,19 @@ number_of_entries: 3
<td>comma-separated list of pattern=N settings for file-filtered logging (default ``)</td>
</tr>
<tr>
<td><code>--workload-cert-grace-period-ratio &lt;float32&gt;</code></td>
<td></td>
<td>The workload certificate rotation grace period, as a ratio of the workload certificate TTL. (default `0.5`)</td>
</tr>
<tr>
<td><code>--workload-cert-min-grace-period &lt;duration&gt;</code></td>
<td></td>
<td>The minimum workload certificate rotation grace period. (default `10m0s`)</td>
</tr>
<tr>
<td><code>--workload-cert-ttl &lt;duration&gt;</code></td>
<td></td>
<td>The TTL of issued workload certificates (default `1h0m0s`)</td>
<td>The TTL of issued workload certificates (default `19h0m0s`)</td>
</tr>
</tbody>
</table>

View File

@ -112,7 +112,7 @@ number_of_entries: 3
<tr>
<td><code>--workload-cert-ttl &lt;duration&gt;</code></td>
<td></td>
<td>The requested TTL for the workload (default `12h0m0s`)</td>
<td>The requested TTL for the workload (default `19h0m0s`)</td>
</tr>
</tbody>
</table>

View File

@ -101,6 +101,11 @@ number_of_entries: 4
<td>Use bootstrap v2 </td>
</tr>
<tr>
<td><code>--concurrency &lt;int&gt;</code></td>
<td></td>
<td>number of worker threads to run (default `0`)</td>
</tr>
<tr>
<td><code>--configPath &lt;string&gt;</code></td>
<td></td>
<td>Path to the generated configuration file directory (default `/etc/istio/proxy`)</td>

View File

@ -2,7 +2,7 @@
title: sidecar-injector
overview: Kubernetes webhook for automatic Istio sidecar injection
layout: pkg-collateral-docs
number_of_entries: 3
number_of_entries: 4
---
<p>Kubernetes webhook for automatic Istio sidecar injection</p>
<pre class="language-bash"><code>sidecar-injector [flags]
@ -15,6 +15,16 @@ number_of_entries: 3
</thead>
<tbody>
<tr>
<td><code>--healthCheckFile &lt;string&gt;</code></td>
<td></td>
<td>File that should be periodically updated if health checking is enabled (default ``)</td>
</tr>
<tr>
<td><code>--healthCheckInterval &lt;duration&gt;</code></td>
<td></td>
<td>Configure how frequently the health check file specified by --healhCheckFile should be updated (default `0s`)</td>
</tr>
<tr>
<td><code>--injectConfig &lt;string&gt;</code></td>
<td></td>
<td>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)</td>
@ -101,6 +111,124 @@ number_of_entries: 3
</tr>
</tbody>
</table>
<h2 id="sidecar-injector probe">sidecar-injector probe</h2>
<p>Check the liveness or readiness of a locally-running server</p>
<pre class="language-bash"><code>sidecar-injector probe [flags]
</code></pre>
<table class="command-flags">
<thead>
<th>Flags</th>
<th>Shorthand</th>
<th>Description</th>
</thead>
<tbody>
<tr>
<td><code>--healthCheckFile &lt;string&gt;</code></td>
<td></td>
<td>File that should be periodically updated if health checking is enabled (default ``)</td>
</tr>
<tr>
<td><code>--healthCheckInterval &lt;duration&gt;</code></td>
<td></td>
<td>Configure how frequently the health check file specified by --healhCheckFile should be updated (default `0s`)</td>
</tr>
<tr>
<td><code>--injectConfig &lt;string&gt;</code></td>
<td></td>
<td>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)</td>
</tr>
<tr>
<td><code>--interval &lt;duration&gt;</code></td>
<td></td>
<td>Duration used for checking the target file&#39;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 &lt;traceLocation&gt;</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 &lt;string&gt;</code></td>
<td></td>
<td>The minimum logging level of messages to output, can be one of &#34;debug&#34;, &#34;info&#34;, &#34;warn&#34;, &#34;error&#34;, or &#34;none&#34; (default `info`)</td>
</tr>
<tr>
<td><code>--log_rotate &lt;string&gt;</code></td>
<td></td>
<td>The path for the optional rotating log file (default ``)</td>
</tr>
<tr>
<td><code>--log_rotate_max_age &lt;int&gt;</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 &lt;int&gt;</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 &lt;int&gt;</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 &lt;string&gt;</code></td>
<td></td>
<td>The minimum logging level at which stack traces are captured, can be one of &#34;debug&#34;, &#34;info&#34;, &#34;warn&#34;, &#34;error&#34;, or &#34;none&#34; (default `none`)</td>
</tr>
<tr>
<td><code>--log_target &lt;stringArray&gt;</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 &lt;string&gt;</code></td>
<td></td>
<td>File containing the Istio mesh configuration (default `/etc/istio/config/mesh`)</td>
</tr>
<tr>
<td><code>--port &lt;int&gt;</code></td>
<td></td>
<td>Webhook port (default `443`)</td>
</tr>
<tr>
<td><code>--probe-path &lt;string&gt;</code></td>
<td></td>
<td>Path of the file for checking the availability. (default ``)</td>
</tr>
<tr>
<td><code>--tlsCertFile &lt;string&gt;</code></td>
<td></td>
<td>File containing the x509 Certificate for HTTPS. (default `/etc/istio/certs/cert.pem`)</td>
</tr>
<tr>
<td><code>--tlsKeyFile &lt;string&gt;</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 &lt;Level&gt;</code></td>
<td><code>-v</code></td>
<td>log level for V logs (default `0`)</td>
</tr>
<tr>
<td><code>--vmodule &lt;moduleSpec&gt;</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]
@ -113,6 +241,16 @@ number_of_entries: 3
</thead>
<tbody>
<tr>
<td><code>--healthCheckFile &lt;string&gt;</code></td>
<td></td>
<td>File that should be periodically updated if health checking is enabled (default ``)</td>
</tr>
<tr>
<td><code>--healthCheckInterval &lt;duration&gt;</code></td>
<td></td>
<td>Configure how frequently the health check file specified by --healhCheckFile should be updated (default `0s`)</td>
</tr>
<tr>
<td><code>--injectConfig &lt;string&gt;</code></td>
<td></td>
<td>File containing the Istio sidecar injection configuration and template (default `/etc/istio/inject/config`)</td>

View File

@ -58,7 +58,7 @@ be lost.</p>
<tbody>
<tr id="Params.Override.dimensions">
<td><code>dimensions</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>The specific dimensions for which this override applies.
String representation of instance dimensions is used to check against configured dimensions.</p>

View File

@ -15,7 +15,7 @@ rolling window algorithm. And it is using Redis as a shared data storage.</p>
<p>Example configuration:</p>
<p>redisServerUrl: localhost:6379
<pre><code class="language-yaml">redisServerUrl: localhost:6379
connectionPoolSize: 10
quotas:
- name: requestCount.quota.istio-system
@ -30,7 +30,8 @@ quotas:
maxAmount: 12
- dimensions:
destination: reviews
maxAmount: 5</p>
maxAmount: 5
</code></pre>
<table class="message-fields">
<thead>
@ -83,7 +84,7 @@ Default is 10 connections per every CPU as reported by runtime.NumCPU.</p>
<tbody>
<tr id="Params.Override.dimensions">
<td><code>dimensions</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>The specific dimensions for which this override applies.
String representation of instance dimensions is used to check against configured dimensions.

View File

@ -118,7 +118,7 @@ of a network failure. Default value is 1 hour.</p>
</tr>
<tr id="Params.metrics">
<td><code>metrics</code></td>
<td><code>map&lt;string, <a href="#Params.MetricInfo">Params.MetricInfo</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#Params.MetricInfo">Params.MetricInfo</a>&gt;</code></td>
<td>
<p>A map of Istio metric name to solarwinds metric info.</p>
@ -126,7 +126,7 @@ of a network failure. Default value is 1 hour.</p>
</tr>
<tr id="Params.logs">
<td><code>logs</code></td>
<td><code>map&lt;string, <a href="#Params.LogInfo">Params.LogInfo</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#Params.LogInfo">Params.LogInfo</a>&gt;</code></td>
<td>
<p>A map of Istio logentry name to solarwinds log info.</p>

View File

@ -78,7 +78,7 @@ or <code>./testdata/my-test-account-creds.json</code>.</p>
</tr>
<tr id="Params.metric_info">
<td><code>metricInfo</code></td>
<td><code>map&lt;string, <a href="#Params.MetricInfo">Params.MetricInfo</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#Params.MetricInfo">Params.MetricInfo</a>&gt;</code></td>
<td>
<p>A map of Istio metric name to Stackdriver metric info.</p>
@ -86,7 +86,7 @@ or <code>./testdata/my-test-account-creds.json</code>.</p>
</tr>
<tr id="Params.log_info">
<td><code>logInfo</code></td>
<td><code>map&lt;string, <a href="#Params.LogInfo">Params.LogInfo</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#Params.LogInfo">Params.LogInfo</a>&gt;</code></td>
<td>
<p>A map of Istio LogEntry name to Stackdriver log info.</p>

View File

@ -65,7 +65,7 @@ same (private) network 1432 bytes is recommended for better performance.</p>
</tr>
<tr id="Params.metrics">
<td><code>metrics</code></td>
<td><code>map&lt;string, <a href="#Params.MetricInfo">Params.MetricInfo</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#Params.MetricInfo">Params.MetricInfo</a>&gt;</code></td>
<td>
<p>Map of metric name -&gt; info. If a metric&rsquo;s name is not in the map then the metric will not be exported to statsd.</p>

View File

@ -36,7 +36,7 @@ STDERR is the default Stream.</p>
</tr>
<tr id="Params.severity_levels">
<td><code>severityLevels</code></td>
<td><code>map&lt;string, <a href="#Params.Level">Params.Level</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#Params.Level">Params.Level</a>&gt;</code></td>
<td>
<p>Maps from severity strings as specified in LogEntry instances to
the set of levels supported by this adapter. This defaults to a map of</p>

View File

@ -60,20 +60,31 @@ Istio service mesh.</p>
</tr>
</thead>
<tbody>
<tr id="MeshConfig.egress_proxy_address">
<td><code>egressProxyAddress</code></td>
<tr id="MeshConfig.mixer_check_server">
<td><code>mixerCheckServer</code></td>
<td><code>string</code></td>
<td>
<p>Address of the egress Envoy service (e.g. <em>istio-egress:80</em>).</p>
<p>Address of the server that will be used by the proxies for policy
check calls (e.g. <em>istio-mixer:15004</em>). By using different names for
mixerCheckServer and mixerReportServer, it is possible to have one set
of mixer servers handle policy check calls, while another set of mixer
servers handle telemetry calls.</p>
<p>NOTE: Omitting mixerCheckServer while specifying mixerReportServer is
equivalent to setting disablePolicyChecks to true.</p>
</td>
</tr>
<tr id="MeshConfig.mixer_address">
<td><code>mixerAddress</code></td>
<tr id="MeshConfig.mixer_report_server">
<td><code>mixerReportServer</code></td>
<td><code>string</code></td>
<td>
<p>Address of the mixer service (e.g. <em>istio-mixer:15004</em>).
Empty value disables Mixer checks and telemetry.</p>
<p>Address of the server that will be used by the proxies as an Istio
telemetry sink (access logs, API/connection metrics)
(e.g. <em>istio-mixer:15004</em>). By using different names for
mixerCheckServer and mixerReportServer, it is possible to have one set
of mixer servers handle policy check calls, while another set of mixer
servers handle telemetry calls.</p>
</td>
</tr>
@ -81,8 +92,7 @@ Empty value disables Mixer checks and telemetry.</p>
<td><code>disablePolicyChecks</code></td>
<td><code>bool</code></td>
<td>
<p>Disable policy checks by the mixer service. Metrics will still be
reported to the mixer for HTTP requests and TCP connections. Default
<p>Disable policy checks by the mixer service. Default
is false, i.e. mixer policy check is enabled by default.</p>
</td>
@ -197,6 +207,15 @@ It has no effect if the authentication policy is already &lsquo;NONE&rsquo;.
DO NOT use this setting for services that are managed by Istio (i.e. using Istio sidecar).
Instead, use service-level annotations to overwrite the authentication policy.</p>
</td>
</tr>
<tr id="MeshConfig.mixer_address">
<td><code>mixerAddress</code></td>
<td><code>string</code></td>
<td>
<p>DEPRECATED. Mixer address. This option will be removed soon. Please
use mixer<em>check</em>server and mixer<em>report</em>server.</p>
</td>
</tr>
</tbody>

View File

@ -55,7 +55,7 @@ enforcement within Istio. It is primarily concerned with enabling Mixer</p>
</tr>
<tr id="Action.properties">
<td><code>properties</code></td>
<td><code>map&lt;string, <a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td>
<p>Additional data about the action for use in policy.</p>
@ -99,7 +99,7 @@ the template.</p>
</tr>
<tr id="Subject.properties">
<td><code>properties</code></td>
<td><code>map&lt;string, <a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td>
<p>Additional attributes about the subject.</p>

View File

@ -40,7 +40,7 @@ to assign values to the generated attributes using the <code>$out.&lt;field name
</tr>
<tr id="OutputTemplate.source_labels">
<td><code>sourceLabels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Refers to source pod labels. attribute<em>bindings can refer to this field using $out.source</em>labels</p>
@ -96,7 +96,7 @@ to assign values to the generated attributes using the <code>$out.&lt;field name
</tr>
<tr id="OutputTemplate.destination_labels">
<td><code>destinationLabels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Refers to destination pod labels. attribute<em>bindings can refer to this field using $out.destination</em>labels</p>
@ -152,7 +152,7 @@ to assign values to the generated attributes using the <code>$out.&lt;field name
</tr>
<tr id="OutputTemplate.origin_labels">
<td><code>originLabels</code></td>
<td><code>map&lt;string, string&gt;</code></td>
<td><code>map&lt;string,&nbsp;string&gt;</code></td>
<td>
<p>Refers to origin pod labels. attribute<em>bindings can refer to this field using $out.origin</em>labels</p>

View File

@ -50,7 +50,7 @@ spec:
<tbody>
<tr id="Template.variables">
<td><code>variables</code></td>
<td><code>map&lt;string, <a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td>
<p>Variables that are delivered for each log entry.</p>
@ -84,7 +84,7 @@ Otherwise these fields will be ignored by the adapter.</p>
</tr>
<tr id="Template.monitored_resource_dimensions">
<td><code>monitoredResourceDimensions</code></td>
<td><code>map&lt;string, <a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td>
<p>Optional. A set of expressions that will form the dimensions of the monitored resource this log entry is being
recorded on. If the logging backend supports monitored resources, these fields are used to populate that resource.

View File

@ -53,7 +53,7 @@ spec:
</tr>
<tr id="Template.dimensions">
<td><code>dimensions</code></td>
<td><code>map&lt;string, <a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td>
<p>The unique identity of the particular metric to report.</p>
@ -71,7 +71,7 @@ these fields will be ignored by the adapter.</p>
</tr>
<tr id="Template.monitored_resource_dimensions">
<td><code>monitoredResourceDimensions</code></td>
<td><code>map&lt;string, <a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td>
<p>Optional. A set of expressions that will form the dimensions of the monitored resource this metric is being reported on.
If the metric backend supports monitored resources, these fields are used to populate that resource. Otherwise

View File

@ -41,7 +41,7 @@ spec:
<tbody>
<tr id="Template.dimensions">
<td><code>dimensions</code></td>
<td><code>map&lt;string, <a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="{{site.baseurl}}/docs/reference/config/mixer/istio.mixer.v1.template.html#Value">istio.mixer.v1.template.Value</a>&gt;</code></td>
<td>
<p>The unique identity of the particular quota to manipulate.</p>