Pr1680 (#2819)

* Update OpenTelemetryCollectorSpec.Config docs The Config field contains YAML, not JSON. * Fix Signed-off-by: Pavol Loffay <p.loffay@gmail.com> * Fix Signed-off-by: Pavol Loffay <p.loffay@gmail.com> --------- Signed-off-by: Pavol Loffay <p.loffay@gmail.com> Co-authored-by: James Roper <james@jazzy.id.au>
open-telemetry · Apr 5, 2024 · 47f78af · 47f78af
1 parent 2116872
commit 47f78af
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/apis/v1alpha1/opentelemetrycollector_types.go b/apis/v1alpha1/opentelemetrycollector_types.go
@@ -174,7 +174,7 @@ type OpenTelemetryCollectorSpec struct {
 	// ImagePullPolicy indicates the pull policy to be used for retrieving the container image (Always, Never, IfNotPresent)
 	// +optional
 	ImagePullPolicy v1.PullPolicy `json:"imagePullPolicy,omitempty"`
-	// Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.
+	// Config is the raw YAML to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.
 	// +required
 	Config string `json:"config,omitempty"`
 	// VolumeMounts represents the mount points to use in the underlying collector deployment(s)

diff --git a/bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml b/bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml
@@ -2239,7 +2239,7 @@ spec:
                     type: integer
                 type: object
               config:
-                description: Config is the raw JSON to be used as the collector's
+                description: Config is the raw YAML to be used as the collector's
                   configuration. Refer to the OpenTelemetry Collector documentation
                   for details.
                 type: string

diff --git a/config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml b/config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml
@@ -2236,7 +2236,7 @@ spec:
                     type: integer
                 type: object
               config:
-                description: Config is the raw JSON to be used as the collector's
+                description: Config is the raw YAML to be used as the collector's
                   configuration. Refer to the OpenTelemetry Collector documentation
                   for details.
                 type: string

diff --git a/docs/api.md b/docs/api.md
@@ -10312,7 +10312,7 @@ for the OpenTelemetryCollector workload.<br/>
         <td><b>config</b></td>
         <td>string</td>
         <td>
-          Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.<br/>
+          Config is the raw YAML to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.<br/>
         </td>
         <td>false</td>
       </tr><tr>