From 1c420584ba75ec1ffe7c763e1a540e20b1093ff7 Mon Sep 17 00:00:00 2001 From: istio-testing Date: Fri, 8 Sep 2023 02:05:30 +0000 Subject: [PATCH] Automator: update istio.io@ reference docs --- .../reference/commands/istioctl/index.html | 103 ++++++++++++++++-- .../reference/commands/istioctl/index.html | 103 ++++++++++++++++-- 2 files changed, 188 insertions(+), 18 deletions(-) diff --git a/content/en/docs/reference/commands/istioctl/index.html b/content/en/docs/reference/commands/istioctl/index.html index 8856e84332f2a..af320f03f0d44 100644 --- a/content/en/docs/reference/commands/istioctl/index.html +++ b/content/en/docs/reference/commands/istioctl/index.html @@ -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 ' --- @@ -1119,6 +1119,8 @@

Examples

istioctl dashboard envoy

Open the Envoy admin dashboard for a sidecar

+

Note: envoy command is deprecated and can be replaced with proxy command, e.g. `istioctl dashboard proxy --help` +

istioctl dashboard envoy [<type>/]<name>[.<namespace>] [flags]
@@ -1462,6 +1464,89 @@

Examples

istioctl dash prometheus istioctl d prometheus +

istioctl dashboard proxy

+

Open the admin dashboard for a proxy, like envoy and ztunnel pods

+
istioctl dashboard proxy [<type>/]<name>[.<namespace>] [flags]
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--address <string>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`)
--browserWhen --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.
--context <string>Kubernetes configuration context (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--selector <string>-lLabel selector (default ``)
--ui-port <int>The component dashboard UI port. (default `15000`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
+

Examples

+
  # 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
+
+

istioctl dashboard skywalking

Open the Istio dashboard in the SkyWalking UI

istioctl dashboard skywalking [flags]
@@ -4293,7 +4378,7 @@ 
istioctl operator init

 
 --context <string>
 
-The name of the kubeconfig context to use.  (default ``)
+Kubernetes configuration context  (default ``)
 
 
 --dry-run
@@ -4325,7 +4410,7 @@ 
istioctl operator init

 
 --kubeconfig <string>
 -c
-Path to kube config.  (default ``)
+Kubernetes configuration file  (default ``)
 
 
 --manifests <string>
@@ -4382,7 +4467,7 @@ 
istioctl operator remove

 
 --context <string>
 
-The name of the kubeconfig context to use.  (default ``)
+Kubernetes configuration context  (default ``)
 
 
 --dry-run
@@ -4402,7 +4487,7 @@ 
istioctl operator remove

 
 --kubeconfig <string>
 -c
-Path to kube config.  (default ``)
+Kubernetes configuration file  (default ``)
 
 
 --namespace <string>
@@ -6060,7 +6145,7 @@ 
istioctl uninstall

 
 --context <string>
 
-The name of the kubeconfig context to use.  (default ``)
+Kubernetes configuration context  (default ``)
 
 
 --dry-run
@@ -6079,13 +6164,13 @@ 
istioctl uninstall

 
 
 --istioNamespace <string>
-
-The namespace of Istio Control Plane.  (default `istio-system`)
+-i
+Istio system namespace  (default `istio-system`)
 
 
 --kubeconfig <string>
 -c
-Path to kube config.  (default ``)
+Kubernetes configuration file  (default ``)
 
 
 --manifests <string>
diff --git a/content/zh/docs/reference/commands/istioctl/index.html b/content/zh/docs/reference/commands/istioctl/index.html
index 8856e84332f2a..af320f03f0d44 100644
--- a/content/zh/docs/reference/commands/istioctl/index.html
+++ b/content/zh/docs/reference/commands/istioctl/index.html
@@ -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 '
 ---
@@ -1119,6 +1119,8 @@ 
Examples

istioctl dashboard envoy

Open the Envoy admin dashboard for a sidecar

+

Note: envoy command is deprecated and can be replaced with proxy command, e.g. `istioctl dashboard proxy --help` +

istioctl dashboard envoy [<type>/]<name>[.<namespace>] [flags]
@@ -1462,6 +1464,89 @@

Examples

istioctl dash prometheus istioctl d prometheus +

istioctl dashboard proxy

+

Open the admin dashboard for a proxy, like envoy and ztunnel pods

+
istioctl dashboard proxy [<type>/]<name>[.<namespace>] [flags]
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FlagsShorthandDescription
--address <string>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`)
--browserWhen --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.
--context <string>Kubernetes configuration context (default ``)
--istioNamespace <string>-iIstio system namespace (default `istio-system`)
--kubeconfig <string>-cKubernetes configuration file (default ``)
--namespace <string>-nNamespace where the addon is running, if not specified, istio-system would be used (default `istio-system`)
--port <int>-pLocal port to listen to (default `0`)
--selector <string>-lLabel selector (default ``)
--ui-port <int>The component dashboard UI port. (default `15000`)
--vklog <Level>number for the log level verbosity. Like -v flag. ex: --vklog=9 (default `0`)
+

Examples

+
  # 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
+
+

istioctl dashboard skywalking

Open the Istio dashboard in the SkyWalking UI

istioctl dashboard skywalking [flags]
@@ -4293,7 +4378,7 @@ 
istioctl operator init

 
 --context <string>
 
-The name of the kubeconfig context to use.  (default ``)
+Kubernetes configuration context  (default ``)
 
 
 --dry-run
@@ -4325,7 +4410,7 @@ 
istioctl operator init

 
 --kubeconfig <string>
 -c
-Path to kube config.  (default ``)
+Kubernetes configuration file  (default ``)
 
 
 --manifests <string>
@@ -4382,7 +4467,7 @@ 
istioctl operator remove

 
 --context <string>
 
-The name of the kubeconfig context to use.  (default ``)
+Kubernetes configuration context  (default ``)
 
 
 --dry-run
@@ -4402,7 +4487,7 @@ 
istioctl operator remove

 
 --kubeconfig <string>
 -c
-Path to kube config.  (default ``)
+Kubernetes configuration file  (default ``)
 
 
 --namespace <string>
@@ -6060,7 +6145,7 @@ 
istioctl uninstall

 
 --context <string>
 
-The name of the kubeconfig context to use.  (default ``)
+Kubernetes configuration context  (default ``)
 
 
 --dry-run
@@ -6079,13 +6164,13 @@ 
istioctl uninstall

 
 
 --istioNamespace <string>
-
-The namespace of Istio Control Plane.  (default `istio-system`)
+-i
+Istio system namespace  (default `istio-system`)
 
 
 --kubeconfig <string>
 -c
-Path to kube config.  (default ``)
+Kubernetes configuration file  (default ``)
 
 
 --manifests <string>