From d754e9d5eed14011c2739a7903433df4941acb8a Mon Sep 17 00:00:00 2001 From: Sunil Singh Date: Thu, 11 Jul 2024 10:04:26 -0700 Subject: [PATCH] Note - Generating Kiali Session Token (#1366) * Adding note on generating session token and the service account name expected. Signed-off-by: Sunil Singh * Updating after review and researching Kiali docs. Added link to Kiali docs and Kiali token authentication strategy page. Signed-off-by: Sunil Singh * Updating link with better example Signed-off-by: Sunil Singh * Updating the Istio - Generate and View Traffic from Istio page to include text guiding users on token generation for Kiali login. This commit has strictly structural changes to the page. Signed-off-by: Sunil Singh * Removing repetitive intro line. Signed-off-by: Sunil Singh * Updating note across versions to include information on Istio auth strategy and adding text into Generate and View Traffic - Prereq section regarding auth strategy and the service account name to specify during token generation. Signed-off-by: Sunil Singh * Applying review suggestions. Signed-off-by: Sunil Singh * Fixing header to h2 and rephrasing optional text after review. Signed-off-by: Sunil Singh --------- Signed-off-by: Sunil Singh --- .../generate-and-view-traffic.md | 16 +++++++++------- docs/integrations-in-rancher/istio/istio.md | 10 +++++++++- .../generate-and-view-traffic.md | 16 +++++++++------- .../integrations-in-rancher/istio/istio.md | 10 +++++++++- .../generate-and-view-traffic.md | 16 +++++++++------- .../integrations-in-rancher/istio/istio.md | 10 +++++++++- .../generate-and-view-traffic.md | 16 +++++++++------- .../integrations-in-rancher/istio/istio.md | 10 +++++++++- 8 files changed, 72 insertions(+), 32 deletions(-) diff --git a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index e965bc9a8b1..47a0cc91f10 100644 --- a/docs/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/docs/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -6,19 +6,21 @@ title: Generate and View Traffic from Istio -This section describes how to view the traffic that is being managed by Istio. - ## The Kiali Traffic Graph -The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you are able to view graphs for each namespace. 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. +The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you can view graphs for each namespace. 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. -:::note Prerequisites: +## Prerequisites -To enable traffic to show up in the graph, ensure you have prometheus installed in the cluster. Rancher-istio installs Kiali configured by default to work with the rancher-monitoring chart. You can use rancher-monitoring or install your own monitoring solution. Optional: you can change configuration on how data scraping occurs by setting the [Selectors & Scrape Configs](../../../integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md) options. +To enable traffic to show up in the graph, ensure that you have Prometheus installed in the cluster. `Rancher-istio` installs Kiali, and configures it by default to work with the `rancher-monitoring` chart. You can use `rancher-monitoring` or install your own monitoring solution. -::: +Additionally, for Istio installations version `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. If you are trying to generate or retrieve the token (e.g. for login), note that the name of the Kiali service account in Rancher is `kiali`. For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). -To see the traffic graph, +Optional: You can configure which namespaces data scraping occurs in by setting the Helm chart options described in [Selectors & Scrape Configs](../../../integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md). + +## Traffic Visualization + +To see the traffic graph follow the steps below: 1. In the cluster where Istio is installed, click **Istio** in the left navigation bar. 1. Click the **Kiali** link. diff --git a/docs/integrations-in-rancher/istio/istio.md b/docs/integrations-in-rancher/istio/istio.md index 0f865ef5363..ec3cdaa0ba4 100644 --- a/docs/integrations-in-rancher/istio/istio.md +++ b/docs/integrations-in-rancher/istio/istio.md @@ -43,10 +43,14 @@ It also includes the following: ### Kiali -Kiali is a comprehensive visualization aid used for graphing traffic flow throughout the service mesh. It allows you to see how they are connected, including the traffic rates and latencies between them. +[Kiali](https://kiali.io/) is a comprehensive visualization aid used for graphing traffic flow throughout the service mesh. It allows you to see how they are connected, including the traffic rates and latencies between them. You can check the health of the service mesh, or drill down to see the incoming and outgoing requests to a single component. +:::note +For Istio installations `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. The name of the Kiali service account in Rancher is `kiali`. Use this name if you are writing commands that require you to enter the name of the Kiali service account (for example, if you are trying to generate or retrieve a session token). For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). +::: + ### Jaeger Our Istio installer includes a quick-start, all-in-one installation of [Jaeger,](https://www.jaegertracing.io/) a tool used for tracing distributed systems. @@ -71,6 +75,10 @@ To remove Istio components from a cluster, namespace, or workload, refer to the > By default, only cluster-admins have access to Kiali. For instructions on how to allow admin, edit or views roles to access them, see [this section.](rbac-for-istio.md) +:::note +For Istio installations version `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. The name of the Kiali service account in Rancher is `kiali`. Use this name if you are writing commands that require you to enter the name of the Kiali service account (for example, if you are trying to generate or retrieve a session token). For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). +::: + After Istio is set up in a cluster, Grafana, Prometheus, and Kiali are available in the Rancher UI. To access the Grafana and Prometheus visualizations, diff --git a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index e965bc9a8b1..47a0cc91f10 100644 --- a/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/versioned_docs/version-2.7/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -6,19 +6,21 @@ title: Generate and View Traffic from Istio -This section describes how to view the traffic that is being managed by Istio. - ## The Kiali Traffic Graph -The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you are able to view graphs for each namespace. 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. +The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you can view graphs for each namespace. 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. -:::note Prerequisites: +## Prerequisites -To enable traffic to show up in the graph, ensure you have prometheus installed in the cluster. Rancher-istio installs Kiali configured by default to work with the rancher-monitoring chart. You can use rancher-monitoring or install your own monitoring solution. Optional: you can change configuration on how data scraping occurs by setting the [Selectors & Scrape Configs](../../../integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md) options. +To enable traffic to show up in the graph, ensure that you have Prometheus installed in the cluster. `Rancher-istio` installs Kiali, and configures it by default to work with the `rancher-monitoring` chart. You can use `rancher-monitoring` or install your own monitoring solution. -::: +Additionally, for Istio installations version `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. If you are trying to generate or retrieve the token (e.g. for login), note that the name of the Kiali service account in Rancher is `kiali`. For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). -To see the traffic graph, +Optional: You can configure which namespaces data scraping occurs in by setting the Helm chart options described in [Selectors & Scrape Configs](../../../integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md). + +## Traffic Visualization + +To see the traffic graph follow the steps below: 1. In the cluster where Istio is installed, click **Istio** in the left navigation bar. 1. Click the **Kiali** link. diff --git a/versioned_docs/version-2.7/integrations-in-rancher/istio/istio.md b/versioned_docs/version-2.7/integrations-in-rancher/istio/istio.md index 0f865ef5363..8fe7ca7b577 100644 --- a/versioned_docs/version-2.7/integrations-in-rancher/istio/istio.md +++ b/versioned_docs/version-2.7/integrations-in-rancher/istio/istio.md @@ -43,10 +43,14 @@ It also includes the following: ### Kiali -Kiali is a comprehensive visualization aid used for graphing traffic flow throughout the service mesh. It allows you to see how they are connected, including the traffic rates and latencies between them. +[Kiali](https://kiali.io/) is a comprehensive visualization aid used for graphing traffic flow throughout the service mesh. It allows you to see how they are connected, including the traffic rates and latencies between them. You can check the health of the service mesh, or drill down to see the incoming and outgoing requests to a single component. +:::note +For Istio installations `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. The name of the Kiali service account in Rancher is `kiali`. Use this name if you are writing commands that require you to enter the name of the Kiali service account (for example, if you are trying to generate or retrieve a session token). For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). +::: + ### Jaeger Our Istio installer includes a quick-start, all-in-one installation of [Jaeger,](https://www.jaegertracing.io/) a tool used for tracing distributed systems. @@ -71,6 +75,10 @@ To remove Istio components from a cluster, namespace, or workload, refer to the > By default, only cluster-admins have access to Kiali. For instructions on how to allow admin, edit or views roles to access them, see [this section.](rbac-for-istio.md) +:::note +For Istio installations `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. The name of the Kiali service account in Rancher is `kiali`. Use this name if you are writing commands that require you to enter the name of the Kiali service account (for example, if you are trying to generate or retrieve a session token). For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). +::: + After Istio is set up in a cluster, Grafana, Prometheus, and Kiali are available in the Rancher UI. To access the Grafana and Prometheus visualizations, diff --git a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index e965bc9a8b1..47a0cc91f10 100644 --- a/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/versioned_docs/version-2.8/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -6,19 +6,21 @@ title: Generate and View Traffic from Istio -This section describes how to view the traffic that is being managed by Istio. - ## The Kiali Traffic Graph -The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you are able to view graphs for each namespace. 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. +The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you can view graphs for each namespace. 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. -:::note Prerequisites: +## Prerequisites -To enable traffic to show up in the graph, ensure you have prometheus installed in the cluster. Rancher-istio installs Kiali configured by default to work with the rancher-monitoring chart. You can use rancher-monitoring or install your own monitoring solution. Optional: you can change configuration on how data scraping occurs by setting the [Selectors & Scrape Configs](../../../integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md) options. +To enable traffic to show up in the graph, ensure that you have Prometheus installed in the cluster. `Rancher-istio` installs Kiali, and configures it by default to work with the `rancher-monitoring` chart. You can use `rancher-monitoring` or install your own monitoring solution. -::: +Additionally, for Istio installations version `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. If you are trying to generate or retrieve the token (e.g. for login), note that the name of the Kiali service account in Rancher is `kiali`. For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). -To see the traffic graph, +Optional: You can configure which namespaces data scraping occurs in by setting the Helm chart options described in [Selectors & Scrape Configs](../../../integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md). + +## Traffic Visualization + +To see the traffic graph follow the steps below: 1. In the cluster where Istio is installed, click **Istio** in the left navigation bar. 1. Click the **Kiali** link. diff --git a/versioned_docs/version-2.8/integrations-in-rancher/istio/istio.md b/versioned_docs/version-2.8/integrations-in-rancher/istio/istio.md index 0f865ef5363..8fe7ca7b577 100644 --- a/versioned_docs/version-2.8/integrations-in-rancher/istio/istio.md +++ b/versioned_docs/version-2.8/integrations-in-rancher/istio/istio.md @@ -43,10 +43,14 @@ It also includes the following: ### Kiali -Kiali is a comprehensive visualization aid used for graphing traffic flow throughout the service mesh. It allows you to see how they are connected, including the traffic rates and latencies between them. +[Kiali](https://kiali.io/) is a comprehensive visualization aid used for graphing traffic flow throughout the service mesh. It allows you to see how they are connected, including the traffic rates and latencies between them. You can check the health of the service mesh, or drill down to see the incoming and outgoing requests to a single component. +:::note +For Istio installations `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. The name of the Kiali service account in Rancher is `kiali`. Use this name if you are writing commands that require you to enter the name of the Kiali service account (for example, if you are trying to generate or retrieve a session token). For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). +::: + ### Jaeger Our Istio installer includes a quick-start, all-in-one installation of [Jaeger,](https://www.jaegertracing.io/) a tool used for tracing distributed systems. @@ -71,6 +75,10 @@ To remove Istio components from a cluster, namespace, or workload, refer to the > By default, only cluster-admins have access to Kiali. For instructions on how to allow admin, edit or views roles to access them, see [this section.](rbac-for-istio.md) +:::note +For Istio installations `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. The name of the Kiali service account in Rancher is `kiali`. Use this name if you are writing commands that require you to enter the name of the Kiali service account (for example, if you are trying to generate or retrieve a session token). For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). +::: + After Istio is set up in a cluster, Grafana, Prometheus, and Kiali are available in the Rancher UI. To access the Grafana and Prometheus visualizations, diff --git a/versioned_docs/version-2.9/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md b/versioned_docs/version-2.9/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md index e965bc9a8b1..47a0cc91f10 100644 --- a/versioned_docs/version-2.9/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md +++ b/versioned_docs/version-2.9/how-to-guides/advanced-user-guides/istio-setup-guide/generate-and-view-traffic.md @@ -6,19 +6,21 @@ title: Generate and View Traffic from Istio -This section describes how to view the traffic that is being managed by Istio. - ## The Kiali Traffic Graph -The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you are able to view graphs for each namespace. 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. +The Istio overview page provides a link to the Kiali dashboard. From the Kiali dashboard, you can view graphs for each namespace. 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. -:::note Prerequisites: +## Prerequisites -To enable traffic to show up in the graph, ensure you have prometheus installed in the cluster. Rancher-istio installs Kiali configured by default to work with the rancher-monitoring chart. You can use rancher-monitoring or install your own monitoring solution. Optional: you can change configuration on how data scraping occurs by setting the [Selectors & Scrape Configs](../../../integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md) options. +To enable traffic to show up in the graph, ensure that you have Prometheus installed in the cluster. `Rancher-istio` installs Kiali, and configures it by default to work with the `rancher-monitoring` chart. You can use `rancher-monitoring` or install your own monitoring solution. -::: +Additionally, for Istio installations version `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. If you are trying to generate or retrieve the token (e.g. for login), note that the name of the Kiali service account in Rancher is `kiali`. For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). -To see the traffic graph, +Optional: You can configure which namespaces data scraping occurs in by setting the Helm chart options described in [Selectors & Scrape Configs](../../../integrations-in-rancher/istio/configuration-options/selectors-and-scrape-configurations.md). + +## Traffic Visualization + +To see the traffic graph follow the steps below: 1. In the cluster where Istio is installed, click **Istio** in the left navigation bar. 1. Click the **Kiali** link. diff --git a/versioned_docs/version-2.9/integrations-in-rancher/istio/istio.md b/versioned_docs/version-2.9/integrations-in-rancher/istio/istio.md index 0f865ef5363..8fe7ca7b577 100644 --- a/versioned_docs/version-2.9/integrations-in-rancher/istio/istio.md +++ b/versioned_docs/version-2.9/integrations-in-rancher/istio/istio.md @@ -43,10 +43,14 @@ It also includes the following: ### Kiali -Kiali is a comprehensive visualization aid used for graphing traffic flow throughout the service mesh. It allows you to see how they are connected, including the traffic rates and latencies between them. +[Kiali](https://kiali.io/) is a comprehensive visualization aid used for graphing traffic flow throughout the service mesh. It allows you to see how they are connected, including the traffic rates and latencies between them. You can check the health of the service mesh, or drill down to see the incoming and outgoing requests to a single component. +:::note +For Istio installations `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. The name of the Kiali service account in Rancher is `kiali`. Use this name if you are writing commands that require you to enter the name of the Kiali service account (for example, if you are trying to generate or retrieve a session token). For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). +::: + ### Jaeger Our Istio installer includes a quick-start, all-in-one installation of [Jaeger,](https://www.jaegertracing.io/) a tool used for tracing distributed systems. @@ -71,6 +75,10 @@ To remove Istio components from a cluster, namespace, or workload, refer to the > By default, only cluster-admins have access to Kiali. For instructions on how to allow admin, edit or views roles to access them, see [this section.](rbac-for-istio.md) +:::note +For Istio installations `103.1.0+up1.19.6` and later, Kiali uses a token value for its authentication strategy. The name of the Kiali service account in Rancher is `kiali`. Use this name if you are writing commands that require you to enter the name of the Kiali service account (for example, if you are trying to generate or retrieve a session token). For more information, refer to the [Kiali token authentication FAQ](https://kiali.io/docs/faq/authentication/). +::: + After Istio is set up in a cluster, Grafana, Prometheus, and Kiali are available in the Rancher UI. To access the Grafana and Prometheus visualizations,