OBSDOCS-923: Add a note for the example OpenTelemetry Collector

Author: max-cx

modules/otel-install-cli.adoc

@@ -112,45 +112,11 @@ EOF
 You can create multiple OpenTelemetry Collector instances in separate projects on the same cluster.
 ====
 +
-.. Customize the `OpenTelemetry Collector` custom resource (CR)  with the OTLP, Jaeger, and Zipkin receivers and the debug exporter:
+.. Customize the `OpenTelemetryCollector` custom resource (CR):
 +
-[source,yaml]
-----
-apiVersion: opentelemetry.io/v1alpha1
-kind: OpenTelemetryCollector
-metadata:
-  name: otel
-  namespace: <project_of_opentelemetry_collector_instance>
-spec:
-  mode: deployment
-  config: |
-    receivers:
-      otlp:
-        protocols:
-          grpc:
-          http:
-      jaeger:
-        protocols:
-          grpc: {}
-          thrift_binary: {}
-          thrift_compact: {}
-          thrift_http: {}
-      zipkin:
-    processors:
-      batch: {}
-      memory_limiter:
-        check_interval: 1s
-        limit_percentage: 50
-        spike_limit_percentage: 30
-    exporters:
-      debug: {}
-    service:
-      pipelines:
-        traces:
-          receivers: [otlp,jaeger,zipkin]
-          processors: [memory_limiter,batch]
-          exporters: [debug]
-----
+--
+include::snippets/otel-collector-custom-resource.adoc[]
+--
 
 .. Apply the customized CR by running the following command:
 +

modules/otel-install-web-console.adoc

@@ -42,45 +42,11 @@ This installs the Operator with the default presets:
 
 .. Select *OpenTelemetry Collector* -> *Create OpenTelemetry Collector* -> *YAML view*.
 
-.. In the *YAML view*, customize the `OpenTelemetryCollector` custom resource (CR) with the OTLP, Jaeger, Zipkin receivers and the debug exporter.
+.. In the *YAML view*, customize the `OpenTelemetryCollector` custom resource (CR):
 +
-[source,yaml]
-----
-apiVersion: opentelemetry.io/v1alpha1
-kind: OpenTelemetryCollector
-metadata:
-  name: otel
-  namespace: <project_of_opentelemetry_collector_instance>
-spec:
-  mode: deployment
-  config: |
-    receivers:
-      otlp:
-        protocols:
-          grpc:
-          http:
-      jaeger:
-        protocols:
-          grpc: {}
-          thrift_binary: {}
-          thrift_compact: {}
-          thrift_http: {}
-      zipkin: {}
-    processors:
-      batch: {}
-      memory_limiter:
-        check_interval: 1s
-        limit_percentage: 50
-        spike_limit_percentage: 30
-    exporters:
-      debug: {}
-    service:
-      pipelines:
-        traces:
-          receivers: [otlp,jaeger,zipkin]
-          processors: [memory_limiter,batch]
-          exporters: [debug]
-----
+--
+include::snippets/otel-collector-custom-resource.adoc[]
+--
 
 .. Select *Create*.
 

snippets/otel-collector-custom-resource.adoc

@@ -0,0 +1,48 @@
+// Text snippet included in the following modules:
+//
+// * otel-install-cli.adoc
+// * otel-install-web-console.adoc
+
+:_mod-docs-content-type: SNIPPET
+
+.Example `OpenTelemetryCollector` CR
+[source,yaml]
+----
+apiVersion: opentelemetry.io/v1alpha1
+kind: OpenTelemetryCollector
+metadata:
+  name: otel
+  namespace: <project_of_opentelemetry_collector_instance>
+spec:
+  mode: deployment
+  config: |
+    receivers: # <1>
+      otlp:
+        protocols:
+          grpc:
+          http:
+      jaeger:
+        protocols:
+          grpc: {}
+          thrift_binary: {}
+          thrift_compact: {}
+          thrift_http: {}
+      zipkin: {}
+    processors: # <2>
+      batch: {}
+      memory_limiter:
+        check_interval: 1s
+        limit_percentage: 50
+        spike_limit_percentage: 30
+    exporters: # <3>
+      debug: {}
+    service:
+      pipelines:
+        traces:
+          receivers: [otlp,jaeger,zipkin]
+          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.