Skip to content

Commit 237042b

Browse files
adellapeadellape
authored
Merge pull request #75458 from gwynnemonahan/OSSM-6304
OSSM-6304 [DOC] Reorg and Deprecation Notice for Jaeger and Elasticsearch
2 parents 3524312 + b1506a4 commit 237042b

8 files changed

+81
-34
lines changed

‎modules/ossm-accessing-jaeger.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ Kiali Console > Distributed Tracing tab
1313

1414
The deployment process creates a route to access the Jaeger console.
1515

16+
[IMPORTANT]
17+
====
18+
Starting with {SMProductName} 2.5, {JaegerName} and {es-op} have been deprecated and will be removed in a future release. Red{nbsp}Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to {JaegerName}, you can use {TempoName} instead.
19+
====
20+
1621
.Procedure
1722
. Log in to the {Product-title} console.
1823

‎modules/ossm-config-external-jaeger.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ This module is included in the following assemblies:
99

1010
If you already have an existing {JaegerName} instance in {product-title}, you can configure your `ServiceMeshControlPlane` resource to use that instance for {DTShortName}.
1111

12+
[IMPORTANT]
13+
====
14+
Starting with {SMProductName} 2.5, {JaegerName} and {es-op} are deprecated and will be removed in a future release. Red{nbsp}Hat will provide bug fixes and support for these features during the current release lifecycle, but these features will no longer receive enhancements and will be removed. As an alternative to {JaegerName}, you can use {TempoName} instead.
15+
====
16+
1217
.Prerequisites
1318

1419
* {DTProductName} instance installed and configured.

‎modules/ossm-install-ossm-operator.adoc

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,26 @@
77
[id="ossm-install-ossm-operator_{context}"]
88
= Installing the Operators
99

10-
To install {SMProductName}, install the following Operators in this order. Repeat the procedure for each Operator.
10+
To install {SMProductName}, you must install the {SMProductName} Operator. Repeat the procedure for each additional Operator you want to install.
11+
12+
Additional Operators include:
13+
14+
* {KialiProduct}
15+
* {TempoOperator}
16+
17+
Deprecated additional Operators include:
18+
19+
[IMPORTANT]
20+
====
21+
Starting with {SMProductName} 2.5, {JaegerName} and {es-op} are deprecated and will be removed in a future release. Red{nbsp}Hat will provide bug fixes and support for these features during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to {JaegerName}, you can use {TempoName} instead.
22+
====
1123

12-
* OpenShift Elasticsearch
1324
* {JaegerName}
14-
* Kiali Operator provided by Red Hat
15-
* {SMProductName}
25+
* {es-op}
1626
1727
[NOTE]
1828
====
19-
If you have already installed the OpenShift Elasticsearch Operator as part of OpenShift Logging, you do not need to install the OpenShift Elasticsearch Operator again. The {JaegerName} Operator will create the Elasticsearch instance using the installed OpenShift Elasticsearch Operator.
29+
If you have already installed the {es-op} as part of OpenShift {logging-uc}, you do not need to install the {es-op} again. The {JaegerName} Operator creates the Elasticsearch instance using the installed {es-op}.
2030
====
2131

2232
.Procedure
@@ -36,12 +46,24 @@ endif::openshift-rosa,openshift-dedicated[]
3646

3747
. On the *Install Operator* page for each Operator, accept the default settings.
3848

