Add note to update CRDs before upgrading to helm chart version 4.12.0 (#4986)

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

* Add a note about recovering from hung CRDs

* Re-organize the notes about upgrading the CRDs

Author: rnishtala-sumo

docs/send-data/kubernetes/troubleshoot-collection.md

@@ -1056,6 +1056,32 @@ It means that Custom Resource Definition has not been applied by Helm. It is [He
 kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.44.0/charts/opentelemetry-operator/crds/crd-opentelemetry.io_opampbridges.yaml
 ```
 
+### Hung/Stuck OpenTelemetryCollector K8s CRD
+
+To patch and delete CustomResourceDefinitions in Kubernetes
+
+```shell
+kubectl patch crd/opentelemetrycollectors.opentelemetry.io -p '{"metadata":{"finalizers":[]}}' --type=merge
+```
+
+Confirm that the finalizer has been removed
+
+```shell
+kubectl get opentelemetrycollectors.opentelemetry.io -o yaml > my-resource.yaml
+```
+
+If the patch command doesn't work, please edit the CRD to remove the finalizer
+
+```shell
+kubectl edit crd opentelemetrycollectors.opentelemetry.io
+```
+
+Finally, delete the CRD
+
+```shell
+kubectl delete crd/opampbridges.opentelemetry.io
+```
+
 ## Using Sumo Logic Mock
 
 Sumo Logic Mock is debugging tool, which helps to see what exactly is being sent from the Sumo Logic Collection to Sumo Logic. It may help with finding if there are any missing metrics, logs, traces, or parts of them like labels or metadata.

docs/send-data/kubernetes/v4/how-to-upgrade.md

@@ -80,6 +80,31 @@ kube-prometheus-stack:
 
 #### Update custom resource definition for OpenTelemetry operator
 
+:::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
+```
+
+Then, annotate and label these CRDs as below
+
+```shell
+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
+```
+
+:::note
+CRDs prior to v4.12.0 are below
+:::
+
 ```shell
 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
 
@@ -108,6 +133,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).

docs/send-data/kubernetes/v4/important-changes.md

@@ -33,21 +33,42 @@ 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
+
+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
 ```
 
-##### OpAMP Bridge CRD
+Then, annotate and label these CRDs as below
 
+```shell
+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
 ```
+
+#### 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
 ```