Visualizing Your Mesh
As part of this task, you install the Kiali add-onand use the web-based graphical user interface to view service graphs ofthe mesh and your Istio configuration objects. Lastly, you use the KialiPublic API to generate graph data in the form of consumable JSON.
This task uses the sample application as the example throughout.
The following instructions assume you have installed Helm and use it to install Kiali.To install Kiali without using Helm, follow the Kiali installation instructions.
If you plan on installing Kiali using the Istio demo profile as described in the then a default secret will be created for you with a username of and passphrase of admin
. You can therefore skip this section.
Create a secret in your Istio namespace with the credentials that you use toauthenticate to Kiali.
First, define the credentials you want to use as the Kiali username and passphrase:
If you are using the Z Shell, zsh
, use the following to define the credentials:
$ KIALI_USERNAME=$(read '?Kiali Username: ' uval && echo -n $uval | base64)
$ KIALI_PASSPHRASE=$(read -s "?Kiali Passphrase: " pval && echo -n $pval | base64)
To create a secret, run the following commands:
$ NAMESPACE=istio-system
$ kubectl create namespace $NAMESPACE
$ cat <<EOF | kubectl apply -f -
apiVersion: v1
kind: Secret
metadata:
name: kiali
namespace: $NAMESPACE
labels:
type: Opaque
username: $KIALI_USERNAME
passphrase: $KIALI_PASSPHRASE
EOF
Once you create the Kiali secret, followthe Helm install instructions to install Kiali via Helm.You must use the —set kiali.enabled=true
option when you run the helm
command, for example:
This task does not discuss Jaeger and Grafana. Ifyou already installed them in your cluster and you want to see how Kialiintegrates with them, you must pass additional arguments to thehelm
command, for example:
$ helm template \
--set kiali.enabled=true \
--set "kiali.dashboard.jaegerURL=http://jaeger-query:16686" \
--set "kiali.dashboard.grafanaURL=http://grafana:3000" \
install/kubernetes/helm/istio \
--name istio --namespace istio-system > $HOME/istio.yaml
$ kubectl apply -f $HOME/istio.yaml
Once you install Istio and Kiali, deploy the sample application.
When Kiali runs on OpenShift it needs access to some OpenShift specific resources in order to function properly,which can be done using the following commands after Kiali has been installed:
$ oc patch clusterrole kiali -p '[{"op":"add", "path":"/rules/-", "value":{"apiGroups":["apps.openshift.io"], "resources":["deploymentconfigs"],"verbs": ["get", "list", "watch"]}}]' --type json
$ oc patch clusterrole kiali -p '[{"op":"add", "path":"/rules/-", "value":{"apiGroups":["project.openshift.io"], "resources":["projects"],"verbs": ["get"]}}]' --type json
- To verify the service is running in your cluster, run the following command:
$ kubectl -n istio-system get svc kiali
To determine the Bookinfo URL, follow the instructions to determine the Bookinfo ingress
GATEWAY_URL
.To send traffic to the mesh, you have three options
Use the following command multiple times:
- If you installed the
watch
command in your system, send requests continually with:
$ watch -n 1 curl -o /dev/null -s -w %{http_code} $GATEWAY_URL/productpage
- To open the Kiali UI, execute the following command in your Kubernetes environment:
$ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=kiali -o jsonpath='{.items[0].metadata.name}') 20001:20001
Visit in your web browser.
To log into the Kiali UI, go to the Kiali login screen and enter the username and passphrase stored in the Kiali secret.
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 following screenshot shows a similar page:
- To view a namespace graph, click on the
bookinfo
graph icon in the Bookinfo namespace card. The graph icon is in the lower left ofthe namespace card and looks like a connected group of circles.The page looks similar to:
Example Graph
To view a summary of metrics, select any node or edge in the graph to displayits metric details in the summary details panel on the right.
To view your service mesh using different graph types, select a graph typefrom the Graph Type drop down menu. There are several graph typesto choose from: App, Versioned App, Workload, Service.
- The App graph type aggregates all versions of an app into a single graph node.The following example shows a single reviews node representing the three versionsof the reviews app.
- The Versioned App graph type shows a node for each version of an app,but all versions of a particular app are grouped together. The following exampleshows the reviews group box that contains the three nodes that represents thethree versions of the reviews app.
Example Versioned App Graph
- The Workload graph type shows a node for each workload in your service mesh.This graph type does not require you to use the
app
andversion
labels so if youopt to not use those labels on your components, this is the graph type you will use.
- The Service graph type shows a node for each service in your mesh but excludesall apps and workloads from the graph.
Example Service Graph
- To examine the details about the Istio configuration, click on theApplications, Workloads, and Services menu icons on the left menubar. The following screenshot shows the Bookinfo applications information:
To generate JSON files representing the graphs and other metrics, health, andconfiguration information, you can access the.For example, point your browser to $KIALI_URL/api/namespaces/graph?namespaces=bookinfo&graphType=app
to get the JSON representation of your graph using the app
graph type.
If you are not planning any follow-up tasks, remove the Bookinfo sample application and Kiali from your cluster.
To remove the Bookinfo application, refer to the Bookinfo cleanup instructions.
To remove Kiali from a Kubernetes environment, remove all components with the
app=kiali
label:
$ kubectl delete all,secrets,sa,configmaps,deployments,ingresses,clusterroles,clusterrolebindings,virtualservices,destinationrules,customresourcedefinitions --selector=app=kiali -n istio-system
此任务展示了如何设置和使用 Istio Dashboard 监控网格流量。
Improving availability and reducing latency.
Provides an overview of Mixer's plug-in architecture.
This task shows you how to configure Istio to collect and customize metrics.
了解如何配置代理以向 Jaeger 发送追踪请求。