Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[enterprise-4.7] OSSMDOC-175 Correct Jaeger/ES installation/config. #28392

Merged
merged 1 commit into from Jan 6, 2021
Merged

[enterprise-4.7] OSSMDOC-175 Correct Jaeger/ES installation/config. #28392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions modules/jaeger-install-elasticsearch.adoc
View file
Open in desktop
Expand Up @@ -7,7 +7,7 @@
[id="jaeger-operator-install-elasticsearch_{context}"]
= Installing the Elasticsearch Operator

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.
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.

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

. Click *Install*.

. On the *Install Operator* page, select the *A specific namespace on the cluster* option and then select *openshift-operators-redhat* from the menu.
. 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.

. Under *Installed Namespaces* select *openshift-operators-redhat* from the menu.
+
[NOTE]
====
The Elasticsearch installation guide says you must specify the *openshift-operators-redhat* namespace for the Elasticsearch operator for {ProductName}.
The Elasticsearch installation requires the *openshift-operators-redhat* namespace for the Elasticsearch operator. The other {ProductName} operators are installed in the `openshift-operators` namespace.
====
+
. 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.
Expand Down
38 changes: 26 additions & 12 deletions service_mesh/v2x/upgrading-ossm.adoc
View file
Open in desktop
Expand Up @@ -18,7 +18,7 @@ To upgrade {ProductName}, you must create an instance of {ProductName} `ServiceM

.Procedure

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

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.
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.

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.

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

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:
_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:

[source,yaml]
----
Expand All @@ -377,7 +377,7 @@ spec:
type: Jaeger
----

Jaeger is configured under the addons section of the SMCP spec.
_Jaeger_ is configured under the addons section of the SMCP spec.

[source,yaml]
----
Expand All @@ -386,16 +386,30 @@ spec:
jaeger:
name: jaeger
install:
storage: Memory # or Elasticsearch
memory: {} # details specific to memory storage
elasticsearch: {} # details specific to elasticsearch storage
storage:
type: Memory # or Elasticsearch for production mode
memory:
maxTraces: 100000
elasticsearch: # the following values only apply if storage:type:=Elasticsearch
storage: # specific storageclass configuration for the Jaeger Elasticsearch (optional)
size: "100G"
storageClassName: "storageclass"
nodeCount: 3
redundancyPolicy: SingleRedundancy
runtime:
components:
tracing.jaeger: {} # general jaeger specific runtime configuration
tracing.jaeger.elasticsearch: {} # runtime configuration for jaeger elasticsearch deployment
----

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.
tracing.jaeger: {} # general Jaeger specific runtime configuration (optional)
tracing.jaeger.elasticsearch: #runtime configuration for Jaeger Elasticsearch deployment (optional)
container:
resources:
requests:
memory: "1Gi"
cpu: "500m"
limits:
memory: "1Gi"
----

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.

[id="ossm-upgrading-config-vis_{context}"]
=== Visualization
Expand Down