Skip to content

Commit 9680b77

Browse files
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
1 parent 7b6a198 commit 9680b77

File tree

3 files changed

+102
-8
lines changed

3 files changed

+102
-8
lines changed

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,6 +1056,32 @@ It means that Custom Resource Definition has not been applied by Helm. It is [He
10561056
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
10571057
```
10581058

1059+
### Hung/Stuck OpenTelemetryCollector K8s CRD
1060+
1061+
To patch and delete CustomResourceDefinitions in Kubernetes
1062+
1063+
```shell
1064+
kubectl patch crd/opentelemetrycollectors.opentelemetry.io -p '{"metadata":{"finalizers":[]}}' --type=merge
1065+
```
1066+
1067+
Confirm that the finalizer has been removed
1068+
1069+
```shell
1070+
kubectl get opentelemetrycollectors.opentelemetry.io -o yaml > my-resource.yaml
1071+
```
1072+
1073+
If the patch command doesn't work, please edit the CRD to remove the finalizer
1074+
1075+
```shell
1076+
kubectl edit crd opentelemetrycollectors.opentelemetry.io
1077+
```
1078+
1079+
Finally, delete the CRD
1080+
1081+
```shell
1082+
kubectl delete crd/opampbridges.opentelemetry.io
1083+
```
1084+
10591085
## Using Sumo Logic Mock
10601086

10611087
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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,31 @@ kube-prometheus-stack:
8080
8181
#### Update custom resource definition for OpenTelemetry operator
8282
83+
:::note
84+
Starting v4.12.0, please use the CRDs below
85+
:::
86+
87+
```shell
88+
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
89+
90+
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
91+
92+
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
93+
```
94+
95+
Then, annotate and label these CRDs as below
96+
97+
```shell
98+
kubectl annotate crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io \
99+
meta.helm.sh/release-name=${RELEASE_NAME} \
100+
meta.helm.sh/release-namespace=${RELEASE_NAMESPACE}
101+
kubectl label crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io app.kubernetes.io/managed-by=Helm
102+
```
103+
104+
:::note
105+
CRDs prior to v4.12.0 are below
106+
:::
107+
83108
```shell
84109
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
85110

@@ -108,6 +133,28 @@ kube-prometheus-stack:
108133
enabled: true
109134
```
110135

136+
Starting v4.12.0, please use the configuration below
137+
138+
```yaml
139+
sumologic:
140+
metrics:
141+
collector:
142+
otelcol:
143+
enabled: false
144+
remoteWriteProxy:
145+
enabled: true
146+
147+
kube-prometheus-stack:
148+
prometheus:
149+
enabled: true
150+
prometheusOperator:
151+
enabled: true
152+
153+
opentelemetry-operator:
154+
crds:
155+
create: true
156+
```
157+
111158
## Remove remaining Fluent Bit and Fluentd configuration
112159

113160
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

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,42 @@ By default, the OpenTelemetry Collector is now used for metrics collection inste
3333

3434
Ensure that the following CRDs from the OpenTelemetry operator are installed and updated using the following commands.
3535

36-
##### Instrumentation CRD (relevant for metrics and traces)
36+
:::note
37+
Please follow instructions below to install the appropriate CRD versions
38+
:::
3739

38-
```
39-
kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetryinstrumentation.yaml
40-
```
40+
#### CRDs to install (v4.12.0 and later)
4141

42-
##### OpenTelemetry collector CRD
42+
```shell
43+
kubectl delete crd instrumentations.opentelemetry.io
4344

44-
```
45-
kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetrycollector.yaml
45+
kubectl delete crd opentelemetrycollectors.opentelemetry.io
46+
47+
kubectl delete crd opampbridges.opentelemetry.io
48+
49+
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
50+
51+
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
52+
53+
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
4654
```
4755

48-
##### OpAMP Bridge CRD
56+
Then, annotate and label these CRDs as below
4957

58+
```shell
59+
kubectl annotate crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io \
60+
meta.helm.sh/release-name=${RELEASE_NAME} \
61+
meta.helm.sh/release-namespace=${RELEASE_NAMESPACE}
62+
kubectl label crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io app.kubernetes.io/managed-by=Helm
5063
```
64+
65+
#### CRDs to install (before v4.12.0)
66+
67+
```shell
68+
kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetryinstrumentation.yaml
69+
70+
kubectl apply -f https://raw.githubusercontent.com/open-telemetry/opentelemetry-helm-charts/opentelemetry-operator-0.56.1/charts/opentelemetry-operator/crds/crd-opentelemetrycollector.yaml
71+
5172
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
5273
```
5374

0 commit comments

Comments
 (0)