Another Manual doc update (#7183)

This commit is contained in:
Eric Van Norman 2020-04-29 12:47:10 -05:00 committed by GitHub
parent 402f064f5a
commit a95018f62e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 179 additions and 124 deletions

View File

@ -2321,6 +2321,14 @@ THIS COMMAND IS STILL UNDER ACTIVE DEVELOPMENT AND NOT READY FOR PRODUCTION USE.
</thead>
<tbody>
<tr>
<td><code>--charts &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz).
(default ``)</td>
</tr>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>The name of the kubeconfig context to use (default ``)</td>
@ -2471,7 +2479,7 @@ istioctl experimental wait --for=distribution --threshold=.99 --timeout=300 virt
<td><code>--charts &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator)
(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz).
(default ``)</td>
</tr>
@ -2727,7 +2735,7 @@ istioctl kube-inject -f samples/bookinfo/platform/kube/bookinfo.yaml \
<td><code>--charts &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator)
(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz).
(default ``)</td>
</tr>
@ -2900,7 +2908,7 @@ e.g.
<td><code>--charts &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator)
(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz).
(default ``)</td>
</tr>
@ -3124,7 +3132,7 @@ https://istio.io/docs/reference/config/istio.operator.v1alpha12.pb/#IstioControl
<td><code>--charts &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator)
(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz).
(default ``)</td>
</tr>
@ -3192,7 +3200,7 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/
<td><code>--charts &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator)
(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz).
(default ``)</td>
</tr>
@ -3237,11 +3245,6 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/
<td>The namespace the operator controller is installed into (default `istio-operator`)</td>
</tr>
<tr>
<td><code>--readiness-timeout &lt;duration&gt;</code></td>
<td></td>
<td>Maximum seconds to wait for the Istio operator to be ready. The --wait flag must be set for this flag to apply (default `5m0s`)</td>
</tr>
<tr>
<td><code>--tag &lt;string&gt;</code></td>
<td></td>
<td>The tag for the operator controller image (default `unknown`)</td>
@ -3251,11 +3254,6 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/
<td></td>
<td>Verbose output. </td>
</tr>
<tr>
<td><code>--wait</code></td>
<td><code>-w</code></td>
<td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds </td>
</tr>
</tbody>
</table>
<h2 id="istioctl-operator-remove">istioctl operator remove</h2>
@ -3272,14 +3270,6 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/
</thead>
<tbody>
<tr>
<td><code>--charts &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.5.0/install/kubernetes/operator)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz).
(default ``)</td>
</tr>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>The name of the kubeconfig context to use (default ``)</td>
@ -3290,21 +3280,11 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/
<td>Console/log output only, make no changes. </td>
</tr>
<tr>
<td><code>--filename &lt;string&gt;</code></td>
<td><code>-f</code></td>
<td>Path to file containing IstioOperator custom resource (default ``)</td>
</tr>
<tr>
<td><code>--force</code></td>
<td></td>
<td>Proceed even with errors </td>
</tr>
<tr>
<td><code>--hub &lt;string&gt;</code></td>
<td></td>
<td>The hub for the operator controller image (default `unknown`)</td>
</tr>
<tr>
<td><code>--istioNamespace &lt;string&gt;</code></td>
<td><code>-i</code></td>
<td>Istio system namespace (default `istio-system`)</td>
@ -3325,25 +3305,10 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/
<td>The namespace the operator controller is installed into (default `istio-operator`)</td>
</tr>
<tr>
<td><code>--readiness-timeout &lt;duration&gt;</code></td>
<td></td>
<td>Maximum seconds to wait for the Istio operator to be ready. The --wait flag must be set for this flag to apply (default `5m0s`)</td>
</tr>
<tr>
<td><code>--tag &lt;string&gt;</code></td>
<td></td>
<td>The tag for the operator controller image (default `unknown`)</td>
</tr>
<tr>
<td><code>--verbose</code></td>
<td></td>
<td>Verbose output. </td>
</tr>
<tr>
<td><code>--wait</code></td>
<td><code>-w</code></td>
<td>Wait, if set will wait until all Pods, Services, and minimum number of Pods of a Deployment are in a ready state before the command exits. It will wait for a maximum duration of --readiness-timeout seconds </td>
</tr>
</tbody>
</table>
<h2 id="istioctl-options">istioctl options</h2>
@ -3485,6 +3450,14 @@ istioctl manifest apply --set profile=demo # Use a profile from the list
</thead>
<tbody>
<tr>
<td><code>--charts &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz).
(default ``)</td>
</tr>
<tr>
<td><code>--config-path &lt;string&gt;</code></td>
<td><code>-p</code></td>
<td>The path the root of the configuration subtree to dump e.g. components.pilot. By default, dump whole tree (default ``)</td>
@ -4250,6 +4223,14 @@ Retrieves last sent and last acknowledged xDS sync from Pilot to each Envoy in t
</thead>
<tbody>
<tr>
<td><code>--charts &lt;string&gt;</code></td>
<td><code>-d</code></td>
<td>Specify a path to a directory of charts and profiles
(e.g. ~/Downloads/istio-1.6.0/install/kubernetes/operator)
or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.5.1/istio-1.5.1-linux.tar.gz).
(default ``)</td>
</tr>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>The name of the kubeconfig context to use (default ``)</td>
@ -4534,6 +4515,12 @@ These environment variables affect the behavior of the <code>istioctl</code> com
<td>Defines the cluster and service registry that this Istiod instance is belongs to</td>
</tr>
<tr>
<td><code>ENABLE_CA_SERVER</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If this is set to false, will not create CA server in istiod.</td>
</tr>
<tr>
<td><code>GKE_CLUSTER_URL</code></td>
<td>String</td>
<td><code></code></td>
@ -4606,12 +4593,6 @@ These environment variables affect the behavior of the <code>istioctl</code> com
<td>namespace that nodeagent/citadel run in</td>
</tr>
<tr>
<td><code>PILOT_CERT_DIR</code></td>
<td>String</td>
<td><code></code></td>
<td></td>
</tr>
<tr>
<td><code>PILOT_CERT_PROVIDER</code></td>
<td>String</td>
<td><code>istiod</code></td>

