Skip to content

Commit 61b36c0

Browse files
Minor reorganization of the steps to install otel CRDs (#5074)
* Minor reorganization of the steps to install otel CRDs * minor edits, added intro --------- Co-authored-by: Kim Pohas <[email protected]>
1 parent 9680b77 commit 61b36c0

File tree

2 files changed

+31
-17
lines changed

2 files changed

+31
-17
lines changed

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

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ sidebar_label: How to Upgrade
55
description: This page describes how to upgrade Kubernetes Collection to v4.
66
---
77

8+
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:
9+
10+
* OpenTelemetry (OTel) as the default metrics pipeline
11+
* Removal of Fluent Bit and Fluentd configurations
12+
* New ServiceMonitors and OTel processors for filtering metrics
13+
* Updated CRDs for OpenTelemetry Operator
14+
15+
Before proceeding, ensure you meet the requirements and review the necessary configuration changes detailed in this guide.
16+
817
## Requirements
918

1019
- `helm3`
@@ -44,19 +53,17 @@ There are several scenarios here, depending on the exact use case:
4453

4554
You'll need to delete the remote write definition and [add an equivalent filter processor][otel_metrics_filter] rule to OTel.
4655

47-
### Upgrade the Kubernetes App
56+
### Upgrade the Kubernetes app
4857

49-
**When?**: If you use the [Sumo Logic Kubernetes App](/docs/integrations/containers-orchestration/kubernetes/)
58+
**When?**: If you use the [Sumo Logic Kubernetes app](/docs/integrations/containers-orchestration/kubernetes/)
5059

51-
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
52-
compatibility with version 4 of Helm Chart. See [here][k8s_app_upgrade] for upgrade instructions.
60+
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.
5361

5462
[k8s_app_upgrade]: /docs/integrations/containers-orchestration/kubernetes/#upgradedowngrade-the-kubernetes-app
5563

5664
#### Using the new app with v3
5765

58-
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
59-
before migrating to version 4. The configuration for version 3 is the following:
66+
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:
6067

6168
```yaml
6269
kube-prometheus-stack:
@@ -81,9 +88,21 @@ kube-prometheus-stack:
8188
#### Update custom resource definition for OpenTelemetry operator
8289
8390
:::note
84-
Starting v4.12.0, please use the CRDs below
91+
Starting with v4.12.0, please follow the steps below.
8592
:::
8693
94+
Delete any existing CRDs:
95+
96+
```shell
97+
kubectl delete crd instrumentations.opentelemetry.io
98+
99+
kubectl delete crd opentelemetrycollectors.opentelemetry.io
100+
101+
kubectl delete crd opampbridges.opentelemetry.io
102+
```
103+
104+
Install the CRDs below:
105+
87106
```shell
88107
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
89108

@@ -92,17 +111,18 @@ kubectl apply --server-side -f https://raw.githubusercontent.com/SumoLogic/sumol
92111
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
93112
```
94113

95-
Then, annotate and label these CRDs as below
114+
Then, annotate and label these CRDs as below:
96115

97116
```shell
98117
kubectl annotate crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io \
99118
meta.helm.sh/release-name=${RELEASE_NAME} \
100119
meta.helm.sh/release-namespace=${RELEASE_NAMESPACE}
120+
101121
kubectl label crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io app.kubernetes.io/managed-by=Helm
102122
```
103123

104124
:::note
105-
CRDs prior to v4.12.0 are below
125+
CRDs prior to v4.12.0 are below.
106126
:::
107127

108128
```shell
@@ -133,7 +153,7 @@ kube-prometheus-stack:
133153
enabled: true
134154
```
135155

136-
Starting v4.12.0, please use the configuration below
156+
Starting with v4.12.0, please use the configuration below:
137157

138158
```yaml
139159
sumologic:
@@ -216,7 +236,7 @@ tracesSampler:
216236
217237
## Running the helm upgrade
218238
219-
Once you've taken care of any manual steps necessary for your configuration, run the helm upgrade:
239+
Once you've taken care of any manual steps necessary for your configuration, run the `helm upgrade`:
220240

221241
```bash
222242
helm upgrade --namespace "${NAMESPACE}" "${HELM_RELEASE_NAME}" sumologic/sumologic --version=4.0.0 -f new-values.yaml

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,6 @@ Please follow instructions below to install the appropriate CRD versions
4040
#### CRDs to install (v4.12.0 and later)
4141

4242
```shell
43-
kubectl delete crd instrumentations.opentelemetry.io
44-
45-
kubectl delete crd opentelemetrycollectors.opentelemetry.io
46-
47-
kubectl delete crd opampbridges.opentelemetry.io
48-
4943
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
5044

5145
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

0 commit comments

Comments
 (0)