OBSDOCS-1253: Improve OTEL installation procedure on console and CLI by unifying namespace

modules/distr-tracing-tempo-install-tempostack-cli.adoc

@@ -33,17 +33,18 @@ 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 project the TempoStack instance that you will create in a subsequent step:
 +
 [source,terminal]
 ----
 $ oc apply -f - << EOF
 apiVersion: project.openshift.io/v1
 kind: Project
 metadata:
-  name: <project_of_tempostack_instance>
+  name: <project_of_tempostack_instance> # <1>
 EOF
 ----
+<1> Do not create the instance in a namespace which starts with `openshift-` prefix.
 
 . In the project that you created for the TempoStack instance, create a secret for your object storage bucket by running the following command:
 +

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

@@ -55,10 +55,10 @@ apiVersion: tempo.grafana.com/v1alpha1
 kind: TempoStack
 metadata:
   name: simplest
-  namespace: <project_of_tempostack_instance>
+  namespace: <project_of_tempostack_instance> # <1>
 spec:
   storageSize: 1Gi
-  storage: # <1>
+  storage: # <2>
     secret:
       name: minio-test
       type: s3
@@ -69,15 +69,16 @@ spec:
         cpu: 2000m
   template:
     queryFrontend:
-      jaegerQuery: # <2>
+      jaegerQuery: # <3>
         enabled: true
         ingress:
           route:
             termination: edge
           type: route
 ----
-<1> In this example, the object storage was set up as one of the prerequisites, and the object storage secret was created in step 2.
-<2> The stack deployed in this example is configured to receive Jaeger Thrift over HTTP and OpenTelemetry Protocol (OTLP), which permits visualizing the data with the Jaeger UI.
+<1> Do not create the instance in a namespace which starts with `openshift-` prefix.
+<2> In this example, the object storage was set up as one of the prerequisites, and the object storage secret was created in step 2.
+<3> The stack deployed in this example is configured to receive Jaeger Thrift over HTTP and OpenTelemetry Protocol (OTLP), which permits visualizing the data with the Jaeger UI.
 
 .. Select *Create*.
 

modules/otel-install-web-console.adoc

@@ -28,7 +28,7 @@ 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*
 ====
 

snippets/distr-tracing-tempo-tempomonolithic-custom-resource.adoc

@@ -11,33 +11,34 @@ apiVersion: tempo.grafana.com/v1alpha1
 kind: TempoMonolithic
 metadata:
   name: <metadata_name>
-  namespace: <project_of_tempomonolithic_instance>
+  namespace: <project_of_tempomonolithic_instance> # <1>
 spec:
   storage:
     traces:
-      backend: <supported_storage_type> # <1>
-      size: <value>Gi # <2>
-      s3: # <3>
-        secret: <secret_name> # <4>
-    tls: # <5>
+      backend: <supported_storage_type> # <2>
+      size: <value>Gi # <3>
+      s3: # <4>
+        secret: <secret_name> # <5>
+    tls: # <6>
       enabled: true
-      caName: <ca_certificate_configmap_name> # <6>
+      caName: <ca_certificate_configmap_name> # <7>
   jaegerui:
-    enabled: true # <7>
+    enabled: true # <8>
     route:
-      enabled: true # <8>
-  resources: # <9>
+      enabled: true # <9>
+  resources: # <10>
     total:
       limits:
         memory: <value>Gi
         cpu: <value>m
 ----
-<1> 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.
-<2> 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 WAL, where the default is `10Gi`.
-<3> Optional: For object storage, the type of object storage. The accepted values are `s3`, `gcs`, and `azure`, depending on the used object store type.
-<4> 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".
-<5> Optional.
-<6> Optional: Name of a `ConfigMap` object that contains a CA certificate.
-<7> Enables the Jaeger UI.
-<8> Enables creation of a route for the Jaeger UI.
-<9> Optional.
+<1> Do not create the instance in a namespace which starts with `openshift-` prefix.
+<2> 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.
+<3> 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 WAL, where the default is `10Gi`.
+<4> Optional: For object storage, the type of object storage. The accepted values are `s3`, `gcs`, and `azure`, depending on the used object store type.
+<5> 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".
+<6> Optional.
+<7> Optional: Name of a `ConfigMap` object that contains a CA certificate.
+<8> Enables the Jaeger UI.
+<9> Enables creation of a route for the Jaeger UI.
+<10> Optional.

snippets/distr-tracing-tempo-tempostack-custom-resource.adoc

@@ -10,16 +10,16 @@ apiVersion: tempo.grafana.com/v1alpha1
 kind: TempoStack
 metadata:
   name: sample
-  namespace: <project_of_tempostack_instance>
+  namespace: <project_of_tempostack_instance> # <1>
 spec:
-  storageSize: <value>Gi # <1>
+  storageSize: <value>Gi # <2>
   storage:
-    secret: # <2>
-      name: <secret_name> # <3>
-      type: <secret_provider> # <4>
-    tls: # <5>
+    secret: # <3>
+      name: <secret_name> # <4>
+      type: <secret_provider> # <5>
+    tls: # <6>
       enabled: true
-      caName: <ca_certificate_configmap_name> # <6>
+      caName: <ca_certificate_configmap_name> # <7>
   template:
     queryFrontend:
       jaegerQuery:
@@ -28,16 +28,17 @@ spec:
           route:
             termination: edge
           type: route
-  resources: # <7>
+  resources: # <8>
     total:
       limits:
         memory: <value>Gi
         cpu: <value>m
 ----
-<1> Size of the persistent volume claim for the Tempo WAL. The default is `10Gi`.
-<2> Secret you created in step 2 for the object storage that had been set up as one of the prerequisites.
-<3> Value of the `name` in the `metadata` of the secret.
-<4> Accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or {odf-full}.
-<5> Optional.
-<6> Optional: Name of a `ConfigMap` object that contains a CA certificate.
-<7> Optional.
+<1> Do not create the instance in a namespace which starts with `openshift-` prefix.
+<2> Size of the persistent volume claim for the Tempo WAL. The default is `10Gi`.
+<3> Secret you created in step 2 for the object storage that had been set up as one of the prerequisites.
+<4> Value of the `name` in the `metadata` of the secret.
+<5> Accepted values are `azure` for Azure Blob Storage; `gcs` for Google Cloud Storage; and `s3` for Amazon S3, MinIO, or {odf-full}.
+<6> Optional.
+<7> Optional: Name of a `ConfigMap` object that contains a CA certificate.
+<8> Optional.

snippets/otel-collector-custom-resource.adoc

@@ -12,11 +12,11 @@ apiVersion: opentelemetry.io/v1alpha1
 kind: OpenTelemetryCollector
 metadata:
   name: otel
-  namespace: <project_of_opentelemetry_collector_instance>
+  namespace: <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> Do not create the instance in a namespace which starts with `openshift-` prefix.
+<2> For details, see the "Receivers" page.
+<3> For details, see the "Processors" page.
+<4> For details, see the "Exporters" page.