mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 21:46:22 +01:00
Restoring Kiali and Jaeger tutorials
This commit is contained in:
Julie Stickler
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
6316a44e18
commit
2f91c036e8
@@ -916,6 +916,7 @@ Topics:
|
||||
File: customizing-installation-ossm
|
||||
- Name: Removing service mesh
|
||||
File: removing-ossm
|
||||
|
||||
- Name: Day Two
|
||||
Dir: service_mesh_day_two
|
||||
Topics:
|
||||
@@ -925,10 +926,10 @@ Topics:
|
||||
File: configuring-jaeger
|
||||
- Name: Example application
|
||||
File: ossm-example-bookinfo
|
||||
# - Name: Kiali tutorial
|
||||
# File: ossm-tutorial-kiali
|
||||
# - Name: Distributed tracing tutorial
|
||||
# File: ossm-tutorial-jaeger-tracing
|
||||
- Name: Kiali tutorial
|
||||
File: ossm-tutorial-kiali
|
||||
- Name: Distributed tracing tutorial
|
||||
File: ossm-tutorial-jaeger-tracing
|
||||
# - Name: Grafana tutorial
|
||||
# File: ossm-tutorial-grafana
|
||||
# - Name: Prometheus tutorial
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
[id="configuring-kiali_{context}"]
|
||||
= Configuring Kiali
|
||||
|
||||
When the {ProductShortName} Operator creates the `ServiceMeshControlPlane` it also processes the Kiali resource. The Kiali Operator then uses this object when creating Kaili instances.
|
||||
When the {ProductShortName} Operator creates the `ServiceMeshControlPlane` it also processes the Kiali resource. The Kiali Operator then uses this object when creating Kiali instances.
|
||||
|
||||
The default Kiali parameters specified in the `ServiceMeshControlPlane` are as follows:
|
||||
|
||||
@@ -52,7 +52,7 @@ spec:
|
||||
|
||||
When you install Kiali and Grafana as part of {ProductName} the Operator configures the following by default:
|
||||
|
||||
* Grafana is enabled as an external service for Kaili
|
||||
* Grafana is enabled as an external service for Kiali
|
||||
* Grafana authorization for the Kiali console
|
||||
* Grafana URL for the Kiali console
|
||||
|
||||
@@ -77,7 +77,7 @@ spec:
|
||||
|
||||
When you install Kiali and Jaeger as part of {ProductName} the Operator configures the following by default:
|
||||
|
||||
* Jaeger is enabled as an external service for Kaili
|
||||
* Jaeger is enabled as an external service for Kiali
|
||||
* Jaeger authorization for the Kiali console
|
||||
* Jaeger URL for the Kiali console
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ This tutorial walks you through creating a Bookinfo project, deploying the Booki
|
||||
|
||||
.Procedure
|
||||
|
||||
. Log in to the {product-title} web console.
|
||||
. Log in to the {product-title} web console as a user with cluster-admin rights.
|
||||
|
||||
. Click to *Home* -> *Projects*.
|
||||
|
||||
@@ -37,12 +37,21 @@ $ oc new-project bookinfo
|
||||
|
||||
. Click *Operators* -> *Installed Operators*.
|
||||
|
||||
. Click the *Project* menu and choose `openshift-operators` from the list.
|
||||
. Click the *Project* menu and choose `bookinfo` from the list.
|
||||
|
||||
. Click the *Istio Service Mesh Member Roll* link under *Provided APIs* for the *{ProductName}* Operator.
|
||||
. Click the *{ProductName}* Operator.
|
||||
|
||||
. Click *Create Service Mesh Member Roll*.
|
||||
. Click the *Istio Service Mesh Member Roll* link.
|
||||
|
||||
.. If you have already created a Istio Service Mesh Member Roll, click the name, then click the YAML tab to open the YAML editor.
|
||||
|
||||
.. If you have not created a Istio Service Mesh Member Roll, click *Create Service Mesh Member Roll*.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
You need cluster-admin rights to edit the Istio Service Mesh Member Roll.
|
||||
====
|
||||
+
|
||||
. Edit the default Service Mesh Member Roll YAML and add `bookinfo` to the *members* list.
|
||||
+
|
||||
.Bookinfo ServiceMeshMemberRoll example
|
||||
|
||||
@@ -6,7 +6,7 @@ This CONCEPT module included in the following assemblies:
|
||||
[id="ossm-tutorial-bookinfo-overview_{context}"]
|
||||
= Bookinfo application
|
||||
|
||||
The upstream Istio project has an example tutorial called https://istio.io/docs/examples/bookinfo[bookinfo], which is composed of four separate microservices used to demonstrate various Istio features. The Bookinfo application displays information about a book, similar to a single catalog entry of an online book store. Displayed on the page is a description of the book, book details (ISBN, number of pages, and other information), and book reviews.
|
||||
The upstream Istio project has an example tutorial called https://istio.io/docs/examples/bookinfo[Bookinfo], which is composed of four separate microservices used to demonstrate various Istio features. The Bookinfo application displays information about a book, similar to a single catalog entry of an online book store. Displayed on the page is a description of the book, book details (ISBN, number of pages, and other information), and book reviews.
|
||||
|
||||
The Bookinfo application consists of these microservices:
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ Follow these steps to remove the Bookinfo application.
|
||||
* Access to the {product-title} Command-line Interface (CLI) also known as `oc`.
|
||||
|
||||
[id="ossm-delete-bookinfo-project_{context}"]
|
||||
== Delete the bookinfo project
|
||||
== Delete the Bookinfo project
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -34,7 +34,7 @@ $ oc delete project bookinfo
|
||||
----
|
||||
|
||||
[id="ossm-remove-bookinfo-smmr_{context}"]
|
||||
== Remove the bookinfo project from the {ProductShortName} member roll
|
||||
== Remove the Bookinfo project from the {ProductShortName} member roll
|
||||
|
||||
.Procedure
|
||||
|
||||
|
||||
@@ -6,24 +6,29 @@ This TASK module included in the following assemblies:
|
||||
[[generating-traces-analyzing-trace-data]]
|
||||
= Generating traces and analyzing trace data
|
||||
|
||||
This tutorial uses {ProductShortName} and the `bookinfo` tutorial to demonstrate how you can perform a trace using the Jaeger component of {ProductName}.
|
||||
This tutorial uses {ProductShortName} and the Bookinfo tutorial to demonstrate how you can perform a trace using the Jaeger component of {ProductName}.
|
||||
|
||||
.Prerequisites:
|
||||
|
||||
* {product-title} 3.11 or higher installed.
|
||||
* {product-title} 4.1 or higher installed.
|
||||
* {ProductName} {ProductVersion} installed.
|
||||
* `Bookinfo` demonstration application installed.
|
||||
* Jaeger enabled during the installation.
|
||||
* Bookinfo example application installed.
|
||||
|
||||
.Procedure
|
||||
. After you have deployed the Bookinfo application you will need to generate calls to the Bookinfo application so that you have some trace data to analyze. Access http://<GATEWAY_URL>/productpage and refresh the page a few times to generate some trace data.
|
||||
. A route to access the Jaeger dashboard already exists. Query for details of the route:
|
||||
. The installation process creates a route to access the Jaeger console.
|
||||
.. In the {product-title} console, navigate to *Networking* -> *Routes* and search for the Jaeger route, which is the URL listed under *Location*.
|
||||
.. Use the CLI to query for details of the route:
|
||||
+
|
||||
----
|
||||
$ export JAEGER_URL=$(oc get route -n istio-system jaeger-query -o jsonpath='{.spec.host}')
|
||||
$ export JAEGER_URL=$(oc get route -n bookinfo jaeger-query -o jsonpath='{.spec.host}')
|
||||
----
|
||||
+
|
||||
. Launch a browser and navigate to `https://<JAEGER_URL>`.
|
||||
|
||||
. If necessary, log in using the same user name and password as you use to access the {product-title} console.
|
||||
|
||||
. In the left pane of the Jaeger dashboard, from the Service menu, select "productpage" and click the *Find Traces* button at the bottom of the pane. A list of traces is displayed, as shown in the following image:
|
||||
|
||||
+
|
||||
|
||||
@@ -10,39 +10,45 @@ The Kiali console provides visualization and observability for your {ProductShor
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* {product-title} 3.11 or higher installed.
|
||||
* {product-title} 4.1 or higher installed.
|
||||
* {ProductName} {ProductVersion} installed.
|
||||
* Kiali parameters specified in the custom resource file.
|
||||
* `Bookinfo` demonstration application installed.
|
||||
* Kiali enabled during the installation.
|
||||
* Bookinfo demonstration application installed.
|
||||
|
||||
The installation process creates a route to access the Kiali console.
|
||||
|
||||
|
||||
.Procedure
|
||||
. A route to access the Kiali console already exists. Run the following command to obtain the route and Kiali URL:
|
||||
+
|
||||
----
|
||||
$ oc get routes
|
||||
----
|
||||
+
|
||||
.Sample output showing routes
|
||||
+
|
||||
----
|
||||
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
|
||||
grafana grafana-istio-system.127.0.0.1.nip.io grafana http None
|
||||
istio-ingress istio-ingress-istio-system.127.0.0.1.nip.io istio-ingress http None
|
||||
istio-ingressgateway istio-ingressgateway-istio-system.127.0.0.1.nip.io istio-ingressgateway http None
|
||||
jaeger-query jaeger-query-istio-system.127.0.0.1.nip.io jaeger-query jaeger-query edge None
|
||||
kiali kiali-istio-system.127.0.0.1.nip.io kiali <all> None
|
||||
prometheus prometheus-istio-system.127.0.0.1.nip.io prometheus http-prometheus None
|
||||
tracing tracing-istio-system.127.0.0.1.nip.io tracing tracing edge None
|
||||
----
|
||||
+
|
||||
. Launch a browser and navigate to https://<KIALI_URL> (in the output example, this is `kiali-istio-system.127.0.0.1.nip.io`). You should see the Kiali console login screen.
|
||||
|
||||
. Log in to the Kiali console using the user name and password that you specified in the custom resource file during installation.
|
||||
.Procedure from the console
|
||||
. In the {product-title} console, navigate to 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]
|
||||
+
|
||||
. Use the left navigation or click one of the Namespace icons to view your Applications, Workloads, or Services.
|
||||
|
||||
.Procedure from the CLI
|
||||
|
||||
. Run this command from the CLI to obtain the route and Kiali URL:
|
||||
+
|
||||
----
|
||||
$ oc get routes
|
||||
----
|
||||
+
|
||||
.Sample CLI output showing routes
|
||||
+
|
||||
----
|
||||
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
|
||||
grafana grafana-openshift-operators.127.0.0.1.nip.io grafana http None
|
||||
istio-ingress istio-ingress-openshift-operators.127.0.0.1.nip.io istio-ingress http None
|
||||
istio-ingressgateway istio-ingressgateway-openshift-operators.127.0.0.1.nip.io istio-ingressgateway http None
|
||||
jaeger-query jaeger-query-openshift-operators.127.0.0.1.nip.io jaeger-query jaeger-query edge None
|
||||
kiali kiali-openshift-operators.127.0.0.1.nip.io kiali <all> None
|
||||
prometheus prometheus-openshift-operators.127.0.0.1.nip.io prometheus http-prometheus None
|
||||
tracing tracing-openshift-operators.127.0.0.1.nip.io tracing tracing edge None
|
||||
----
|
||||
+
|
||||
. Launch a browser and navigate to https://<KIALI_URL> (in the CLI output example, this is `kiali-openshift-operators.127.0.0.1.nip.io`). You should see the Kiali console login screen.
|
||||
|
||||
. Log in to the Kiali console using the user name and password that you use when logging into the {product-title} console.
|
||||
|
||||
@@ -9,7 +9,7 @@ This TASK module included in the following assemblies:
|
||||
The Applications page lets you search for and view applications, their health, and other details.
|
||||
|
||||
.Procedure
|
||||
. Click *Applications* in the left navigation.
|
||||
. In the Kiali console, click *Applications* in the left navigation.
|
||||
. If necessary, select `bookinfo` from the *Namespace* menu. The page displays the applications in the selected Namespace and their health.
|
||||
. Hover over the Health icon to view additional health details.
|
||||
. Click the `reviews` Service to view the details for that application.
|
||||
|
||||
@@ -9,7 +9,7 @@ This TASK module included in the following assemblies:
|
||||
The Graph page shows a graph of microservices, which are connected by the requests going through them. On this page, you can see how Applications, Workloads, or Services interact with each other.
|
||||
|
||||
.Procedure
|
||||
. Click *Graph* in the left navigation.
|
||||
. In the Kiali console, click *Graph* in the left navigation.
|
||||
+
|
||||
image:ossm-kiali-graph.png[Kiali graph]
|
||||
+
|
||||
|
||||
@@ -9,7 +9,7 @@ This TASK module included in the following assemblies:
|
||||
The Istio Config page lets you view all of the currently running configurations to your {ProductShortName}, such as Circuit Breakers, Destination Rules, Fault Injection, Gateways, Routes, Route Rules, and Virtual Services.
|
||||
|
||||
.Procedure
|
||||
. Click *Istio Config* in the left navigation.
|
||||
. In the Kiali console, click *Istio Config* in the left navigation.
|
||||
. If necessary, select `bookinfo` from the *Namespace* menu. The page displays a listing of configurations running in the selected Namespace and validation status.
|
||||
+
|
||||
image:ossm-kiali-istio-config.png[Istio configuration]
|
||||
|
||||
@@ -9,7 +9,7 @@ This TASK module included in the following assemblies:
|
||||
The Services page lets you search for and view Services, their health, and other details.
|
||||
|
||||
.Procedure
|
||||
. Click *Services* in the left navigation.
|
||||
. In the Kiali console, click *Services* in the left navigation.
|
||||
. If necessary, select `bookinfo` from the *Namespace* menu. The page displays a listing of all the Services that are running in the selected Namespace and additional information about them, such as health status.
|
||||
. Hover over the health icon for any of the Services to view health information about the Service. A Service is considered healthy when it is online and responding to requests without errors.
|
||||
. Click the *Reviews* Service to view its details. Note that there are three different versions of this Service.
|
||||
|
||||
@@ -9,7 +9,7 @@ This TASK module included in the following assemblies:
|
||||
The Workloads page lets you search for and view Workloads, their health, and other details.
|
||||
|
||||
.Procedure
|
||||
. Click *Workloads* in the left navigation.
|
||||
. In the Kiali console, click *Workloads* in the left navigation.
|
||||
. If necessary, select `bookinfo` from the *Namespace* menu. The page displays the Workloads in the selected Namespace, their health, and labels.
|
||||
. Click the `reviews-v1` Workload to view the details for that Workload.
|
||||
. On the Workload Details page you can view an overview of Pods and Services associated with the Workload.
|
||||
|
||||
@@ -9,7 +9,7 @@ With OpenShift Cluster Logging, the logs that your applications write to the con
|
||||
|
||||
.Procedure
|
||||
|
||||
. Use the following command to find the URL to Kibana:
|
||||
. Use the following command to find the URL to Kibana:
|
||||
+
|
||||
----
|
||||
$ oc -n cluster-logging get route kibana`
|
||||
@@ -19,16 +19,16 @@ $ oc -n cluster-logging get route kibana`
|
||||
|
||||
. Ensure the index is set to *.all*. If the index is not set to *.all*, only the OpenShift system logs will be listed.
|
||||
|
||||
. Filter the logs by using the Kubernetes namespace your service is deployed in. Add a filter to identify the service itself: `kubernetes.namespace_name:default AND kubernetes.labels.serving_knative_dev\/service:{SERVICE_NAME}`.
|
||||
. Filter the logs by using the Kubernetes namespace your service is deployed in. Add a filter to identify the service itself: `kubernetes.namespace_name:default AND kubernetes.labels.serving_knative_dev\/service:{SERVICE_NAME}`.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
You can also filter by using `/configuration` or `/revision`.
|
||||
You can also filter by using `/configuration` or `/revision`.
|
||||
====
|
||||
|
||||
. You can narrow your search by using `kubernetes.container_name:<user-container>` to only display the logs generated by your application. Otherwise, you will see logs from the queue-proxy.
|
||||
+
|
||||
[NOTE]
|
||||
[NOTE]
|
||||
====
|
||||
Use JSON-based structured logging in your application to allow for the quick filtering of these logs in production environments.
|
||||
====
|
||||
====
|
||||
|
||||
@@ -7,7 +7,7 @@ toc::[]
|
||||
|
||||
[WARNING]
|
||||
====
|
||||
The Bookinfo example application allows you to test your {ProductName} {ProductVersion} installation on {product-title} 4.1.
|
||||
The Bookinfo example application allows you to test your {ProductName} {ProductVersion} installation on {product-title}.
|
||||
|
||||
Red Hat does not provide support for the Bookinfo application.
|
||||
====
|
||||
|
||||
@@ -3,7 +3,16 @@
|
||||
include::modules/ossm-document-attributes.adoc[]
|
||||
:context: ossm-jaeger-tutorial
|
||||
|
||||
Jaeger is an open source distributed tracing system. You use Jaeger for monitoring and troubleshooting microservices-based distributed systems. Using Jaeger you can perform a trace, which follows the path of a request through various microservices that make up an application. Jaeger is installed by default as part of the Service Mesh.
|
||||
Jaeger is an open source distributed tracing system. You use Jaeger for monitoring and troubleshooting microservices-based distributed systems. Using Jaeger you can perform a trace, which follows the path of a request through various microservices that make up an application. Jaeger is installed by default as part of the {ProductShortName}.
|
||||
|
||||
This tutorial uses {ProductShortName} and the bookinfo tutorial to demonstrate how you can use Jeager to perform distributed tracing.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The Bookinfo example application allows you to test your {ProductName} {ProductVersion} installation on {product-title}.
|
||||
|
||||
Red Hat does not provide support for the Bookinfo application.
|
||||
====
|
||||
|
||||
// The following include statements pull in the module files that comprise the assembly.
|
||||
|
||||
@@ -7,7 +7,14 @@ toc::[]
|
||||
|
||||
Kiali works with Istio to visualize your service mesh topology to provide visibility into features like circuit breakers, request rates, and more. Kiali offers insights about the mesh components at different levels, from abstract Applications to Services and Workloads. Kiali provides an interactive graph view of your Namespace in real time. It can display the interactions at several levels (applications, versions, workloads) with contextual information and charts on the selected graph node or edge.
|
||||
|
||||
This tutorial uses {ProductShortName} and the `bookinfo` tutorial to demonstrate how you can use the Kiali console to view the topography and health of your service mesh.
|
||||
This tutorial uses {ProductShortName} and the Bookinfo tutorial to demonstrate how you can use the Kiali console to view the topography and health of your service mesh.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The Bookinfo example application allows you to test your {ProductName} {ProductVersion} installation on {product-title}.
|
||||
|
||||
Red Hat does not provide support for the Bookinfo application.
|
||||
====
|
||||
|
||||
// The following include statements pull in the module files that comprise the assembly.
|
||||
|
||||
Reference in New Issue
Block a user