Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion jaeger/jaeger_arch/rhbjaeger-architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ include::modules/jaeger-document-attributes.adoc[]

toc::[]

Every time a user takes an action in an application, a request is executed by the architecture that may require dozens of different services to participate in order to produce a response.
Every time a user takes an action in an application, a request is executed by the architecture that may require dozens of different services to participate to produce a response.
Jaeger lets you perform distributed tracing, which records the path of a request through various microservices that make up an application.

_Distributed tracing_ is a technique that is used to tie the information about different units of work together — usually executed in different processes or hosts — to understand a whole chain of events in a distributed transaction.
Expand Down
14 changes: 8 additions & 6 deletions jaeger/jaeger_install/rhbjaeger-deploying.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,23 @@ The streaming strategy requires an additional Red Hat subscription for AMQ Strea

[NOTE]
====
There are two ways to install and use Jaeger, as part of a service mesh or as a stand alone component. If you have installed Jaeger as part of Red Hat OpenShift Service Mesh, you can configure and deploy Jaeger as part of the xref:../../service_mesh/v2x/ossm-custom-resources.adoc#ossm-custom-resources-v2x[ServiceMeshControlPlane] or configure Jaeger and then xref:../../service_mesh/v2x/ossm-custom-resources.adoc#ossm-deploying-jaeger-streaming[reference your Jaeger configuration in the SMCP].
There are two ways to install and use Jaeger, as part of a service mesh or as a stand alone component. If you have installed Jaeger as part of Red Hat OpenShift Service Mesh, you can configure and deploy Jaeger as part of the xref:../../service_mesh/v2x/installing-ossm.adoc#installing-ossm[ServiceMeshControlPlane] or configure Jaeger and then xref:../../service_mesh/v2x/ossm-observability.html#ossm-config-external-jaeger_observability[reference your Jaeger configuration in the ServiceMeshControlPlane].

====

// The following include statements pull in the module files that comprise the assembly.

include::modules/jaeger-deploy-default.adoc[leveloffset=+1]

include::modules/jaeger-deploy-production-es.adoc[leveloffset=1]
include::modules/jaeger-deploy-production-es.adoc[leveloffset=+1]

include::modules/jaeger-deploy-streaming.adoc[leveloffset=1]
include::modules/jaeger-deploy-streaming.adoc[leveloffset=+1]

[id="customizing-jaeger-deployment"]
== Customizing Jaeger deployment

include::modules/jaeger-deployment-best-practices.adoc[leveloffset=+2]

include::modules/jaeger-config-default.adoc[leveloffset=+2]

include::modules/jaeger-config-collector.adoc[leveloffset=+2]
Expand All @@ -70,8 +72,8 @@ include::modules/jaeger-config-ingester.adoc[leveloffset=+2]
[id="injecting-sidecars"]
== Injecting sidecars

{ProductName} relies on a proxy sidecar within the applications pod to provide the agent. The Jaeger Operator can inject Jaeger Agent sidecars into Deployment workloads. You can enable automatic sidecar injection or manage it manually.
{ProductName} relies on a proxy sidecar within the application's pod to provide the agent. The Jaeger Operator can inject Jaeger Agent sidecars into Deployment workloads. You can enable automatic sidecar injection or manage it manually.

include::modules/jaeger-sidecar-automatic.adoc[leveloffset=2]
include::modules/jaeger-sidecar-automatic.adoc[leveloffset=+2]

include::modules/jaeger-sidecar-manual.adoc[leveloffset=2]
include::modules/jaeger-sidecar-manual.adoc[leveloffset=+2]
6 changes: 3 additions & 3 deletions jaeger/jaeger_install/rhbjaeger-installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ toc::[]

You can install Jaeger on {product-title} in either of two ways:

