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 (#9091)

This commit is contained in:
Istio Automation 2021-03-01 18:12:36 -08:00 committed by GitHub
parent 751d90bd67
commit ec5ebe725b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 116 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
title: istioctl
description: Istio control interface.
generator: pkg-collateral-docs
number_of_entries: 82
number_of_entries: 83
max_toc_level: 2
remove_toc_prefix: 'istioctl '
---
@ -1073,7 +1073,7 @@ istioctl experimental add-to-mesh dep <deployment> [flags]
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
<tr>
@ -1243,7 +1243,7 @@ See https://istio.io/v1.10/docs/ops/deployment/requirements/</p>
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
<tr>
@ -2018,7 +2018,7 @@ calculated over a time interval of 1 minute.
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
</tbody>
@ -2093,7 +2093,7 @@ Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
<tr>
@ -2893,7 +2893,7 @@ If set to true, the user is not prompted and a Yes response is assumed in all ca
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
<tr>
@ -2986,7 +2986,7 @@ istioctl x version --xds-label istio.io/rev=default
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
<tr>
@ -3162,7 +3162,7 @@ Configure requires either the WorkloadGroup artifact path or its location on the
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
<tr>
@ -3466,7 +3466,7 @@ kube-inject on deployments to get the most up-to-date changes.
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
<tr>
@ -4372,6 +4372,107 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.10/i
<pre class="language-bash"><code> # Retrieve information about proxy configuration from an Envoy instance.
istioctl proxy-config &lt;clusters|listeners|routes|endpoints|bootstrap|log|secret&gt; &lt;pod-name[.namespace]&gt;
</code></pre>
<h2 id="istioctl-proxy-config-all">istioctl proxy-config all</h2>
<p>Retrieve information about all configuration for the Envoy instance in the specified pod.</p>
<pre class="language-bash"><code>istioctl proxy-config all [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre>
<div class="aliases">
<pre class="language-bash"><code>istioctl proxy-config all [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
istioctl proxy-config a [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre></div>
<table class="command-flags">
<thead>
<tr>
<th>Flags</th>
<th>Shorthand</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>--address &lt;string&gt;</code></td>
<td></td>
<td>Filter listeners by address field (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>
</tr>
<tr>
<td><code>--direction &lt;string&gt;</code></td>
<td></td>
<td>Filter clusters by Direction field (default ``)</td>
</tr>
<tr>
<td><code>--file &lt;string&gt;</code></td>
<td><code>-f</code></td>
<td>Envoy config dump JSON file (default ``)</td>
</tr>
<tr>
<td><code>--fqdn &lt;string&gt;</code></td>
<td></td>
<td>Filter clusters by substring of Service FQDN field (default ``)</td>
</tr>
<tr>
<td><code>--istioNamespace &lt;string&gt;</code></td>
<td><code>-i</code></td>
<td>Istio system namespace (default `istio-system`)</td>
</tr>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Kubernetes configuration file (default ``)</td>
</tr>
<tr>
<td><code>--name &lt;string&gt;</code></td>
<td></td>
<td>Filter listeners by route name field (default ``)</td>
</tr>
<tr>
<td><code>--namespace &lt;string&gt;</code></td>
<td><code>-n</code></td>
<td>Config namespace (default ``)</td>
</tr>
<tr>
<td><code>--output &lt;string&gt;</code></td>
<td><code>-o</code></td>
<td>Output format: one of json|short (default `short`)</td>
</tr>
<tr>
<td><code>--port &lt;int&gt;</code></td>
<td></td>
<td>Filter clusters and listeners by Port field (default `0`)</td>
</tr>
<tr>
<td><code>--subset &lt;string&gt;</code></td>
<td></td>
<td>Filter clusters by substring of Subset field (default ``)</td>
</tr>
<tr>
<td><code>--type &lt;string&gt;</code></td>
<td></td>
<td>Filter listeners by type field (default ``)</td>
</tr>
<tr>
<td><code>--verbose</code></td>
<td></td>
<td>Output more information </td>
</tr>
</tbody>
</table>
<h3 id="istioctl-proxy-config-all Examples">Examples</h3>
<pre class="language-bash"><code> # Retrieve summary about all configuration for a given pod from Envoy.
istioctl proxy-config all &lt;pod-name[.namespace]&gt;
# Retrieve full cluster dump as JSON
istioctl proxy-config all &lt;pod-name[.namespace]&gt; -o json
# Retrieve cluster summary without using Kubernetes API
ssh &lt;user@hostname&gt; &#39;curl localhost:15000/config_dump&#39; &gt; envoy-config.json
istioctl proxy-config all --file envoy-config.json
</code></pre>
<h2 id="istioctl-proxy-config-bootstrap">istioctl proxy-config bootstrap</h2>
<p>Retrieve information about bootstrap configuration for the Envoy instance in the specified pod.</p>
<pre class="language-bash"><code>istioctl proxy-config bootstrap [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
@ -4935,7 +5036,7 @@ Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
</tbody>
@ -5164,7 +5265,7 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.10/i
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
</tbody>
@ -5178,6 +5279,9 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.10/i
# Verify the deployment matches the Istio Operator deployment definition
istioctl verify-install --revision &lt;canary&gt;
# Verify the installation of specific revision
istioctl verify-install -r 1-9-0
</code></pre>
<h2 id="istioctl-version">istioctl version</h2>
<p>Prints out build version information</p>
@ -5224,7 +5328,7 @@ or release tar URL (e.g. https://github.com/istio/istio/releases/download/1.10/i
</tr>
<tr>
<td><code>--revision &lt;string&gt;</code></td>
<td></td>
<td><code>-r</code></td>
<td>Control plane revision (default ``)</td>
</tr>
<tr>