Skip to content

fix(helm): quickstart deployment command nb of brokers#8090

Merged
leiicamundi merged 6 commits intomainfrom
fix/quickstart-h2
Feb 27, 2026
Merged

fix(helm): quickstart deployment command nb of brokers#8090
leiicamundi merged 6 commits intomainfrom
fix/quickstart-h2

Conversation

@leiicamundi
Copy link
Contributor

@leiicamundi leiicamundi commented Feb 27, 2026

Description

Fix quickstart instructions, related to https://camunda.slack.com/archives/C03UR0V2R2M/p1772126738381749

This pull request updates the quick installation instructions for Camunda 8 using Helm, clarifying the recommended cluster configuration when using the embedded H2 database as secondary storage. The changes ensure users configure a single-broker, single-partition cluster to avoid issues with the local nature of H2, and update the example Helm commands accordingly.

Documentation improvements for Helm installation:

  • Updated the Helm install command examples in quick-install.md to explicitly set orchestration.clusterSize=1, orchestration.partitionCount=1, and orchestration.replicationFactor=1, ensuring a single-broker, single-partition setup when using embedded H2. [1] [2]
  • Expanded the explanation to clarify that multiple brokers with embedded H2 would result in independent databases and incomplete query results, helping users avoid misconfiguration.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.9).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@leiicamundi leiicamundi requested review from a team, Copilot and ingorichtsmeier February 27, 2026 12:34
@leiicamundi leiicamundi self-assigned this Feb 27, 2026
@leiicamundi leiicamundi added kind/bug Issues related with bugs in the documentation affects/8.9 8.9.0 labels Feb 27, 2026
@camunda-docs-pr-automation camunda-docs-pr-automation bot moved this to 👀 In Review in Documentation Team Feb 27, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 27, 2026

👋 🤖 🤔 Hello, @leiicamundi! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.8/.

  • docs/self-managed/deployment/helm/configure/database/elasticsearch/using-external-elasticsearch.md
  • docs/self-managed/deployment/helm/configure/database/using-external-opensearch.md
  • docs/self-managed/deployment/helm/install/quick-install.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@leiicamundi leiicamundi requested review from a team and jessesimpson36 and removed request for a team February 27, 2026 12:34
@leiicamundi leiicamundi added the deploy Stand up a temporary docs site with this PR label Feb 27, 2026
@leiicamundi leiicamundi marked this pull request as ready for review February 27, 2026 12:34
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Helm quick-install documentation to avoid misconfigured multi-broker Orchestration Cluster setups when using embedded H2 as RDBMS secondary storage.

Changes:

  • Updates Helm install command examples to explicitly set orchestration.clusterSize=1, orchestration.partitionCount=1, and orchestration.replicationFactor=1.
  • Expands the explanatory text to describe why embedded H2 requires a single-broker/single-partition setup.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions github-actions bot temporarily deployed to camunda-docs February 27, 2026 12:43 Destroyed
@giorgionaps giorgionaps requested review from giorgionaps and removed request for a team February 27, 2026 12:55
Copy link
Contributor

@giorgionaps giorgionaps left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like some of the updates should be slightly reworded/reconciled with other docs. I'm requesting changes for now

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions github-actions bot temporarily deployed to camunda-docs February 27, 2026 13:13 Destroyed
@leiicamundi
Copy link
Contributor Author

Thanks for the review @giorgionaps - I also edited the outdated pages, and fixed the directions around embedded elasticsearch that is now deprecated in 8.9

Happy to get your counter review!

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions github-actions bot temporarily deployed to camunda-docs February 27, 2026 13:31 Destroyed
jessesimpson36
jessesimpson36 previously approved these changes Feb 27, 2026
Copy link
Contributor

@ingorichtsmeier ingorichtsmeier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

…arch/using-external-elasticsearch.md

Co-authored-by: Christina Ausley <84338309+christinaausley@users.noreply.github.com>
@leiicamundi
Copy link
Contributor Author

Thanks @christinaausley, can you re-approve it so it can be automerge? ty!

auto-merge was automatically disabled February 27, 2026 14:48

Pull request was closed

@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in Documentation Team Feb 27, 2026
@leiicamundi leiicamundi reopened this Feb 27, 2026
@github-project-automation github-project-automation bot moved this from ✅ Done to 🔖 Ready in Documentation Team Feb 27, 2026
@github-actions github-actions bot temporarily deployed to camunda-docs February 27, 2026 14:56 Destroyed
@leiicamundi leiicamundi merged commit 735a224 into main Feb 27, 2026
12 checks passed
@leiicamundi leiicamundi deleted the fix/quickstart-h2 branch February 27, 2026 14:58
@github-project-automation github-project-automation bot moved this from 🔖 Ready to ✅ Done in Documentation Team Feb 27, 2026
@github-actions
Copy link
Contributor

The preview environment relating to the commit 5ac86e2 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-8090/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

8.9.0 affects/8.9 deploy Stand up a temporary docs site with this PR kind/bug Issues related with bugs in the documentation

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

6 participants