From 640e53101ce28253d34c128c585e3f66d3020a0f Mon Sep 17 00:00:00 2001 From: Pavol Loffay Date: Thu, 4 Nov 2021 10:19:05 +0100 Subject: [PATCH] Fix typos in Readme for auto-instrumentation (#499) * Fix typos in Readme for auto-instrumentation Signed-off-by: Pavol Loffay * do not wrap lines Signed-off-by: Pavol Loffay --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 91cba63285..04b8f5fa70 100644 --- a/README.md +++ b/README.md @@ -156,24 +156,20 @@ EOF ### OpenTelemetry auto-instrumentation injection -The operator can inject and configure OpenTelemetry auto-instrumentation libraries. At this moment, the operator can inject only -OpenTelemetry [Java auto-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation). +The operator can inject and configure OpenTelemetry auto-instrumentation libraries. At this moment, the operator can inject only OpenTelemetry [Java auto-instrumentation](https://github.com/open-telemetry/opentelemetry-java-instrumentation). -The injection of the Java agent can be enabled by adding an annotation to the namespace, so that all pods within that -namespace will get the instrumentation, or by adding the annotation to individual PodSpec objects, available as part -of Deployment, Statefulset, and other resources. +The injection of the Java agent can be enabled by adding an annotation to the namespace, so that all pods within that namespace will get the instrumentation, or by adding the annotation to individual PodSpec objects, available as part of Deployment, Statefulset, and other resources. ```console instrumentation.opentelemetry.io/inject-java: "true" ``` The value can be -* `false` - do not inject -* `true` - inject -* `java-instrumentation` - name of `Instrumentation` CR instance. +* `"false"` - do not inject +* `"true"` - inject and `Instrumentation` resource from the namespace. +* `"java-instrumentation"` - name of `Instrumentation` CR instance. -In the addition to the annotation the following `CR` has to be created. The `Instrumentation` -provides configuration for OpenTelemetry SDK and auto-instrumentation. +In addition to the annotation, the following `CR` has to be created. The `Instrumentation` resource provides configuration for OpenTelemetry SDK and auto-instrumentation. ```yaml kubectl apply -f - <