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

OBSDOCS-1253: Clarify OTEL and Tempo namespaces

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 openshift-cherrypick-robot
parent e1a0e523e2
commit 119b14c77f
9 changed files with 33 additions and 28 deletions

View File

@@ -31,7 +31,7 @@ $ oc login --username=<your_username>
.Procedure
. Run the following command to create a 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]
----
@@ -39,9 +39,10 @@ $ oc apply -f - << EOF
apiVersion: project.openshift.io/v1
kind: Project
metadata:
name: <project_of_tempomonolithic_instance>
name: <permitted_project_of_tempomonolithic_instance> # <1>
EOF
----
<1> 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.
+

View File

@@ -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 project of your choice for the *TempoMonolithic* instance that you will create in a subsequent step.
. 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.
+

View File

@@ -35,7 +35,7 @@ Object storage is required and not included with the {TempoShortName}. You must
.Procedure
. Run the following command to create a 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]
----
@@ -43,9 +43,10 @@ $ oc apply -f - << EOF
apiVersion: project.openshift.io/v1
kind: Project
metadata:
name: <project_of_tempostack_instance>
name: <permitted_project_of_tempostack_instance> # <1>
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:
+

View File

@@ -25,7 +25,7 @@ Object storage is required and not included with the {TempoShortName}. You must
.Procedure
. Go to *Home* -> *Projects* -> *Create Project* to create a project of your choice for the TempoStack instance that you will create in a subsequent step.
. 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".
+

View File

@@ -84,16 +84,17 @@ EOF
$ oc get csv -n openshift-opentelemetry-operator
----
. Create a project of your choice for the OpenTelemetry Collector instance that you will create in a subsequent step:
. Create a permitted project of your choice for the OpenTelemetry Collector instance that you will create in a subsequent step:
** To create a project without metadata, run the following command:
** To create a permitted project without metadata, run the following command:
+
[source,terminal]
----
$ oc new-project <project_of_opentelemetry_collector_instance>
$ oc new-project <permitted_project_of_opentelemetry_collector_instance> # <1>
----
<1> Project names beginning with the `openshift-` prefix are not permitted.
** To create a project with metadata, run the following command:
** To create a permitted project with metadata, run the following command:
+
[source,terminal]
----
@@ -101,9 +102,10 @@ $ oc apply -f - << EOF
apiVersion: project.openshift.io/v1
kind: Project
metadata:
name: <project_of_opentelemetry_collector_instance>
name: <permitted_project_of_opentelemetry_collector_instance> # <1>
EOF
----
<1> Project names beginning with the `openshift-` prefix are not permitted.
. Create an OpenTelemetry Collector instance in the project that you created for it.
+

View File

@@ -28,13 +28,13 @@ This installs the Operator with the default presets:
* *Update channel* -> *stable*
* *Installation mode* -> *All namespaces on the cluster*
* *Installed Namespace* -> *openshift-operators*
* *Installed Namespace* -> *openshift-opentelemetry-operator*
* *Update approval* -> *Automatic*
====
.. In the *Details* tab of the installed Operator page, under *ClusterServiceVersion details*, verify that the installation *Status* is *Succeeded*.
. Create a project of your choice for the *OpenTelemetry Collector* instance that you will create in the next step by going to *Home* -> *Projects* -> *Create Project*.
. Create a permitted project of your choice for the *OpenTelemetry Collector* instance that you will create in the next step by going to *Home* -> *Projects* -> *Create Project*. Project names beginning with the `openshift-` prefix are not permitted.
. Create an *OpenTelemetry Collector* instance.

View File

@@ -10,7 +10,7 @@ apiVersion: tempo.grafana.com/v1alpha1
kind: TempoMonolithic # <1>
metadata:
name: <metadata_name>
namespace: <project_of_tempomonolithic_instance> # <2>
namespace: <permitted_project_of_tempomonolithic_instance> # <2>
spec: # <3>
storage: # <4>
traces:
@@ -39,8 +39,8 @@ spec: # <3>
- tenantName: prod
tenantId: "1610b0c3-c509-4592-a256-a1871353dbfb"
----
<1> This CR creates a TempoMonolithic deployment with trace ingestion in the OTLP protocol.
<2> The namespace that you have chosen for the TempoMonolithic deployment.
<1> This CR creates a `TempoMonolithic` deployment with trace ingestion in the OTLP protocol.
<2> The project that you have chosen for the `TempoMonolithic` deployment. Project names beginning with the `openshift-` prefix are not permitted.
<3> Red{nbsp}Hat supports only the custom resource options that are available in the {DTProductName} documentation.
<4> Specifies the storage for storing traces.
<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.
@@ -50,7 +50,7 @@ spec: # <3>
<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+`.
<12> Enables creation of a route for the Jaeger UI.
<12> Enables creation of the route for the Jaeger UI.
<13> Optional.
<14> Lists the tenants.
<15> The tenant name, which is used as the value for the `X-Scope-OrgId` HTTP header.

View File

@@ -11,8 +11,8 @@ apiVersion: tempo.grafana.com/v1alpha1
kind: TempoStack # <1>
metadata:
name: simplest
namespace: <project_of_tempostack_instance> # <2>
spec: <3>
namespace: <permitted_project_of_tempostack_instance> # <2>
spec: # <3>
storage: # <4>
secret: # <5>
name: <secret_name> # <6>
@@ -37,8 +37,8 @@ spec: <3>
jaegerQuery:
enabled: true # <15>
----
<1> This CR creates a TempoStack deployment, which is configured to receive Jaeger Thrift over the HTTP and OpenTelemetry Protocol (OTLP).
<2> The namespace that you have chosen for the TempoStack deployment.
<1> This CR creates a `TempoStack` deployment, which is configured to receive Jaeger Thrift over the HTTP and OpenTelemetry Protocol (OTLP).
<2> The project that you have chosen for the `TempoStack` deployment. Project names beginning with the `openshift-` prefix are not permitted.
<3> Red{nbsp}Hat supports only the custom resource options that are available in the {DTProductName} documentation.
<4> Specifies the storage for storing traces.
<5> The secret you created in step 2 for the object storage that had been set up as one of the prerequisites.

View File

@@ -12,11 +12,11 @@ apiVersion: opentelemetry.io/v1beta1
kind: OpenTelemetryCollector
metadata:
name: otel
namespace: <project_of_opentelemetry_collector_instance>
namespace: <permitted_project_of_opentelemetry_collector_instance> # <1>
spec:
mode: deployment
config:
receivers: # <1>
receivers: # <2>
otlp:
protocols:
grpc:
@@ -28,13 +28,13 @@ spec:
thrift_compact: {}
thrift_http: {}
zipkin: {}
processors: # <2>
processors: # <3>
batch: {}
memory_limiter:
check_interval: 1s
limit_percentage: 50
spike_limit_percentage: 30
exporters: # <3>
exporters: # <4>
debug: {}
service:
pipelines:
@@ -43,6 +43,7 @@ spec:
processors: [memory_limiter,batch]
exporters: [debug]
----
<1> For details, see the "Receivers" page.
<2> For details, see the "Processors" page.
<3> For details, see the "Exporters" page.
<1> The project that you have chosen for the `OpenTelemetryCollector` deployment. Project names beginning with the `openshift-` prefix are not permitted.
<2> For details, see the "Receivers" page.
<3> For details, see the "Processors" page.
<4> For details, see the "Exporters" page.