openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

OBSDOCS-1253: Clarify OTEL and Tempo namespaces

Browse Source 
Signed-off-by: Pavol Loffay <p.loffay@gmail.com>
This commit is contained in:
Pavol Loffay
2024-09-11 14:37:20 +02:00
committed by Max Leonov
parent 30fd80659f
commit bcbfb7f5a6
7 changed files with 41 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
modules/distr-tracing-tempo-install-tempomonolithic-cli.adoc
View File

@@ -6,10 +6,10 @@
[id="distr-tracing-tempo-install-tempomonolithic-cli_{context}"]
= Installing a TempoMonolithic instance by using the CLI
:FeatureName: The TempoMonolithic instance
:FeatureName: The `TempoMonolithic` instance
include::snippets/technology-preview.adoc[]
You can install a TempoMonolithic instance from the command line.
You can install a `TempoMonolithic` instance from the command line.
.Prerequisites
@@ -31,7 +31,7 @@ $ oc login --username=<your_username>
.Procedure
. Run the following command to create a permitted project of your choice for the TempoMonolithic instance that you will create in a subsequent step:
. Run the following command to create a permitted project of your choice for the `TempoMonolithic` instance that you will create in a subsequent step:
+
[source,terminal]
----
@@ -50,7 +50,7 @@ EOF
====
Object storage is not included with the {TempoShortName} and requires setting up an object store by a supported provider: link:https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation[{odf-full}], link:https://min.io/[MinIO], link:https://aws.amazon.com/s3/[Amazon S3], link:https://azure.microsoft.com/en-us/products/storage/blobs/[Azure Blob Storage], or link:https://cloud.google.com/storage/[Google Cloud Storage].
Additionally, opting for object storage requires creating a secret for your object storage bucket in the project that you created for the TempoMonolithic instance. You can do this by running the following command:
Additionally, opting for object storage requires creating a secret for your object storage bucket in the project that you created for the `TempoMonolithic` instance. You can do this by running the following command:
[source,terminal]
----
@@ -67,11 +67,11 @@ include::snippets/distr-tracing-tempo-secret-example.adoc[]
====
. Create a TempoMonolithic instance in the project that you created for it.
. Create a `TempoMonolithic` instance in the project that you created for it.
+
[TIP]
====
You can create multiple TempoMonolithic instances in separate projects on the same cluster.
You can create multiple `TempoMonolithic` instances in separate projects on the same cluster.
====
.. Customize the `TempoMonolithic` custom resource (CR).
@@ -91,14 +91,14 @@ EOF
.Verification
. Verify that the `status` of all TempoMonolithic `components` is `Running` and the `conditions` are `type: Ready` by running the following command:
. Verify that the `status` of all `TempoMonolithic` `components` is `Running` and the `conditions` are `type: Ready` by running the following command:
+
[source,terminal]
----
$ oc get tempomonolithic.tempo.grafana.com <metadata_name_of_tempomonolithic_cr> -o yaml
----
. Run the following command to verify that the pod of the TempoMonolithic instance is running:
. Run the following command to verify that the pod of the `TempoMonolithic` instance is running:
+
[source,terminal]
----
@@ -116,6 +116,6 @@ $ oc get route
.. Open `\https://<route_from_previous_step>` in a web browser.
. When the pod of the TempoMonolithic instance is ready, you can send traces to the `tempo-<metadata_name_of_tempomonolithic_cr>:4317` (OTLP/gRPC) and `tempo-<metadata_name_of_tempomonolithic_cr>:4318` (OTLP/HTTP) endpoints inside the cluster.
. When the pod of the `TempoMonolithic` instance is ready, you can send traces to the `tempo-<metadata_name_of_tempomonolithic_cr>:4317` (OTLP/gRPC) and `tempo-<metadata_name_of_tempomonolithic_cr>:4318` (OTLP/HTTP) endpoints inside the cluster.
+
The Tempo API is available at the `tempo-<metadata_name_of_tempomonolithic_cr>:3200` endpoint inside the cluster.

20
modules/distr-tracing-tempo-install-tempomonolithic-web-console.adoc
View File

