Merge pull request #86131 from openshift-cherrypick-robot/cherry-pick-84370-to-enterprise-4.16

[enterprise-4.16] OBSDOCS-1423: Document that instrumentation injection is GA

Author: lahinson

modules/otel-config-instrumentation.adoc

@@ -98,9 +98,46 @@ spec:
 
 |===
 
+[id="otel-configuration-of-opentelemetry-sdk-variables_{context}"]
+== Configuration of the OpenTelemetry SDK variables
+
+You can use the `instrumentation.opentelemetry.io/inject-sdk` annotation in the OpenTelemetry Collector custom resource to instruct the {OTELName} Operator to inject some of the following OpenTelemetry SDK environment variables, depending on the `Instrumentation` CR, into your pod:
+
+* `OTEL_SERVICE_NAME`
+* `OTEL_TRACES_SAMPLER`
+* `OTEL_TRACES_SAMPLER_ARG`
+* `OTEL_PROPAGATORS`
+* `OTEL_RESOURCE_ATTRIBUTES`
+* `OTEL_EXPORTER_OTLP_ENDPOINT`
+* `OTEL_EXPORTER_OTLP_CERTIFICATE`
+* `OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE`
+* `OTEL_EXPORTER_OTLP_CLIENT_KEY`
+
+.Values for the `instrumentation.opentelemetry.io/inject-sdk` annotation
+[cols="a, a"]
+|===
+| Value | Description
+
+|`"true"`
+|Injects the `+Instrumentation+` resource with the default name from the current namespace.
+
+|`"false"`
+|Injects no `+Instrumentation+` resource.
+
+|`"<instrumentation_name>"`
+|Specifies the name of the `+Instrumentation+` resource to inject from the current namespace.
+
+|`"<namespace>/<instrumentation_name>"`
+|Specifies the name of the `+Instrumentation+` resource to inject from another namespace.
+
+|===
+
 [id="otel-configuration-of-apache-http-server-auto-instrumentation_{context}"]
 == Configuration of the Apache HTTP Server auto-instrumentation
 
+:FeatureName: The Apache HTTP Server auto-instrumentation
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
 .Parameters for the `+.spec.apacheHttpd+` field
 [options="header"]
 [cols="a, a, a"]
@@ -142,6 +179,14 @@ instrumentation.opentelemetry.io/inject-apache-httpd: "true"
 [id="otel-configuration-of-dotnet-auto-instrumentation_{context}"]
 == Configuration of the .NET auto-instrumentation
 
+:FeatureName: The .NET auto-instrumentation
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
+[IMPORTANT]
+====
+By default, this feature injects unsupported, upstream instrumentation libraries.
+====
+
 [options="header"]
 [cols="a, a"]
 |===
@@ -169,6 +214,14 @@ instrumentation.opentelemetry.io/inject-dotnet: "true"
 [id="otel-configuration-of-go-auto-instrumentation_{context}"]
 == Configuration of the Go auto-instrumentation
 
+:FeatureName: The Go auto-instrumentation
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
+[IMPORTANT]
+====
+By default, this feature injects unsupported, upstream instrumentation libraries.
+====
+
 [options="header"]
 [cols="a, a"]
 |===
@@ -227,6 +280,14 @@ $ oc adm policy add-scc-to-user otel-go-instrumentation-scc -z <service_account>
 [id="otel-configuration-of-java-auto-instrumentation_{context}"]
 == Configuration of the Java auto-instrumentation
 
+:FeatureName: The Java auto-instrumentation
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
+[IMPORTANT]
+====
+By default, this feature injects unsupported, upstream instrumentation libraries.
+====
+
 [options="header"]
 [cols="a, a"]
 |===
@@ -252,6 +313,14 @@ instrumentation.opentelemetry.io/inject-java: "true"
 [id="otel-configuration-of-nodejs-auto-instrumentation_{context}"]
 == Configuration of the Node.js auto-instrumentation
 
+:FeatureName: The Node.js auto-instrumentation
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
+[IMPORTANT]
+====
+By default, this feature injects unsupported, upstream instrumentation libraries.
+====
+
 [options="header"]
 [cols="a, a"]
 |===
@@ -280,6 +349,14 @@ The `+instrumentation.opentelemetry.io/otel-go-auto-target-exe+` annotation sets
 [id="otel-configuration-of-python-auto-instrumentation_{context}"]
 == Configuration of the Python auto-instrumentation
 
+:FeatureName: The Python auto-instrumentation
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
+[IMPORTANT]
+====
+By default, this feature injects unsupported, upstream instrumentation libraries.
+====
+
 [options="header"]
 [cols="a, a"]
 |===
@@ -304,26 +381,6 @@ For Python auto-instrumentation, the `OTEL_EXPORTER_OTLP_ENDPOINT` environment v
 instrumentation.opentelemetry.io/inject-python: "true"
 ----
 
-[id="otel-configuration-of-opentelemetry-sdk-variables_{context}"]
-== Configuration of the OpenTelemetry SDK variables
-
-The OpenTelemetry SDK variables in your pod are configurable by using the following annotation:
-
-[source,yaml]
-----
-instrumentation.opentelemetry.io/inject-sdk: "true"
-----
-
-Note that all the annotations accept the following values:
-
-`true`:: Injects the `+Instrumentation+` resource from the namespace.
-
-`false`:: Does not inject any instrumentation.
-
-`instrumentation-name`:: The name of the instrumentation resource to inject from the current namespace.
-
-`other-namespace/instrumentation-name`:: The name of the instrumentation resource to inject from another namespace.
-
 [id="otel-multi-container-pods_{context}"]
 == Multi-container pods
 

observability/otel/otel-configuration-of-instrumentation.adoc

@@ -6,8 +6,6 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
-:FeatureName: OpenTelemetry instrumentation injection
-include::snippets/technology-preview.adoc[leveloffset=+1]
 
 The {OTELName} Operator uses a custom resource definition (CRD) file that defines the configuration of the instrumentation.