docs: clarify disabling Optimize/legacy exporter requires an actuator disable#6455
Open
eamonnmoloney wants to merge 2 commits into
Open
docs: clarify disabling Optimize/legacy exporter requires an actuator disable#6455eamonnmoloney wants to merge 2 commits into
eamonnmoloney wants to merge 2 commits into
Conversation
…able Disabling Optimize (or orchestration.exporters.zeebe.enabled) only removes the legacy Elasticsearch/OpenSearch exporter from the broker's static config. The broker's dynamic-config reconciliation runs only on partition leaders and relies on gossip to converge; if it does not, the exporter can stay stuck in UNKNOWN/CONFIG_NOT_FOUND, halting log compaction and growing the Zeebe PVC (SUPPORT-33221). Document the required follow-up actuator disable + how to verify convergence in the 8.8, 8.9 and 8.10 chart READMEs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Per crev review: name the minimum patch version that includes the camunda/camunda#52260 reconciliation fix in the 8.9 and 8.10 notes, matching the 8.8 note (8.8.25). Fixed versions per the issue labels: 8.9.3 and 8.10.0-alpha2 (present in all 8.10.x releases). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds prominent operator-facing documentation to clarify that disabling Optimize (or disabling the legacy Zeebe Elasticsearch/OpenSearch exporter) via Helm values only removes the exporter from Zeebe’s static configuration, and may still require an explicit actuator disable on each broker to stop the running exporter and avoid PVC growth in non-converging clusters.
Changes:
- Add an
[!IMPORTANT]warning explaining static-vs-dynamic exporter configuration behavior and the potential for non-convergence. - Document the required actuator calls (
POST /actuator/exporters/{elasticsearch|opensearch}/disable, verify viaGET /actuator/exporters) and reference the upstream fix (#52260) with version guidance. - Apply the note consistently across the 8.8, 8.9, and 8.10 chart READMEs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| charts/camunda-platform-8.8/README.md | Adds an Important note describing the required actuator disable when removing the legacy exporter via values. |
| charts/camunda-platform-8.9/README.md | Same Important note, including the upstream fix reference/version note for 8.9. |
| charts/camunda-platform-8.10/README.md | Adds the same Important note alongside existing 8.10 Important notices. |
Ian-wang-liyang
approved these changes
Jun 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which problem does the PR fix?
Follow-up to SUPPORT-33221 ("PVC usage grows, is the exporter disfunctional?") and the broker defect camunda/camunda#52260.
A customer did a within-8.8 chart upgrade and disabled Optimize in the same step. The chart correctly removed the legacy Elasticsearch exporter from the broker's static config (
hasLegacyElasticsearchExporteris gated onoptimize.enabled, so disabling Optimize drops the exporter). However, the broker's dynamic cluster-configuration reconciliation (ExporterStateInitializer) runs only on partition leaders and relies on gossip to propagate to the remaining brokers. In this cluster one broker never took leadership and gossip did not converge, so the legacy exporter stayedENABLEDon that broker while the others moved it toCONFIG_NOT_FOUND. The aggregated state wasUNKNOWN,exportedPositionstayed at-1, log compaction was blocked, and the Zeebe PVC grew for ~72h. It was resolved manually withPOST /actuator/exporters/elasticsearch/disable.This is a broker-side defect (fixed in 8.8.25 via #52260), not a chart defect — the chart does the right thing by removing the static config. The actionable gap on the Helm side is documentation: nothing in
charts/ordocs/told operators that disabling Optimize/the legacy exporter via values does not stop the running exporter and that an explicit actuator disable is required.The same coupling exists in 8.8, 8.9, and 8.10 (the
hasLegacyElasticsearchExporter/hasLegacyOpenSearchExporterhelpers all includeoptimize.enabled), and #52260 affects all versions since 8.6, so the note is added to all three chart READMEs.What's in this PR?
Adds an
[!IMPORTANT]note to the intro of the 8.8, 8.9, and 8.10 chart READMEs explaining that:optimize.enabled/orchestration.exporters.zeebe.enabledonly removes the legacy exporter from static config;POST /actuator/exporters/{elasticsearch|opensearch}/disableper broker and verify withGET /actuator/exporters;Docs-only; no template/values/golden changes. The intro is hand-maintained content, so
make helm.readme-update(which only regenerates the parameter tables) does not affect it.Checklist
Before opening the PR:
make go.update-golden-only.After opening the PR: