Skip to content

Commit

Permalink
Automator: update istio.io@ reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@istio-testing
istio-testing committed Sep 8, 2023
1 parent a048603 commit 1c42058
Show file tree
Hide file tree
Showing 2 changed files with 188 additions and 18 deletions.
103 changes: 94 additions & 9 deletions content/en/docs/reference/commands/istioctl/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
title: istioctl
description: Istio control interface.
generator: pkg-collateral-docs
number_of_entries: 94
number_of_entries: 95
max_toc_level: 2
remove_toc_prefix: 'istioctl '
---
Expand Down Expand Up @@ -1119,6 +1119,8 @@ <h3 id="istioctl-dashboard-controlz Examples">Examples</h3>
</code></pre>
<h2 id="istioctl-dashboard-envoy">istioctl dashboard envoy</h2>
<p>Open the Envoy admin dashboard for a sidecar</p>
<p>Note: envoy command is deprecated and can be replaced with proxy command, e.g. `istioctl dashboard proxy --help`
</p>
<pre class="language-bash"><code>istioctl dashboard envoy [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre>
<table class="command-flags">
Expand Down Expand Up @@ -1462,6 +1464,89 @@ <h3 id="istioctl-dashboard-prometheus Examples">Examples</h3>
istioctl dash prometheus
istioctl d prometheus
</code></pre>
<h2 id="istioctl-dashboard-proxy">istioctl dashboard proxy</h2>
<p>Open the admin dashboard for a proxy, like envoy and ztunnel pods</p>
<pre class="language-bash"><code>istioctl dashboard proxy [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre>
<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>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
</tr>
<tr>
<td><code>--browser</code></td>
<td></td>
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
</tr>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>Kubernetes configuration context (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>--namespace &lt;string&gt;</code></td>
<td><code>-n</code></td>
<td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td>
</tr>
<tr>
<td><code>--port &lt;int&gt;</code></td>
<td><code>-p</code></td>
<td>Local port to listen to (default `0`)</td>
</tr>
<tr>
<td><code>--selector &lt;string&gt;</code></td>
<td><code>-l</code></td>
<td>Label selector (default ``)</td>
</tr>
<tr>
<td><code>--ui-port &lt;int&gt;</code></td>
<td></td>
<td>The component dashboard UI port. (default `15000`)</td>
</tr>
<tr>
<td><code>--vklog &lt;Level&gt;</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-dashboard-proxy Examples">Examples</h3>
<pre class="language-bash"><code> # Open envoy admin dashboard for the productpage-123-456.default pod
istioctl dashboard proxy productpage-123-456.default

# Open envoy admin dashboard for one pod under a deployment
istioctl dashboard proxy deployment/productpage-v1

# Open dashboard for the ztunnel-bwh89.istio-system pod
istioctl dashboard proxy ztunnel-bwh89.istio-system

# Open dashboard for a waypoint pod
istioctl dashboard proxy namespace-istio-waypoint-869b56b69c-7khz4

# with short syntax
istioctl dash proxy ztunnel-bwh89.istio-system
istioctl d proxy ztunnel-bwh89.istio-system

</code></pre>
<h2 id="istioctl-dashboard-skywalking">istioctl dashboard skywalking</h2>
<p>Open the Istio dashboard in the SkyWalking UI</p>
<pre class="language-bash"><code>istioctl dashboard skywalking [flags]
Expand Down Expand Up @@ -4293,7 +4378,7 @@ <h2 id="istioctl-operator-init">istioctl operator init</h2>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>The name of the kubeconfig context to use. (default ``)</td>
<td>Kubernetes configuration context (default ``)</td>
</tr>
<tr>
<td><code>--dry-run</code></td>
Expand Down Expand Up @@ -4325,7 +4410,7 @@ <h2 id="istioctl-operator-init">istioctl operator init</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Path to kube config. (default ``)</td>
<td>Kubernetes configuration file (default ``)</td>
</tr>
<tr>
<td><code>--manifests &lt;string&gt;</code></td>
Expand Down Expand Up @@ -4382,7 +4467,7 @@ <h2 id="istioctl-operator-remove">istioctl operator remove</h2>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>The name of the kubeconfig context to use. (default ``)</td>
<td>Kubernetes configuration context (default ``)</td>
</tr>
<tr>
<td><code>--dry-run</code></td>
Expand All @@ -4402,7 +4487,7 @@ <h2 id="istioctl-operator-remove">istioctl operator remove</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Path to kube config. (default ``)</td>
<td>Kubernetes configuration file (default ``)</td>
</tr>
<tr>
<td><code>--namespace &lt;string&gt;</code></td>
Expand Down Expand Up @@ -6060,7 +6145,7 @@ <h2 id="istioctl-uninstall">istioctl uninstall</h2>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>The name of the kubeconfig context to use. (default ``)</td>
<td>Kubernetes configuration context (default ``)</td>
</tr>
<tr>
<td><code>--dry-run</code></td>
Expand All @@ -6079,13 +6164,13 @@ <h2 id="istioctl-uninstall">istioctl uninstall</h2>
</tr>
<tr>
<td><code>--istioNamespace &lt;string&gt;</code></td>
<td></td>
<td>The namespace of Istio Control Plane. (default `istio-system`)</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>Path to kube config. (default ``)</td>
<td>Kubernetes configuration file (default ``)</td>
</tr>
<tr>
<td><code>--manifests &lt;string&gt;</code></td>
Expand Down
103 changes: 94 additions & 9 deletions content/zh/docs/reference/commands/istioctl/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
title: istioctl
description: Istio control interface.
generator: pkg-collateral-docs
number_of_entries: 94
number_of_entries: 95
max_toc_level: 2
remove_toc_prefix: 'istioctl '
---
Expand Down Expand Up @@ -1119,6 +1119,8 @@ <h3 id="istioctl-dashboard-controlz Examples">Examples</h3>
</code></pre>
<h2 id="istioctl-dashboard-envoy">istioctl dashboard envoy</h2>
<p>Open the Envoy admin dashboard for a sidecar</p>
<p>Note: envoy command is deprecated and can be replaced with proxy command, e.g. `istioctl dashboard proxy --help`
</p>
<pre class="language-bash"><code>istioctl dashboard envoy [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre>
<table class="command-flags">
Expand Down Expand Up @@ -1462,6 +1464,89 @@ <h3 id="istioctl-dashboard-prometheus Examples">Examples</h3>
istioctl dash prometheus
istioctl d prometheus
</code></pre>
<h2 id="istioctl-dashboard-proxy">istioctl dashboard proxy</h2>
<p>Open the admin dashboard for a proxy, like envoy and ztunnel pods</p>
<pre class="language-bash"><code>istioctl dashboard proxy [&lt;type&gt;/]&lt;name&gt;[.&lt;namespace&gt;] [flags]
</code></pre>
<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>Address to listen on. Only accepts IP address or localhost as a value. When localhost is supplied, istioctl will try to bind on both 127.0.0.1 and ::1 and will fail if neither of these address are available to bind. (default `localhost`)</td>
</tr>
<tr>
<td><code>--browser</code></td>
<td></td>
<td>When --browser is supplied as false, istioctl dashboard will not open the browser. Default is true which means istioctl dashboard will always open a browser to view the dashboard. </td>
</tr>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>Kubernetes configuration context (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>--namespace &lt;string&gt;</code></td>
<td><code>-n</code></td>
<td>Namespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)</td>
</tr>
<tr>
<td><code>--port &lt;int&gt;</code></td>
<td><code>-p</code></td>
<td>Local port to listen to (default `0`)</td>
</tr>
<tr>
<td><code>--selector &lt;string&gt;</code></td>
<td><code>-l</code></td>
<td>Label selector (default ``)</td>
</tr>
<tr>
<td><code>--ui-port &lt;int&gt;</code></td>
<td></td>
<td>The component dashboard UI port. (default `15000`)</td>
</tr>
<tr>
<td><code>--vklog &lt;Level&gt;</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-dashboard-proxy Examples">Examples</h3>
<pre class="language-bash"><code> # Open envoy admin dashboard for the productpage-123-456.default pod
istioctl dashboard proxy productpage-123-456.default

# Open envoy admin dashboard for one pod under a deployment
istioctl dashboard proxy deployment/productpage-v1

# Open dashboard for the ztunnel-bwh89.istio-system pod
istioctl dashboard proxy ztunnel-bwh89.istio-system

# Open dashboard for a waypoint pod
istioctl dashboard proxy namespace-istio-waypoint-869b56b69c-7khz4

# with short syntax
istioctl dash proxy ztunnel-bwh89.istio-system
istioctl d proxy ztunnel-bwh89.istio-system

</code></pre>
<h2 id="istioctl-dashboard-skywalking">istioctl dashboard skywalking</h2>
<p>Open the Istio dashboard in the SkyWalking UI</p>
<pre class="language-bash"><code>istioctl dashboard skywalking [flags]
Expand Down Expand Up @@ -4293,7 +4378,7 @@ <h2 id="istioctl-operator-init">istioctl operator init</h2>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>The name of the kubeconfig context to use. (default ``)</td>
<td>Kubernetes configuration context (default ``)</td>
</tr>
<tr>
<td><code>--dry-run</code></td>
Expand Down Expand Up @@ -4325,7 +4410,7 @@ <h2 id="istioctl-operator-init">istioctl operator init</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Path to kube config. (default ``)</td>
<td>Kubernetes configuration file (default ``)</td>
</tr>
<tr>
<td><code>--manifests &lt;string&gt;</code></td>
Expand Down Expand Up @@ -4382,7 +4467,7 @@ <h2 id="istioctl-operator-remove">istioctl operator remove</h2>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>The name of the kubeconfig context to use. (default ``)</td>
<td>Kubernetes configuration context (default ``)</td>
</tr>
<tr>
<td><code>--dry-run</code></td>
Expand All @@ -4402,7 +4487,7 @@ <h2 id="istioctl-operator-remove">istioctl operator remove</h2>
<tr>
<td><code>--kubeconfig &lt;string&gt;</code></td>
<td><code>-c</code></td>
<td>Path to kube config. (default ``)</td>
<td>Kubernetes configuration file (default ``)</td>
</tr>
<tr>
<td><code>--namespace &lt;string&gt;</code></td>
Expand Down Expand Up @@ -6060,7 +6145,7 @@ <h2 id="istioctl-uninstall">istioctl uninstall</h2>
<tr>
<td><code>--context &lt;string&gt;</code></td>
<td></td>
<td>The name of the kubeconfig context to use. (default ``)</td>
<td>Kubernetes configuration context (default ``)</td>
</tr>
<tr>
<td><code>--dry-run</code></td>
Expand All @@ -6079,13 +6164,13 @@ <h2 id="istioctl-uninstall">istioctl uninstall</h2>
</tr>
<tr>
<td><code>--istioNamespace &lt;string&gt;</code></td>
<td></td>
<td>The namespace of Istio Control Plane. (default `istio-system`)</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>Path to kube config. (default ``)</td>
<td>Kubernetes configuration file (default ``)</td>
</tr>
<tr>
<td><code>--manifests &lt;string&gt;</code></td>
Expand Down

0 comments on commit 1c42058

Please sign in to comment.