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

Automator: update istio.io@ reference docs (#8068)

This commit is contained in:
Istio Automation 2020-09-03 19:09:59 -07:00 committed by GitHub
parent 9bf9ddb324
commit e924acbaa9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 106 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
content/en/docs/reference/commands/istioctl/index.html
View File

@ -1045,6 +1045,10 @@ See https://istio.io/v1.8/docs/ops/deployment/requirements/</p>
</p>
<pre class="language-bash"><code>istioctl experimental add-to-mesh deployment &lt;deployment&gt; [flags]
</code></pre>
<div class="aliases">
<pre class="language-bash"><code>istioctl experimental add-to-mesh deploy &lt;deployment&gt; [flags]
istioctl experimental add-to-mesh dep &lt;deployment&gt; [flags]
</code></pre></div>
<table class="command-flags">
<thead>
<tr>
@ -1207,6 +1211,9 @@ See https://istio.io/v1.8/docs/ops/deployment/requirements/</p>
</p>
<pre class="language-bash"><code>istioctl experimental add-to-mesh service &lt;service&gt; [flags]
</code></pre>
<div class="aliases">
<pre class="language-bash"><code>istioctl experimental add-to-mesh svc &lt;service&gt; [flags]
</code></pre></div>
<table class="command-flags">
<thead>
<tr>
@ -2447,6 +2454,10 @@ istioctl experimental remove-from-mesh service productpage
</p>
<pre class="language-bash"><code>istioctl experimental remove-from-mesh deployment &lt;deployment&gt; [flags]
</code></pre>
<div class="aliases">
<pre class="language-bash"><code>istioctl experimental remove-from-mesh deploy &lt;deployment&gt; [flags]
istioctl experimental remove-from-mesh dep &lt;deployment&gt; [flags]
</code></pre></div>
<table class="command-flags">
<thead>
<tr>
@ -2534,6 +2545,9 @@ istioctl experimental remove-from-mesh external-service vmhttp
</p>
<pre class="language-bash"><code>istioctl experimental remove-from-mesh service &lt;service&gt; [flags]
</code></pre>
<div class="aliases">
<pre class="language-bash"><code>istioctl experimental remove-from-mesh svc &lt;service&gt; [flags]
</code></pre></div>
<table class="command-flags">
<thead>
<tr>
@ -5408,12 +5422,6 @@ These environment variables affect the behavior of the <code>istioctl</code> com
<td>If enabled, pilot will validate CRDs while retrieving CRDs from kubernetes cache.Use this flag to enable validation of CRDs in Pilot, especially in deployments that do not have galley installed.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_EDS_CACHE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If true, Pilot will cache EDS responses.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_EDS_DEBOUNCE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
@ -5498,6 +5506,12 @@ These environment variables affect the behavior of the <code>istioctl</code> com
<td>If set to false, virtualService delegate will not be supported.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_XDS_CACHE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If true, Pilot will cache XDS responses.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_XDS_IDENTITY_CHECK</code></td>
<td>Boolean</td>
<td><code>true</code></td>
@ -5576,6 +5590,18 @@ These environment variables affect the behavior of the <code>istioctl</code> com
<td>If enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used</td>
</tr>
<tr>
<td><code>PILOT_XDS_CACHE_SIZE</code></td>
<td>Integer</td>
<td><code>20000</code></td>
<td>The maximum number of cache entries for the XDS cache. If the size is &lt;= 0, the cache will have no upper bound.</td>
</tr>
<tr>
<td><code>PILOT_XDS_CACHE_STATS</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Pilot will collect metrics for XDS cache efficiency.</td>
</tr>
<tr>
<td><code>POD_NAME</code></td>
<td>String</td>
<td><code></code></td>
@ -5704,5 +5730,8 @@ These environment variables affect the behavior of the <code>istioctl</code> com
<tr><td><code>sidecar_injection_requests_total</code></td><td><code>Sum</code></td><td>Total number of sidecar injection requests.</td></tr>
<tr><td><code>sidecar_injection_skip_total</code></td><td><code>Sum</code></td><td>Total number of skipped sidecar injection requests.</td></tr>
<tr><td><code>sidecar_injection_success_total</code></td><td><code>Sum</code></td><td>Total number of successful sidecar injection requests.</td></tr>
<tr><td><code>xds_cache_evictions</code></td><td><code>Sum</code></td><td>Total number of xds cache evictions.</td></tr>
<tr><td><code>xds_cache_reads</code></td><td><code>Sum</code></td><td>Total number of xds cache xdsCacheReads.</td></tr>
<tr><td><code>xds_cache_size</code></td><td><code>LastValue</code></td><td>Current size of xds cache</td></tr>
</tbody>
</table>

27
content/en/docs/reference/commands/operator/index.html
View File

@ -279,12 +279,6 @@ These environment variables affect the behavior of the <code>operator</code> com
<td>If enabled, pilot will validate CRDs while retrieving CRDs from kubernetes cache.Use this flag to enable validation of CRDs in Pilot, especially in deployments that do not have galley installed.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_EDS_CACHE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If true, Pilot will cache EDS responses.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_EDS_DEBOUNCE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
@ -369,6 +363,12 @@ These environment variables affect the behavior of the <code>operator</code> com
<td>If set to false, virtualService delegate will not be supported.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_XDS_CACHE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If true, Pilot will cache XDS responses.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_XDS_IDENTITY_CHECK</code></td>
<td>Boolean</td>
<td><code>true</code></td>
@ -447,6 +447,18 @@ These environment variables affect the behavior of the <code>operator</code> com
<td>If enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used</td>
</tr>
<tr>
<td><code>PILOT_XDS_CACHE_SIZE</code></td>
<td>Integer</td>
<td><code>20000</code></td>
<td>The maximum number of cache entries for the XDS cache. If the size is &lt;= 0, the cache will have no upper bound.</td>
</tr>
<tr>
<td><code>PILOT_XDS_CACHE_STATS</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Pilot will collect metrics for XDS cache efficiency.</td>
</tr>
<tr>
<td><code>POD_NAME</code></td>
<td>String</td>
<td><code></code></td>
@ -548,5 +560,8 @@ These environment variables affect the behavior of the <code>operator</code> com
<tr><td><code>sidecar_injection_requests_total</code></td><td><code>Sum</code></td><td>Total number of sidecar injection requests.</td></tr>
<tr><td><code>sidecar_injection_skip_total</code></td><td><code>Sum</code></td><td>Total number of skipped sidecar injection requests.</td></tr>
<tr><td><code>sidecar_injection_success_total</code></td><td><code>Sum</code></td><td>Total number of successful sidecar injection requests.</td></tr>
<tr><td><code>xds_cache_evictions</code></td><td><code>Sum</code></td><td>Total number of xds cache evictions.</td></tr>
<tr><td><code>xds_cache_reads</code></td><td><code>Sum</code></td><td>Total number of xds cache xdsCacheReads.</td></tr>
<tr><td><code>xds_cache_size</code></td><td><code>LastValue</code></td><td>Current size of xds cache</td></tr>
</tbody>
</table>

57
content/en/docs/reference/commands/pilot-agent/index.html
View File

@ -632,24 +632,6 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
<td>The type of the credential fetcher. Currently supported types include GoogleComputeEngine</td>
</tr>
<tr>
<td><code>DNS_ADDR</code></td>
<td>String</td>
<td><code>:15053</code></td>
<td>DNS listen address</td>
</tr>
<tr>
<td><code>DNS_AGENT</code></td>
<td>String</td>
<td><code></code></td>
<td>If set, enable the capture of outgoing DNS packets on port 53, redirecting to istio-agent on :15053</td>
</tr>
<tr>
<td><code>DNS_SERVER</code></td>
<td>String</td>
<td><code></code></td>
<td>Protocol and DNS server to use. Currently only tcp-tls: is supported.</td>
</tr>
<tr>
<td><code>ECC_SIGNATURE_ALGORITHM</code></td>
<td>String</td>
<td><code></code></td>
@ -788,6 +770,12 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
<td>If set, enable the capture of outgoing DNS packets on port 53, redirecting to istio-agent on :15053</td>
</tr>
<tr>
<td><code>ISTIO_META_PROXY_XDS_VIA_AGENT</code></td>
<td>String</td>
<td><code></code></td>
<td>If set to enable or true or 1, envoy will proxy XDS calls via the agent instead of directly connecting to istiod. This option will be removed once the feature is stabilized.</td>
</tr>
<tr>
<td><code>ISTIO_PROMETHEUS_ANNOTATIONS</code></td>
<td>String</td>
<td><code></code></td>
@ -872,12 +860,6 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
<td>If enabled, pilot will validate CRDs while retrieving CRDs from kubernetes cache.Use this flag to enable validation of CRDs in Pilot, especially in deployments that do not have galley installed.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_EDS_CACHE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If true, Pilot will cache EDS responses.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_EDS_DEBOUNCE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
@ -962,6 +944,12 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
<td>If set to false, virtualService delegate will not be supported.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_XDS_CACHE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If true, Pilot will cache XDS responses.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_XDS_IDENTITY_CHECK</code></td>
<td>Boolean</td>
<td><code>true</code></td>
@ -1040,6 +1028,18 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
<td>If enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used</td>
</tr>
<tr>
<td><code>PILOT_XDS_CACHE_SIZE</code></td>
<td>Integer</td>
<td><code>20000</code></td>
<td>The maximum number of cache entries for the XDS cache. If the size is &lt;= 0, the cache will have no upper bound.</td>
</tr>
<tr>
<td><code>PILOT_XDS_CACHE_STATS</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Pilot will collect metrics for XDS cache efficiency.</td>
</tr>
<tr>
<td><code>PKCS8_KEY</code></td>
<td>Boolean</td>
<td><code>false</code></td>
@ -1076,12 +1076,6 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
<td>The proxy configuration. This will be set by the injection - gateways will use file mounts.</td>
</tr>
<tr>
<td><code>PROXY_XDS_VIA_AGENT</code></td>
<td>String</td>
<td><code></code></td>
<td>If set to enable or true or 1, envoy will proxy XDS calls via the agent instead of directly connecting to istiod. This option will be removed once the feature is stabilized.</td>
</tr>
<tr>
<td><code>REQUIRE_3P_TOKEN</code></td>
<td>Boolean</td>
<td><code>false</code></td>
@ -1236,5 +1230,8 @@ These environment variables affect the behavior of the <code>pilot-agent</code>
<tr><td><code>total_pushes</code></td><td><code>Sum</code></td><td>The total number of SDS pushes.</td></tr>
<tr><td><code>total_secret_update_failures</code></td><td><code>Sum</code></td><td>The total number of dynamic secret update failures reported by proxy.</td></tr>
<tr><td><code>total_stale_connections</code></td><td><code>Sum</code></td><td>The total number of stale SDS connections.</td></tr>
<tr><td><code>xds_cache_evictions</code></td><td><code>Sum</code></td><td>Total number of xds cache evictions.</td></tr>
<tr><td><code>xds_cache_reads</code></td><td><code>Sum</code></td><td>Total number of xds cache xdsCacheReads.</td></tr>
<tr><td><code>xds_cache_size</code></td><td><code>LastValue</code></td><td>Current size of xds cache</td></tr>
</tbody>
</table>

45
content/en/docs/reference/commands/pilot-discovery/index.html
View File

@ -527,24 +527,6 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
<td>The default TTL of issued workload certificates. Applied when the client sets a non-positive TTL in the CSR.</td>
</tr>
<tr>
<td><code>DNS_ADDR</code></td>
<td>String</td>
<td><code>:15053</code></td>
<td>DNS listen address</td>
</tr>
<tr>
<td><code>DNS_AGENT</code></td>
<td>String</td>
<td><code></code></td>
<td>If set, enable the capture of outgoing DNS packets on port 53, redirecting to istio-agent on :15053</td>
</tr>
<tr>
<td><code>DNS_SERVER</code></td>
<td>String</td>
<td><code></code></td>
<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>
@ -695,12 +677,6 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
<td>If enabled, pilot will validate CRDs while retrieving CRDs from kubernetes cache.Use this flag to enable validation of CRDs in Pilot, especially in deployments that do not have galley installed.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_EDS_CACHE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If true, Pilot will cache EDS responses.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_EDS_DEBOUNCE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
@ -785,6 +761,12 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
<td>If set to false, virtualService delegate will not be supported.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_XDS_CACHE</code></td>
<td>Boolean</td>
<td><code>true</code></td>
<td>If true, Pilot will cache XDS responses.</td>
</tr>
<tr>
<td><code>PILOT_ENABLE_XDS_IDENTITY_CHECK</code></td>
<td>Boolean</td>
<td><code>true</code></td>
@ -863,6 +845,18 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
<td>If enabled, Pilot will use EndpointSlices as the source of endpoints for Kubernetes services. By default, this is false, and Endpoints will be used. This requires the Kubernetes EndpointSlice controller to be enabled. Currently this is mutual exclusive - either Endpoints or EndpointSlices will be used</td>
</tr>
<tr>
<td><code>PILOT_XDS_CACHE_SIZE</code></td>
<td>Integer</td>
<td><code>20000</code></td>
<td>The maximum number of cache entries for the XDS cache. If the size is &lt;= 0, the cache will have no upper bound.</td>
</tr>
<tr>
<td><code>PILOT_XDS_CACHE_STATS</code></td>
<td>Boolean</td>
<td><code>false</code></td>
<td>If true, Pilot will collect metrics for XDS cache efficiency.</td>
</tr>
<tr>
<td><code>POD_NAME</code></td>
<td>String</td>
<td><code></code></td>
@ -1035,5 +1029,8 @@ These environment variables affect the behavior of the <code>pilot-discovery</co
<tr><td><code>sidecar_injection_requests_total</code></td><td><code>Sum</code></td><td>Total number of sidecar injection requests.</td></tr>
<tr><td><code>sidecar_injection_skip_total</code></td><td><code>Sum</code></td><td>Total number of skipped sidecar injection requests.</td></tr>
<tr><td><code>sidecar_injection_success_total</code></td><td><code>Sum</code></td><td>Total number of successful sidecar injection requests.</td></tr>
<tr><td><code>xds_cache_evictions</code></td><td><code>Sum</code></td><td>Total number of xds cache evictions.</td></tr>
<tr><td><code>xds_cache_reads</code></td><td><code>Sum</code></td><td>Total number of xds cache xdsCacheReads.</td></tr>
<tr><td><code>xds_cache_size</code></td><td><code>LastValue</code></td><td>Current size of xds cache</td></tr>
</tbody>
</table>

4
content/en/docs/reference/config/security/authorization-policy/index.html
View File

@ -31,7 +31,7 @@ Requests will be allowed or denied based solely on ALLOW and DENY policies.</p>
<p>A request will be internally marked that it should be audited if there is an AUDIT policy on the workload that matches the request.
A separate plugin must be configured and enabled to actually fulfill the audit decision and complete the audit behavior.
The request will not be audited if there are no such supporting plugins enabled.
Currently, the only supported plugin is the <a href="/docs/reference/config/proxy_extensions/stackdriver/">Telemetry v2 Stackdriver</a> plugin.</p>
Currently, the only supported plugin is the <a href="/docs/reference/config/proxy_extensions/stackdriver/">Stackdriver</a> plugin.</p>
<p>Here is an example of Istio Authorization Policy:</p>
@ -118,7 +118,7 @@ spec:
- to:
- operation:
methods: [&quot;GET&quot;]
paths: ["/user/profile/*"]
paths: [&quot;/user/profile/*&quot;]
````
Authorization Policy scope (target) is determined by &quot;metadata/namespace&quot; and