From 4ce31ecaead674dce94db239a4bbeea18d9809b4 Mon Sep 17 00:00:00 2001 From: Jina Jain Date: Fri, 17 Jan 2025 13:01:21 -0800 Subject: [PATCH 1/3] [chore] add upgrade guide --- UPGRADING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/UPGRADING.md b/UPGRADING.md index 41f83040dd..943f9ea01b 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,5 +1,20 @@ # Upgrade guidelines +## 0.113.0 to 0.116.0 + +Chart version 0.116.0 introduces a localized subchart for installing CustomResourceDefinitions (CRDs) for the OpenTelemetry Operator and by default disables the installation of CRDs from the upstream `opentelemetry-operator` chart by setting the argument `operator.crds.create` to `false`. These changes are made to ensure that new installs of the Splunk OpenTelemetry Collector chart use Helm's CRD installation mechanism, which is more reliable and less error-prone than the previous method which treated CRDs as regular Kubernetes resources causing issues with Helm not recognizing the new resource types at install time. + +Existing installations of the Splunk OpenTelemetry Collector chart that are being upgraded from versions prior to 0.116.0 and have the operator enabled (`operator.enabled=true`), can keep the operator related CRDs installed by explicitly setting the option `operator.crds.create` to `true`. + +Example custom values yaml to keep the operator related CRDs installed: +```yaml +operator: + enabled: true + crds: + create: true + ... +``` + ## 0.105.5 to 0.108.0 We've simplified the Helm chart configuration for `operator` auto-instrumentation. From d222ed7b815f4e2de21c16ae2c6fd6ab78b05d25 Mon Sep 17 00:00:00 2001 From: Jina Jain Date: Fri, 17 Jan 2025 13:16:19 -0800 Subject: [PATCH 2/3] add helm upgrade example --- UPGRADING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/UPGRADING.md b/UPGRADING.md index 943f9ea01b..b4053ce38b 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -15,6 +15,14 @@ operator: ... ``` +Example helm upgrade command: +```bash + +helm upgrade my-splunk-otel-collector splunk-otel-collector/splunk-otel-collector \ +--values custom-values.yaml \ +--set operator.crds.create=true +``` + ## 0.105.5 to 0.108.0 We've simplified the Helm chart configuration for `operator` auto-instrumentation. From ffb8a16c75462678cce58b50e8449792fa400239 Mon Sep 17 00:00:00 2001 From: Jina Jain Date: Fri, 17 Jan 2025 13:18:29 -0800 Subject: [PATCH 3/3] add helm upgrade example --- UPGRADING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/UPGRADING.md b/UPGRADING.md index b4053ce38b..f7a8181e46 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -7,6 +7,7 @@ Chart version 0.116.0 introduces a localized subchart for installing CustomResou Existing installations of the Splunk OpenTelemetry Collector chart that are being upgraded from versions prior to 0.116.0 and have the operator enabled (`operator.enabled=true`), can keep the operator related CRDs installed by explicitly setting the option `operator.crds.create` to `true`. Example custom values yaml to keep the operator related CRDs installed: + ```yaml operator: enabled: true @@ -16,8 +17,8 @@ operator: ``` Example helm upgrade command: -```bash +```bash helm upgrade my-splunk-otel-collector splunk-otel-collector/splunk-otel-collector \ --values custom-values.yaml \ --set operator.crds.create=true