From 313d5a2bef6ff888594d4bf46f329a90cec7145c Mon Sep 17 00:00:00 2001 From: James Roper Date: Thu, 27 Apr 2023 10:56:58 +1000 Subject: [PATCH] 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 457c6d7004..1bbbb28dfd 100644 --- a/apis/v1alpha1/opentelemetrycollector_types.go +++ b/apis/v1alpha1/opentelemetrycollector_types.go @@ -124,7 +124,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)