Skip to content
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.

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

[chore] add upgrade guide #1621

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,29 @@
# 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
...
```

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.
Expand Down
Loading