View File

@ -359,6 +359,12 @@ These environment variables affect the behavior of the <code>mixs</code> command
<td>Defines the cluster and service registry that this Istiod instance is belongs to</td>
</tr>
<tr>
<td><code>ENABLE_CA_SERVER</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If this is set to false, will not create CA server in istiod.</td>
</tr>
<tr>
<td><code>ISTIOD_ADDR</code></td>
<td>String</td>
<td><code></code></td>
@ -401,12 +407,6 @@ These environment variables affect the behavior of the <code>mixs</code> command
<td>Path for a kubeconfig file.</td>
</tr>
<tr>
<td><code>PILOT_CERT_DIR</code></td>
<td>String</td>
<td><code></code></td>
<td></td>
</tr>
<tr>
<td><code>PILOT_CERT_PROVIDER</code></td>
<td>String</td>
<td><code>istiod</code></td>

View File

@ -153,6 +153,12 @@ These environment variables affect the behavior of the <code>operator</code> com
<td>Defines the cluster and service registry that this Istiod instance is belongs to</td>
</tr>
<tr>
<td><code>ENABLE_CA_SERVER</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If this is set to false, will not create CA server in istiod.</td>
</tr>
<tr>
<td><code>ISTIOD_ADDR</code></td>
<td>String</td>
<td><code></code></td>
@ -183,12 +189,6 @@ These environment variables affect the behavior of the <code>operator</code> com
<td>The JWT validation policy.</td>
</tr>
<tr>
<td><code>PILOT_CERT_DIR</code></td>
<td>String</td>
<td><code></code></td>
<td></td>
</tr>
<tr>
<td><code>PILOT_CERT_PROVIDER</code></td>
<td>String</td>
<td><code>istiod</code></td>

View File

@ -574,6 +574,12 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
<td>Protocol and DNS server to use. Currently only tcp-tls: is supported.</td>
</tr>
<tr>
<td><code>ENABLE_CA_SERVER</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If this is set to false, will not create CA server in istiod.</td>
</tr>
<tr>
<td><code>ENABLE_INGRESS_GATEWAY_SDS</code></td>
<td>Boolean</td>
<td><code>false</code></td>
@ -694,12 +700,6 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
<td>The output directory for the key and certificate. If empty, key and certificate will not be saved. Must be set for VMs using provisioning certificates.</td>
</tr>
<tr>
<td><code>PILOT_CERT_DIR</code></td>
<td>String</td>
<td><code></code></td>
<td></td>
</tr>
<tr>
<td><code>PILOT_CERT_PROVIDER</code></td>
<td>String</td>
<td><code>istiod</code></td>

View File

@ -94,6 +94,11 @@ remove_toc_prefix: 'pilot-discovery '
<td>Restrict the applications namespace the controller manages; if not set, controller watches all namespaces (default ``)</td>
</tr>
<tr>
<td><code>--caCertFile &lt;string&gt;</code></td>
<td></td>
<td>File containing the x509 Server CA Certificate (default ``)</td>
</tr>
<tr>
<td><code>--clusterID &lt;string&gt;</code></td>
<td></td>
<td>The ID of the cluster that this Istiod instance resides (default `Kubernetes`)</td>
@ -264,6 +269,16 @@ remove_toc_prefix: 'pilot-discovery '
<td>Controller resync interval (default `1m0s`)</td>
</tr>
<tr>
<td><code>--tlsCertFile &lt;string&gt;</code></td>
<td></td>
<td>File containing the x509 Server Certificate (default ``)</td>
</tr>
<tr>
<td><code>--tlsKeyFile &lt;string&gt;</code></td>
<td></td>
<td>File containing the x509 private key matching --tlsCertFile (default ``)</td>
</tr>
<tr>
<td><code>--trust-domain &lt;string&gt;</code></td>
<td></td>
<td>The domain serves to identify the system with spiffe (default ``)</td>
@ -532,6 +547,12 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
<td>Protocol and DNS server to use. Currently only tcp-tls: is supported.</td>
</tr>
<tr>
<td><code>ENABLE_CA_SERVER</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If this is set to false, will not create CA server in istiod.</td>
</tr>
<tr>
<td><code>ENABLE_INCREMENTAL_MCP</code></td>
<td>Boolean</td>
<td><code>false</code></td>
@ -616,12 +637,6 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
<td></td>
</tr>
<tr>
<td><code>PILOT_CERT_DIR</code></td>
<td>String</td>
<td><code></code></td>
<td></td>
</tr>
<tr>
<td><code>PILOT_CERT_PROVIDER</code></td>
<td>String</td>
<td><code>istiod</code></td>

