mirror of https://github.com/istio/istio.io.git
Automator: update istio.io@ reference docs (#14183)
This commit is contained in:
Istio Automation
GitHub
parent
15cddd4d8c
commit
43d3507f86
|
|
@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
|
|||
title: istioctl
|
||||
description: Istio control interface.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 95
|
||||
number_of_entries: 92
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'istioctl '
|
||||
---
|
||||
|
|
@ -2650,196 +2650,6 @@ Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in
|
|||
# (Select a specific control plane in an in-cluster canary Istio configuration.)
|
||||
istioctl x ps --xds-label istio.io/rev=default
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision">istioctl experimental revision</h2>
|
||||
<p>The revision command provides a revision centric view of istio deployments. It provides insight into IstioOperator CRs defining the revision, istiod and gateway pods which are part of deployment of a particular revision.</p>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.21.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-revision-describe">istioctl experimental revision describe</h2>
|
||||
<p>Show information about a revision, including customizations, istiod version and which pods/gateways are using it.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision describe [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.21.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-revision-describe Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # View the details of a revision named 'canary'
|
||||
istioctl x revision describe canary
|
||||
|
||||
# View the details of a revision named 'canary' and also the pods
|
||||
# under that particular revision
|
||||
istioctl x revision describe canary -v
|
||||
|
||||
# Get details about a revision in json format (default format is human-friendly table format)
|
||||
istioctl x revision describe canary -v -o json
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-list">istioctl experimental revision list</h2>
|
||||
<p>Show list of control plane and gateway revisions that are currently installed in cluster</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision list [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.21.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-revision-list Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # View summary of revisions installed in the current cluster
|
||||
# which can be overridden with --context parameter.
|
||||
istioctl x revision list
|
||||
|
||||
# View list of revisions including customizations, istiod and gateway pods
|
||||
istioctl x revision list -v
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-version">istioctl experimental version</h2>
|
||||
<p>Prints out build version information</p>
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ source_repo: https://github.com/istio/istio
|
|||
title: istioctl
|
||||
description: Istio control interface.
|
||||
generator: pkg-collateral-docs
|
||||
number_of_entries: 95
|
||||
number_of_entries: 92
|
||||
max_toc_level: 2
|
||||
remove_toc_prefix: 'istioctl '
|
||||
---
|
||||
|
|
@ -2650,196 +2650,6 @@ Retrieves last sent and last acknowledged xDS sync from Istiod to each Envoy in
|
|||
# (Select a specific control plane in an in-cluster canary Istio configuration.)
|
||||
istioctl x ps --xds-label istio.io/rev=default
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision">istioctl experimental revision</h2>
|
||||
<p>The revision command provides a revision centric view of istio deployments. It provides insight into IstioOperator CRs defining the revision, istiod and gateway pods which are part of deployment of a particular revision.</p>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.21.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="istioctl-experimental-revision-describe">istioctl experimental revision describe</h2>
|
||||
<p>Show information about a revision, including customizations, istiod version and which pods/gateways are using it.</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision describe [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.21.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-revision-describe Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # View the details of a revision named 'canary'
|
||||
istioctl x revision describe canary
|
||||
|
||||
# View the details of a revision named 'canary' and also the pods
|
||||
# under that particular revision
|
||||
istioctl x revision describe canary -v
|
||||
|
||||
# Get details about a revision in json format (default format is human-friendly table format)
|
||||
istioctl x revision describe canary -v -o json
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-revision-list">istioctl experimental revision list</h2>
|
||||
<p>Show list of control plane and gateway revisions that are currently installed in cluster</p>
|
||||
<pre class="language-bash"><code>istioctl experimental revision list [flags]
|
||||
</code></pre>
|
||||
<table class="command-flags">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flags</th>
|
||||
<th>Shorthand</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>--context <string></code></td>
|
||||
<td></td>
|
||||
<td>Kubernetes configuration context (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--istioNamespace <string></code></td>
|
||||
<td><code>-i</code></td>
|
||||
<td>Istio system namespace (default `istio-system`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--kubeconfig <string></code></td>
|
||||
<td><code>-c</code></td>
|
||||
<td>Kubernetes configuration file (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--manifests <string></code></td>
|
||||
<td><code>-d</code></td>
|
||||
<td>Specify a path to a directory of charts and profiles
|
||||
(e.g. ~/Downloads/istio-1.21.0/manifests).
|
||||
(default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--namespace <string></code></td>
|
||||
<td><code>-n</code></td>
|
||||
<td>Kubernetes namespace (default ``)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--output <string></code></td>
|
||||
<td><code>-o</code></td>
|
||||
<td>Output format for revision description (available formats: table,json) (default `table`)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--verbose</code></td>
|
||||
<td><code>-v</code></td>
|
||||
<td>Enable verbose output </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>--vklog <Level></code></td>
|
||||
<td></td>
|
||||
<td>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="istioctl-experimental-revision-list Examples">Examples</h3>
|
||||
<pre class="language-bash"><code> # View summary of revisions installed in the current cluster
|
||||
# which can be overridden with --context parameter.
|
||||
istioctl x revision list
|
||||
|
||||
# View list of revisions including customizations, istiod and gateway pods
|
||||
istioctl x revision list -v
|
||||
|
||||
</code></pre>
|
||||
<h2 id="istioctl-experimental-version">istioctl experimental version</h2>
|
||||
<p>Prints out build version information</p>
|
||||
|
|
|
|||
Loading…
Reference in New Issue