39-
. Click *Install*. Wait until the Operator has installed before repeating the steps for the next Operator in the list.
49+
. Click *Install*. Wait until the Operator installs before repeating the steps for the next Operator you want to install.
50+
+
51+
* The {SMProductName} Operator installs in the `openshift-operators` namespace and is available for all namespaces in the cluster.
52+
* The {KialiProduct} installs in the `openshift-operators` namespace and is available for all namespaces in the cluster.
53+
* The {TempoOperator} installs in the `openshift-tempo-operator` namespace and is available for all namespaces in the cluster.
54+
* The {JaegerName} installs in the `openshift-distributed-tracing` namespace and is available for all namespaces in the cluster.
4055
+
41-
* The OpenShift Elasticsearch Operator is installed in the `openshift-operators-redhat` namespace and is available for all namespaces in the cluster.
42-
* The {JaegerName} is installed in the `openshift-distributed-tracing` namespace and is available for all namespaces in the cluster.
43-
* The Kiali Operator provided by Red Hat is installed in the `openshift-operators` namespace and is available for all namespaces in the cluster.
44-
* The {SMProductName} Operator is installed in the `openshift-operators` namespace and is available for all namespaces in the cluster.
56+
[IMPORTANT]
57+
====
58+
Starting with {SMProductName} 2.5, {JaegerName} is deprecated and will be removed in a future release. Red{nbsp}Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to {JaegerName}, you can use {TempoName} instead.
59+
====
60+
+
61+
* The {es-op} installs in the `openshift-operators-redhat` namespace and is available for all namespaces in the cluster.
62+
+
63+
[IMPORTANT]
64+
====
65+
Starting with {SMProductName} 2.5, {es-op} is deprecated and will be removed in a future release. Red{nbsp}Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed.
66+
====
4567
4668
.Verification
4769

‎modules/ossm-installation-activities.adoc

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,33 @@
22
//
33
// * service_mesh/v1x/preparing-ossm-installation.adoc
44
// * service_mesh/v2x/preparing-ossm-installation.adoc
5-
// * post_installation_configuration/network-configuration.adoc
65

76
:_mod-docs-content-type: CONCEPT
87
[id="ossm-installation-activities_{context}"]
9-
= Operator overview
8+
= Service Mesh Operators overview
109

11-
{SMProductName} requires the following Operators:
10+
{SMProductName} requires the use of the {SMProductName} Operator which allows you to connect, secure, control, and observe the microservices that comprise your applications. You can also install other Operators to enhance your service mesh experience.
1211

13-
* *OpenShift Elasticsearch* - (Optional) Provides database storage for tracing and logging with the {JaegerShortName}. It is based on the open source link:https://www.elastic.co/[Elasticsearch] project.
14-
* *{JaegerName}* - Provides distributed tracing to monitor and troubleshoot transactions in complex distributed systems. It is based on the open source link:https://www.jaegertracing.io/[Jaeger] project.
15-
* *Kiali Operator (provided by Red Hat)* - Provides observability for your service mesh. You can view configurations, monitor traffic, and analyze traces in a single console. It is based on the open source link:https://www.kiali.io/[Kiali] project.
16-
* *{SMProductName}* - Allows you to connect, secure, control, and observe the microservices that comprise your applications. The {SMProductShortName} Operator defines and monitors the `ServiceMeshControlPlane` resources that manage the deployment, updating, and deletion of the {SMProductShortName} components. It is based on the open source link:https://istio.io/[Istio] project.
12+
[WARNING]
13+
====
14+
Do not install Community versions of the Operators. Community Operators are not supported.
15+
====
16+
17+
The following Operator is required:
18+
19+
{SMProductName} Operator:: Allows you to connect, secure, control, and observe the microservices that comprise your applications. It also defines and monitors the `ServiceMeshControlPlane` resources that manage the deployment, updating, and deletion of the {SMProductShortName} components. It is based on the open source link:https://istio.io/[Istio] project.
20+
21+
The following Operators are optional:
22+
23+
{KialiProduct}:: Provides observability for your service mesh. You can view configurations, monitor traffic, and analyze traces in a single console. It is based on the open source link:https://www.kiali.io/[Kiali] project.
24+
{TempoName}:: Provides distributed tracing to monitor and troubleshoot transactions in complex distributed systems. It is based on the open source link:https://grafana.com/oss/tempo/[Grafana Tempo] project.
25+
26+
The following optional Operators are deprecated:
27+
28+
[IMPORTANT]
29+
====
30+
Starting with {SMProductName} 2.5, {JaegerName} and {es-op} are deprecated and will be removed in a future release. Red{nbsp}Hat will provide bug fixes and support for these features during the current release lifecycle, but these features will no longer receive enhancements and will be removed. As an alternative to {JaegerName}, you can use {TempoName} instead.
31+
====
32+
33+
{JaegerName}:: Provides distributed tracing to monitor and troubleshoot transactions in complex distributed systems. It is based on the open source link:https://www.jaegertracing.io/[Jaeger] project.
34+
{es-op}:: Provides database storage for tracing and logging with the {JaegerShortName}. It is based on the open source link:https://www.elastic.co/[Elasticsearch] project.

