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

Update controlz interface img and output command (#7859) 

* Update controlz interface img and output command

* Fix review comments

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

* use istiod pod name

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>

* Update title and description to be more specific to istiod

Co-authored-by: Frank Budinsky <frankb@ca.ibm.com>
This commit is contained in:
Shamsher Ansari 2020-08-07 21:21:05 +05:30 committed by GitHub
parent ac7754c8cb
commit 616983f3fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
content/en/docs/ops/diagnostic-tools/controlz/ctrlz.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 209 KiB

After

Width:  |  Height:  |  Size: 106 KiB

22
content/en/docs/ops/diagnostic-tools/controlz/index.md
View File

@ -1,6 +1,6 @@
---
title: Component Introspection
description: Describes how to use ControlZ to get insight into individual running components.
title: Istiod Introspection
description: Describes how to use ControlZ to get insight into a running istiod component.
weight: 60
keywords: [ops]
aliases:
@ -10,27 +10,25 @@ owner: istio/wg-user-experience-maintainers
test: no
---
Istio components are built with a flexible introspection framework which makes it easy to inspect and manipulate the internal state
of a running component. Components open a port which can be used from a web browser to get an interactive view into the state of the
component, or via REST for access and control from external tools.
Istiod is build with a flexible introspection framework, called ControlZ, which makes it easy to inspect and manipulate the internal state
of an istiod instance. Istiod opens a port which can be used from a web browser to get an interactive view into its state,
or via REST for access and control from external tools.
Mixer, Pilot, and Galley all implement the ControlZ functionality. When these components start, a message is logged indicating the
IP address and port to connect to in order to interact with ControlZ.
When Istiod starts, a message is logged indicating the IP address and port to connect to in order to interact with ControlZ.
{{< text plain >}}
2018-07-26T23:28:48.889370Z info ControlZ available at 100.76.122.230:9876
2020-08-04T23:28:48.889370Z info ControlZ available at 100.76.122.230:9876
{{< /text >}}
Here's sample of the ControlZ interface:
{{< image width="80%" link="./ctrlz.png" caption="ControlZ User Interface" >}}
{{< image width="90%" link="./ctrlz.png" caption="ControlZ User Interface" >}}
To access the ControlZ page of deployed components (i.e. Mixer, Galley, Pilot), you can port-forward their ControlZ endpoints
To access the ControlZ page of istiod, you can port-forward its ControlZ endpoint
locally and connect through your local browser:
{{< text bash >}}
$ istioctl dashboard controlz <podname>
$ istioctl dashboard controlz <istiod pod name> -n istio-system
{{< /text >}}
This will redirect the component's ControlZ page to `http://localhost:9876` for remote access.