View File

@ -0,0 +1,62 @@
---
WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/proxy' REPO
source_repo: https://github.com/istio/proxy
title: AccessLogPolicy Config
description: Configuration for AccessLogPolicy Filter.
location: https://istio.io/docs/reference/config/proxy_extensions/accesslogpolicy.html
layout: protoc-gen-docs
generator: protoc-gen-docs
weight: 20
number_of_entries: 1
---
<p>Accesslog Policy plugin is a stateful http log sampler.
It decides whether a request is logged based on the following rules.
1. All requests resulting in errors are logged.
2. First successful request within log<em>window</em>duration from a specific
source ip (source principal) is logged.
The plugin records its decision in the istio.access<em>log</em>policy attribute with
a value of &ldquo;no&rdquo;. A downstream plugin may honor the the attribute. For
example, Stackdriver plugin will not produce an access log entry if this
attribute is set.</p>
<h2 id="AccessLogPolicyConfig">AccessLogPolicyConfig</h2>
<section>
<p>Top level Config for Access Log Policy Config Filter.</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="AccessLogPolicyConfig-log_window_duration">
<td><code>logWindowDuration</code></td>
<td><code><a href="https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration">Duration</a></code></td>
<td>
<p>Optional. Allows specifying logging window for successful requests.
The default duration is <code>12h</code>.</p>
</td>
<td>
No
</td>
</tr>
<tr id="AccessLogPolicyConfig-max_client_cache_size">
<td><code>maxClientCacheSize</code></td>
<td><code>int32</code></td>
<td>
<p>Optional. Allows specifying max client cache size.
The default is 500 entries.</p>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>

View File

@ -3,7 +3,7 @@ WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL
source_repo: https://github.com/istio/proxy
title: AttributeGen Config
description: Configuration for Attribute Generation plugin.
location: https://istio.io/docs/reference/config/attributegen.html
location: https://istio.io/docs/reference/config/proxy_extensions/attributegen.html
layout: protoc-gen-docs
generator: protoc-gen-docs
schema: istio.attributegen
@ -106,47 +106,6 @@ example, all response codes in 200s are mapped to <code>2xx</code>.</p>
<p>If multiple AttributeGene configurations produce the same attribute, the
result of the last configuration will be visible to downstream filters.</p>
<h2 id="PluginConfig">PluginConfig</h2>
<section>
<p>Top level configuration to generate new attributes based on attributes of the
proxied traffic.</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="PluginConfig-debug">
<td><code>debug</code></td>
<td><code>bool</code></td>
<td>
<p>The following settings should be rarely used.
Enable debug for this filter.</p>
</td>
<td>
No
</td>
</tr>
<tr id="PluginConfig-attributes">
<td><code>attributes</code></td>
<td><code><a href="#AttributeGeneration">AttributeGeneration[]</a></code></td>
<td>
<p>Multiple independent attribute generation configurations.</p>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>
<h2 id="AttributeGeneration">AttributeGeneration</h2>
<section>
<p>AttributeGeneration define generation of one attribute.</p>
@ -279,3 +238,44 @@ No
</tbody>
</table>
</section>
<h2 id="PluginConfig">PluginConfig</h2>
<section>
<p>Top level configuration to generate new attributes based on attributes of the
proxied traffic.</p>
<table class="message-fields">
<thead>
<tr>
<th>Field</th>
<th>Type</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr id="PluginConfig-debug">
<td><code>debug</code></td>
<td><code>bool</code></td>
<td>
<p>The following settings should be rarely used.
Enable debug for this filter.</p>
</td>
<td>
No
</td>
</tr>
<tr id="PluginConfig-attributes">
<td><code>attributes</code></td>
<td><code><a href="#AttributeGeneration">AttributeGeneration[]</a></code></td>
<td>
<p>Multiple independent attribute generation configurations.</p>
</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</section>

View File

@ -25,8 +25,7 @@ number_of_entries: 2
<td><code>maxPeerCacheSize</code></td>
<td><code><a href="#google-protobuf-UInt32Value">UInt32Value</a></code></td>
<td>
<p>next id: 2
maximum size of the peer metadata cache.
<p>maximum size of the peer metadata cache.
A long lived proxy that connects with many transient peers can build up a
large cache. To turn off the cache, set this field to zero.</p>

View File

@ -11,8 +11,6 @@ number_of_entries: 1
---
<h2 id="PluginConfig">PluginConfig</h2>
<section>
<p>next id: 9</p>
<table class="message-fields">
<thead>
<tr>