Skip to content

feat: enhance Broker HA mode docs#995

Open
shuaibmunshi wants to merge 3 commits intomainfrom
feat/update-broker-ha-docs
Open

feat: enhance Broker HA mode docs#995
shuaibmunshi wants to merge 3 commits intomainfrom
feat/update-broker-ha-docs

Conversation

@shuaibmunshi
Copy link
Contributor

@shuaibmunshi shuaibmunshi commented Mar 9, 2026

Enchances the Snyk Broker documentation surrounding High Availability (HA) mode to provide better gudiance for running multiple instances of the Broker Client and adding an example Docker Compose file for deployments

High Availability Mode documentation updates:

  • Clarified that high availability mode is enabled by default, supportng up to four Broker client replicas (deployment-tips-and-reference-architectures.md)
  • Updated description to recommended Docker Compose for running multiple replicas, and removed instructions for enabling HA mode via environment variables or Helm arguments. (high-availability-mode.md)
  • Improved explanation of required settings, emphasising that all Broker clients in an HA set must share the same BROKER_CLIENT_URL and BROKER_TOKEN. (high-availability-mode.md)

Prerequisites and deployment guidance:

  • Changed prerequisites to recommend Docker Compose installation and configuration, instead of just Docker, and clarified environment variable naming. (prerequisites-for-universal-broker.md)

Running the Universal Broker client:

  • Added a detailed section on running the Broker client and guidance for Helm deployments. (running-your-universal-broker-client.md)

@snyk-io
Copy link

snyk-io bot commented Mar 9, 2026

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@skyth3r skyth3r changed the title feat: wip broker ha docs feat: enhance Broker HA mode docs Mar 9, 2026
@skyth3r skyth3r marked this pull request as ready for review March 9, 2026 16:24
@skyth3r skyth3r requested review from a team as code owners March 9, 2026 16:24
@skyth3r skyth3r force-pushed the feat/update-broker-ha-docs branch from b852732 to afb269f Compare March 10, 2026 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants