Add note to update CRDs before upgrading to helm chart version 4.12.0

SumoLogic · Jan 28, 2025 · a0ba310 · a0ba310
1 parent 6f77c18
commit a0ba310
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 9 deletions.
diff --git a/docs/send-data/kubernetes/v4/how-to-upgrade.md b/docs/send-data/kubernetes/v4/how-to-upgrade.md
@@ -88,6 +88,23 @@ kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-
 kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetrycollector.yaml`
 ```
 
+:::note
+Starting v4.12.0, please use the CRDs below
+:::
+
+```shell
+kubectl apply --server-side -f https://raw.githubusercontent.com/SumoLogic/sumologic-kubernetes-collection/refs/tags/v4.12.0/deploy/helm/sumologic/crds/crd-opentelemetry.io_opampbridges.yaml --force-conflicts
+
+kubectl apply --server-side -f https://raw.githubusercontent.com/SumoLogic/sumologic-kubernetes-collection/refs/tags/v4.12.0/deploy/helm/sumologic/crds/crd-opentelemetrycollector.yaml --force-conflicts
+
+kubectl apply --server-side -f https://raw.githubusercontent.com/SumoLogic/sumologic-kubernetes-collection/refs/tags/v4.12.0/deploy/helm/sumologic/crds/crd-opentelemetryinstrumentation.yaml --force-conflicts
+
+kubectl annotate crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io \
+  meta.helm.sh/release-name=${RELEASE_NAME} \
+  meta.helm.sh/release-namespace=${RELEASE_NAMESPACE}
+kubectl label crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io app.kubernetes.io/managed-by=Helm
+```
+
 ### How to revert to the v3 defaults
 
 Set the following in your configuration:
@@ -108,6 +125,28 @@ kube-prometheus-stack:
     enabled: true
 ```
 
+Starting v4.12.0, please use the configuration below
+
+```yaml
+sumologic:
+  metrics:
+    collector:
+      otelcol:
+        enabled: false
+    remoteWriteProxy:
+      enabled: true
+
+kube-prometheus-stack:
+  prometheus:
+    enabled: true
+  prometheusOperator:
+    enabled: true
+
+opentelemetry-operator:
+  crds:
+    create: true
+```
+
 ## Remove remaining Fluent Bit and Fluentd configuration
 
 If you've already switched to OTel, skip straight to the [next major section](#switch-to-otlp-sources).

diff --git a/docs/send-data/kubernetes/v4/important-changes.md b/docs/send-data/kubernetes/v4/important-changes.md
@@ -33,21 +33,33 @@ By default, the OpenTelemetry Collector is now used for metrics collection inste
 
 Ensure that the following CRDs from the OpenTelemetry operator are installed and updated using the following commands.
 
-##### Instrumentation CRD (relevant for metrics and traces)
+:::note
+Please follow instructions below to install the appropriate CRD versions
+:::
 
-```
-kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetryinstrumentation.yaml
-```
+#### CRDS to install (v4.12.0 and later)
 
-##### OpenTelemetry collector CRD
+```shell
+kubectl delete crd instrumentations.opentelemetry.io
 
-```
-kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetrycollector.yaml
-```
+kubectl delete crd opentelemetrycollectors.opentelemetry.io
 
-##### OpAMP Bridge CRD
+kubectl delete crd opampbridges.opentelemetry.io
 
+kubectl apply --server-side -f https://raw.githubusercontent.com/SumoLogic/sumologic-kubernetes-collection/refs/tags/v4.12.0/deploy/helm/sumologic/crds/crd-opentelemetry.io_opampbridges.yaml --force-conflicts
+
+kubectl apply --server-side -f https://raw.githubusercontent.com/SumoLogic/sumologic-kubernetes-collection/refs/tags/v4.12.0/deploy/helm/sumologic/crds/crd-opentelemetrycollector.yaml --force-conflicts
+
+kubectl apply --server-side -f https://raw.githubusercontent.com/SumoLogic/sumologic-kubernetes-collection/refs/tags/v4.12.0/deploy/helm/sumologic/crds/crd-opentelemetryinstrumentation.yaml --force-conflicts
 ```
+
+#### CRDs to install (before v4.12.0)
+
+```shell
+kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetryinstrumentation.yaml
+
+kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetrycollector.yaml
+
 kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetry.io_opampbridges.yaml
 ```