* You can install Jaeger as part of Red Hat OpenShift Service Mesh. Jaeger is included by default in the Service Mesh installation. To install Jaeger as part of a service mesh, follow the xref:../../service_mesh/v2x/preparing-ossm-installation.adoc#preparing-ossm-installation[Red Hat Service Mesh Installation] instructions.
* You can install Jaeger as part of Red Hat OpenShift Service Mesh. Jaeger is included by default in the Service Mesh installation. To install Jaeger as part of a service mesh, follow the xref:../../service_mesh/v2x/preparing-ossm-installation.adoc#preparing-ossm-installation[Red Hat Service Mesh Installation] instructions. Jaeger must be installed in the same namespace as your service mesh, that is, the `ServiceMeshControlPlane` and the Jaeger resources must be in the same namespace.

* If you do not want to install a service mesh, you can use the Jaeger Operator to install the Red Hat build of Jaeger by itself. To install Jaeger without a service mesh, use the following instructions.
* If you do not want to install a service mesh, you can use the Jaeger Operator to install {ProductName} by itself. To install Jaeger without a service mesh, use the following instructions.


== Prerequisites
Expand All @@ -25,7 +25,7 @@ Before you can install {ProductName}, review the installation activities, and en
** xref:../../installing/installing_aws/installing-aws-user-infra.adoc#installing-aws-user-infra[Install {product-title} {product-version} on user-provisioned AWS]
** xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Install {product-title} {product-version} on bare metal]
** xref:../../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[Install {product-title} {product-version} on vSphere]
* Install the version of the {product-title} command line utility (the `oc` client tool) that matches your {product-title} version and add it to your path.
* Install the version of the OpenShift CLI (`oc`) that matches your {product-title} version and add it to your path.

* An account with the `cluster-admin` role.

Expand Down
2 changes: 1 addition & 1 deletion jaeger/jaeger_install/rhbjaeger-removing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ include::modules/jaeger-removing-instance-cli.adoc[leveloffset=+1]

* Remove the Jaeger Operator.

* After the Jaeger Operator has been removed, if appropriate, remove the Elasticsearch Operator.
* After the Jaeger Operator has been removed, if appropriate, remove the OpenShift Elasticsearch Operator.
4 changes: 3 additions & 1 deletion jaeger/jaeger_install/rhbjaeger-updating.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ The Operator Lifecycle Manager (OLM) controls the installation, upgrade, and rol
The OLM queries for available Operators as well as upgrades for installed Operators.
For more information about how {product-title} handled upgrades, refer to the xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager] documentation.

The update approach used by the Jaeger Operator upgrades the managed Jaeger instances to the version associated with the Operator. Whenever a new version of the Jaeger Operator is installed, all the Jaeger application instances managed by the Operator will be upgraded to the Operator’s version. For example, if version 1.10 is installed (both Operator and backend components) and the Operator is upgraded to version 1.11, then as soon as the Operator upgrade has completed, the Operator will scan for running Jaeger instances and upgrade them to 1.11 as well.
The update approach used by the Jaeger Operator upgrades the managed Jaeger instances to the version associated with the Operator. Whenever a new version of the Jaeger Operator is installed, all the Jaeger application instances managed by the Operator will be upgraded to the Operator's version. For example, if version 1.10 is installed (both Operator and backend components) and the Operator is upgraded to version 1.11, then as soon as the Operator upgrade has completed, the Operator will scan for running Jaeger instances and upgrade them to 1.11 as well.

For specific instructions for how to update the OpenShift Elasticsearch Operator, refer to xref:../../logging/cluster-logging-upgrading.adoc#cluster-logging-upgrading_cluster-logging-upgrading[Updating OpenShift Logging].
11 changes: 5 additions & 6 deletions service_mesh/v1x/installing-ossm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@
= Installing {ProductName}
include::modules/ossm-document-attributes-1x.adoc[]
:context: installing-ossm-v1x

toc::[]

Installing the {ProductShortName} involves installing the Elasticsearch, Jaeger, Kiali and {ProductShortName} Operators, creating and managing a `ServiceMeshControlPlane` resource to deploy the control plane, and creating a `ServiceMeshMemberRoll` resource to specify the namespaces associated with the {ProductShortName}.
Installing the {ProductShortName} involves installing the OpenShift Elasticsearch, Jaeger, Kiali and {ProductShortName} Operators, creating and managing a `ServiceMeshControlPlane` resource to deploy the control plane, and creating a `ServiceMeshMemberRoll` resource to specify the namespaces associated with the {ProductShortName}.

[NOTE]
====
Mixers policy enforcement is disabled by default. You must enable it to run policy tasks. See xref:../../service_mesh/v1x/prepare-to-deploy-applications-ossm.adoc#ossm-mixer-policy-1x_deploying-applications-ossm-v1x[Update Mixer policy enforcement] for instructions on enabling Mixer policy enforcement.
Mixer's policy enforcement is disabled by default. You must enable it to run policy tasks. See xref:../../service_mesh/v1x/prepare-to-deploy-applications-ossm.adoc#ossm-mixer-policy-1x_deploying-applications-ossm-v1x[Update Mixer policy enforcement] for instructions on enabling Mixer policy enforcement.
====

[NOTE]
Expand All @@ -18,7 +19,7 @@ Multi-tenant control plane installations are the default configuration starting

[NOTE]
====
The {ProductShortName} documentation uses `istio-system` as the example project, but you may deploy the service mesh to any project.
The {ProductShortName} documentation uses `istio-system` as the example project, but you can deploy the service mesh to any project.
====

== Prerequisites
Expand All @@ -27,7 +28,7 @@ The {ProductShortName} documentation uses `istio-system` as the example project,

The {ProductShortName} installation process uses the link:https://operatorhub.io/[OperatorHub] to install the `ServiceMeshControlPlane` custom resource definition within the `openshift-operators` project. The {ProductName} defines and monitors the `ServiceMeshControlPlane` related to the deployment, update, and deletion of the control plane.

Starting with {ProductName} {ProductVersion}, you must install the Elasticsearch Operator, the Jaeger Operator, and the Kiali Operator before the {ProductName} Operator can install the control plane.
Starting with {ProductName} {ProductVersion}, you must install the OpenShift Elasticsearch Operator, the Jaeger Operator, and the Kiali Operator before the {ProductName} Operator can install the control plane.

include::modules/jaeger-install-elasticsearch.adoc[leveloffset=+1]

Expand Down Expand Up @@ -56,6 +57,4 @@ include::modules/ossm-update-app-sidecar.adoc[leveloffset=+2]

== Next steps

* xref:../../service_mesh/v1x/customizing-installation-ossm.adoc#customize-installation-ossm-v1x[Customize the {ProductName} installation].

* xref:../../service_mesh/v1x/prepare-to-deploy-applications-ossm.adoc#deploying-applications-ossm-v1x[Prepare to deploy applications] on {ProductName}.
5 changes: 3 additions & 2 deletions service_mesh/v1x/ossm-architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
= Understanding {ProductName}
include::modules/ossm-document-attributes-1x.adoc[]
:context: ossm-architecture-v1x

toc::[]

{ProductName} provides a platform for behavioral insight and operational control over your networked microservices in a service mesh. With {ProductName}, you can connect, secure, and monitor microservices in your {product-title} environment.
Expand All @@ -22,11 +23,11 @@ include::modules/ossm-kiali-features.adoc[leveloffset=+2]

== Understanding Jaeger

Every time a user takes an action in an application, a request is executed by the architecture that may require dozens of different services to participate in order to produce a response.
Every time a user takes an action in an application, a request is executed by the architecture that may require dozens of different services to participate to produce a response.
The path of this request is a distributed transaction.
Jaeger lets you perform distributed tracing, which follows the path of a request through various microservices that make up an application.

*Distributed tracing* is a technique that is used to tie the information about different units of work together—usually executed in different processes or hosts—in order to understand a whole chain of events in a distributed transaction.
*Distributed tracing* is a technique that is used to tie the information about different units of work together—usually executed in different processes or hosts—to understand a whole chain of events in a distributed transaction.
Distributed tracing lets developers visualize call flows in large service oriented architectures.
It can be invaluable in understanding serialization, parallelism, and sources of latency.

Expand Down
24 changes: 24 additions & 0 deletions service_mesh/v1x/ossm-config.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[id="ossm-config-v1x"]
= Configuring {ProductName}
include::modules/ossm-document-attributes-1x.adoc[]
:context: ossm-config-v1x

toc::[]

After you create a `ServiceMeshControlPlane` resource, configure the resource to suit your environment and requirements.

This guide references the Bookinfo sample application to provide examples of security in an example application. Install the xref:../../service_mesh/v2x/prepare-to-deploy-applications-ossm.adoc#ossm-tutorial-bookinfo-overview_deploying-applications-ossm[Bookinfo application] to learn how these routing examples work.

include::modules/ossm-config-security.adoc[leveloffset=+1]

include::modules/ossm-security-mtls-1x.adoc[leveloffset=+2]

include::modules/ossm-security-cipher.adoc[leveloffset=+2]

include::modules/ossm-security-cert-manage.adoc[leveloffset=+2]

include::modules/ossm-config-dist-trac.adoc[leveloffset=+1]

include::modules/ossm-config-sampling.adoc[leveloffset=+2]

include::modules/ossm-config-external-jaeger.adoc[leveloffset=+2]
1 change: 1 addition & 0 deletions service_mesh/v1x/ossm-custom-resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
= Custom resources
include::modules/ossm-document-attributes.adoc[]
:context: ossm-controler-items-v1x

toc::[]

You can customize your {ProductName} by modifying the default {ProductShortName} custom resource or by creating a new custom resource.
Expand Down
10 changes: 2 additions & 8 deletions service_mesh/v1x/ossm-observability.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +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.

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/v1x/prepare-to-deploy-applications-ossm.adoc#ossm-tutorial-bookinfo-overview_deploying-applications-ossm-v1x[Bookinfo sample application].
.Before you begin

After installing the Bookinfo sample application, send traffic to the mesh. Enter the following command a few times:

----
$ curl http://$GATEWAY_URL/productpage
----

If your sample application is configured correctly, this command simulates a user visiting the `productpage` microservice of the application.
You can observe the data flow through your application if you have an application installed. If you don't have your own application installed, you can see how observability works in {ProductName} by installing the xref:../../service_mesh/v1x/prepare-to-deploy-applications-ossm.adoc#ossm-tutorial-bookinfo-overview_deploying-applications-ossm-v1x[Bookinfo sample application].

include::modules/ossm-observability-access.adoc[leveloffset=+1]

Expand Down
8 changes: 7 additions & 1 deletion service_mesh/v1x/ossm-traffic-manage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,14 @@ This guide references the Bookinfo sample application to provide examples of rou

include::modules/ossm-routing.adoc[leveloffset=+1]

include::modules/ossm-routing-ingress.adoc[leveloffset=+1]
include::modules/ossm-routing-gateways.adoc[leveloffset=+1]

include::modules/ossm-routing-bookinfo-example.adoc[leveloffset=+1]

include::modules/ossm-routing-ingress.adoc[leveloffset=+1]

include::modules/ossm-auto-route-1x.adoc[leveloffset=+1]

== Links

For more information about configuring an {product-title} wildcard policy, see xref:../../networking/ingress-operator.adoc#using-wildcard-routes_configuring-ingress[Using wildcard routes].
5 changes: 5 additions & 0 deletions service_mesh/v1x/ossm-vs-community.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ The current release of {ProductName} differs from the current upstream Istio com
include::modules/ossm-multitenant.adoc[leveloffset=+1]

include::modules/ossm-vs-istio-1x.adoc[leveloffset=+1]
[discrete]
[id="additional-resources_ossm-vs-istio-v1x"]
==== Additional resources

* xref:../../service_mesh/v1x/ossm-traffic-manage.adoc#ossm-auto-route-1x_routing-traffic-v1x[Automatic route creation]

include::modules/ossm-kiali-service-mesh.adoc[leveloffset=+1]

Expand Down
4 changes: 2 additions & 2 deletions service_mesh/v1x/prepare-to-deploy-applications-ossm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ When you deploy an application into the {ProductShortName}, there are several di

include::modules/ossm-control-plane-templates-1x.adoc[leveloffset=+1]

include::modules/ossm-sidecar-injection.adoc[leveloffset=+1]
include::modules/ossm-automatic-sidecar-injection.adoc[leveloffset=+1]

include::modules/ossm-automatic-sidecar-injection.adoc[leveloffset=+2]
include::modules/ossm-sidecar-injection-env-var.adoc[leveloffset=+1]

include::modules/ossm-mixer-policy-1x.adoc[leveloffset=+1]

Expand Down
3 changes: 2 additions & 1 deletion service_mesh/v1x/preparing-ossm-installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
= Preparing to install {ProductName}
include::modules/ossm-document-attributes-1x.adoc[]
:context: preparing-ossm-installation-v1x

toc::[]

Before you can install {ProductName}, review the installation activities, ensure that you meet the prerequisites:
Expand Down Expand Up @@ -30,7 +31,7 @@ include::modules/ossm-installation-activities.adoc[leveloffset=+1]

[WARNING]
====
Please see xref:../../logging/config/cluster-logging-log-store.adoc[Configuring the log store] for details on configuring the default Jaeger parameters for Elasticsearch in a production environment.
See xref:../../logging/config/cluster-logging-log-store.adoc[Configuring the log store] for details on configuring the default Jaeger parameters for Elasticsearch in a production environment.
====

== Next steps
Expand Down
9 changes: 5 additions & 4 deletions service_mesh/v1x/removing-ossm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
= Removing {ProductName}
include::modules/ossm-document-attributes-1x.adoc[]
:context: removing-ossm-v1x
toc::[]

This process allows you to remove {ProductName} from an existing {product-title} instance. Remove the control plane before removing the operators.
toc::[]

include::modules/ossm-member-roll-delete.adoc[leveloffset=+1]
To remove {ProductName} from an existing {product-title} instance, remove the control plane before removing the operators.

include::modules/ossm-control-plane-remove.adoc[leveloffset=+1]

include::modules/ossm-operatorhub-remove.adoc[leveloffset=+1]
include::modules/ossm-remove-operators.adoc[leveloffset=+1]

include::modules/ossm-remove-cleanup-1x.adoc[leveloffset=+2]
8 changes: 8 additions & 0 deletions service_mesh/v1x/threescale-adapter.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
= Using the 3scale Istio adapter
include::modules/ossm-document-attributes-1x.adoc[]
:context: threescale-adapter-v1x

toc::[]

The 3scale Istio Adapter is an optional adapter that allows you to label a service running within the {ProductName} and integrate that service with the 3scale API Management solution.
Expand All @@ -25,3 +26,10 @@ include::modules/ossm-threescale-caching.adoc[leveloffset=+1]
include::modules/ossm-threescale-authentication.adoc[leveloffset=+1]

include::modules/ossm-threescale-metrics-1x.adoc[leveloffset=+1]

include::modules/ossm-threescale-istio-adapter-verification.adoc[leveloffset=+1]

.Additional resources
* link:https://docs.openshift.com/container-platform/4.7/support/troubleshooting/investigating-pod-issues.html#inspecting-pod-and-container-logs_investigating-pod-issues[Inspecting pod and container logs].

include::modules/ossm-threescale-istio-adapter-troubleshooting-checklist.adoc[leveloffset=+1]
Loading