@@ -6,10 +6,10 @@
[id="distr-tracing-tempo-install-tempomonolithic-web-console_{context}"]
= Installing a TempoMonolithic instance by using the web console
:FeatureName: The TempoMonolithic instance
:FeatureName: The `TempoMonolithic` instance
include::snippets/technology-preview.adoc[]
You can install a TempoMonolithic instance from the *Administrator* view of the web console.
You can install a `TempoMonolithic` instance from the *Administrator* view of the web console.
.Prerequisites
@@ -21,7 +21,7 @@ You can install a TempoMonolithic instance from the *Administrator* view of the
.Procedure
. Go to *Home* -> *Projects* -> *Create Project* to create a permitted project of your choice for the *TempoMonolithic* instance that you will create in a subsequent step. Project names beginning with the `openshift-` prefix are not permitted.
. Go to *Home* -> *Projects* -> *Create Project* to create a permitted project of your choice for the `TempoMonolithic` instance that you will create in a subsequent step. Project names beginning with the `openshift-` prefix are not permitted.
. Decide which type of supported storage to use for storing traces: in-memory storage, a persistent volume, or object storage.
+
@@ -29,7 +29,7 @@ You can install a TempoMonolithic instance from the *Administrator* view of the
====
Object storage is not included with the {TempoShortName} and requires setting up an object store by a supported provider: link:https://www.redhat.com/en/technologies/cloud-computing/openshift-data-foundation[{odf-full}], link:https://min.io/[MinIO], link:https://aws.amazon.com/s3/[Amazon S3], link:https://azure.microsoft.com/en-us/products/storage/blobs/[Azure Blob Storage], or link:https://cloud.google.com/storage/[Google Cloud Storage].
Additionally, opting for object storage requires creating a secret for your object storage bucket in the project that you created for the *TempoMonolithic* instance. You can do this in *Workloads* -> *Secrets* -> *Create* -> *From YAML*.
Additionally, opting for object storage requires creating a secret for your object storage bucket in the project that you created for the `TempoMonolithic` instance. You can do this in *Workloads* -> *Secrets* -> *Create* -> *From YAML*.
For more information, see "Object storage setup".
@@ -38,11 +38,11 @@ include::snippets/distr-tracing-tempo-secret-example.adoc[]
--
====
. Create a *TempoMonolithic* instance:
. Create a `TempoMonolithic` instance:
+
[NOTE]
====
You can create multiple *TempoMonolithic* instances in separate projects on the same cluster.
You can create multiple `TempoMonolithic` instances in separate projects on the same cluster.
====
.. Go to *Operators* -> *Installed Operators*.
@@ -59,11 +59,11 @@ include::snippets/distr-tracing-tempo-tempomonolithic-custom-resource.adoc[]
.Verification
. Use the *Project:* dropdown list to select the project of the *TempoMonolithic* instance.
. Use the *Project:* dropdown list to select the project of the `TempoMonolithic` instance.
. Go to *Operators* -> *Installed Operators* to verify that the *Status* of the *TempoMonolithic* instance is *Condition: Ready*.
. Go to *Operators* -> *Installed Operators* to verify that the *Status* of the `TempoMonolithic` instance is *Condition: Ready*.
. Go to *Workloads* -> *Pods* to verify that the pod of the *TempoMonolithic* instance is running.
. Go to *Workloads* -> *Pods* to verify that the pod of the `TempoMonolithic` instance is running.
. Access the Jaeger UI:
@@ -76,6 +76,6 @@ The Jaeger UI uses the `tempo-<metadata_name_of_TempoMonolithic_CR>-jaegerui` ro
.. In the *Location* column, open the URL to access the Jaeger UI.
. When the pod of the *TempoMonolithic* instance is ready, you can send traces to the `tempo-<metadata_name_of_TempoMonolithic_CR>:4317` (OTLP/gRPC) and `tempo-<metadata_name_of_TempoMonolithic_CR>:4318` (OTLP/HTTP) endpoints inside the cluster.
. When the pod of the `TempoMonolithic` instance is ready, you can send traces to the `tempo-<metadata_name_of_TempoMonolithic_CR>:4317` (OTLP/gRPC) and `tempo-<metadata_name_of_TempoMonolithic_CR>:4318` (OTLP/HTTP) endpoints inside the cluster.
+
The Tempo API is available at the `tempo-<metadata_name_of_TempoMonolithic_CR>:3200` endpoint inside the cluster.

14
modules/distr-tracing-tempo-install-tempostack-cli.adoc
View File