‎modules/ossm-jaeger-accessing-console.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ The installation process creates a route to access the Jaeger console.
1414

1515
If you know the URL for the Jaeger console, you can access it directly. If you do not know the URL, use the following directions.
1616

17+
[IMPORTANT]
18+
====
19+
Starting with {SMProductName} 2.5, {JaegerName} and {es-op} have been deprecated and will be removed in a future release. Red{nbsp}Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to {JaegerName}, you can use {TempoName} instead.
20+
====
21+
1722
.Procedure from OpenShift console
1823
. Log in to the {product-title} web console as a user with cluster-admin rights. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role.
1924

‎post_installation_configuration/network-configuration.adoc

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,6 @@ include::modules/modifying-template-for-new-projects.adoc[leveloffset=+2]
9494
include::modules/nw-networkpolicy-project-defaults.adoc[leveloffset=+3]
9595
endif::[]
9696

97-
ifndef::openshift-origin[]
98-
include::modules/ossm-supported-configurations.adoc[leveloffset=+1]
99-
100-
include::modules/ossm-installation-activities.adoc[leveloffset=+2]
101-
102-
.Next steps
103-
104-
* xref:../service_mesh/v2x/installing-ossm.adoc#installing-ossm[Install {SMProductName}] in your {product-title} environment.
105-
endif::openshift-origin[]
106-
10797
[id="post-installationrouting-optimization"]
10898
== Optimizing routing
10999

‎service_mesh/v2x/installing-ossm.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
To install {SMProductName}, first install the required Operators on {product-title} and then create a `ServiceMeshControlPlane` resource to deploy the control plane.
9+
To install {SMProductName}, first install the {SMProductName} Operator and any optional Operators on {product-title}. Then create a `ServiceMeshControlPlane` resource to deploy the control plane.
1010

1111
[NOTE]
1212
====
@@ -24,13 +24,13 @@ endif::openshift-rosa[]
2424
2525
The following steps show how to install a basic instance of {SMProductName} on {product-title}.
2626

27-
include::modules/ossm-installation-activities.adoc[leveloffset=+1]
28-
29-
[WARNING]
27+
[IMPORTANT]
3028
====
31-
Do not install Community versions of the Operators. Community Operators are not supported.
29+
Starting with {SMProductName} 2.5, {JaegerName} and {es-op} are deprecated and will be removed in a future release. Red{nbsp}Hat will provide bug fixes and support for these features during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to {JaegerName}, you can use {TempoName} instead.
3230
====
3331

32+
include::modules/ossm-installation-activities.adoc[leveloffset=+1]
33+
3434
include::modules/ossm-install-ossm-operator.adoc[leveloffset=+1]
3535

3636
ifndef::openshift-rosa[]

‎service_mesh/v2x/ossm-reference-jaeger.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ When the {SMProductShortName} Operator deploys the `ServiceMeshControlPlane` res
1010

1111
[IMPORTANT]
1212
====
13-
Jaeger does not use FIPS validated cryptographic modules.
13+
* Jaeger does not use FIPS validated cryptographic modules.
14+
15+
* Starting with {SMProductName} 2.5, {JaegerName} is deprecated and will be removed in a future release. Red{nbsp}Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to {JaegerName}, you can use {TempoName} instead.
1416
====
1517

1618
include::modules/ossm-enabling-jaeger.adoc[leveloffset=+1]
@@ -39,7 +41,7 @@ include::modules/distr-tracing-config-jaeger-collector.adoc[leveloffset=+2]
3941

4042
include::modules/distr-tracing-config-sampling.adoc[leveloffset=+2]
4143

42-
include::modules/distr-tracing-config-storage.adoc[leveloffset=+2]
44+
include::modules/distr-tracing-config-storage.adoc[leveloffset=+2]
4345

4446
ifdef::openshift-enterprise[]
4547
For more information about configuring Elasticsearch with {product-title}, see xref:../../observability/logging/log_storage/logging-config-es-store.adoc#logging-config-es-store[Configuring the Elasticsearch log store] or xref:../../observability/distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc#distr-tracing-jaeger-configuring[Configuring and deploying distributed tracing].

0 commit comments

Comments
 (0)