WIP

Author: aurbiztondo-splunk

_includes/collector-upgrade.rst

@@ -5,17 +5,15 @@ When you update the Collector using the official packages, configuration files a
 General guidelines
 =================================
 
-Apply the following changes to the Collector configuration files for specific version upgrades. 
-
-.. :important::
+.. :note::
 
   For every configuration update use the default agent config as a reference.
 
+Apply the following changes to the Collector configuration files for specific version upgrades. For more details refer to :new-page:`Upgrade guidelines <ttps://github.com/signalfx/splunk-otel-collector?tab=readme-ov-file#upgrade-guidelines>` in GitHub. 
+
 From 0.96.1 to 0.97.0
 ------------------------------------
 
-
-
 .. raw:: html
 
    <div class="include-start" id="collector-upgrade-memory-ballast.rst"></div>
@@ -26,9 +24,6 @@ From 0.96.1 to 0.97.0
 
    <div class="include-stop" id="collector-upgrade-memory-ballast.rst"></div>
 
-
-
-
 From 0.68.0 to 0.69.0
 ------------------------------------
 

gdi/opentelemetry/collector-kubernetes/kubernetes-upgrade.rst

@@ -6,22 +6,7 @@ Upgrade the Collector for Kubernetes and other updates
 *********************************************************************************
 
 .. meta::
-  :description: Upgrade the Splunk Distribution of OpenTelemetry Collector for Kubernetes.
-
-TEST TEST
-
-.. raw:: html
-
-   <div class="include-start" id="collector-upgrade.rst"></div>
-
-.. include:: /_includes/collector-upgrade.rst
-
-.. raw:: html
-
-   <div class="include-stop" id="collector-upgrade.rst"></div>
-
-
-
+  :description: Upgrade the Splunk Distribution of the OpenTelemetry Collector for Kubernetes.
 
 .. _otel-upgrade-k8s:
 
@@ -43,7 +28,73 @@ To upgrade the Collector for Kubernetes run the following commands:
 
   helm upgrade splunk-otel-collector --values config.yaml splunk-otel-collector-chart/splunk-otel-collector --reuse-values
 
-Read more in the official Helm upgrade options documentation at :new-page:`https://helm.sh/docs/helm/helm_upgrade/#options <https://helm.sh/docs/helm/helm_upgrade/#options>`.
+Read more in the official :new-page:`Helm upgrade options <https://helm.sh/docs/helm/helm_upgrade/#options>` documentation.
+
+.. _otel-upgrade-k8s-guidelines:
+
+Upgrade guidelines
+=================================
+
+.. :note::
+
+  For every configuration update use the default agent config as a reference.
+
+Apply the following changes to the Collector configuration files for specific version upgrades. For more details refer to :new-page:`Upgrade guidelines <https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md>` in GitHub.
+
+From 0.113.0 to 0.116.0
+---------------------------------------
+
+This guide provides steps for new users, transitioning users, and those maintaining previous operator CRD configurations:
+
+New users: No migration for CRDs is required.
+Previous users: Migration may be needed if using operator.enabled=true.
+CRD deployment has evolved over chart versions:
+
+Before 0.110.0: CRDs were deployed via a crds/ directory (upstream default).
+0.110.0 to 1.113.0: CRDs were deployed using Helm templates (upstream default), which had reported issues.
+0.116.0 and later: Users must now explicitly configure their preferred CRD deployment method or deploy the CRDs manually to avoid potential issues. Users can deploy CRDs via a crds/ directory again by enabling a newly added value.
+
+New users
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+New users are advised to deploy CRDs via the crds/ directory. For a fresh installation, use the following Helm values:
+
+operatorcrds:
+  install: true
+operator:
+  enabled: true
+To install the chart:
+
+helm install <release-name> splunk-otel-collector-chart/splunk-otel-collector --set operatorcrds.install=true,operator.enabled=true <extra_args>
+Current Users (Recommended Migration to crds/ Directory)
+If you're using chart versions 0.110.0 to 1.113.0, CRDs are likely deployed via Helm templates. To migrate to the recommended crds/ directory deployment:
+
+Step 1: Delete the Existing Chart
+Remove the chart to prepare for a fresh installation:
+
+helm delete <release-name>
+Step 2: Verify or Remove Existing CRDs
+Check if the following CRDs are present and delete them if necessary:
+
+kubectl get crds | grep opentelemetry
+kubectl delete crd opentelemetrycollectors.opentelemetry.io
+kubectl delete crd opampbridges.opentelemetry.io
+kubectl delete crd instrumentations.opentelemetry.io
+Step 3: Reinstall with Recommended Values
+Reinstall the chart with the updated configuration:
+
+helm install <release-name> splunk-otel-collector --set operatorcrds.install=true,operator.enabled=true <extra_args>
+Previous Users (Maintaining Legacy Helm Templates)
+If you're using chart versions 0.110.0 to 1.113.0 and prefer to continue deploying CRDs via Helm templates (not recommended), you can do so with the following values:
+
+operator:
+  enabled: true
+operator:
+  crds:
+    create: true
+Warning: This method may cause race conditions during installation or upgrades
+
+
 
 .. _otel-upgrade-k8s-access-token: