Add clarifications to Istio docs

2026-05-13 08:33:35 +00:00 · 2019-06-17 14:23:12 -07:00
parent 94205e15b0
commit efd887ea94
3 changed files with 23 additions and 6 deletions
@@ -27,6 +27,15 @@ As an [administrator]({{< baseurl >}}/rancher/v2.x/en/admin-settings/rbac/global

 Once Istio is `active`, you can see visualizations of your Istio service mesh across several services:

+- **Kiali** helps you define, validate, and observe your Istio service mesh. Kiali shows you what services are in your mesh and how they are connected. Kiali includes Jaeger Tracing to provide distributed tracing out of the box.
+- **Jaeger** is a distributed tracing system released as open source by Uber Technologies. It is used for monitoring and troubleshooting microservices-based distributed systems.
+- **Grafana** is an analytics platform that allows you to query, visualize, alert on and understand your metrics. Grafana lets you visualize data from Prometheus.
+- **Prometheus** is a systems monitoring and alerting toolkit.
+
+Kiali, Jaeger, Grafana, and Prometheus are open-source.
+
+With Istio enabled, you can:
+
 1. Access [Kiali UI](https://www.kiali.io/) by clicking the Kiali UI icon in the Istio page.
 1. Access [Jaeger UI](https://www.jaegertracing.io/) by clicking the Jaeger UI icon in the Istio page.
 1. Access [Grafana UI](https://grafana.com/) by clicking the Grafana UI icon in the Istio page.
@@ -41,6 +41,8 @@ Mixer Selector | Ability to select the nodes in which istio-policy and istio-tel

 ## TRACING

+Istio-enabled applications can collect trace spans. For more information on distributed tracing with Istio, refer to the [documentation](https://istio.io/docs/tasks/telemetry/distributed-tracing/overview/).
+
 Option | Description| Required | Default
 -------|------------|-------|-------
 Enable Tracing | Whether or not to deploy the istio-tracing. | Yes | True
@@ -52,6 +54,8 @@ Tracing Selector | Ability to select the nodes in which tracing pod is deployed

 ## INGRESS GATEWAY

+The Istio Gateway allows Istio features such as monitoring and route rules to be applied to traffic entering the cluster. For more information, refer to the [documentation](https://istio.io/docs/tasks/traffic-management/ingress/).
+
 Option | Description| Required | Default
 -------|------------|-------|-------
 Enable Ingress Gateway | Whether or not to deploy the istio-ingressgateway. | Yes      | False
@@ -68,6 +72,8 @@ Ingress Gateway Selector | Ability to select the nodes in which istio-ingressgat

 ## PROMETHEUS

+You can query for Istio metrics using Prometheus. Prometheus is an open-source systems monitoring and alerting toolkit.
+
 Option | Description| Required | Default
 -------|------------|-------|-------
 Prometheus CPU Limit | CPU resource limit for the Prometheus pod.| Yes      | 1000
@@ -79,6 +85,8 @@ Prometheus Selector | Ability to select the nodes in which Prometheus pod is dep

 ## GRAFANA

+You can visualize metrics with Grafana. Grafana is a tool that lets you visualize Istio traffic data.
+
 Option | Description| Required | Default
 -------|------------|-------|-------
 Enable Grafana | Whether or not to deploy the Grafana.| Yes                                                         | True
@@ -10,17 +10,19 @@ Using Rancher, you can connect, secure, control, and observe services through in
 >**Prerequisites:**
 >
 >- [Istio]({{< baseurl >}}/rancher/v2.x/en/cluster-admin/tools/istio/) must be enabled in the cluster.
->- To be a part of an Istio service mesh, pods and services in a Kubernetes cluster must satisfy the [Istio Pods and Services Requirements](https://istio.io/docs/setup/kubernetes/prepare/requirements/)
+>- To be a part of an Istio service mesh, pods and services in a Kubernetes cluster must satisfy the [Istio Pods and Services Requirements](https://istio.io/docs/setup/kubernetes/prepare/requirements/).

 ## Istio Sidecar Auto Injection

 In the create and edit namespace page, you can enable or disable [Istio sidecar auto injection](https://istio.io/blog/2019/data-plane-setup/#automatic-injection). When you enable it, Rancher will add `istio-injection=enabled` label to the namespace automatically.

+After the `istio-injection=enabled` label is added to the namespace, all pods that are created in the namespace will have an injected Istio sidecar.
+
 > **Note:** Injection occurs at pod creation time. If the pod has been created before you enable auto injection. You need to kill the running pod and verify a new pod is created with the injected sidecar.

 ## View Traffic Graph

-Rancher integrates Kiali Graph into the Rancher UI. The Kiali graph provides a powerful way to visualize the topology of your Istio service mesh. It shows you which services communicate with each other.
+Rancher integrates a Kiali graph into the Rancher UI. The Kiali graph provides a powerful way to visualize the topology of your Istio service mesh. It shows you which services communicate with each other.

 To see the traffic graph for a particular namespace:

@@ -30,13 +32,11 @@ To see the traffic graph for a particular namespace:

 1. Select **Traffic Graph** in the navigation bar.

-1. Select the namespace. Note: It only shows the namespaces which has `istio-injection=enabled` label.
+1. Select the namespace. Note: It only shows the namespaces which have the `istio-injection=enabled` label.

 ## View Traffic Metrics

-Istio’s monitoring features provide visibility into the performance of all your services.
-
-To see the Success Rate, Request Volume, 4xx Request Count, Project 5xx Request Count and Request Duration metrics:
+Istio’s monitoring features provide visibility into the performance of all your services. To see the Success Rate, Request Volume, 4xx Response Count, Project 5xx Response Count and Request Duration metrics:

 1. From the **Global** view, navigate to the project that you want to view traffic metrics for.