Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 13, 2025
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0ba310
Add note to update CRDs before upgrading to helm chart version 4.12.0
rnishtala-sumo Jan 23, 2025
47b5215
Add a note about recovering from hung CRDs
rnishtala-sumo Feb 13, 2025
daedffa
Re-organize the notes about upgrading the CRDs
rnishtala-sumo Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/send-data/kubernetes/v4/how-to-upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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).
Expand Down
30 changes: 21 additions & 9 deletions docs/send-data/kubernetes/v4/important-changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down