@@ -6,7 +6,7 @@
[id="distr-tracing-tempo-install-tempostack-cli_{context}"]
= Installing a TempoStack instance by using the CLI
You can install a TempoStack instance from the command line.
You can install a `TempoStack` instance from the command line.
.Prerequisites
@@ -35,7 +35,7 @@ Object storage is required and not included with the {TempoShortName}. You must
.Procedure
. Run the following command to create a permitted project of your choice for the TempoStack instance that you will create in a subsequent step:
. Run the following command to create a permitted project of your choice for the `TempoStack` instance that you will create in a subsequent step:
+
[source,terminal]
----
@@ -48,7 +48,7 @@ EOF
----
<1> Project names beginning with the `openshift-` prefix are not permitted.
. In the project that you created for the TempoStack instance, create a secret for your object storage bucket by running the following command:
. In the project that you created for the `TempoStack` instance, create a secret for your object storage bucket by running the following command:
+
[source,terminal]
----
@@ -63,11 +63,11 @@ For more information, see "Object storage setup".
include::snippets/distr-tracing-tempo-secret-example.adoc[]
--
. Create a TempoStack instance in the project that you created for it:
. Create a `TempoStack` instance in the project that you created for it:
+
[NOTE]
====
You can create multiple TempoStack instances in separate projects on the same cluster.
You can create multiple `TempoStack` instances in separate projects on the same cluster.
====
.. Customize the `TempoStack` custom resource (CR):
@@ -87,14 +87,14 @@ EOF
.Verification
. Verify that the `status` of all TempoStack `components` is `Running` and the `conditions` are `type: Ready` by running the following command:
. Verify that the `status` of all `TempoStack` `components` is `Running` and the `conditions` are `type: Ready` by running the following command:
+
[source,terminal]
----
$ oc get tempostacks.tempo.grafana.com simplest -o yaml
----
. Verify that all the TempoStack component pods are running by running the following command:
. Verify that all the `TempoStack` component pods are running by running the following command:
+
[source,terminal]
----

16
modules/distr-tracing-tempo-install-tempostack-web-console.adoc
View File

@@ -6,7 +6,7 @@
[id="distr-tracing-tempo-install-tempostack-web-console_{context}"]
= Installing a TempoStack instance by using the web console
You can install a TempoStack instance from the *Administrator* view of the web console.
You can install a `TempoStack` instance from the *Administrator* view of the web console.
.Prerequisites
@@ -25,19 +25,19 @@ Object storage is required and not included with the {TempoShortName}. You must
.Procedure
. Go to *Home* -> *Projects* -> *Create Project* to create a permitted project of your choice for the TempoStack instance that you will create in a subsequent step. Project names beginning with the `openshift-` prefix are not permitted.
. Go to *Home* -> *Projects* -> *Create Project* to create a permitted project of your choice for the `TempoStack` instance that you will create in a subsequent step. Project names beginning with the `openshift-` prefix are not permitted.
. Go to *Workloads* -> *Secrets* -> *Create* -> *From YAML* to create a secret for your object storage bucket in the project that you created for the TempoStack instance. For more information, see "Object storage setup".
. Go to *Workloads* -> *Secrets* -> *Create* -> *From YAML* to create a secret for your object storage bucket in the project that you created for the `TempoStack` instance. For more information, see "Object storage setup".
+
--
include::snippets/distr-tracing-tempo-secret-example.adoc[]
--
. Create a TempoStack instance.
. Create a `TempoStack` instance.
+
[NOTE]
====
You can create multiple TempoStack instances in separate projects on the same cluster.
You can create multiple `TempoStack` instances in separate projects on the same cluster.
====
.. Go to *Operators* -> *Installed Operators*.
@@ -55,11 +55,11 @@ include::snippets/distr-tracing-tempo-tempostack-custom-resource.adoc[]
.Verification
. Use the *Project:* dropdown list to select the project of the *TempoStack* instance.
. Use the *Project:* dropdown list to select the project of the `TempoStack` instance.
. Go to *Operators* -> *Installed Operators* to verify that the *Status* of the *TempoStack* instance is *Condition: Ready*.
. Go to *Operators* -> *Installed Operators* to verify that the *Status* of the `TempoStack` instance is *Condition: Ready*.
. Go to *Workloads* -> *Pods* to verify that all the component pods of the *TempoStack* instance are running.
. Go to *Workloads* -> *Pods* to verify that all the component pods of the `TempoStack` instance are running.
. Access the Tempo console:

8
observability/distr_tracing/distr-tracing-tempo-installing.adoc
View File

