From c07dc288d040f6732063227fea9db68848f6df81 Mon Sep 17 00:00:00 2001 From: James Roper Date: Thu, 27 Apr 2023 10:56:58 +1000 Subject: [PATCH 1/3] Update OpenTelemetryCollectorSpec.Config docs The Config field contains YAML, not JSON. --- apis/v1alpha1/opentelemetrycollector_types.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apis/v1alpha1/opentelemetrycollector_types.go b/apis/v1alpha1/opentelemetrycollector_types.go index 1647ca54a9..998f49ae84 100644 --- 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) From ec5f77585be62d604bf03d2e997205c43e01cc68 Mon Sep 17 00:00:00 2001 From: Pavol Loffay Date: Fri, 5 Apr 2024 13:44:12 +0200 Subject: [PATCH 2/3] Fix Signed-off-by: Pavol Loffay --- config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml b/config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml index 4c16042603..9924a8c948 100644 --- 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 From 4851ed875f3f87e7c5b259d8f6a6b4c80f94ea6f Mon Sep 17 00:00:00 2001 From: Pavol Loffay Date: Fri, 5 Apr 2024 14:32:33 +0200 Subject: [PATCH 3/3] Fix Signed-off-by: Pavol Loffay --- bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml | 2 +- docs/api.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml b/bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml index 95192f9395..2883192bf6 100644 --- 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/docs/api.md b/docs/api.md index 259cf829ea..73f12f5f0a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -10312,7 +10312,7 @@ for the OpenTelemetryCollector workload.
config string - 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.
false