Skip to content

Commit

Permalink
Another Manual doc update (istio#7183)
Browse files Browse the repository at this point in the history
  • Loading branch information
ericvn committed Apr 29, 2020
1 parent 402f064 commit a95018f
Show file tree
Hide file tree
Showing 9 changed files with 179 additions and 124 deletions.
89 changes: 35 additions & 54 deletions content/en/docs/reference/commands/istioctl/index.html
Expand Up @@ -2321,6 +2321,14 @@ <h2 id="istioctl-experimental-upgrade">istioctl experimental upgrade</h2>
</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>
Expand Down Expand Up @@ -2471,7 +2479,7 @@ <h2 id="istioctl-install">istioctl install</h2>
<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>
Expand Down Expand Up @@ -2727,7 +2735,7 @@ <h2 id="istioctl-manifest-apply">istioctl manifest apply</h2>
<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>
Expand Down Expand Up @@ -2900,7 +2908,7 @@ <h2 id="istioctl-manifest-generate">istioctl manifest generate</h2>
<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>
Expand Down Expand Up @@ -3124,7 +3132,7 @@ <h2 id="istioctl-operator-dump">istioctl operator dump</h2>
<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>
Expand Down Expand Up @@ -3192,7 +3200,7 @@ <h2 id="istioctl-operator-init">istioctl operator init</h2>
<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>
Expand Down Expand Up @@ -3237,11 +3245,6 @@ <h2 id="istioctl-operator-init">istioctl operator init</h2>
<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>
Expand All @@ -3251,11 +3254,6 @@ <h2 id="istioctl-operator-init">istioctl operator init</h2>
<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>
Expand All @@ -3272,14 +3270,6 @@ <h2 id="istioctl-operator-remove">istioctl operator remove</h2>
</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>
Expand All @@ -3290,21 +3280,11 @@ <h2 id="istioctl-operator-remove">istioctl operator remove</h2>
<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>
Expand All @@ -3325,25 +3305,10 @@ <h2 id="istioctl-operator-remove">istioctl operator remove</h2>
<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>
Expand Down Expand Up @@ -3485,6 +3450,14 @@ <h2 id="istioctl-profile-dump">istioctl profile dump</h2>
</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>
Expand Down Expand Up @@ -4250,6 +4223,14 @@ <h2 id="istioctl-upgrade">istioctl upgrade</h2>
</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>
Expand Down Expand Up @@ -4534,6 +4515,12 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down Expand Up @@ -4606,12 +4593,6 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/reference/commands/mixs/index.html
Expand Up @@ -359,6 +359,12 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down Expand Up @@ -401,12 +407,6 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/reference/commands/operator/index.html
Expand Up @@ -153,6 +153,12 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down Expand Up @@ -183,12 +189,6 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/reference/commands/pilot-agent/index.html
Expand Up @@ -574,6 +574,12 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down Expand Up @@ -694,12 +700,6 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down
27 changes: 21 additions & 6 deletions content/en/docs/reference/commands/pilot-discovery/index.html
Expand Up @@ -94,6 +94,11 @@ <h2 id="pilot-discovery-discovery">pilot-discovery discovery</h2>
<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>
Expand Down Expand Up @@ -264,6 +269,16 @@ <h2 id="pilot-discovery-discovery">pilot-discovery discovery</h2>
<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>
Expand Down Expand Up @@ -532,6 +547,12 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down Expand Up @@ -616,12 +637,6 @@ <h2 id="envvars">Environment variables</h2>
<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>
Expand Down
@@ -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>

0 comments on commit a95018f

Please sign in to comment.