Skip to content

Commit bb37be3

Browse files
authored
Merge pull request #27568 from JStickler/OSSMDOC-175
OSSMDOC-175 Correct Jaeger/ES installation/config.
2 parents ca4dac6 + d3ae395 commit bb37be3

File tree

2 files changed

+31
-15
lines changed

2 files changed

+31
-15
lines changed

modules/jaeger-install-elasticsearch.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[id="jaeger-operator-install-elasticsearch_{context}"]
88
= Installing the Elasticsearch Operator
99

10-
The default Jaeger deployment uses in-memory storage because it is designed to be installed quickly for those evaluating Jaeger, giving demonstrations, or using Jaeger in a test environment. If you plan to use Jaeger in production, you must install a persistent storage option, in this case, Elasticsearch.
10+
The default Jaeger deployment uses in-memory storage because it is designed to be installed quickly for those evaluating Jaeger, giving demonstrations, or using Jaeger in a test environment. If you plan to use Jaeger in production, you must install and configure a persistent storage option, in this case, Elasticsearch.
1111

1212
.Prerequisites
1313
* Access to the {product-title} web console.
@@ -35,11 +35,13 @@ If you have already installed the Elasticsearch Operator as part of OpenShift cl
3535

3636
. Click *Install*.
3737

38-
. On the *Install Operator* page, select the *A specific namespace on the cluster* option and then select *openshift-operators-redhat* from the menu.
38+
. On the *Install Operator* page, under *Installation Mode* select *All namespaces on the cluster (default)*. This makes the Operator available to all projects in the cluster.
39+
40+
. Under *Installed Namespaces* select *openshift-operators-redhat* from the menu.
3941
+
4042
[NOTE]
4143
====
42-
The Elasticsearch installation guide says you must specify the *openshift-operators-redhat* namespace for the Elasticsearch operator for {ProductName}.
44+
The Elasticsearch installation requires the *openshift-operators-redhat* namespace for the Elasticsearch operator. The other {ProductName} operators are installed in the `openshift-operators` namespace.
4345
====
4446
+
4547
. Select the *Update Channel* that matches your {product-title} installation. For example, if you are installing on {product-title} version 4.6, select the 4.6 update channel.

service_mesh/v2x/upgrading-ossm.adoc

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To upgrade {ProductName}, you must create an instance of {ProductName} `ServiceM
1818

1919
.Procedure
2020

21-
. Check your v1 `ServiceMeshControlPlane` resource configuration to make sure it is valid.
21+
. Check your v1 `ServiceMeshControlPlane` resource configuration to make sure it is valid.
2222
+
2323
.. Run the following command to view your `ServiceMeshControlPlane` resource as a v2 resource.
2424
+
@@ -108,7 +108,7 @@ The `ServiceMeshControlPlane` resource has been changed for {ProductName} versio
108108
[id="ossm-upgrading-differences-arch_{context}"]
109109
=== Architecture changes
110110

111-
The architectural units used by previous versions have been replaced by Istiod. In 2.0 the control plane components Mixer, Pilot, Citadel, Galley and the sidecar injector functionality have been combined into a single component, Istiod.
111+
The architectural units used by previous versions have been replaced by Istiod. In 2.0 the control plane components Mixer, Pilot, Citadel, Galley, and the sidecar injector functionality have been combined into a single component, Istiod.
112112

113113
Although Mixer is no longer supported as a control plane component, Mixer policy and telemetry plugins are now supported through WASM extensions in Istiod. Mixer can be enabled for policy and telemetry if you need to integrate legacy Mixer plugins.
114114

@@ -367,7 +367,7 @@ Istiod manages client certificates and private keys used by service proxies. By
367367
[id="ossm-upgrading-config-tracing_{context}"]
368368
=== Tracing
369369

370-
Tracing is configured under `spec.tracing`. Currently, the only type of tracer that is supported is `Jaeger`. Sampling is a scaled integer representing 0.01% increments, e.g. 1 is 0.01% and 10000 is 100%. The tracing implementation and sampling rate can be specified:
370+
_Tracing_ is configured under `spec.tracing`. Currently, the only type of tracer that is supported is `Jaeger`. Sampling is a scaled integer representing 0.01% increments, for example, 1 is 0.01% and 10000 is 100%. The tracing implementation and sampling rate can be specified:
371371

372372
[source,yaml]
373373
----
@@ -377,7 +377,7 @@ spec:
377377
type: Jaeger
378378
----
379379

380-
Jaeger is configured under the addons section of the SMCP spec.
380+
_Jaeger_ is configured under the addons section of the SMCP spec.
381381

382382
[source,yaml]
383383
----
@@ -386,16 +386,30 @@ spec:
386386
jaeger:
387387
name: jaeger
388388
install:
389-
storage: Memory # or Elasticsearch
390-
memory: {} # details specific to memory storage
391-
elasticsearch: {} # details specific to elasticsearch storage
389+
storage:
390+
type: Memory # or Elasticsearch for production mode
391+
memory:
392+
maxTraces: 100000
393+
elasticsearch: # the following values only apply if storage:type:=Elasticsearch
394+
storage: # specific storageclass configuration for the Jaeger Elasticsearch (optional)
395+
size: "100G"
396+
storageClassName: "storageclass"
397+
nodeCount: 3
398+
redundancyPolicy: SingleRedundancy
392399
runtime:
393400
components:
394-
tracing.jaeger: {} # general jaeger specific runtime configuration
395-
tracing.jaeger.elasticsearch: {} # runtime configuration for jaeger elasticsearch deployment
396-
----
397-
398-
The Jaeger installation can be customized with the `install` field. Container configuration, such as resource limits is configured in `spec.runtime.components.jaeger` related fields. If a Jaeger resource matching the value of name exists, the control plane will be configured to use the existing installation. Use an existing Jaeger resource to fully customize your Jaeger installation.
401+
tracing.jaeger: {} # general Jaeger specific runtime configuration (optional)
402+
tracing.jaeger.elasticsearch: #runtime configuration for Jaeger Elasticsearch deployment (optional)
403+
container:
404+
resources:
405+
requests:
406+
memory: "1Gi"
407+
cpu: "500m"
408+
limits:
409+
memory: "1Gi"
410+
----
411+
412+
The Jaeger installation can be customized with the `install` field. Container configuration, such as resource limits is configured in `spec.runtime.components.jaeger` related fields. If a Jaeger resource matching the value of `spec.addons.jaeger.name` exists, the control plane will be configured to use the existing installation. Use an existing Jaeger resource to fully customize your Jaeger installation.
399413

400414
[id="ossm-upgrading-config-vis_{context}"]
401415
=== Visualization

0 commit comments

Comments
 (0)