istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update reference docs. (#1385)

This commit is contained in:
Martin Taillefer 2018-05-30 10:32:00 -07:00 committed by GitHub
parent a1092c7b73
commit 80d948d44c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
40 changed files with 671 additions and 329 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
content/docs/reference/commands/istio_ca.html
View File

@ -1,7 +1,7 @@
---
title: istio_ca
description: Istio Certificate Authority (CA)
layout: pkg-collateral-docs
generator: pkg-collateral-docs
number_of_entries: 4
---
<p>Istio Certificate Authority (CA)</p>

106
content/docs/reference/commands/istioctl.html
View File

@ -1,7 +1,7 @@
---
title: istioctl
description: Istio control interface
layout: pkg-collateral-docs
generator: pkg-collateral-docs
number_of_entries: 19
---
<p>
@ -9,9 +9,10 @@ Istio configuration command line utility.</p>
<p>Create, list, modify, and delete configuration resources in the Istio
system.</p>
<p>Available routing and traffic management configuration types:</p>
<p> [routerule ingressrule egressrule destinationpolicy]</p>
<p>See https://istio.io/docs/reference/ for an overview of routing rules
and destination policies.</p>
<p> [virtualservice gateway destinationrule serviceentry httpapispec httpapispecbinding quotaspec quotaspecbinding servicerole servicerolebinding policy]</p>
<p>Legacy routing and traffic management configuration types:</p>
<p> [routerule egressrule destinationpolicy]</p>
<p>See https://istio.io/docs/reference/ for an overview of Istio routing.</p>
<p></p>
<table class="command-flags">
<thead>
@ -353,8 +354,8 @@ istioctl context-create --api-server http://127.0.0.1:8080
<pre class="language-bash"><code># 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
# Delete the virtual service bookinfo
istioctl delete virtualservice bookinfo
</code></pre>
<h2 id="istioctl deregister">istioctl deregister</h2>
@ -894,7 +895,7 @@ istioctl experimental rbac can -u test GET rating /v1/health
istioctl experimental rbac can -s service=product-page POST rating /data -a version=dev
</code></pre>
<h2 id="istioctl gen-deploy">istioctl gen-deploy</h2>
<p>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.</p>
<p>istioctl gen-deploy produces deployment files to run the Istio.</p>
<pre class="language-bash"><code>istioctl gen-deploy [flags]
</code></pre>
<table class="command-flags">
@ -910,11 +911,6 @@ istioctl experimental rbac can -s service=product-page POST rating /data -a vers
<td>If true, uses debug images instead of release images </td>
</tr>
<tr>
<td><code>--features &lt;stringArray&gt;</code></td>
<td><code>-f</code></td>
<td>List of Istio features to enable. Accepts any combination of &#34;mtls&#34;, &#34;telemetry&#34;, &#34;routing&#34;, &#34;ingress&#34;, &#34;policy&#34;, &#34;sidecar-injector&#34;. (default `[]`)</td>
</tr>
<tr>
<td><code>--helm-chart-dir &lt;string&gt;</code></td>
<td></td>
<td>The directory to find the helm charts used to render Istio deployments. -o yaml uses these to render the helm chart locally. (default `.`)</td>
@ -995,11 +991,6 @@ istioctl experimental rbac can -s service=product-page POST rating /data -a vers
<td>Config namespace (default ``)</td>
</tr>
<tr>
<td><code>--out &lt;string&gt;</code></td>
<td><code>-o</code></td>
<td>Output format. Acceptable values are&#39;helm&#39; to produce contents of values.yaml or &#39;helm&#39; to produces Kubernetes deployments (default `helm`)</td>
</tr>
<tr>
<td><code>--platform &lt;string&gt;</code></td>
<td><code>-p</code></td>
<td>Istio host platform (default `kube`)</td>
@ -1012,7 +1003,7 @@ istioctl experimental rbac can -s service=product-page POST rating /data -a vers
</tbody>
</table>
<h3 id="istioctl gen-deploy Examples">Examples</h3>
<pre class="language-bash"><code>istioctl gen-deploy --features routing,policy,sidecar-injector -o helm
<pre class="language-bash"><code>istioctl gen-deploy --values myvalues.yaml
</code></pre>
<h2 id="istioctl get">istioctl get</h2>
<p>Retrieve policies and rules</p>
@ -1098,14 +1089,14 @@ istioctl experimental rbac can -s service=product-page POST rating /data -a vers
</tbody>
</table>
<h3 id="istioctl get Examples">Examples</h3>
<pre class="language-bash"><code># List all route rules
istioctl get routerules
<pre class="language-bash"><code># List all virtual services
istioctl get virtualservices
# List all destination policies
istioctl get destinationpolicies
# List all destination rules
istioctl get destinationrules
# Get a specific rule named productpage-default
istioctl get routerule productpage-default
# Get a specific virtual service named bookinfo
istioctl get virtualservice bookinfo
</code></pre>
<h2 id="istioctl kube-inject">istioctl kube-inject</h2>
@ -1138,56 +1129,11 @@ file/configmap created with a new Istio release.
</thead>
<tbody>
<tr>
<td><code>--coreDump</code></td>
<td></td>
<td>Enable/Disable core dumps in injected Envoy sidecar (--coreDump=true affects all pods in a node and should only be used the cluster admin) </td>
</tr>
<tr>
<td><code>--debug</code></td>
<td></td>
<td>Use debug images and settings for the sidecar </td>
</tr>
<tr>
<td><code>--emitTemplate</code></td>
<td></td>
<td>Emit sidecar template based on parameterized flags </td>
</tr>
<tr>
<td><code>--excludeIPRanges &lt;string&gt;</code></td>
<td></td>
<td>Comma separated list of IP ranges in CIDR form. If set, outbound traffic will not be redirected for these IP ranges. Exclusions are only applied if configured to redirect all outbound traffic. By default, no IP ranges are excluded. (default ``)</td>
</tr>
<tr>
<td><code>--excludeInboundPorts &lt;string&gt;</code></td>
<td></td>
<td>Comma separated list of inbound ports. If set, inbound traffic will not be redirected for those ports. Exclusions are only applied if configured to redirect all inbound traffic. By default, no ports are excluded. (default ``)</td>
</tr>
<tr>
<td><code>--filename &lt;string&gt;</code></td>
<td><code>-f</code></td>
<td>Input Kubernetes resource filename (default ``)</td>
</tr>
<tr>
<td><code>--hub &lt;string&gt;</code></td>
<td></td>
<td>Docker hub (default `unknown`)</td>
</tr>
<tr>
<td><code>--imagePullPolicy &lt;string&gt;</code></td>
<td></td>
<td>Sets the container image pull policy. Valid options are Always,IfNotPresent,Never.The default policy is IfNotPresent. (default `IfNotPresent`)</td>
</tr>
<tr>
<td><code>--includeIPRanges &lt;string&gt;</code></td>
<td></td>
<td>Comma separated list of IP ranges in CIDR form. If set, only redirect outbound traffic to Envoy for these IP ranges. All outbound traffic can be redirected with the wildcard character &#39;*&#39;. Defaults to &#39;*&#39;. (default `*`)</td>
</tr>
<tr>
<td><code>--includeInboundPorts &lt;string&gt;</code></td>
<td></td>
<td>Comma separated list of inbound ports for which traffic is to be redirected to Envoy. All ports can be redirected with the wildcard character &#39;*&#39;. Defaults to &#39;*&#39;. (default `*`)</td>
</tr>
<tr>
<td><code>--injectConfigFile &lt;string&gt;</code></td>
<td></td>
<td>injection configuration filename. Cannot be used with --injectConfigMapName (default ``)</td>
@ -1195,7 +1141,7 @@ file/configmap created with a new Istio release.
<tr>
<td><code>--injectConfigMapName &lt;string&gt;</code></td>
<td></td>
<td>ConfigMap name for Istio sidecar injection, key should be &#34;config&#34;.This option overrides any other sidecar injection config options, eg. --hub (default ``)</td>
<td>ConfigMap name for Istio sidecar injection, key should be &#34;config&#34;.This option overrides any other sidecar injection config options, eg. --hub (default `istio-sidecar-injector`)</td>
</tr>
<tr>
<td><code>--istioNamespace &lt;string&gt;</code></td>
@ -1277,26 +1223,6 @@ file/configmap created with a new Istio release.
<td><code>-p</code></td>
<td>Istio host platform (default `kube`)</td>
</tr>
<tr>
<td><code>--setVersionString &lt;string&gt;</code></td>
<td></td>
<td>Override version info injected into resource (default ``)</td>
</tr>
<tr>
<td><code>--sidecarProxyUID &lt;uint&gt;</code></td>
<td></td>
<td>Envoy sidecar UID (default `1337`)</td>
</tr>
<tr>
<td><code>--tag &lt;string&gt;</code></td>
<td></td>
<td>Docker tag (default `unknown`)</td>
</tr>
<tr>
<td><code>--verbosity &lt;int&gt;</code></td>
<td></td>
<td>Runtime verbosity (default `2`)</td>
</tr>
</tbody>
</table>
<h3 id="istioctl kube-inject Examples">Examples</h3>

2
content/docs/reference/commands/mixc.html
View File

@ -1,7 +1,7 @@
---
title: mixc
description: Utility to trigger direct calls to Mixer&#39;s API.
layout: pkg-collateral-docs
generator: pkg-collateral-docs
number_of_entries: 5
---
<p>This command lets you interact with a running instance of

19
content/docs/reference/commands/mixs.html
View File

@ -1,7 +1,7 @@
---
title: mixs
description: Mixer is Istio&#39;s abstraction on top of infrastructure backends.
layout: pkg-collateral-docs
generator: pkg-collateral-docs
number_of_entries: 9
---
<p>Mixer is Istio&#39;s point of integration with infrastructure backends and is the
@ -40,11 +40,11 @@ nexus for policy evaluation and telemetry reporting.</p>
</tr>
<tr>
<td><code>--log_caller &lt;string&gt;</code></td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [adapters, attributes, default] (default ``)</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 &lt;string&gt;</code></td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [adapters, attributes, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... 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 &lt;string&gt;</code></td>
@ -64,7 +64,7 @@ nexus for policy evaluation and telemetry reporting.</p>
</tr>
<tr>
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [adapters, attributes, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... 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 &lt;stringArray&gt;</code></td>
@ -113,6 +113,11 @@ nexus for policy evaluation and telemetry reporting.</p>
<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 &lt;string&gt;</code></td>
<td></td>
<td>The IP Address to listen on for the ControlZ introspection facility. Use &#39;*&#39; to indicate all addresses. (default `127.0.0.1`)</td>
</tr>
<tr>
<td><code>--ctrlz_port &lt;uint16&gt;</code></td>
<td></td>
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</td>
@ -135,12 +140,12 @@ nexus for policy evaluation and telemetry reporting.</p>
<tr>
<td><code>--log_caller &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [adapters, attributes, default] (default ``)</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 &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [adapters, attributes, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... 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 &lt;string&gt;</code></td>
@ -165,7 +170,7 @@ nexus for policy evaluation and telemetry reporting.</p>
<tr>
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [adapters, attributes, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... 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 &lt;stringArray&gt;</code></td>

2
content/docs/reference/commands/node_agent.html
View File

@ -1,7 +1,7 @@
---
title: node_agent
description: Istio security per-node agent
layout: pkg-collateral-docs
generator: pkg-collateral-docs
number_of_entries: 3
---
<p>Istio security per-node agent</p>

4
content/docs/reference/commands/pilot-agent.html
View File

@ -1,7 +1,7 @@
---
title: pilot-agent
description: Istio Pilot agent
layout: pkg-collateral-docs
generator: pkg-collateral-docs
number_of_entries: 5
---
<p>Istio Pilot agent runs in the side car or gateway container and bootstraps envoy.</p>
@ -213,7 +213,7 @@ number_of_entries: 5
</tr>
<tr>
<td><code>--proxyLogLevel &lt;string&gt;</code></td>
<td>The log level used to start the Envoy proxy (choose from {trace, debug, info, warn, err, critical, off}) (default `info`)</td>
<td>The log level used to start the Envoy proxy (choose from {trace, debug, info, warn, err, critical, off}) (default `warn`)</td>
</tr>
<tr>
<td><code>--serviceCluster &lt;string&gt;</code></td>

62
content/docs/reference/commands/pilot-discovery.html
View File

@ -1,7 +1,7 @@
---
title: pilot-discovery
description: Istio Pilot
layout: pkg-collateral-docs
generator: pkg-collateral-docs
number_of_entries: 5
---
<p>Istio Pilot provides fleet-wide traffic management capabilities in the Istio Service Mesh.</p>
@ -12,16 +12,24 @@ number_of_entries: 5
</thead>
<tbody>
<tr>
<td><code>--ctrlz_address &lt;string&gt;</code></td>
<td>The IP Address to listen on for the ControlZ introspection facility. Use &#39;*&#39; to indicate all addresses. (default `127.0.0.1`)</td>
</tr>
<tr>
<td><code>--ctrlz_port &lt;uint16&gt;</code></td>
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</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 &lt;string&gt;</code></td>
<td>Comma-separated list of scopes for which to include called information, scopes can be any of [default] (default ``)</td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default] (default ``)</td>
</tr>
<tr>
<td><code>--log_output_level &lt;string&gt;</code></td>
<td>The minimum logging level of messages to output, can be one of [debug, info, warn, error, none] (default `default:info`)</td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
</tr>
<tr>
<td><code>--log_rotate &lt;string&gt;</code></td>
@ -41,7 +49,7 @@ number_of_entries: 5
</tr>
<tr>
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
<td>The minimum logging level at which stack traces are captured, can be one of [debug, info, warn, error, none] (default `default:none`)</td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
</tr>
<tr>
<td><code>--log_target &lt;stringArray&gt;</code></td>
@ -60,16 +68,24 @@ number_of_entries: 5
</thead>
<tbody>
<tr>
<td><code>--ctrlz_address &lt;string&gt;</code></td>
<td>The IP Address to listen on for the ControlZ introspection facility. Use &#39;*&#39; to indicate all addresses. (default `127.0.0.1`)</td>
</tr>
<tr>
<td><code>--ctrlz_port &lt;uint16&gt;</code></td>
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</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 &lt;string&gt;</code></td>
<td>Comma-separated list of scopes for which to include called information, scopes can be any of [default] (default ``)</td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default] (default ``)</td>
</tr>
<tr>
<td><code>--log_output_level &lt;string&gt;</code></td>
<td>The minimum logging level of messages to output, can be one of [debug, info, warn, error, none] (default `default:info`)</td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
</tr>
<tr>
<td><code>--log_rotate &lt;string&gt;</code></td>
@ -89,7 +105,7 @@ number_of_entries: 5
</tr>
<tr>
<td><code>--log_stacktrace_level &lt;string&gt;</code></td>
<td>The minimum logging level at which stack traces are captured, can be one of [debug, info, warn, error, none] (default `default:none`)</td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
</tr>
<tr>
<td><code>--log_target &lt;stringArray&gt;</code></td>
@ -144,6 +160,16 @@ number_of_entries: 5
<td>URL for the Consul server (default ``)</td>
</tr>
<tr>
<td><code>--ctrlz_address &lt;string&gt;</code></td>
<td></td>
<td>The IP Address to listen on for the ControlZ introspection facility. Use &#39;*&#39; to indicate all addresses. (default `127.0.0.1`)</td>
</tr>
<tr>
<td><code>--ctrlz_port &lt;uint16&gt;</code></td>
<td></td>
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</td>
</tr>
<tr>
<td><code>--discovery_cache</code></td>
<td></td>
<td>Enable caching discovery service responses </td>
@ -181,12 +207,12 @@ number_of_entries: 5
<tr>
<td><code>--log_caller &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated list of scopes for which to include called information, scopes can be any of [default] (default ``)</td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default] (default ``)</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 [debug, info, warn, error, none] (default `default:info`)</td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
</tr>
<tr>
<td><code>--log_rotate &lt;string&gt;</code></td>
@ -211,7 +237,7 @@ number_of_entries: 5
<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 [debug, info, warn, error, none] (default `default:none`)</td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
</tr>
<tr>
<td><code>--log_target &lt;stringArray&gt;</code></td>
@ -277,6 +303,16 @@ number_of_entries: 5
</thead>
<tbody>
<tr>
<td><code>--ctrlz_address &lt;string&gt;</code></td>
<td></td>
<td>The IP Address to listen on for the ControlZ introspection facility. Use &#39;*&#39; to indicate all addresses. (default `127.0.0.1`)</td>
</tr>
<tr>
<td><code>--ctrlz_port &lt;uint16&gt;</code></td>
<td></td>
<td>The IP port to use for the ControlZ introspection facility (default `9876`)</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>
@ -284,12 +320,12 @@ number_of_entries: 5
<tr>
<td><code>--log_caller &lt;string&gt;</code></td>
<td></td>
<td>Comma-separated list of scopes for which to include called information, scopes can be any of [default] (default ``)</td>
<td>Comma-separated list of scopes for which to include caller information, scopes can be any of [ads, default] (default ``)</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 [debug, info, warn, error, none] (default `default:info`)</td>
<td>Comma-separated minimum per-scope logging level of messages to output, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope&gt;:&lt;level&gt;,... where scope can be one of [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:info`)</td>
</tr>
<tr>
<td><code>--log_rotate &lt;string&gt;</code></td>
@ -314,7 +350,7 @@ number_of_entries: 5
<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 [debug, info, warn, error, none] (default `default:none`)</td>
<td>Comma-separated minimum per-scope logging level at which stack traces are captured, in the form of &lt;scope&gt;:&lt;level&gt;,&lt;scope:level&gt;,... where scope can be one of [ads, default] and level can be one of [debug, info, warn, error, none] (default `default:none`)</td>
</tr>
<tr>
<td><code>--log_target &lt;stringArray&gt;</code></td>

2
content/docs/reference/commands/sidecar-injector.html
View File

@ -1,7 +1,7 @@
---
title: sidecar-injector
description: Kubernetes webhook for automatic Istio sidecar injection
layout: pkg-collateral-docs
generator: pkg-collateral-docs
number_of_entries: 4
---
<p>Kubernetes webhook for automatic Istio sidecar injection</p>

99
content/docs/reference/config/istio.networking.v1alpha3.html
View File

@ -3,6 +3,7 @@ title: Route Rules v1alpha3
description: Configuration affecting traffic routing
location: https://istio.io/docs/reference/config/istio.networking.v1alpha3.html
layout: protoc-gen-docs
generator: protoc-gen-docs
number_of_entries: 39
---
<p>Configuration affecting traffic routing. Here are a few terms useful to define
@ -441,15 +442,9 @@ DestinationRule.</p>
<td><code>port</code></td>
<td><code><a href="#PortSelector">PortSelector</a></code></td>
<td>
<p>Specifies the port on the host that is being addressed. Many services
only expose a single port or label ports with the protocols they support,
in these cases it is not required to explicitly select the port. Note that
selection priority is to first match by name and then match by number.</p>
<p>Names must comply with DNS label syntax (rfc1035) and therefore cannot
collide with numbers. If there are multiple ports on a service with
the same protocol the names should be of the form <protocol-name>-<DNS
label>.</p>
<p>Specifies the port on the host that is being addressed. If a service
exposes only a single port it is not required to explicitly select the
port.</p>
</td>
</tr>
@ -745,7 +740,7 @@ the forwarding of traffic arriving at a particular host or gateway port.</p>
an internal reviews service on port 9080. In addition, requests
containing the cookie &ldquo;user: dev-123&rdquo; will be sent to special port 7777
in the qa version. The same rule is also applicable inside the mesh for
requests to the r&rdquo;eviews.prod.svc.cluster.local&rdquo; service. This rule is
requests to the &ldquo;reviews.prod.svc.cluster.local&rdquo; service. This rule is
applicable across ports 443, 9080. Note that &ldquo;http://uk.bookinfo.com&rdquo;
gets redirected to &ldquo;https://uk.bookinfo.com&rdquo; (i.e. 80 redirects to 443).</p>
@ -770,7 +765,7 @@ spec:
- destination:
port:
number: 7777
host: reviews.qa.svc.cluster.local
name: reviews.qa.svc.cluster.local
- match:
uri:
prefix: /reviews/
@ -781,7 +776,7 @@ spec:
name: reviews.prod.svc.cluster.local
weight: 80
- destination:
host: reviews.qa.svc.cluster.local
name: reviews.qa.svc.cluster.local
weight: 20
</code></pre>
@ -806,7 +801,7 @@ spec:
sourceSubnet: &quot;172.17.16.0/24&quot;
route:
- destination:
host: mongo.prod.svc.cluster.local
name: mongo.prod.svc.cluster.local
</code></pre>
<table class="message-fields">
@ -934,22 +929,6 @@ not specified, all requests are aborted.</p>
<td>
<p>REQUIRED. HTTP status code to use to abort the Http request.</p>
</td>
</tr>
<tr id="HTTPFaultInjection.Abort.grpc_status" class="oneof">
<td><code>grpcStatus</code></td>
<td><code>string (oneof)</code></td>
<td>
<p>(&ndash; NOT IMPLEMENTED &ndash;)</p>
</td>
</tr>
<tr id="HTTPFaultInjection.Abort.http2_error" class="oneof">
<td><code>http2Error</code></td>
<td><code>string (oneof)</code></td>
<td>
<p>(&ndash; NOT IMPLEMENTED &ndash;)</p>
</td>
</tr>
</tbody>
@ -1012,16 +991,6 @@ unspecified, all request will be delayed.</p>
<p>REQUIRED. Add a fixed delay before forwarding the request. Format:
1h/1m/1s/1ms. MUST be &gt;=1ms.</p>
</td>
</tr>
<tr id="HTTPFaultInjection.Delay.exponential_delay" class="oneof">
<td><code>exponentialDelay</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration (oneof)</a></code></td>
<td>
<p>(&ndash; Add a delay (based on an exponential function) before forwarding
the request. mean delay needed to derive the exponential delay
values &ndash;)</p>
</td>
</tr>
</tbody>
@ -1861,7 +1830,7 @@ TCP-TLS is used to indicate secure connections to non HTTP services.</p>
</section>
<h2 id="PortSelector">PortSelector</h2>
<section>
<p>PortSelector specifies the name or number of a port to be used for
<p>PortSelector specifies the number of a port to be used for
matching or selection for final routing.</p>
<table class="message-fields">
@ -1879,14 +1848,6 @@ matching or selection for final routing.</p>
<td>
<p>Valid port number</p>
</td>
</tr>
<tr id="PortSelector.name" class="oneof">
<td><code>name</code></td>
<td><code>string (oneof)</code></td>
<td>
<p>Port name</p>
</td>
</tr>
</tbody>
@ -1978,7 +1939,9 @@ connections</p>
<p>REQUIRED. A list of hosts exposed by this gateway. At least one
host is required. While typically applicable to
HTTP services, it can also be used for TCP services using TLS with
SNI. Standard DNS wildcard prefix syntax is permitted.</p>
SNI. May contain a wildcard prefix for the bottom-level component of
a domain name. For example <code>*.foo.com</code> matches <code>bar.foo.com</code>
and <code>*.com</code> matches <code>bar.foo.com</code>, <code>example.com</code>, and so on.</p>
<p><strong>Note</strong>: A <code>VirtualService</code> that is bound to a gateway must have one
or more hosts that match the hosts specified in a server. The match
@ -2182,6 +2145,27 @@ spec:
resolution: NONE
</code></pre>
<p>The following example demonstrates a service that is available via a
Unix Domain Socket on the host of the client. The resolution must be
set to STATIC to use unix address endpoints.</p>
<pre><code>apiVersion: networking.istio.io/v1alpha3
kind: ServiceEntry
metadata:
name: unix-domain-socket-example
spec:
hosts:
- &quot;example.unix.local&quot;
location: MESH_EXTERNAL
ports:
- number: 80
name: http
protocol: HTTP
resolution: STATIC
endpoints:
- address: unix:///var/run/example/socket
</code></pre>
<p>For HTTP based services, it is possible to create a VirtualService
backed by multiple DNS addressable endpoints. In such a scenario, the
application can use the HTTP_PROXY environment variable to transparently
@ -2272,7 +2256,8 @@ solely based on the destination port. In such scenarios, the port on
which the service is being accessed must not be shared by any other
service in the mesh. In other words, the sidecar will behave as a
simple TCP proxy, forwarding incoming traffic on a specified port to
the specified destination endpoint IP/host.</p>
the specified destination endpoint IP/host. Unix domain socket
addresses are not supported in this field.</p>
</td>
</tr>
@ -2280,7 +2265,9 @@ the specified destination endpoint IP/host.</p>
<td><code>ports</code></td>
<td><code><a href="#Port">Port[]</a></code></td>
<td>
<p>REQUIRED. The ports associated with the external service.</p>
<p>REQUIRED. The ports associated with the external service. If the
Endpoints are unix domain socket addresses, there must be exactly one
port.</p>
</td>
</tr>
@ -2332,8 +2319,9 @@ the mesh service.</p>
<td><code>string</code></td>
<td>
<p>REQUIRED: Address associated with the network endpoint without the
port ( IP or fully qualified domain name without wildcards). Domain
names can be used if and only if the resolution is set to DNS.</p>
port. Domain names can be used if and only if the resolution is set
to DNS, and must be fully-qualified without wildcards. Use the form
unix:///absolute/path/to/socket for unix domain socket endpoints.</p>
</td>
</tr>
@ -2343,7 +2331,7 @@ names can be used if and only if the resolution is set to DNS.</p>
<td>
<p>Set of ports associated with the endpoint. The ports must be
associated with a port name that was declared as part of the
service.</p>
service. Do not use for unix:// addresses.</p>
</td>
</tr>
@ -2444,7 +2432,8 @@ during request processing. If no endpoints are specified, the proxy
will resolve the DNS address specified in the hosts field, if
wildcards are not used. If endpoints are specified, the DNS
addresses specified in the endpoints will be resolved to determine
the destination IP address.</p>
the destination IP address. DNS resolution cannot be used with unix
domain socket endpoints.</p>
</td>
</tr>

1
content/docs/reference/config/istio.rbac.v1alpha1.html
View File

@ -3,6 +3,7 @@ title: RBAC
description: Configuration for Role Based Access Control
location: https://istio.io/docs/reference/config/istio.rbac.v1alpha1.html
layout: protoc-gen-docs
generator: protoc-gen-docs
number_of_entries: 9
---
<p>Istio RBAC (Role Based Access Control) defines ServiceRole and ServiceRoleBinding

6
content/docs/reference/config/istio.routing.v1alpha1.html
View File

@ -1,11 +1,15 @@
---
title: Route Rules v1alpha1
title: Route Rules v1alpha1 (deprecated)
description: Configuration affecting traffic routing
location: https://istio.io/docs/reference/config/istio.routing.v1alpha1.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/traffic-rules/routing-rules.html
number_of_entries: 28
---
<p><strong>Note: This version of the traffic management API has been deprecated and will
not be supported after Istio 0.8.</strong></p>
<p>Configuration affecting traffic routing. Here are a few terms useful to define
in the context of routing rules.</p>

3
content/docs/reference/config/policy-and-telemetry/adapters/circonus.html
View File

@ -4,7 +4,8 @@ description: Adapter for circonus.com's monitoring solution.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/circonus.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/circonus.html
aliases:
- /docs/reference/config/adapters/circonus.html
number_of_entries: 3
---
<p>The <code>circonus</code> adapter enables Istio to deliver metric data to the

6
content/docs/reference/config/policy-and-telemetry/adapters/cloudwatch.html
View File

@ -4,7 +4,8 @@ description: Adapter for cloudwatch metrics.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/cloudwatch.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/cloudwatch.html
aliases:
- /docs/reference/config/adapters/cloudwatch.html
number_of_entries: 3
---
<p>The CloudWatch adapter enables Istio to deliver metrics to
@ -13,9 +14,6 @@ number_of_entries: 3
<p>To push metrics to CloudWatch using this adapter you must provide AWS credentials the AWS SDK.
(see <a href="https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html">AWS docs</a>).</p>
<p>To activate the CloudWatch adapter, operators need to provide configuration for the
<a href="/docs/reference/config/policy-and-telemetry/adapters/cloudwatch/">cloudwatch adapter</a>.</p>
<p>The handler configuration must contain the same metrics as the instance configuration.
The metrics specified in both instance and handler configurations will be sent to CloudWatch.</p>

3
content/docs/reference/config/policy-and-telemetry/adapters/datadog.html
View File

@ -4,7 +4,8 @@ description: Adapter to deliver metrics to a dogstatsd agent for delivery to Dat
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/datadog.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/datadog.html
aliases:
- /docs/reference/config/adapters/datadog.html
number_of_entries: 3
---
<p>The <code>dogstatsd</code> adapter is designed to deliver Istio metric instances to a

3
content/docs/reference/config/policy-and-telemetry/adapters/denier.html
View File

@ -4,7 +4,8 @@ description: Adapter that always returns a precondition denial.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/denier.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/denier.html
aliases:
- /docs/reference/config/adapters/denier.html
number_of_entries: 2
---
<p>The <code>denier</code> adapter is designed to always return a denial to precondition

3
content/docs/reference/config/policy-and-telemetry/adapters/fluentd.html
View File

@ -4,7 +4,8 @@ description: Adapter that delivers logs to a fluentd daemon.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/fluentd.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/fluentd.html
aliases:
- /docs/reference/config/adapters/fluentd.html
number_of_entries: 1
---
<p>The <code>fluentd</code> adapter is designed to deliver Istio log entries to a

3
content/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv.html
View File

@ -4,7 +4,8 @@ description: Adapter that extracts information from a Kubernetes environment.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/kubernetesenv.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/kubernetesenv.html
aliases:
- /docs/reference/config/adapters/kubernetesenv.html
number_of_entries: 1
---
<p>The <code>kubernetesenv</code> adapter extracts information from a Kubernetes environment

3
content/docs/reference/config/policy-and-telemetry/adapters/list.html
View File

@ -4,7 +4,8 @@ description: Adapter that performs whitelist or blacklist checks
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/list.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/list.html
aliases:
- /docs/reference/config/adapters/list.html
number_of_entries: 2
---
<p>The <code>list</code> adapter makes it possible to perform simple whitelist or blacklist

3
content/docs/reference/config/policy-and-telemetry/adapters/memquota.html
View File

@ -4,7 +4,8 @@ description: Adapter for a simple in-memory quota management system.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/memquota.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/memquota.html
aliases:
- /docs/reference/config/adapters/memquota.html
number_of_entries: 3
---
<p>The <code>memquota</code> adapter can be used to support Istio&rsquo;s quota management

3
content/docs/reference/config/policy-and-telemetry/adapters/opa.html
View File

@ -4,7 +4,8 @@ description: Adapter that implements an Open Policy Agent engine
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/opa.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/opa.html
aliases:
- /docs/reference/config/adapters/opa.htm l
number_of_entries: 1
---
<p>The <code>opa</code> adapter exposes an <a href="http://www.openpolicyagent.org">Open Policy Agent</a> engine

7
content/docs/reference/config/policy-and-telemetry/adapters/prometheus.html
View File

@ -3,11 +3,16 @@ title: Prometheus
description: Adapter that exposes Istio metrics for ingestion by a Prometheus harvester.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/prometheus.html
layout: protoc-gen-docs
generator: protoc-gen-docs
aliases:
- /docs/reference/config/adapters/prometheus.html
number_of_entries: 7
---
<p>The <code>prometheus</code> adapter collects Istio metrics and makes them available to
<a href="https://prometheus.io">Prometheus</a>.</p>
<p>This adapter supports the <a href="/docs/reference/config/policy-and-telemetry/templates/metric/">metric template</a>.</p>
<h2 id="Params">Params</h2>
<section>
<p>Configuration format for the <code>prometheus</code> adapter.</p>
@ -56,7 +61,7 @@ the full metric name becomes &ldquo;istio</em>request_count&rdquo;.
NOTE: The specificed namespace should be a prometheus-safe name. If not, the adapter
will attempt to convert the namespace to a prometheus-safe name.
NOTE: Changing the value for this will potentially impact downstream integrations
and should be used with caution.<br />
and should be used with caution.
Default value: &ldquo;istio&rdquo;.</p>
</td>

3
content/docs/reference/config/policy-and-telemetry/adapters/rbac.html
View File

@ -4,7 +4,8 @@ description: Adapter that exposes Istio's Role-Based Access Control model.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/rbac.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/rbac.html
aliases:
- /docs/reference/config/adapters/rbac.html
number_of_entries: 1
---
<p>The <code>rbac</code> adapter provides Role-Based Access Control (RBAC) functionality for

3
content/docs/reference/config/policy-and-telemetry/adapters/redisquota.html
View File

@ -4,7 +4,8 @@ description: Adapter for a Redis-based quota management system.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/redisquota.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/redisquota.html
aliases:
- /docs/reference/config/adapters/redisquota.html
number_of_entries: 4
---
<p>The <code>redisquota</code> adapter can be used to support Istio&rsquo;s quota management

3
content/docs/reference/config/policy-and-telemetry/adapters/servicecontrol.html
View File

@ -4,7 +4,8 @@ description: Adapter that delivers logs and metrics to Google Service Control
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/servicecontrol.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/servicecontrol.html
aliases:
- /docs/reference/config/adapters/servicecontrol.html
number_of_entries: 4
---
<p>The <code>servicecontrol</code> adapter delivers logs and metrics to

3
content/docs/reference/config/policy-and-telemetry/adapters/solarwinds.html
View File

@ -4,7 +4,8 @@ description: Adapter to deliver logs and metrics to Papertrail and AppOptics bac
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/solarwinds.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/solarwinds.html
aliases:
- /docs/reference/config/adapters/solarwinds.html
number_of_entries: 3
---
<p>The <code>solarwinds</code> adapter enables Istio to deliver log and metric data to the

35
content/docs/reference/config/policy-and-telemetry/adapters/stackdriver.html
View File

@ -4,7 +4,8 @@ description: Adapter to deliver logs and metrics to Stackdriver
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/stackdriver.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/stackdriver.html
aliases:
- /docs/reference/config/adapters/stackdriver.html
number_of_entries: 11
---
<p>The <code>stackdriver</code> adapter enables Istio to deliver log and metric data to the
@ -211,6 +212,38 @@ See https://godoc.org/cloud.google.com/go/logging#HTTPRequest</p>
<td>
<p>template variable name to map into HTTPRequest.RemoteIP</p>
</td>
</tr>
<tr id="Params.LogInfo.HttpRequestMapping.url">
<td><code>url</code></td>
<td><code>string</code></td>
<td>
<p>template variable name to map into HTTPRequest.Request.Url</p>
</td>
</tr>
<tr id="Params.LogInfo.HttpRequestMapping.method">
<td><code>method</code></td>
<td><code>string</code></td>
<td>
<p>template variable name to map into HTTPRequest.RequestMethod</p>
</td>
</tr>
<tr id="Params.LogInfo.HttpRequestMapping.user_agent">
<td><code>userAgent</code></td>
<td><code>string</code></td>
<td>
<p>template variable name to map into HTTPRequest.UserAgent</p>
</td>
</tr>
<tr id="Params.LogInfo.HttpRequestMapping.referer">
<td><code>referer</code></td>
<td><code>string</code></td>
<td>
<p>template variable name to map into HTTPRequest.Referer</p>
</td>
</tr>
</tbody>

3
content/docs/reference/config/policy-and-telemetry/adapters/statsd.html
View File

@ -4,7 +4,8 @@ description: Adapter to deliver metrics to a StatsD backend
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/statsd.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/statsd.html
aliases:
- /docs/reference/config/adapters/statsd.html
number_of_entries: 3
---
<p>The <code>statsd</code> adapter enables Istio to deliver metric data to a

3
content/docs/reference/config/policy-and-telemetry/adapters/stdio.html
View File

@ -4,7 +4,8 @@ description: Adapter for outputting logs and metrics locally.
location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/stdio.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/stdio.html
aliases:
- /docs/reference/config/adapters/stdio.html
number_of_entries: 3
---
<p>The <code>stdio</code> adapter enables Istio to output logs and metrics to

276
content/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html
View File

@ -4,7 +4,7 @@ description: Describes the rules used to configure Mixer's policy and telemetry
location: https://istio.io/docs/reference/config/policy-and-telemetry/istio.policy.v1beta1.html
layout: protoc-gen-docs
generator: protoc-gen-docs
number_of_entries: 8
number_of_entries: 15
---
<p>Describes the rules used to configure Mixer&rsquo;s policy and telemetry features.</p>
@ -200,6 +200,91 @@ Connection is part of the handler custom resource and is specified alongside ada
<td>
<p>The address of the backend.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="DNSName">DNSName</h2>
<section>
<p>An instance field of type DNSName denotes that the expression for the field must evalaute to
<a href="#ValueType.DNS_NAME">ValueType.DNS_NAME</a></p>
<p>Objects of type DNSName are also passed to the adapters during request-time for the instance fields of
type DNSName</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="DNSName.value">
<td><code>value</code></td>
<td><code>string</code></td>
<td>
<p>DNSName encoded as string.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Duration">Duration</h2>
<section>
<p>An instance field of type Duration denotes that the expression for the field must evalaute to
<a href="#ValueType.DURATION">ValueType.DURATION</a></p>
<p>Objects of type Duration are also passed to the adapters during request-time for the instance fields of
type Duration</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Duration.value">
<td><code>value</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a></code></td>
<td>
<p>Duration encoded as google.protobuf.Duration.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="EmailAddress">EmailAddress</h2>
<section>
<p>DO NOT USE !! Under Development
An instance field of type EmailAddress denotes that the expression for the field must evalaute to
<a href="#ValueType.EMAIL_ADDRESS">ValueType.EMAIL_ADDRESS</a></p>
<p>Objects of type EmailAddress are also passed to the adapters during request-time for the instance fields of
type EmailAddress</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="EmailAddress.value">
<td><code>value</code></td>
<td><code>string</code></td>
<td>
<p>EmailAddress encoded as string.</p>
</td>
</tr>
</tbody>
@ -301,6 +386,34 @@ proto defined by the adapter implementation; this varies depending on the value
<p>Optional. Information on how to connect to the out-of-process adapter.
This is used if the adapter is not compiled into Mixer binary and is running as a separate process.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="IPAddress">IPAddress</h2>
<section>
<p>An instance field of type IPAddress denotes that the expression for the field must evalaute to
<a href="#ValueType.IP_ADDRESS">ValueType.IP_ADDRESS</a></p>
<p>Objects of type IPAddress are also passed to the adapters during request-time for the instance fields of
type IPAddress</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="IPAddress.value">
<td><code>value</code></td>
<td><code>bytes</code></td>
<td>
<p>IPAddress encoded as bytes.</p>
</td>
</tr>
</tbody>
@ -419,6 +532,167 @@ name starts with &ldquo;ratings&rdquo;</li>
<td>
<p>Optional. The actions that will be executed when match evaluates to <code>true</code>.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="TimeStamp">TimeStamp</h2>
<section>
<p>An instance field of type TimeStamp denotes that the expression for the field must evalaute to
<a href="#ValueType.TIMESTAMP">ValueType.TIMESTAMP</a></p>
<p>Objects of type TimeStamp are also passed to the adapters during request-time for the instance fields of
type TimeStamp</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="TimeStamp.value">
<td><code>value</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp">google.protobuf.Timestamp</a></code></td>
<td>
<p>TimeStamp encoded as google.protobuf.Timestamp.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Uri">Uri</h2>
<section>
<p>DO NOT USE !! Under Development
An instance field of type Uri denotes that the expression for the field must evalaute to
<a href="#ValueType.URI">ValueType.URI</a></p>
<p>Objects of type Uri are also passed to the adapters during request-time for the instance fields of
type Uri</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Uri.value">
<td><code>value</code></td>
<td><code>string</code></td>
<td>
<p>Uri encoded as string.</p>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="Value">Value</h2>
<section>
<p>An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any
<a href="#ValueType">ValueType</a> enum values. For example, when
authoring an instance configuration for a template that has a field <code>data</code> of type <code>istio.policy.v1beta1.Value</code>,
both of the following expressions are valid <code>data: source.ip | ip(&quot;0.0.0.0&quot;)</code>, <code>data: request.id | &quot;&quot;</code>;
the resulting type is either ValueType.IP_ADDRESS or ValueType.STRING for the two cases respectively.</p>
<p>Objects of type Value are also passed to the adapters during request-time. There is a 1:1 mapping between
oneof fields in <code>Value</code> and enum values inside <code>ValueType</code>. Depending on the expression&rsquo;s evaluated <code>ValueType</code>,
the equivalent oneof field in <code>Value</code> is populated by Mixer and passed to the adapters.</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr id="Value.string_value" class="oneof oneof-start">
<td><code>stringValue</code></td>
<td><code>string (oneof)</code></td>
<td>
<p>Used for values of type STRING</p>
</td>
</tr>
<tr id="Value.int64_value" class="oneof">
<td><code>int64Value</code></td>
<td><code>int64 (oneof)</code></td>
<td>
<p>Used for values of type INT64</p>
</td>
</tr>
<tr id="Value.double_value" class="oneof">
<td><code>doubleValue</code></td>
<td><code>double (oneof)</code></td>
<td>
<p>Used for values of type DOUBLE</p>
</td>
</tr>
<tr id="Value.bool_value" class="oneof">
<td><code>boolValue</code></td>
<td><code>bool (oneof)</code></td>
<td>
<p>Used for values of type BOOL</p>
</td>
</tr>
<tr id="Value.ip_address_value" class="oneof">
<td><code>ipAddressValue</code></td>
<td><code><a href="#IPAddress">IPAddress (oneof)</a></code></td>
<td>
<p>Used for values of type IPAddress</p>
</td>
</tr>
<tr id="Value.timestamp_value" class="oneof">
<td><code>timestampValue</code></td>
<td><code><a href="#TimeStamp">TimeStamp (oneof)</a></code></td>
<td>
<p>Used for values of type TIMESTAMP</p>
</td>
</tr>
<tr id="Value.duration_value" class="oneof">
<td><code>durationValue</code></td>
<td><code><a href="#Duration">Duration (oneof)</a></code></td>
<td>
<p>Used for values of type DURATION</p>
</td>
</tr>
<tr id="Value.email_address_value" class="oneof">
<td><code>emailAddressValue</code></td>
<td><code><a href="#EmailAddress">EmailAddress (oneof)</a></code></td>
<td>
<p>Used for values of type EmailAddress</p>
</td>
</tr>
<tr id="Value.dns_name_value" class="oneof">
<td><code>dnsNameValue</code></td>
<td><code><a href="#DNSName">DNSName (oneof)</a></code></td>
<td>
<p>Used for values of type DNSName</p>
</td>
</tr>
<tr id="Value.uri_value" class="oneof">
<td><code>uriValue</code></td>
<td><code><a href="#Uri">Uri (oneof)</a></code></td>
<td>
<p>Used for values of type Uri</p>
</td>
</tr>
</tbody>

15
content/docs/reference/config/policy-and-telemetry/templates/apikey.html
View File

@ -4,7 +4,8 @@ description: A template that represents a single API key.
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/apikey.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/template/apikey.html
aliases:
- /docs/reference/config/template/apikey.html
number_of_entries: 2
---
<p>The <code>apikey</code> template represents a single API key, which is used for authorization checks.</p>
@ -71,7 +72,7 @@ spec:
</tr>
<tr id="Template.timestamp">
<td><code>timestamp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp</a></code></td>
<td><code><a href="#istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
<td>
<p>Timestamp of API call.</p>
@ -80,9 +81,13 @@ spec:
</tbody>
</table>
</section>
<h2 id="istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp</h2>
<h2 id="istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp</h2>
<section>
<p>TimeStamp is used inside templates for fields that are of ValueType &ldquo;TIMESTAMP&rdquo;</p>
<p>An instance field of type TimeStamp denotes that the expression for the field must evalaute to
<em>ValueType.TIMESTAMP</em></p>
<p>Objects of type TimeStamp are also passed to the adapters during request-time for the instance fields of
type TimeStamp</p>
<table class="message-fields">
<thead>
@ -93,7 +98,7 @@ spec:
</tr>
</thead>
<tbody>
<tr id="istio.mixer.adapter.model.v1beta1.TimeStamp.value">
<tr id="istio.policy.v1beta1.TimeStamp.value">
<td><code>value</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp">google.protobuf.Timestamp</a></code></td>
<td>

52
content/docs/reference/config/policy-and-telemetry/templates/authorization.html
View File

@ -4,7 +4,8 @@ description: A template used to represent an access control query.
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/authorization.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/template/authorization.html
aliases:
- /docs/reference/config/template/authorization.html
number_of_entries: 4
---
<p>The <code>authorization</code> template defines parameters for performing policy
@ -79,7 +80,7 @@ spec:
</tr>
<tr id="Action.properties">
<td><code>properties</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</a>&gt;</code></td>
<td>
<p>Additional data about the action for use in policy.</p>
@ -123,7 +124,7 @@ the template.</p>
</tr>
<tr id="Subject.properties">
<td><code>properties</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</a>&gt;</code></td>
<td>
<p>Additional attributes about the subject.</p>
@ -171,10 +172,17 @@ the caller identity.</p>
</tbody>
</table>
</section>
<h2 id="istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</h2>
<h2 id="istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</h2>
<section>
<p>Value is used inside templates for fields that have dynamic types. The actual datatype
of the field depends on the datatype of the expression used in the operator configuration.</p>
<p>An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any
<em>ValueType</em> enum values. For example, when
authoring an instance configuration for a template that has a field <code>data</code> of type <code>istio.policy.v1beta1.Value</code>,
both of the following expressions are valid <code>data: source.ip | ip(&quot;0.0.0.0&quot;)</code>, <code>data: request.id | &quot;&quot;</code>;
the resulting type is either ValueType.IP_ADDRESS or ValueType.STRING for the two cases respectively.</p>
<p>Objects of type Value are also passed to the adapters during request-time. There is a 1:1 mapping between
oneof fields in <code>Value</code> and enum values inside <code>ValueType</code>. Depending on the expression&rsquo;s evaluated <code>ValueType</code>,
the equivalent oneof field in <code>Value</code> is populated by Mixer and passed to the adapters.</p>
<table class="message-fields">
<thead>
@ -185,7 +193,7 @@ of the field depends on the datatype of the expression used in the operator conf
</tr>
</thead>
<tbody>
<tr id="istio.mixer.adapter.model.v1beta1.Value.string_value" class="oneof oneof-start">
<tr id="istio.policy.v1beta1.Value.string_value" class="oneof oneof-start">
<td><code>stringValue</code></td>
<td><code>string (oneof)</code></td>
<td>
@ -193,7 +201,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.int64_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.int64_value" class="oneof">
<td><code>int64Value</code></td>
<td><code>int64 (oneof)</code></td>
<td>
@ -201,7 +209,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.double_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.double_value" class="oneof">
<td><code>doubleValue</code></td>
<td><code>double (oneof)</code></td>
<td>
@ -209,7 +217,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.bool_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.bool_value" class="oneof">
<td><code>boolValue</code></td>
<td><code>bool (oneof)</code></td>
<td>
@ -217,49 +225,49 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.ip_address_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.ip_address_value" class="oneof">
<td><code>ipAddressValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress (oneof)</a></code></td>
<td>
<p>Used for values of type IPAddress</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.timestamp_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.timestamp_value" class="oneof">
<td><code>timestampValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp (oneof)</a></code></td>
<td>
<p>Used for values of type TIMESTAMP</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.duration_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.duration_value" class="oneof">
<td><code>durationValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Duration">istio.mixer.adapter.model.v1beta1.Duration (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Duration">istio.policy.v1beta1.Duration (oneof)</a></code></td>
<td>
<p>Used for values of type DURATION</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.email_address_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.email_address_value" class="oneof">
<td><code>emailAddressValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.EmailAddress">istio.mixer.adapter.model.v1beta1.EmailAddress (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.EmailAddress">istio.policy.v1beta1.EmailAddress (oneof)</a></code></td>
<td>
<p>Used for values of type EmailAddress</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.dns_name_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.dns_name_value" class="oneof">
<td><code>dnsNameValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.DNSName">istio.mixer.adapter.model.v1beta1.DNSName (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.DNSName">istio.policy.v1beta1.DNSName (oneof)</a></code></td>
<td>
<p>Used for values of type DNSName</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.uri_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.uri_value" class="oneof">
<td><code>uriValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Uri">istio.mixer.adapter.model.v1beta1.Uri (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Uri">istio.policy.v1beta1.Uri (oneof)</a></code></td>
<td>
<p>Used for values of type Uri</p>

3
content/docs/reference/config/policy-and-telemetry/templates/checknothing.html
View File

@ -4,7 +4,8 @@ description: A template that carries no data, useful for testing.
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/checknothing.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/template/checknothing.html
aliases:
- /docs/reference/config/template/checknothing.html
number_of_entries: 1
---
<p>The <code>checknothing</code> template represents an empty block of data, which can useful

28
content/docs/reference/config/policy-and-telemetry/templates/kubernetes.html
View File

@ -53,7 +53,7 @@ to assign values to the generated attributes using the <code>$out.&lt;field name
<tbody>
<tr id="OutputTemplate.source_pod_ip">
<td><code>sourcePodIp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
<td>
<p>Refers to source pod ip address. attribute<em>bindings can refer to this field using $out.source</em>pod_ip</p>
@ -101,7 +101,7 @@ to assign values to the generated attributes using the <code>$out.&lt;field name
</tr>
<tr id="OutputTemplate.source_host_ip">
<td><code>sourceHostIp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
<td>
<p>Refers to source pod host ip address. attribute<em>bindings can refer to this field using $out.source</em>host_ip</p>
@ -109,7 +109,7 @@ to assign values to the generated attributes using the <code>$out.&lt;field name
</tr>
<tr id="OutputTemplate.destination_pod_ip">
<td><code>destinationPodIp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
<td>
<p>Refers to destination pod ip address. attribute<em>bindings can refer to this field using $out.destination</em>pod_ip</p>
@ -157,7 +157,7 @@ to assign values to the generated attributes using the <code>$out.&lt;field name
</tr>
<tr id="OutputTemplate.destination_host_ip">
<td><code>destinationHostIp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
<td>
<p>Refers to destination pod host ip address. attribute<em>bindings can refer to this field using $out.destination</em>host_ip</p>
@ -165,7 +165,7 @@ to assign values to the generated attributes using the <code>$out.&lt;field name
</tr>
<tr id="OutputTemplate.origin_pod_ip">
<td><code>originPodIp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
<td>
<p>Refers to origin pod ip address. attribute<em>bindings can refer to this field using $out.origin</em>pod_ip</p>
@ -213,7 +213,7 @@ to assign values to the generated attributes using the <code>$out.&lt;field name
</tr>
<tr id="OutputTemplate.origin_host_ip">
<td><code>originHostIp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
<td>
<p>Refers to origin pod host ip address. attribute<em>bindings can refer to this field using $out.origin</em>host_ip</p>
@ -248,7 +248,7 @@ generates values related to pod information.</p>
</tr>
<tr id="Template.source_ip">
<td><code>sourceIp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
<td>
<p>Source pod&rsquo;s ip.</p>
@ -264,7 +264,7 @@ generates values related to pod information.</p>
</tr>
<tr id="Template.destination_ip">
<td><code>destinationIp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
<td>
<p>Destination pod&rsquo;s ip.</p>
@ -280,7 +280,7 @@ generates values related to pod information.</p>
</tr>
<tr id="Template.origin_ip">
<td><code>originIp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</a></code></td>
<td>
<p>Origin pod&rsquo;s ip.</p>
@ -289,9 +289,13 @@ generates values related to pod information.</p>
</tbody>
</table>
</section>
<h2 id="istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress</h2>
<h2 id="istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress</h2>
<section>
<p>IPAddress is used inside templates for fields that are of ValueType &ldquo;IP_ADDRESS&rdquo;</p>
<p>An instance field of type IPAddress denotes that the expression for the field must evalaute to
<em>ValueType.IP_ADDRESS</em></p>
<p>Objects of type IPAddress are also passed to the adapters during request-time for the instance fields of
type IPAddress</p>
<table class="message-fields">
<thead>
@ -302,7 +306,7 @@ generates values related to pod information.</p>
</tr>
</thead>
<tbody>
<tr id="istio.mixer.adapter.model.v1beta1.IPAddress.value">
<tr id="istio.policy.v1beta1.IPAddress.value">
<td><code>value</code></td>
<td><code>bytes</code></td>
<td>

7
content/docs/reference/config/policy-and-telemetry/templates/listentry.html
View File

@ -4,7 +4,8 @@ description: A template designed to let you perform list checking operations.
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/listentry.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/template/listentry.html
aliases:
- /docs/reference/config/template/listentry.html
number_of_entries: 1
---
<p>The <code>listentry</code> template is designed to let you perform list check operations
@ -27,8 +28,8 @@ spec:
within a list.</p>
<p>When writing the configuration, the value for the fields associated with this template can either be a
literal or an <a href="/docs//reference/config/policy-and-telemetry/expression-language/">expression</a>. Please note that if the datatype of a field is not istio.mixer.adapter.model.v1beta1.Value,
then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetry/expression-language/#type-checking">inferred type</a> must match the datatype of the field.</p>
literal or an <a href="/docs/reference//config/policy-and-telemetry/expression-language/">expression</a>. Please note that if the datatype of a field is not istio.policy.v1beta1.Value,
then the expression&rsquo;s <a href="/docs/reference//config/policy-and-telemetry/expression-language/#type-checking">inferred type</a> must match the datatype of the field.</p>
<table class="message-fields">
<thead>

68
content/docs/reference/config/policy-and-telemetry/templates/logentry.html
View File

@ -4,7 +4,8 @@ description: A template that represents a single runtime log entry.
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/logentry.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/template/logentry.html
aliases:
- /docs/reference/config/template/logentry.html
number_of_entries: 3
---
<p>The <code>logentry</code> template represents an individual entry within a log.</p>
@ -38,8 +39,8 @@ spec:
<p>The <code>logentry</code> template represents an individual entry within a log.</p>
<p>When writing the configuration, the value for the fields associated with this template can either be a
literal or an <a href="/docs//reference/config/policy-and-telemetry/expression-language/">expression</a>. Please note that if the datatype of a field is not istio.mixer.adapter.model.v1beta1.Value,
then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetry/expression-language/#type-checking">inferred type</a> must match the datatype of the field.</p>
literal or an <a href="/docs/reference//config/policy-and-telemetry/expression-language/">expression</a>. Please note that if the datatype of a field is not istio.policy.v1beta1.Value,
then the expression&rsquo;s <a href="/docs/reference//config/policy-and-telemetry/expression-language/#type-checking">inferred type</a> must match the datatype of the field.</p>
<table class="message-fields">
<thead>
@ -52,7 +53,7 @@ then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetr
<tbody>
<tr id="Template.variables">
<td><code>variables</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</a>&gt;</code></td>
<td>
<p>Variables that are delivered for each log entry.</p>
@ -60,7 +61,7 @@ then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetr
</tr>
<tr id="Template.timestamp">
<td><code>timestamp</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp</a></code></td>
<td><code><a href="#istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
<td>
<p>Timestamp is the time value for the log entry</p>
@ -86,7 +87,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,&nbsp;<a href="#istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.policy.v1beta1.Value">istio.policy.v1beta1.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.
@ -97,9 +98,13 @@ Otherwise these fields will be ignored by the adapter.</p>
</tbody>
</table>
</section>
<h2 id="istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp</h2>
<h2 id="istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp</h2>
<section>
<p>TimeStamp is used inside templates for fields that are of ValueType &ldquo;TIMESTAMP&rdquo;</p>
<p>An instance field of type TimeStamp denotes that the expression for the field must evalaute to
<em>ValueType.TIMESTAMP</em></p>
<p>Objects of type TimeStamp are also passed to the adapters during request-time for the instance fields of
type TimeStamp</p>
<table class="message-fields">
<thead>
@ -110,7 +115,7 @@ Otherwise these fields will be ignored by the adapter.</p>
</tr>
</thead>
<tbody>
<tr id="istio.mixer.adapter.model.v1beta1.TimeStamp.value">
<tr id="istio.policy.v1beta1.TimeStamp.value">
<td><code>value</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp">google.protobuf.Timestamp</a></code></td>
<td>
@ -121,10 +126,17 @@ Otherwise these fields will be ignored by the adapter.</p>
</tbody>
</table>
</section>
<h2 id="istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</h2>
<h2 id="istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</h2>
<section>
<p>Value is used inside templates for fields that have dynamic types. The actual datatype
of the field depends on the datatype of the expression used in the operator configuration.</p>
<p>An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any
<em>ValueType</em> enum values. For example, when
authoring an instance configuration for a template that has a field <code>data</code> of type <code>istio.policy.v1beta1.Value</code>,
both of the following expressions are valid <code>data: source.ip | ip(&quot;0.0.0.0&quot;)</code>, <code>data: request.id | &quot;&quot;</code>;
the resulting type is either ValueType.IP_ADDRESS or ValueType.STRING for the two cases respectively.</p>
<p>Objects of type Value are also passed to the adapters during request-time. There is a 1:1 mapping between
oneof fields in <code>Value</code> and enum values inside <code>ValueType</code>. Depending on the expression&rsquo;s evaluated <code>ValueType</code>,
the equivalent oneof field in <code>Value</code> is populated by Mixer and passed to the adapters.</p>
<table class="message-fields">
<thead>
@ -135,7 +147,7 @@ of the field depends on the datatype of the expression used in the operator conf
</tr>
</thead>
<tbody>
<tr id="istio.mixer.adapter.model.v1beta1.Value.string_value" class="oneof oneof-start">
<tr id="istio.policy.v1beta1.Value.string_value" class="oneof oneof-start">
<td><code>stringValue</code></td>
<td><code>string (oneof)</code></td>
<td>
@ -143,7 +155,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.int64_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.int64_value" class="oneof">
<td><code>int64Value</code></td>
<td><code>int64 (oneof)</code></td>
<td>
@ -151,7 +163,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.double_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.double_value" class="oneof">
<td><code>doubleValue</code></td>
<td><code>double (oneof)</code></td>
<td>
@ -159,7 +171,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.bool_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.bool_value" class="oneof">
<td><code>boolValue</code></td>
<td><code>bool (oneof)</code></td>
<td>
@ -167,49 +179,49 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.ip_address_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.ip_address_value" class="oneof">
<td><code>ipAddressValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress (oneof)</a></code></td>
<td>
<p>Used for values of type IPAddress</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.timestamp_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.timestamp_value" class="oneof">
<td><code>timestampValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp (oneof)</a></code></td>
<td>
<p>Used for values of type TIMESTAMP</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.duration_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.duration_value" class="oneof">
<td><code>durationValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Duration">istio.mixer.adapter.model.v1beta1.Duration (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Duration">istio.policy.v1beta1.Duration (oneof)</a></code></td>
<td>
<p>Used for values of type DURATION</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.email_address_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.email_address_value" class="oneof">
<td><code>emailAddressValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.EmailAddress">istio.mixer.adapter.model.v1beta1.EmailAddress (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.EmailAddress">istio.policy.v1beta1.EmailAddress (oneof)</a></code></td>
<td>
<p>Used for values of type EmailAddress</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.dns_name_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.dns_name_value" class="oneof">
<td><code>dnsNameValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.DNSName">istio.mixer.adapter.model.v1beta1.DNSName (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.DNSName">istio.policy.v1beta1.DNSName (oneof)</a></code></td>
<td>
<p>Used for values of type DNSName</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.uri_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.uri_value" class="oneof">
<td><code>uriValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Uri">istio.mixer.adapter.model.v1beta1.Uri (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Uri">istio.policy.v1beta1.Uri (oneof)</a></code></td>
<td>
<p>Used for values of type Uri</p>

58
content/docs/reference/config/policy-and-telemetry/templates/metric.html
View File

@ -4,7 +4,8 @@ description: A template that represents a single runtime metric.
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/metric.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/template/metric.html
aliases:
- /docs/reference/config/template/metric.html
number_of_entries: 2
---
<p>The <code>metric</code> template is designed to let you describe runtime metric to dispatch to
@ -33,8 +34,8 @@ spec:
<p>The <code>metric</code> template represents a single piece of data to report.</p>
<p>When writing the configuration, the value for the fields associated with this template can either be a
literal or an <a href="/docs//reference/config/policy-and-telemetry/expression-language/">expression</a>. Please note that if the datatype of a field is not istio.mixer.adapter.model.v1beta1.Value,
then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetry/expression-language/#type-checking">inferred type</a> must match the datatype of the field.</p>
literal or an <a href="/docs/reference//config/policy-and-telemetry/expression-language/">expression</a>. Please note that if the datatype of a field is not istio.policy.v1beta1.Value,
then the expression&rsquo;s <a href="/docs/reference//config/policy-and-telemetry/expression-language/#type-checking">inferred type</a> must match the datatype of the field.</p>
<table class="message-fields">
<thead>
@ -47,7 +48,7 @@ then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetr
<tbody>
<tr id="Template.value">
<td><code>value</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</a></code></td>
<td>
<p>The value being reported.</p>
@ -55,7 +56,7 @@ then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetr
</tr>
<tr id="Template.dimensions">
<td><code>dimensions</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</a>&gt;</code></td>
<td>
<p>The unique identity of the particular metric to report.</p>
@ -73,7 +74,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,&nbsp;<a href="#istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.policy.v1beta1.Value">istio.policy.v1beta1.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
@ -84,10 +85,17 @@ these fields will be ignored by the adapter.</p>
</tbody>
</table>
</section>
<h2 id="istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</h2>
<h2 id="istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</h2>
<section>
<p>Value is used inside templates for fields that have dynamic types. The actual datatype
of the field depends on the datatype of the expression used in the operator configuration.</p>
<p>An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any
<em>ValueType</em> enum values. For example, when
authoring an instance configuration for a template that has a field <code>data</code> of type <code>istio.policy.v1beta1.Value</code>,
both of the following expressions are valid <code>data: source.ip | ip(&quot;0.0.0.0&quot;)</code>, <code>data: request.id | &quot;&quot;</code>;
the resulting type is either ValueType.IP_ADDRESS or ValueType.STRING for the two cases respectively.</p>
<p>Objects of type Value are also passed to the adapters during request-time. There is a 1:1 mapping between
oneof fields in <code>Value</code> and enum values inside <code>ValueType</code>. Depending on the expression&rsquo;s evaluated <code>ValueType</code>,
the equivalent oneof field in <code>Value</code> is populated by Mixer and passed to the adapters.</p>
<table class="message-fields">
<thead>
@ -98,7 +106,7 @@ of the field depends on the datatype of the expression used in the operator conf
</tr>
</thead>
<tbody>
<tr id="istio.mixer.adapter.model.v1beta1.Value.string_value" class="oneof oneof-start">
<tr id="istio.policy.v1beta1.Value.string_value" class="oneof oneof-start">
<td><code>stringValue</code></td>
<td><code>string (oneof)</code></td>
<td>
@ -106,7 +114,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.int64_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.int64_value" class="oneof">
<td><code>int64Value</code></td>
<td><code>int64 (oneof)</code></td>
<td>
@ -114,7 +122,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.double_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.double_value" class="oneof">
<td><code>doubleValue</code></td>
<td><code>double (oneof)</code></td>
<td>
@ -122,7 +130,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.bool_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.bool_value" class="oneof">
<td><code>boolValue</code></td>
<td><code>bool (oneof)</code></td>
<td>
@ -130,49 +138,49 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.ip_address_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.ip_address_value" class="oneof">
<td><code>ipAddressValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress (oneof)</a></code></td>
<td>
<p>Used for values of type IPAddress</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.timestamp_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.timestamp_value" class="oneof">
<td><code>timestampValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp (oneof)</a></code></td>
<td>
<p>Used for values of type TIMESTAMP</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.duration_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.duration_value" class="oneof">
<td><code>durationValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Duration">istio.mixer.adapter.model.v1beta1.Duration (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Duration">istio.policy.v1beta1.Duration (oneof)</a></code></td>
<td>
<p>Used for values of type DURATION</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.email_address_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.email_address_value" class="oneof">
<td><code>emailAddressValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.EmailAddress">istio.mixer.adapter.model.v1beta1.EmailAddress (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.EmailAddress">istio.policy.v1beta1.EmailAddress (oneof)</a></code></td>
<td>
<p>Used for values of type EmailAddress</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.dns_name_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.dns_name_value" class="oneof">
<td><code>dnsNameValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.DNSName">istio.mixer.adapter.model.v1beta1.DNSName (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.DNSName">istio.policy.v1beta1.DNSName (oneof)</a></code></td>
<td>
<p>Used for values of type DNSName</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.uri_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.uri_value" class="oneof">
<td><code>uriValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Uri">istio.mixer.adapter.model.v1beta1.Uri (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Uri">istio.policy.v1beta1.Uri (oneof)</a></code></td>
<td>
<p>Used for values of type Uri</p>

54
content/docs/reference/config/policy-and-telemetry/templates/quota.html
View File

@ -4,7 +4,8 @@ description: A template that represents a quota allocation request
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/quota.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/template/quota.html
aliases:
- /docs/reference/config/template/quota.html
number_of_entries: 2
---
<p>The <code>quota</code> template represents an item for which to check quota.</p>
@ -29,8 +30,8 @@ spec:
<p>The <code>quota</code> template represents a piece of data to check Quota for.</p>
<p>When writing the configuration, the value for the fields associated with this template can either be a
literal or an <a href="/docs//reference/config/policy-and-telemetry/expression-language/">expression</a>. Please note that if the datatype of a field is not istio.mixer.adapter.model.v1beta1.Value,
then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetry/expression-language/#type-checking">inferred type</a> must match the datatype of the field.</p>
literal or an <a href="/docs/reference//config/policy-and-telemetry/expression-language/">expression</a>. Please note that if the datatype of a field is not istio.policy.v1beta1.Value,
then the expression&rsquo;s <a href="/docs/reference//config/policy-and-telemetry/expression-language/#type-checking">inferred type</a> must match the datatype of the field.</p>
<table class="message-fields">
<thead>
@ -43,7 +44,7 @@ then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetr
<tbody>
<tr id="Template.dimensions">
<td><code>dimensions</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</a>&gt;</code></td>
<td><code>map&lt;string,&nbsp;<a href="#istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</a>&gt;</code></td>
<td>
<p>The unique identity of the particular quota to manipulate.</p>
@ -52,10 +53,17 @@ then the expression&rsquo;s <a href="/docs//reference/config/policy-and-telemetr
</tbody>
</table>
</section>
<h2 id="istio.mixer.adapter.model.v1beta1.Value">istio.mixer.adapter.model.v1beta1.Value</h2>
<h2 id="istio.policy.v1beta1.Value">istio.policy.v1beta1.Value</h2>
<section>
<p>Value is used inside templates for fields that have dynamic types. The actual datatype
of the field depends on the datatype of the expression used in the operator configuration.</p>
<p>An instance field of type Value denotes that the expression for the field is of dynamic type and can evalaute to any
<em>ValueType</em> enum values. For example, when
authoring an instance configuration for a template that has a field <code>data</code> of type <code>istio.policy.v1beta1.Value</code>,
both of the following expressions are valid <code>data: source.ip | ip(&quot;0.0.0.0&quot;)</code>, <code>data: request.id | &quot;&quot;</code>;
the resulting type is either ValueType.IP_ADDRESS or ValueType.STRING for the two cases respectively.</p>
<p>Objects of type Value are also passed to the adapters during request-time. There is a 1:1 mapping between
oneof fields in <code>Value</code> and enum values inside <code>ValueType</code>. Depending on the expression&rsquo;s evaluated <code>ValueType</code>,
the equivalent oneof field in <code>Value</code> is populated by Mixer and passed to the adapters.</p>
<table class="message-fields">
<thead>
@ -66,7 +74,7 @@ of the field depends on the datatype of the expression used in the operator conf
</tr>
</thead>
<tbody>
<tr id="istio.mixer.adapter.model.v1beta1.Value.string_value" class="oneof oneof-start">
<tr id="istio.policy.v1beta1.Value.string_value" class="oneof oneof-start">
<td><code>stringValue</code></td>
<td><code>string (oneof)</code></td>
<td>
@ -74,7 +82,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.int64_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.int64_value" class="oneof">
<td><code>int64Value</code></td>
<td><code>int64 (oneof)</code></td>
<td>
@ -82,7 +90,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.double_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.double_value" class="oneof">
<td><code>doubleValue</code></td>
<td><code>double (oneof)</code></td>
<td>
@ -90,7 +98,7 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.bool_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.bool_value" class="oneof">
<td><code>boolValue</code></td>
<td><code>bool (oneof)</code></td>
<td>
@ -98,49 +106,49 @@ of the field depends on the datatype of the expression used in the operator conf
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.ip_address_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.ip_address_value" class="oneof">
<td><code>ipAddressValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.IPAddress">istio.mixer.adapter.model.v1beta1.IPAddress (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.IPAddress">istio.policy.v1beta1.IPAddress (oneof)</a></code></td>
<td>
<p>Used for values of type IPAddress</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.timestamp_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.timestamp_value" class="oneof">
<td><code>timestampValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp (oneof)</a></code></td>
<td>
<p>Used for values of type TIMESTAMP</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.duration_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.duration_value" class="oneof">
<td><code>durationValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Duration">istio.mixer.adapter.model.v1beta1.Duration (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Duration">istio.policy.v1beta1.Duration (oneof)</a></code></td>
<td>
<p>Used for values of type DURATION</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.email_address_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.email_address_value" class="oneof">
<td><code>emailAddressValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.EmailAddress">istio.mixer.adapter.model.v1beta1.EmailAddress (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.EmailAddress">istio.policy.v1beta1.EmailAddress (oneof)</a></code></td>
<td>
<p>Used for values of type EmailAddress</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.dns_name_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.dns_name_value" class="oneof">
<td><code>dnsNameValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.DNSName">istio.mixer.adapter.model.v1beta1.DNSName (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.DNSName">istio.policy.v1beta1.DNSName (oneof)</a></code></td>
<td>
<p>Used for values of type DNSName</p>
</td>
</tr>
<tr id="istio.mixer.adapter.model.v1beta1.Value.uri_value" class="oneof">
<tr id="istio.policy.v1beta1.Value.uri_value" class="oneof">
<td><code>uriValue</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Uri">istio.mixer.adapter.model.v1beta1.Uri (oneof)</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Uri">istio.policy.v1beta1.Uri (oneof)</a></code></td>
<td>
<p>Used for values of type Uri</p>

3
content/docs/reference/config/policy-and-telemetry/templates/reportnothing.html
View File

@ -4,7 +4,8 @@ description: A template that carries no data, useful for testing.
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/reportnothing.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/template/reportnothing.html
aliases:
- /docs/reference/config/template/reportnothing.html
number_of_entries: 1
---
<p>The <code>reportnothing</code> template represents an empty block of data, which can useful

29
content/docs/reference/config/policy-and-telemetry/templates/servicecontrolreport.html
View File

@ -4,7 +4,8 @@ description: A template used by the Google Service Control adapter.
location: https://istio.io/docs/reference/config/policy-and-telemetry/templates/servicecontrolreport.html
layout: protoc-gen-docs
generator: protoc-gen-docs
redirect_from: /docs/reference/config/adapters/servicecontrolreport.html
aliases:
- /docs/reference/config/adapters/servicecontrolreport.html
number_of_entries: 3
---
<p>The <code>servicecontrolreport</code> template is used by the <a href="/docs/reference/config/policy-and-telemetry/adapters/servicecontrol/">Google Service Control</a>
@ -80,7 +81,7 @@ defined by this template.</p>
</tr>
<tr id="Template.request_time">
<td><code>requestTime</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp</a></code></td>
<td><code><a href="#istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
<td>
</td>
</tr>
@ -104,7 +105,7 @@ defined by this template.</p>
</tr>
<tr id="Template.response_time">
<td><code>responseTime</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp</a></code></td>
<td><code><a href="#istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp</a></code></td>
<td>
</td>
</tr>
@ -122,16 +123,20 @@ defined by this template.</p>
</tr>
<tr id="Template.response_latency">
<td><code>responseLatency</code></td>
<td><code><a href="#istio.mixer.adapter.model.v1beta1.Duration">istio.mixer.adapter.model.v1beta1.Duration</a></code></td>
<td><code><a href="#istio.policy.v1beta1.Duration">istio.policy.v1beta1.Duration</a></code></td>
<td>
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="istio.mixer.adapter.model.v1beta1.Duration">istio.mixer.adapter.model.v1beta1.Duration</h2>
<h2 id="istio.policy.v1beta1.Duration">istio.policy.v1beta1.Duration</h2>
<section>
<p>Duration is used inside templates for fields that are of ValueType &ldquo;DURATION&rdquo;</p>
<p>An instance field of type Duration denotes that the expression for the field must evalaute to
<em>ValueType.DURATION</em></p>
<p>Objects of type Duration are also passed to the adapters during request-time for the instance fields of
type Duration</p>
<table class="message-fields">
<thead>
@ -142,7 +147,7 @@ defined by this template.</p>
</tr>
</thead>
<tbody>
<tr id="istio.mixer.adapter.model.v1beta1.Duration.value">
<tr id="istio.policy.v1beta1.Duration.value">
<td><code>value</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">google.protobuf.Duration</a></code></td>
<td>
@ -153,9 +158,13 @@ defined by this template.</p>
</tbody>
</table>
</section>
<h2 id="istio.mixer.adapter.model.v1beta1.TimeStamp">istio.mixer.adapter.model.v1beta1.TimeStamp</h2>
<h2 id="istio.policy.v1beta1.TimeStamp">istio.policy.v1beta1.TimeStamp</h2>
<section>
<p>TimeStamp is used inside templates for fields that are of ValueType &ldquo;TIMESTAMP&rdquo;</p>
<p>An instance field of type TimeStamp denotes that the expression for the field must evalaute to
<em>ValueType.TIMESTAMP</em></p>
<p>Objects of type TimeStamp are also passed to the adapters during request-time for the instance fields of
type TimeStamp</p>
<table class="message-fields">
<thead>
@ -166,7 +175,7 @@ defined by this template.</p>
</tr>
</thead>
<tbody>
<tr id="istio.mixer.adapter.model.v1beta1.TimeStamp.value">
<tr id="istio.policy.v1beta1.TimeStamp.value">
<td><code>value</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp">google.protobuf.Timestamp</a></code></td>
<td>

12
scripts/grab_reference_docs.sh
View File

@ -1,19 +1,19 @@
#!/bin/bash
# This script copies generated .pb.html files, which contain reference docs for protos, and installs
# them in their targeted location within the _docs/reference tree of this repo. Each .pb.html file contains a
# them in their targeted location within the content/docs/reference tree of this repo. Each .pb.html file contains a
# line that indicates the target directory location. The line is of the form:
#
# location: https://istio.io/docs/reference/...
#
# Additionally, this script also builds Istio components and runs them to extract their command-line docs which it
# copies to _docs/reference/commands.
# copies to content/docs/reference/commands.
#set -e
ISTIO_BASE=$(cd "$(dirname "$0")" ; pwd -P)/..
WORK_DIR=$(mktemp -d)
COMMAND_DIR=$ISTIO_BASE/_docs/reference/commands
COMMAND_DIR=$ISTIO_BASE/content/docs/reference/commands
# Get the source code
pushd $WORK_DIR
@ -37,7 +37,7 @@ locate_file() {
FNP=${LOCATION:31}
FN=$(echo $FNP | rev | cut -d'/' -f1 | rev)
PP=$(echo $FNP | rev | cut -d'/' -f2- | rev)
sed -e 's/href="https:\/\/istio.io/href="/g' ${FILENAME} >_docs${PP}/${FN}
sed -e 's/href="https:\/\/istio.io/href="/g' ${FILENAME} >content/docs${PP}/${FN}
}
# Given the path and name to an Istio command, builds the command and then
@ -60,13 +60,13 @@ get_command_doc() {
# First delete all the current generated files so that any stale files are removed
find _docs/reference -name '*.html' -type f|xargs rm
for f in `find $WORK_DIR/api -type f -name '*.pb.html'`
for f in `find ../api -type f -name '*.pb.html'`
do
echo "processing $f"
locate_file $f
done
for f in `find $WORK_DIR/istio -type f -name '*.pb.html'`
for f in `find ../istio -type f -name '*.pb.html'`
do
echo "processing $f"
locate_file $f