Use 'istioctl dashboard' instead of port-forward (#5296)

* Use 'istioctl dashboard' instead of port-forward

* bold references to UI elements

* Cleanup dashboards

* Address comments

* Mention control-c, which is easier way to stop dashboard
This commit is contained in:
Ed Snible 2019-11-12 10:28:54 -05:00 committed by Istio Automation
parent ad1020b40c
commit b419fcbfab
8 changed files with 20 additions and 32 deletions

View File

@ -174,14 +174,14 @@ in processing the most recent configuration as supplied.
1. In Kubernetes environments, setup port-forwarding with: 1. In Kubernetes environments, setup port-forwarding with:
{{< text bash >}} {{< text bash >}}
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090 & $ istioctl dashboard prometheus
{{< /text >}} {{< /text >}}
1. Visit `http://localhost:9090/targets` 1. In the Prometheus browser window, select **Status** then **Targets**.
1. Confirm the target `istio-mesh` has a status of UP. 1. Confirm the target `istio-mesh` has a status of UP.
1. Visit `http://localhost:9090/config` 1. In the Prometheus browser window, select **Status** then **Configuration**.
1. Confirm an entry exists similar to: 1. Confirm an entry exists similar to:

View File

@ -37,11 +37,9 @@ To learn how Istio handles tracing, visit this task's [overview](../overview/).
For testing (and temporary access), you may also use port-forwarding. Use the following, assuming you've deployed Jaeger to the `istio-system` namespace: For testing (and temporary access), you may also use port-forwarding. Use the following, assuming you've deployed Jaeger to the `istio-system` namespace:
{{< text bash >}} {{< text bash >}}
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=jaeger -o jsonpath='{.items[0].metadata.name}') 15032:16686 $ istioctl dashboard jaeger
{{< /text >}} {{< /text >}}
Open your browser to [http://localhost:15032](http://localhost:15032).
## Generating traces using the Bookinfo sample ## Generating traces using the Bookinfo sample
1. When the Bookinfo application is up and running, access `http://$GATEWAY_URL/productpage` one or more times 1. When the Bookinfo application is up and running, access `http://$GATEWAY_URL/productpage` one or more times
@ -65,10 +63,10 @@ Open your browser to [http://localhost:15032](http://localhost:15032).
## Cleanup ## Cleanup
1. Remove any `kubectl port-forward` processes that may still be running: 1. Remove any `istioctl` processes that may still be running using control-C or:
{{< text bash >}} {{< text bash >}}
$ killall kubectl $ killall istioctl
{{< /text >}} {{< /text >}}
1. If you are not planning to explore any follow-on tasks, refer to the 1. If you are not planning to explore any follow-on tasks, refer to the

View File

@ -37,11 +37,9 @@ To learn how Istio handles tracing, visit this task's [overview](../overview/).
For testing (and temporary access), you may also use port-forwarding. Use the following, assuming you've deployed Zipkin to the `istio-system` namespace: For testing (and temporary access), you may also use port-forwarding. Use the following, assuming you've deployed Zipkin to the `istio-system` namespace:
{{< text bash >}} {{< text bash >}}
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=zipkin -o jsonpath='{.items[0].metadata.name}') 15032:9411 $ istioctl dashboard zipkin
{{< /text >}} {{< /text >}}
Open your browser to [http://localhost:15032](http://localhost:15032).
## Generating traces using the Bookinfo sample ## Generating traces using the Bookinfo sample
1. When the Bookinfo application is up and running, access `http://$GATEWAY_URL/productpage` one or more times 1. When the Bookinfo application is up and running, access `http://$GATEWAY_URL/productpage` one or more times
@ -65,10 +63,10 @@ Open your browser to [http://localhost:15032](http://localhost:15032).
## Cleanup ## Cleanup
1. Remove any `kubectl port-forward` processes that may still be running: 1. Remove any `istioctl` processes that may still be running using control-C or:
{{< text bash >}} {{< text bash >}}
$ killall kubectl $ killall istioctl
{{< /text >}} {{< /text >}}
1. If you are not planning to explore any follow-on tasks, refer to the 1. If you are not planning to explore any follow-on tasks, refer to the

View File

@ -139,7 +139,7 @@ $ oc patch clusterrole kiali -p '[{"op":"add", "path":"/rules/-", "value":{"apiG
$ istioctl dashboard kiali $ istioctl dashboard kiali
{{< /text >}} {{< /text >}}
1. To log into the Kiali UI, enter the username and passphrase stored in the Kiali secret (`admin/admin` if you are using the demo profile). 1. To log into the Kiali UI, go to the Kiali login screen and enter the username and passphrase stored in the Kiali secret.
1. View the overview of your mesh in the **Overview** page that appears immediately after you log in. 1. View the overview of your mesh in the **Overview** page that appears immediately after you log in.
The **Overview** page displays all the namespaces that have services in your mesh. The **Overview** page displays all the namespaces that have services in your mesh.

View File

@ -133,12 +133,6 @@ here to illustrate how to use `match` expressions to control rule execution.
$ kubectl delete -f @samples/bookinfo/telemetry/log-entry-crd.yaml@ $ kubectl delete -f @samples/bookinfo/telemetry/log-entry-crd.yaml@
{{< /text >}} {{< /text >}}
* Remove any `kubectl port-forward` processes that may still be running:
{{< text bash >}}
$ killall kubectl
{{< /text >}}
* If you are not planning to explore any follow-on tasks, refer to the * If you are not planning to explore any follow-on tasks, refer to the
[Bookinfo cleanup](/docs/examples/bookinfo/#cleanup) instructions [Bookinfo cleanup](/docs/examples/bookinfo/#cleanup) instructions
to shutdown the application. to shutdown the application.

View File

@ -59,10 +59,9 @@ as the example application throughout this task.
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090 & $ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090 &
{{< /text >}} {{< /text >}}
View values for the new metric via the [Prometheus UI](http://localhost:9090/graph#%5B%7B%22range_input%22%3A%221h%22%2C%22expr%22%3A%22istio_double_request_count%22%2C%22tab%22%3A1%7D%5D). View values for the new metric in the Prometheus browser window. Select **Graph**.
Enter the `istio_double_request_count` metric and select **Execute**.
The provided link opens the Prometheus UI and executes a query for values of The table displayed in the
the `istio_double_request_count` metric. The table displayed in the
**Console** tab includes entries similar to: **Console** tab includes entries similar to:
{{< text plain >}} {{< text plain >}}

View File

@ -49,10 +49,10 @@ application.
In Kubernetes environments, execute the following command: In Kubernetes environments, execute the following command:
{{< text bash >}} {{< text bash >}}
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090 & $ istioctl dashboard prometheus
{{< /text >}} {{< /text >}}
Visit [http://localhost:9090/graph](http://localhost:9090/graph) in your web browser. Click **Graph** in Prometheus.
1. Execute a Prometheus query. 1. Execute a Prometheus query.
@ -108,10 +108,10 @@ docs](https://prometheus.io/docs/querying/basics/).
## Cleanup ## Cleanup
- Remove any `kubectl port-forward` processes that may still be running: - Remove any `istioctl` processes that may still be running using control-C or:
{{< text bash >}} {{< text bash >}}
$ killall kubectl $ killall istioctl
{{< /text >}} {{< /text >}}
- If you are not planning to explore any follow-on tasks, refer to the - If you are not planning to explore any follow-on tasks, refer to the

View File

@ -125,10 +125,9 @@ will generate and collect automatically.
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090 & $ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090 &
{{< /text >}} {{< /text >}}
View values for the new metric via the [Prometheus UI](http://localhost:9090/graph#%5B%7B%22range_input%22%3A%221h%22%2C%22expr%22%3A%22istio_mongo_received_bytes%22%2C%22tab%22%3A1%7D%5D). View values for the new metric in the Prometheus browser window. Select **Graph**.
Enter the `istio_mongo_received_bytes` metric and select **Execute**.
The provided link opens the Prometheus UI and executes a query for values of The table displayed in the
the `istio_mongo_received_bytes` metric. The table displayed in the
**Console** tab includes entries similar to: **Console** tab includes entries similar to:
{{< text plain >}} {{< text plain >}}