From 0e5f60aad7b6998640e0b82903f8fcbac25152ac Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Mon, 18 May 2020 16:51:10 -0400 Subject: [PATCH 01/16] kiali intro --- ...ossm-tutorial-kiali-accessing-console.adoc | 5 ++- .../observability.adoc | 32 +++++++++++++++++++ 2 files changed, 34 insertions(+), 3 deletions(-) create mode 100644 service_mesh/service_mesh_user_guide/observability.adoc diff --git a/modules/ossm-tutorial-kiali-accessing-console.adoc b/modules/ossm-tutorial-kiali-accessing-console.adoc index 70e49bbf7651..8f6321f28829 100644 --- a/modules/ossm-tutorial-kiali-accessing-console.adoc +++ b/modules/ossm-tutorial-kiali-accessing-console.adoc @@ -18,10 +18,9 @@ The Kiali console provides visualization and observability for your {ProductShor The installation process creates a route to access the Kiali console. .Procedure from the console -. In the {product-title} console, navigate to *Networking* -> *Routes* and search for the Kiali route. -. Click the URL listed under *Location*. +. To start, in the menu bar, click the *Application launcher* > *Kiali*. + -The default login strategy is `openshift` which means that you should be automatically logged into the Kiali console using the same user name and password as you use to access the {product-title} console. +. Log in to the Kiali console w the same user name and password as you use to access the {product-title} console. When you first log in you see the Overview page, which provides a quick overview of the health of the various Namespaces that are part of your {ProductShortName}. + image:ossm-kiali-overview.png[Overview Page] diff --git a/service_mesh/service_mesh_user_guide/observability.adoc b/service_mesh/service_mesh_user_guide/observability.adoc new file mode 100644 index 000000000000..b3f11ff20262 --- /dev/null +++ b/service_mesh/service_mesh_user_guide/observability.adoc @@ -0,0 +1,32 @@ +[id="ossm-observability"] += Observability +include::modules/ossm-document-attributes.adoc[] +:context: observability + +toc::[] + +Visualize your application's topology, health and metrics with using the Kiali operator you installed as part of your {ProductName} installation. + +If your service is having issues, Kiali offers ways to visualize the data flowing through your service. Kiali offers insights about the mesh components at different levels, from abstract Applications to Services and Workloads. It also provides an interactive graph view of your Namespace in real time. + +* Topology +* Health +* Details +* Project summary + +To start, in the menu bar, click the *Application launcher* > *Kiali*. + +Select the project for your service in the *Namespace* field. If you have installed the Bookinfo example, select `bookinfo`. + +== Observing topology + + + +== Observing health + +== Observing details + +== Viewing a summary + +To view a summary of metrics, select any node or edge in the graph to display its metric details in the summary details panel on the right. + From 01c9cfa88dee12c5db0892aa1c592bb21eaf0e91 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 21 May 2020 18:34:32 -0400 Subject: [PATCH 02/16] kiali intro --- modules/ossm-observability-access.adoc | 20 ++++++++++ modules/ossm-observability-visual.adoc | 40 +++++++++++++++++++ .../observability.adoc | 29 ++++++-------- 3 files changed, 72 insertions(+), 17 deletions(-) create mode 100644 modules/ossm-observability-access.adoc create mode 100644 modules/ossm-observability-visual.adoc diff --git a/modules/ossm-observability-access.adoc b/modules/ossm-observability-access.adoc new file mode 100644 index 000000000000..79f9a8734f4f --- /dev/null +++ b/modules/ossm-observability-access.adoc @@ -0,0 +1,20 @@ +// Module included in the following assemblies: +// +//- ossm-observability.adoc + +[id="ossm-observability-access-console_{context}"] += Accessing the Kiali console + +To access the console to see how the traffic moves around the application, in the menu bar, click the *Application launcher* > *Kiali*. + +Select the project for your service in the *Namespace* field. Log in to the Kiali console w the same user name and password as you use to access the {product-title} console. If you have installed the Bookinfo example, select `bookinfo`. + +.Procedure from the command line + +. Run this command from the CLI to obtain the route and Kiali URL: ++ +---- +$ oc get routes +---- ++ +In the output on the `kiali` line, use the URL in the HOST/PORT column to open the Kiali console. Select the project for your service in the *Namespace* field. Log in to the Kiali console with the same user name and password as you use to access the {product-title} console. diff --git a/modules/ossm-observability-visual.adoc b/modules/ossm-observability-visual.adoc new file mode 100644 index 000000000000..581a018f4c4e --- /dev/null +++ b/modules/ossm-observability-visual.adoc @@ -0,0 +1,40 @@ +//// +This module is included in the following assemblies: +- ossm-observability +//// + +[id="ossm-observability-visual_{context}"] += Visualizing your service + +The Kiali operator works with the telemetry data gathered in {ProductName} to provide graphs and real time architecture diagrams of the applications, services, and workloads in your namespace. + +The Overview page displays all the namespaces that have services in your mesh. You can reveal deeper insights about the data traveling through your Service mesh or help identify problems with services or workloads in your service mesh with the following graphs and visualizations. + +[id="ossm-observability-topology_{context}"] +== Namespace graphs + +The namespace graph is a map of the services in your namespace and arrows that show how data flows through them. To view a namespace graph: + +1. Click *Graph* in the main navigation and select `bookinfo` from the namespace menu. ++ +2. Select `bookinfo` from the *Namespace* menu. ++ +image:ossm-kiali-graph.png[Kiali graph] + +If your application uses version tags, like the Bookinfo sample application, you can see a Version graph select a graph type from the Graph Type drop down menu. There are several graph types to choose from: + +* App +* Versioned App +* Workload +* Service + +The App graph shows the an aggregate workload for all applications that are labeled the same. + +The Versioned App graph type shows a node for each version of an app. All versions of a particular app are grouped together. + +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 and version labels. If your app does not use version labels, use this the graph type. + +The Service graph type shows a node for each service in your mesh but excludes all apps and workloads from the graph. It provides a high level view and aggregates all traffic for defined services. + +To view a summary of metrics, select any node or edge in the graph to display its metric details in the summary details panel. + diff --git a/service_mesh/service_mesh_user_guide/observability.adoc b/service_mesh/service_mesh_user_guide/observability.adoc index b3f11ff20262..00b155dd1342 100644 --- a/service_mesh/service_mesh_user_guide/observability.adoc +++ b/service_mesh/service_mesh_user_guide/observability.adoc @@ -1,32 +1,27 @@ [id="ossm-observability"] -= Observability += Data visualization and observability include::modules/ossm-document-attributes.adoc[] :context: observability toc::[] -Visualize your application's topology, health and metrics with using the Kiali operator you installed as part of your {ProductName} installation. +You can your application's topology, health and metrics with using the Kiali operator you installed as part of your {ProductName} installation. -If your service is having issues, Kiali offers ways to visualize the data flowing through your service. Kiali offers insights about the mesh components at different levels, from abstract Applications to Services and Workloads. It also provides an interactive graph view of your Namespace in real time. +If your service is having issues, Kiali offers ways to visualize the data flowing through your service. Kiali offers insights about the mesh components at different levels, including abstract applications, services, and workloads. It also provides an interactive graph view of your namespace in real time. -* Topology -* Health -* Details -* Project summary +.Prerequisites -To start, in the menu bar, click the *Application launcher* > *Kiali*. +* You can observe data flowing through a working service if you install the xref:../../service_mesh/service_mesh_day_two/ossm-example-bookinfo.html#ossm-tutorial-bookinfo-overview_ossm-bookinfo-tutorial[Bookinfo sample application]. -Select the project for your service in the *Namespace* field. If you have installed the Bookinfo example, select `bookinfo`. +To send traffic to the mesh, enter the following command a few times: -== Observing topology +---- +$ curl http://$GATEWAY_URL/productpage +---- +If your sample application is configured correctly, this command simulates a user visiting the `productpage` microservice of the application. +include::modules/ossm-observability-access.adoc[leveloffset=+1] -== Observing health - -== Observing details - -== Viewing a summary - -To view a summary of metrics, select any node or edge in the graph to display its metric details in the summary details panel on the right. +include::modules/ossm-observability-visual.adoc[leveloffset=+1] From 8d807ea455548891cf7f8a049c8c471a3a8af5a1 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 21 May 2020 18:39:33 -0400 Subject: [PATCH 03/16] removed changes to kiali tutorial --- modules/ossm-tutorial-kiali-accessing-console.adoc | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/modules/ossm-tutorial-kiali-accessing-console.adoc b/modules/ossm-tutorial-kiali-accessing-console.adoc index 8f6321f28829..96d0c9d1df85 100644 --- a/modules/ossm-tutorial-kiali-accessing-console.adoc +++ b/modules/ossm-tutorial-kiali-accessing-console.adoc @@ -17,11 +17,12 @@ The Kiali console provides visualization and observability for your {ProductShor The installation process creates a route to access the Kiali console. -.Procedure from the console -. To start, in the menu bar, click the *Application launcher* > *Kiali*. -+ -. Log in to the Kiali console w the same user name and password as you use to access the {product-title} console. -When you first log in you see the Overview page, which provides a quick overview of the health of the various Namespaces that are part of your {ProductShortName}. +.Procedure from the console .Procedure from the console +. In the {product-title} console, navigate to *Networking* -> *Routes* and search for the Kiali route. . To start, in the menu bar, click the *Application launcher* > *Kiali*. +. Click the URL listed under *Location*. ++ + +The default login strategy is `openshift` which means that you should be automatically logged into the Kiali console using the same user name and password as you use to access the {product-title} console. . Log in to the Kiali console w the same user name and password as you use to access the {product-title} console. +When you first log in you see the Overview page, which provides a quick overview of the health of the various Namespaces that are part of your {ProductShortName}. + image:ossm-kiali-overview.png[Overview Page] + From 5750536806967b9355da3c9366d9c5d924835bd8 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 21 May 2020 18:41:32 -0400 Subject: [PATCH 04/16] removed changes to kiali tutorial again --- modules/ossm-tutorial-kiali-accessing-console.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/modules/ossm-tutorial-kiali-accessing-console.adoc b/modules/ossm-tutorial-kiali-accessing-console.adoc index 96d0c9d1df85..70e49bbf7651 100644 --- a/modules/ossm-tutorial-kiali-accessing-console.adoc +++ b/modules/ossm-tutorial-kiali-accessing-console.adoc @@ -17,12 +17,12 @@ The Kiali console provides visualization and observability for your {ProductShor The installation process creates a route to access the Kiali console. -.Procedure from the console .Procedure from the console -. In the {product-title} console, navigate to *Networking* -> *Routes* and search for the Kiali route. . To start, in the menu bar, click the *Application launcher* > *Kiali*. -. Click the URL listed under *Location*. -+ + -The default login strategy is `openshift` which means that you should be automatically logged into the Kiali console using the same user name and password as you use to access the {product-title} console. . Log in to the Kiali console w the same user name and password as you use to access the {product-title} console. -When you first log in you see the Overview page, which provides a quick overview of the health of the various Namespaces that are part of your {ProductShortName}. +.Procedure from the console +. In the {product-title} console, navigate to *Networking* -> *Routes* and search for the Kiali route. +. Click the URL listed under *Location*. ++ +The default login strategy is `openshift` which means that you should be automatically logged into the Kiali console using the same user name and password as you use to access the {product-title} console. +When you first log in you see the Overview page, which provides a quick overview of the health of the various Namespaces that are part of your {ProductShortName}. + image:ossm-kiali-overview.png[Overview Page] + From 70903cd81226a314dda412ef8153e36b2dd5148a Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 21 May 2020 19:28:54 -0400 Subject: [PATCH 05/16] added to toc --- _topic_map.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_topic_map.yml b/_topic_map.yml index b576980f3f23..1757801435d1 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -1429,6 +1429,8 @@ Topics: Topics: - Name: Traffic management File: ossm-traffic-manage + - Name: Data visualization and observability + File: ossm-observability # - Name: Grafana tutorial # File: ossm-tutorial-grafana # - Name: Prometheus tutorial From eaafd77d9ef2e9da2d9ab0919f863984354ff966 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 21 May 2020 19:31:58 -0400 Subject: [PATCH 06/16] renamed assembly --- .../{observability.adoc => ossm-observability.adoc} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename service_mesh/service_mesh_user_guide/{observability.adoc => ossm-observability.adoc} (100%) diff --git a/service_mesh/service_mesh_user_guide/observability.adoc b/service_mesh/service_mesh_user_guide/ossm-observability.adoc similarity index 100% rename from service_mesh/service_mesh_user_guide/observability.adoc rename to service_mesh/service_mesh_user_guide/ossm-observability.adoc From 53d9fc6ecd26daf04549fde4bde8311b80656470 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 21 May 2020 20:09:47 -0400 Subject: [PATCH 07/16] fixed ul --- modules/ossm-observability-visual.adoc | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/modules/ossm-observability-visual.adoc b/modules/ossm-observability-visual.adoc index 581a018f4c4e..d19aa2c9a6f7 100644 --- a/modules/ossm-observability-visual.adoc +++ b/modules/ossm-observability-visual.adoc @@ -21,20 +21,15 @@ The namespace graph is a map of the services in your namespace and arrows that s + image:ossm-kiali-graph.png[Kiali graph] -If your application uses version tags, like the Bookinfo sample application, you can see a Version graph select a graph type from the Graph Type drop down menu. There are several graph types to choose from: +If your application uses version tags, like the Bookinfo sample application, you can see a Version graph select a graph from the Graph Type drop down menu. There are several graphs to choose from: -* App -* Versioned App -* Workload -* Service +* The App graph shows an aggregate workload for all applications that are labeled the same. -The App graph shows the an aggregate workload for all applications that are labeled the same. +* The Versioned App graph shows a node for each version of an app. All versions of an app are grouped together. -The Versioned App graph type shows a node for each version of an app. All versions of a particular app are grouped together. +* The Workload graph shows a node for each workload in your service mesh. This graph does not require you to use the app and version labels. If your app does not use version labels, use this the 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 and version labels. If your app does not use version labels, use this the graph type. - -The Service graph type shows a node for each service in your mesh but excludes all apps and workloads from the graph. It provides a high level view and aggregates all traffic for defined services. +* The Service graph shows a node for each service in your mesh but excludes all apps and workloads from the graph. It provides a high level view and aggregates all traffic for defined services. To view a summary of metrics, select any node or edge in the graph to display its metric details in the summary details panel. From 75649d65722e4012ae5ed8084ea0c9b05eca0071 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Tue, 2 Jun 2020 10:29:58 -0400 Subject: [PATCH 08/16] matt feedback --- service_mesh/service_mesh_user_guide/ossm-observability.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/service_mesh/service_mesh_user_guide/ossm-observability.adoc b/service_mesh/service_mesh_user_guide/ossm-observability.adoc index 00b155dd1342..1e7bfb23ad57 100644 --- a/service_mesh/service_mesh_user_guide/ossm-observability.adoc +++ b/service_mesh/service_mesh_user_guide/ossm-observability.adoc @@ -5,7 +5,7 @@ include::modules/ossm-document-attributes.adoc[] toc::[] -You can your application's topology, health and metrics with using the Kiali operator you installed as part of your {ProductName} installation. +You can view your application's topology, health and metrics with using the Kiali operator you installed as part of your {ProductName} installation. If your service is having issues, Kiali offers ways to visualize the data flowing through your service. Kiali offers insights about the mesh components at different levels, including abstract applications, services, and workloads. It also provides an interactive graph view of your namespace in real time. From dfb086d629a310cc2a0f12ecf443b5594e2a4258 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Tue, 2 Jun 2020 10:45:33 -0400 Subject: [PATCH 09/16] more matt comments --- modules/ossm-observability-access.adoc | 2 +- modules/ossm-observability-visual.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ossm-observability-access.adoc b/modules/ossm-observability-access.adoc index 79f9a8734f4f..d85096ce3a56 100644 --- a/modules/ossm-observability-access.adoc +++ b/modules/ossm-observability-access.adoc @@ -7,7 +7,7 @@ To access the console to see how the traffic moves around the application, in the menu bar, click the *Application launcher* > *Kiali*. -Select the project for your service in the *Namespace* field. Log in to the Kiali console w the same user name and password as you use to access the {product-title} console. If you have installed the Bookinfo example, select `bookinfo`. +Select the project for your service in the *Namespace* field. Log in to the Kiali console with the same user name and password as you use to access the {product-title} console. If you have installed the Bookinfo example, select `bookinfo`. .Procedure from the command line diff --git a/modules/ossm-observability-visual.adoc b/modules/ossm-observability-visual.adoc index d19aa2c9a6f7..864baa7527fb 100644 --- a/modules/ossm-observability-visual.adoc +++ b/modules/ossm-observability-visual.adoc @@ -15,7 +15,7 @@ The Overview page displays all the namespaces that have services in your mesh. Y The namespace graph is a map of the services in your namespace and arrows that show how data flows through them. To view a namespace graph: -1. Click *Graph* in the main navigation and select `bookinfo` from the namespace menu. +1. Click *Graph* in the main navigation. + 2. Select `bookinfo` from the *Namespace* menu. + From b2c1411f6d7bf16436c218f8ec3c2e9a5dddd997 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Wed, 3 Jun 2020 17:54:51 -0400 Subject: [PATCH 10/16] julie feedback --- modules/ossm-observability-access.adoc | 2 +- modules/ossm-observability-visual.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ossm-observability-access.adoc b/modules/ossm-observability-access.adoc index d85096ce3a56..c73dcf656963 100644 --- a/modules/ossm-observability-access.adoc +++ b/modules/ossm-observability-access.adoc @@ -5,7 +5,7 @@ [id="ossm-observability-access-console_{context}"] = Accessing the Kiali console -To access the console to see how the traffic moves around the application, in the menu bar, click the *Application launcher* > *Kiali*. +To access the console, in the menu bar, click the *Application launcher* > *Kiali*. Select the project for your service in the *Namespace* field. Log in to the Kiali console with the same user name and password as you use to access the {product-title} console. If you have installed the Bookinfo example, select `bookinfo`. diff --git a/modules/ossm-observability-visual.adoc b/modules/ossm-observability-visual.adoc index 864baa7527fb..5fb9a1326369 100644 --- a/modules/ossm-observability-visual.adoc +++ b/modules/ossm-observability-visual.adoc @@ -6,7 +6,7 @@ This module is included in the following assemblies: [id="ossm-observability-visual_{context}"] = Visualizing your service -The Kiali operator works with the telemetry data gathered in {ProductName} to provide graphs and real time architecture diagrams of the applications, services, and workloads in your namespace. +The Kiali operator works with the telemetry data gathered in {ProductName} to provide graphs and real time network diagrams of the applications, services, and workloads in your namespace. The Overview page displays all the namespaces that have services in your mesh. You can reveal deeper insights about the data traveling through your Service mesh or help identify problems with services or workloads in your service mesh with the following graphs and visualizations. From 8020766008b07b077d9644568a0b50919507091b Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 4 Jun 2020 17:35:25 -0400 Subject: [PATCH 11/16] julie fixes --- .../service_mesh_user_guide/ossm-observability.adoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/service_mesh/service_mesh_user_guide/ossm-observability.adoc b/service_mesh/service_mesh_user_guide/ossm-observability.adoc index 1e7bfb23ad57..8f0e2d940259 100644 --- a/service_mesh/service_mesh_user_guide/ossm-observability.adoc +++ b/service_mesh/service_mesh_user_guide/ossm-observability.adoc @@ -5,13 +5,11 @@ include::modules/ossm-document-attributes.adoc[] toc::[] -You can view your application's topology, health and metrics with using the Kiali operator you installed as part of your {ProductName} installation. - -If your service is having issues, Kiali offers ways to visualize the data flowing through your service. Kiali offers insights about the mesh components at different levels, including abstract applications, services, and workloads. It also provides an interactive graph view of your namespace in real time. +You can view your application's topology, health and metrics in the Kiali console. If your service is having issues, the Kiali console offers ways to visualize the data flowing through your service. You can view insights about the mesh components at different levels, including abstract applications, services, and workloads. It also provides an interactive graph view of your namespace in real time. .Prerequisites -* You can observe data flowing through a working service if you install the xref:../../service_mesh/service_mesh_day_two/ossm-example-bookinfo.html#ossm-tutorial-bookinfo-overview_ossm-bookinfo-tutorial[Bookinfo sample application]. +* You can observe data flowing through an example application if you install the xref:../../service_mesh/service_mesh_day_two/ossm-example-bookinfo.html#ossm-tutorial-bookinfo-overview_ossm-bookinfo-tutorial[Bookinfo sample application]. To send traffic to the mesh, enter the following command a few times: From 4e46e109616b8bad5e931eee064c267fd551ed8c Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 4 Jun 2020 17:46:10 -0400 Subject: [PATCH 12/16] more julie feedback --- modules/ossm-observability-visual.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ossm-observability-visual.adoc b/modules/ossm-observability-visual.adoc index 5fb9a1326369..a8c46320626f 100644 --- a/modules/ossm-observability-visual.adoc +++ b/modules/ossm-observability-visual.adoc @@ -13,7 +13,7 @@ The Overview page displays all the namespaces that have services in your mesh. Y [id="ossm-observability-topology_{context}"] == Namespace graphs -The namespace graph is a map of the services in your namespace and arrows that show how data flows through them. To view a namespace graph: +The namespace graph is a map of the services, deployments and workflows in your namespace and arrows that show how data flows through them. To view a namespace graph: 1. Click *Graph* in the main navigation. + From 396a85e827c43edea3bf28168e30f2a60950582b Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 4 Jun 2020 18:05:48 -0400 Subject: [PATCH 13/16] julie feedback 3 --- service_mesh/service_mesh_user_guide/ossm-observability.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/service_mesh/service_mesh_user_guide/ossm-observability.adoc b/service_mesh/service_mesh_user_guide/ossm-observability.adoc index 8f0e2d940259..4abe58cfeb54 100644 --- a/service_mesh/service_mesh_user_guide/ossm-observability.adoc +++ b/service_mesh/service_mesh_user_guide/ossm-observability.adoc @@ -5,11 +5,11 @@ include::modules/ossm-document-attributes.adoc[] toc::[] -You can view your application's topology, health and metrics in the Kiali console. If your service is having issues, the Kiali console offers ways to visualize the data flowing through your service. You can view insights about the mesh components at different levels, including abstract applications, services, and workloads. It also provides an interactive graph view of your namespace in real time. +You can view your application's topology, health and metrics in the Kiali console. If your service is having issues, the Kiali console offers ways to visualize the data flow through your service. You can view insights about the mesh components at different levels, including abstract applications, services, and workloads. It also provides an interactive graph view of your namespace in real time. .Prerequisites -* You can observe data flowing through an example application if you install the xref:../../service_mesh/service_mesh_day_two/ossm-example-bookinfo.html#ossm-tutorial-bookinfo-overview_ossm-bookinfo-tutorial[Bookinfo sample application]. +* You can observe the data flow through an example application if you install the xref:../../service_mesh/service_mesh_day_two/ossm-example-bookinfo.html#ossm-tutorial-bookinfo-overview_ossm-bookinfo-tutorial[Bookinfo sample application]. To send traffic to the mesh, enter the following command a few times: From 449aac5bf3d5c3daab37b3abaa9c884b35dc0fed Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Thu, 4 Jun 2020 18:09:44 -0400 Subject: [PATCH 14/16] julie feedback 4 --- modules/ossm-observability-access.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/ossm-observability-access.adoc b/modules/ossm-observability-access.adoc index c73dcf656963..50759872a4cc 100644 --- a/modules/ossm-observability-access.adoc +++ b/modules/ossm-observability-access.adoc @@ -18,3 +18,5 @@ $ oc get routes ---- + In the output on the `kiali` line, use the URL in the HOST/PORT column to open the Kiali console. Select the project for your service in the *Namespace* field. Log in to the Kiali console with the same user name and password as you use to access the {product-title} console. + +When you first log in, you see the Overview page which displays all the namespaces in your mesh that you have permission to view. From 72545bd23edbc8985d3f693efc5869c217243f2f Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Fri, 5 Jun 2020 11:37:30 -0400 Subject: [PATCH 15/16] feedback --- modules/ossm-observability-access.adoc | 10 +++++++--- modules/ossm-observability-visual.adoc | 2 +- .../service_mesh_user_guide/ossm-observability.adoc | 7 ++----- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/modules/ossm-observability-access.adoc b/modules/ossm-observability-access.adoc index 50759872a4cc..77e5e4a44ea7 100644 --- a/modules/ossm-observability-access.adoc +++ b/modules/ossm-observability-access.adoc @@ -5,9 +5,13 @@ [id="ossm-observability-access-console_{context}"] = Accessing the Kiali console -To access the console, in the menu bar, click the *Application launcher* > *Kiali*. +To see how observability works in {ProductName}, open the Kiali console. -Select the project for your service in the *Namespace* field. Log in to the Kiali console with the same user name and password as you use to access the {product-title} console. If you have installed the Bookinfo example, select `bookinfo`. +1. In the {product-title} menu bar, click the *Application launcher* > *Kiali*. + +2. Log in to the Kiali console with the same user name and password as you use to access the {product-title} console. + +3. Select the project for your service in the *Namespace* field. If you have installed the Bookinfo example, select `bookinfo`. .Procedure from the command line @@ -17,6 +21,6 @@ Select the project for your service in the *Namespace* field. Log in to the Kial $ oc get routes ---- + -In the output on the `kiali` line, use the URL in the HOST/PORT column to open the Kiali console. Select the project for your service in the *Namespace* field. Log in to the Kiali console with the same user name and password as you use to access the {product-title} console. +In the output on the `kiali` line, use the URL in the HOST/PORT column to open the Kiali console. Log in to the Kiali console with the same user name and password as you use to access the {product-title} console. Select the project for your service in the *Namespace* field. When you first log in, you see the Overview page which displays all the namespaces in your mesh that you have permission to view. diff --git a/modules/ossm-observability-visual.adoc b/modules/ossm-observability-visual.adoc index a8c46320626f..03ff7d26c241 100644 --- a/modules/ossm-observability-visual.adoc +++ b/modules/ossm-observability-visual.adoc @@ -21,7 +21,7 @@ The namespace graph is a map of the services, deployments and workflows in your + image:ossm-kiali-graph.png[Kiali graph] -If your application uses version tags, like the Bookinfo sample application, you can see a Version graph select a graph from the Graph Type drop down menu. There are several graphs to choose from: +If your application uses version tags, like the Bookinfo sample application, you can see a Version graph. Select a graph from the Graph Type drop down menu. There are several graphs to choose from: * The App graph shows an aggregate workload for all applications that are labeled the same. diff --git a/service_mesh/service_mesh_user_guide/ossm-observability.adoc b/service_mesh/service_mesh_user_guide/ossm-observability.adoc index 4abe58cfeb54..b43c6cca6803 100644 --- a/service_mesh/service_mesh_user_guide/ossm-observability.adoc +++ b/service_mesh/service_mesh_user_guide/ossm-observability.adoc @@ -7,11 +7,9 @@ toc::[] You can view your application's topology, health and metrics in the Kiali console. If your service is having issues, the Kiali console offers ways to visualize the data flow through your service. You can view insights about the mesh components at different levels, including abstract applications, services, and workloads. It also provides an interactive graph view of your namespace in real time. -.Prerequisites +You can observe the data flow through your application if you have one installed. If you don't have your own application installed, you can see how observability works in {ProductName} by installing the xref:../../service_mesh/service_mesh_day_two/ossm-example-bookinfo.html#ossm-tutorial-bookinfo-overview_ossm-bookinfo-tutorial[Bookinfo sample application]. -* You can observe the data flow through an example application if you install the xref:../../service_mesh/service_mesh_day_two/ossm-example-bookinfo.html#ossm-tutorial-bookinfo-overview_ossm-bookinfo-tutorial[Bookinfo sample application]. - -To send traffic to the mesh, enter the following command a few times: +After installing the Bookinfo sample application, send traffic to the mesh. Enter the following command a few times: ---- $ curl http://$GATEWAY_URL/productpage @@ -22,4 +20,3 @@ If your sample application is configured correctly, this command simulates a use include::modules/ossm-observability-access.adoc[leveloffset=+1] include::modules/ossm-observability-visual.adoc[leveloffset=+1] - From 2a0a9a2ba61ed4a226aa68e91e15b87fb32841b8 Mon Sep 17 00:00:00 2001 From: Neal Timpe Date: Fri, 5 Jun 2020 13:45:27 -0400 Subject: [PATCH 16/16] access update --- modules/ossm-observability-access.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ossm-observability-access.adoc b/modules/ossm-observability-access.adoc index 77e5e4a44ea7..e3e31b95d935 100644 --- a/modules/ossm-observability-access.adoc +++ b/modules/ossm-observability-access.adoc @@ -5,7 +5,7 @@ [id="ossm-observability-access-console_{context}"] = Accessing the Kiali console -To see how observability works in {ProductName}, open the Kiali console. +To access the console, in the menu bar, click the *Application launcher* > *Kiali*. 1. In the {product-title} menu bar, click the *Application launcher* > *Kiali*.