Skip to content

Commit 47f78af

Browse files
pavolloffayjroper
andauthored
Pr1680 (#2819)
* Update OpenTelemetryCollectorSpec.Config docs The Config field contains YAML, not JSON. * Fix Signed-off-by: Pavol Loffay <[email protected]> * Fix Signed-off-by: Pavol Loffay <[email protected]> --------- Signed-off-by: Pavol Loffay <[email protected]> Co-authored-by: James Roper <[email protected]>
1 parent 2116872 commit 47f78af

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

apis/v1alpha1/opentelemetrycollector_types.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ type OpenTelemetryCollectorSpec struct {
174174
// ImagePullPolicy indicates the pull policy to be used for retrieving the container image (Always, Never, IfNotPresent)
175175
// +optional
176176
ImagePullPolicy v1.PullPolicy `json:"imagePullPolicy,omitempty"`
177-
// Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.
177+
// Config is the raw YAML to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.
178178
// +required
179179
Config string `json:"config,omitempty"`
180180
// VolumeMounts represents the mount points to use in the underlying collector deployment(s)

bundle/manifests/opentelemetry.io_opentelemetrycollectors.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2239,7 +2239,7 @@ spec:
22392239
type: integer
22402240
type: object
22412241
config:
2242-
description: Config is the raw JSON to be used as the collector's
2242+
description: Config is the raw YAML to be used as the collector's
22432243
configuration. Refer to the OpenTelemetry Collector documentation
22442244
for details.
22452245
type: string

config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2236,7 +2236,7 @@ spec:
22362236
type: integer
22372237
type: object
22382238
config:
2239-
description: Config is the raw JSON to be used as the collector's
2239+
description: Config is the raw YAML to be used as the collector's
22402240
configuration. Refer to the OpenTelemetry Collector documentation
22412241
for details.
22422242
type: string

docs/api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10312,7 +10312,7 @@ for the OpenTelemetryCollector workload.<br/>
1031210312
<td><b>config</b></td>
1031310313
<td>string</td>
1031410314
<td>
10315-
Config is the raw JSON to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.<br/>
10315+
Config is the raw YAML to be used as the collector's configuration. Refer to the OpenTelemetry Collector documentation for details.<br/>
1031610316
</td>
1031710317
<td>false</td>
1031810318
</tr><tr>

0 commit comments

Comments
 (0)