Update READMEs with note on array merging (#303)

Signed-off-by: Matej Gera <[email protected]>
coralogix · Oct 9, 2023 · 10b369f · 10b369f
1 parent 46fe918
commit 10b369f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/otel-agent/k8s-helm/README.md b/otel-agent/k8s-helm/README.md
@@ -73,6 +73,8 @@ helm upgrade --install otel-coralogix-agent coralogix-charts-virtual/opentelemet
   -f values.yaml
 ```
 
+If you'd like to provide your own overrides for array values such as `extraEnvs`, `extraVolumes` or `extraVolumeMounts`, please beware that Helm does not support merging arrays, but instead the arrays will be nulled out (see this [issue](https://github.com/helm/helm/issues/3486) for more). In case you'd like to provide your own values for these arrays, make sure that you first **copy over any existing array values** from the provided `values.yaml` file.
+
 ### Generating OpenTelemetryCollector CRD for OpenTelemetry Operator users
 
 If you wish to deploy the `otel-agent` using the OpenTelemetry Operator, you can generate an `OpenTelemetryCollector` CRD. You might want to do this if you'd like to take advantage of some advanced features provided by the operator, such as automatic collector upgrade or CRD-defined auto-instrumentation.

diff --git a/otel-infrastructure-collector/k8s-helm/README.md b/otel-infrastructure-collector/k8s-helm/README.md
@@ -57,6 +57,8 @@ helm upgrade --install otel-infrastructure-collector coralogix-charts-virtual/ot
   -f values.yaml
 ```
 
+If you'd like to provide your own overrides for array values such as `extraEnvs`, `extraVolumes` or `extraVolumeMounts`, please beware that Helm does not support merging arrays, but instead the arrays will be nulled out (see this [issue](https://github.com/helm/helm/issues/3486) for more). In case you'd like to provide your own values for these arrays, make sure that you first **copy over any existing array values** from the provided `values.yaml` file.
+
 # Infrastructure Monitoring
 
 ## Kubernetes Events

diff --git a/otel-integration/k8s-helm/README.md b/otel-integration/k8s-helm/README.md
@@ -106,6 +106,8 @@ helm upgrade --install otel-coralogix-integration coralogix-charts-virtual/otel-
   -f values.yaml
 ```
 
+If you'd like to provide your own overrides for array values such as `extraEnvs`, `extraVolumes` or `extraVolumeMounts`, please beware that Helm does not support merging arrays, but instead the arrays will be nulled out (see this [issue](https://github.com/helm/helm/issues/3486) for more). In case you'd like to provide your own values for these arrays, make sure that you first **copy over any existing array values** from the provided `values.yaml` file.
+
 ### Generating OpenTelemetryCollector CRD for OpenTelemetry Operator users
 
 If you wish to deploy the `otel-integration` using the OpenTelemetry Operator, you can generate an `OpenTelemetryCollector` CRD. You might want to do this if you'd like to take advantage of some advanced features provided by the operator, such as automatic collector upgrade or CRD-defined auto-instrumentation.