From de9187b7e457a8cbbb0d5ab15c3064b08eeb9522 Mon Sep 17 00:00:00 2001 From: Raj Nishtala Date: Thu, 13 Feb 2025 16:56:51 -0500 Subject: [PATCH 1/2] Minor reorganization of the steps to install otel CRDs --- docs/send-data/kubernetes/v4/how-to-upgrade.md | 15 ++++++++++++++- docs/send-data/kubernetes/v4/important-changes.md | 6 ------ 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/send-data/kubernetes/v4/how-to-upgrade.md b/docs/send-data/kubernetes/v4/how-to-upgrade.md index 000419a8bf..5863df74ab 100644 --- a/docs/send-data/kubernetes/v4/how-to-upgrade.md +++ b/docs/send-data/kubernetes/v4/how-to-upgrade.md @@ -81,9 +81,21 @@ kube-prometheus-stack: #### Update custom resource definition for OpenTelemetry operator :::note -Starting v4.12.0, please use the CRDs below +Starting v4.12.0, please follow the steps below ::: +Delete any existing CRDs + +```shell +kubectl delete crd instrumentations.opentelemetry.io + +kubectl delete crd opentelemetrycollectors.opentelemetry.io + +kubectl delete crd opampbridges.opentelemetry.io +``` + +Install 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 @@ -98,6 +110,7 @@ Then, annotate and label these CRDs as below 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 ``` diff --git a/docs/send-data/kubernetes/v4/important-changes.md b/docs/send-data/kubernetes/v4/important-changes.md index 2f2fb78494..0e5e0a4a8e 100644 --- a/docs/send-data/kubernetes/v4/important-changes.md +++ b/docs/send-data/kubernetes/v4/important-changes.md @@ -40,12 +40,6 @@ Please follow instructions below to install the appropriate CRD versions #### CRDs to install (v4.12.0 and later) ```shell -kubectl delete crd instrumentations.opentelemetry.io - -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 From 4f1e7a0253197fcb533f1426286d0943d180591a Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Thu, 13 Feb 2025 14:12:57 -0800 Subject: [PATCH 2/2] minor edits, added intro --- .../send-data/kubernetes/v4/how-to-upgrade.md | 35 +++++++++++-------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/docs/send-data/kubernetes/v4/how-to-upgrade.md b/docs/send-data/kubernetes/v4/how-to-upgrade.md index 5863df74ab..9b4f04949f 100644 --- a/docs/send-data/kubernetes/v4/how-to-upgrade.md +++ b/docs/send-data/kubernetes/v4/how-to-upgrade.md @@ -5,6 +5,15 @@ sidebar_label: How to Upgrade description: This page describes how to upgrade Kubernetes Collection to v4. --- +This guide walks you through upgrading to Sumo Logic Kubernetes Collection v4.0.0, including key changes, migration steps, and best practices to ensure a smooth transition. Here's what’s new: + +* OpenTelemetry (OTel) as the default metrics pipeline +* Removal of Fluent Bit and Fluentd configurations +* New ServiceMonitors and OTel processors for filtering metrics +* Updated CRDs for OpenTelemetry Operator + +Before proceeding, ensure you meet the requirements and review the necessary configuration changes detailed in this guide. + ## Requirements - `helm3` @@ -44,19 +53,17 @@ There are several scenarios here, depending on the exact use case: You'll need to delete the remote write definition and [add an equivalent filter processor][otel_metrics_filter] rule to OTel. -### Upgrade the Kubernetes App +### Upgrade the Kubernetes app -**When?**: If you use the [Sumo Logic Kubernetes App](/docs/integrations/containers-orchestration/kubernetes/) +**When?**: If you use the [Sumo Logic Kubernetes app](/docs/integrations/containers-orchestration/kubernetes/) -Recording rule metrics removed in version 4 were used in the Sumo Kubernetes App. A new version of the App must be installed to ensure -compatibility with version 4 of Helm Chart. See [here][k8s_app_upgrade] for upgrade instructions. +Recording rule metrics removed in version 4 were used in the Sumo Logic Kubernetes app. A new version of the app must be installed to ensure compatibility with version 4 of Helm Chart. See [here][k8s_app_upgrade] for upgrade instructions. [k8s_app_upgrade]: /docs/integrations/containers-orchestration/kubernetes/#upgradedowngrade-the-kubernetes-app #### Using the new app with v3 -To make the migration simpler, it's possible to configure v3 to be compatible with the new App. This way, you can migrate to the new App -before migrating to version 4. The configuration for version 3 is the following: +To make the migration simpler, it's possible to configure v3 to be compatible with the new app. This way, you can migrate to the new app before migrating to version 4. The configuration for version 3 is the following: ```yaml kube-prometheus-stack: @@ -81,10 +88,10 @@ kube-prometheus-stack: #### Update custom resource definition for OpenTelemetry operator :::note -Starting v4.12.0, please follow the steps below +Starting with v4.12.0, please follow the steps below. ::: -Delete any existing CRDs +Delete any existing CRDs: ```shell kubectl delete crd instrumentations.opentelemetry.io @@ -94,7 +101,7 @@ kubectl delete crd opentelemetrycollectors.opentelemetry.io kubectl delete crd opampbridges.opentelemetry.io ``` -Install the CRDs below +Install 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 @@ -104,18 +111,18 @@ kubectl apply --server-side -f https://raw.githubusercontent.com/SumoLogic/sumol 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 +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 +CRDs prior to v4.12.0 are below. ::: ```shell @@ -146,7 +153,7 @@ kube-prometheus-stack: enabled: true ``` -Starting v4.12.0, please use the configuration below +Starting with v4.12.0, please use the configuration below: ```yaml sumologic: @@ -229,7 +236,7 @@ tracesSampler: ## Running the helm upgrade -Once you've taken care of any manual steps necessary for your configuration, run the helm upgrade: +Once you've taken care of any manual steps necessary for your configuration, run the `helm upgrade`: ```bash helm upgrade --namespace "${NAMESPACE}" "${HELM_RELEASE_NAME}" sumologic/sumologic --version=4.0.0 -f new-values.yaml