diff --git a/.chloggen/operator-instrumentation-update.yaml b/.chloggen/operator-instrumentation-update.yaml new file mode 100644 index 0000000000..52756797fb --- /dev/null +++ b/.chloggen/operator-instrumentation-update.yaml @@ -0,0 +1,12 @@ +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: breaking +# The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other) +component: operator +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Operator Helm values previously under `.Values.operator.instrumentation.spec.*` have been moved to `.Values.instrumentation.*` +# One or more tracking issues related to the change +issues: [1436] +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: If you use custom values under `.Values.operator.instrumentation.spec.*` please review the [upgrade guidelines](https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#01055-01080) diff --git a/UPGRADING.md b/UPGRADING.md index 8c4250a70d..774f3e5f49 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -1,5 +1,37 @@ # Upgrade guidelines +## 0.105.5 to 0.108.0 + +We've simplified the Helm chart configuration for `operator` auto-instrumentation. +The values previously under `.Values.operator.instrumentation.spec.*` have been moved to `.Values.instrumentation.*`. + +- **No Action Needed**: If you have no customizations under `.Values.operator.instrumentation.spec.*`, no migration is required. +- **Action Required**: Continuing to use the old values path will result in a Helm install or upgrade error, blocking the process. + +Migration Steps: + +1. **Find** any references to `.Values.operator.instrumentation.spec.*` in your Helm values with custom values. +2. **Migrate** them from `.Values.operator.instrumentation.spec.*` to `.Values.instrumentation.*`. + +Example Migration: + +Before (Deprecated Path): + +```yaml +operator: + instrumentation: + spec: + endpoint: XXX + ... +``` + +After (Updated Path): +```yaml +instrumentation: + endpoint: XXX + ... +``` + ## 0.105.3 to 0.105.4 The `Java instrumentation` for Operator auto-instrumentation has been upgraded from v1.32.2 to v2.7.0.