@@ -111,7 +111,7 @@ include::modules/distr-tracing-tempo-install-gateway-write-permissions.adoc[leve
[id="installing-a-tempostack-instance_{context}"]
== Installing a TempoStack instance
You can install a TempoStack instance by using the web console or command line.
You can install a `TempoStack` instance by using the web console or command line.
include::modules/distr-tracing-tempo-install-tempostack-web-console.adoc[leveloffset=+2]
@@ -120,15 +120,15 @@ include::modules/distr-tracing-tempo-install-tempostack-cli.adoc[leveloffset=+2]
[id="installing-a-tempomonolithic-instance_{context}"]
== Installing a TempoMonolithic instance
:FeatureName: The TempoMonolithic instance
:FeatureName: The `TempoMonolithic` instance
include::snippets/technology-preview.adoc[]
You can install a TempoMonolithic instance by using the web console or command line.
You can install a `TempoMonolithic` instance by using the web console or command line.
The `TempoMonolithic` custom resource (CR) creates a Tempo deployment in monolithic mode.
All components of the Tempo deployment, such as the compactor, distributor, ingester, querier, and query frontend, are contained in a single container.
A TempoMonolithic instance supports storing traces in in-memory storage, a persistent volume, or object storage.
A `TempoMonolithic` instance supports storing traces in in-memory storage, a persistent volume, or object storage.
Tempo deployment in monolithic mode is preferred for a small deployment, demonstration, testing, and as a migration path of the {JaegerName} all-in-one deployment.

4
snippets/distr-tracing-tempo-tempomonolithic-custom-resource.adoc
View File

@@ -46,7 +46,7 @@ spec: # <3>
<5> Type of storage for storing traces: in-memory storage, a persistent volume, or object storage. The value for a persistent volume is `pv`. The accepted values for object storage are `s3`, `gcs`, or `azure`, depending on the used object store type. The default value is `memory` for the `tmpfs` in-memory storage, which is only appropriate for development, testing, demonstrations, and proof-of-concept environments because the data does not persist when the pod is shut down.
<6> Memory size: For in-memory storage, this means the size of the `tmpfs` volume, where the default is `2Gi`. For a persistent volume, this means the size of the persistent volume claim, where the default is `10Gi`. For object storage, this means the size of the persistent volume claim for the Tempo Write-Ahead Logging (WAL), where the default is `10Gi`.
<7> Optional: For object storage, the type of object storage. The accepted values are `s3`, `gcs`, and `azure`, depending on the used object store type.
<8> Optional: For object storage, the value of the `name` in the `metadata` of the storage secret. The storage secret must be in the same namespace as the TempoMonolithic instance and contain the fields specified in "Table 1. Required secret parameters" in the section "Object storage setup".
<8> Optional: For object storage, the value of the `name` in the `metadata` of the storage secret. The storage secret must be in the same namespace as the `TempoMonolithic` instance and contain the fields specified in "Table 1. Required secret parameters" in the section "Object storage setup".
<9> Optional.
<10> Optional: Name of a `ConfigMap` object that contains a CA certificate.
<11> Exposes the Jaeger UI, which visualizes the data, via a route at `+http://<gateway_ingress>/api/traces/v1/<tenant_name>/search+`.
@@ -54,4 +54,4 @@ spec: # <3>
<13> Optional.
<14> Lists the tenants.
<15> The tenant name, which is used as the value for the `X-Scope-OrgId` HTTP header.
<16> The unique identifier of the tenant. Must be unique throughout the lifecycle of the TempoMonolithic deployment. This ID will be added as a prefix to the objects in the object storage. You can reuse the value of the UUID or `tempoName` field.
<16> The unique identifier of the tenant. Must be unique throughout the lifecycle of the `TempoMonolithic` deployment. This ID will be added as a prefix to the objects in the object storage. You can reuse the value of the UUID or `tempoName` field.

2
snippets/distr-tracing-tempo-tempostack-custom-resource.adoc
View File

@@ -49,6 +49,6 @@ spec: # <3>
<10> The value must be `openshift`.
<11> The list of tenants.
<12> The tenant name, which is used as the value for the `X-Scope-OrgId` HTTP header.
<13> The unique identifier of the tenant. Must be unique throughout the lifecycle of the TempoStack deployment. The {TempoShortName} uses this ID to prefix objects in the object storage. You can reuse the value of the UUID or `tempoName` field.
<13> The unique identifier of the tenant. Must be unique throughout the lifecycle of the `TempoStack` deployment. The {TempoShortName} uses this ID to prefix objects in the object storage. You can reuse the value of the UUID or `tempoName` field.
<14> Enables a gateway that performs authentication and authorization.
<15> Exposes the Jaeger UI, which visualizes the data, via a route at `+http://<gateway_ingress>/api/traces/v1/<tenant_name>/search+`.