feat: enhance Broker HA mode docs by shuaibmunshi · Pull Request #995 · snyk/user-docs

shuaibmunshi · 2026-03-09T01:45:56Z

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 · 2026-03-09T01:46:12Z

✅ 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.

mikeromard · 2026-03-31T19:23:20Z

...enterprise-setup/snyk-broker/universal-broker/deployment-tips-and-reference-architectures.md

@@ -20,6 +20,6 @@ Contact your Snyk account team or [Snyk support](https://support.snyk.io/s/) if

 ### High Availability Mode


High availability mode

mikeromard · 2026-03-31T19:24:05Z

...enterprise-setup/snyk-broker/universal-broker/deployment-tips-and-reference-architectures.md

 ### High Availability Mode

-High Availability Mode for a Universal Broker deployment is enabled by default and can be disabled by by setting the `BROKER_HA_MODE_ENABLED=false` environment variable inside the container. When this mode is enabled, the Universal Broker deployment will support up to four Broker client replicas.
+High Availability Mode for a Universal Broker deployment is enabled by default, the Universal Broker deployment will support up to four Broker client replicas.


High availability (HA) mode for a Universal Broker deployment is enabled by default. The Universal Broker deployment supports up to four Broker client replicas.

mikeromard · 2026-03-31T19:32:59Z

...enterprise-setup/snyk-broker/universal-broker/deployment-tips-and-reference-architectures.md

-High Availability Mode for a Universal Broker deployment is enabled by default and can be disabled by by setting the `BROKER_HA_MODE_ENABLED=false` environment variable inside the container. When this mode is enabled, the Universal Broker deployment will support up to four Broker client replicas.
+High Availability Mode for a Universal Broker deployment is enabled by default, the Universal Broker deployment will support up to four Broker client replicas.

 For more information on High Availability Mode, please refer to the [HA mode documentation page.](../../../implementation-and-setup/enterprise-setup/snyk-broker/high-availability-mode.md)


For more information about HA mode, visit High availability mode.

mikeromard · 2026-03-31T19:34:26Z

...nd-setup/enterprise-setup/snyk-broker/universal-broker/prerequisites-for-universal-broker.md

 * An SCM token or password. Snyk Broker does not support authentication with the mTLS method.
 * Node 20 or higher installed.
-* Docker configured to pull images from Docker Hub in order to install with Docker.
+* Docker Compose install and configured to pull images from Docker Hub.


Is Docker Compose a prerequisite? Elsewhere, we recommend it, but don't seem to require it. Which is correct?

mikeromard · 2026-03-31T19:39:31Z

...nd-setup/enterprise-setup/snyk-broker/universal-broker/prerequisites-for-universal-broker.md


 Linux/Mac

 * `export SNYK_TOKEN=xxxx`


We should replace xxxx with <your_snyk_token> and yyyy with <your_tenant_id>, here and in the Windows commands.

mikeromard · 2026-03-31T19:44:36Z

...-setup/enterprise-setup/snyk-broker/universal-broker/running-your-universal-broker-client.md

+
+### Usage 

+1. Create a .env file with required and optional configuration variables:


Create a .env file with required and optional configuration variables:

mikeromard · 2026-03-31T19:45:09Z

...-setup/enterprise-setup/snyk-broker/universal-broker/running-your-universal-broker-client.md

-e PORT=8000 
-e <YOUR_CREDENTIALS_REFERENCE>=<secret value> 
-snyk/broker:universal
+2. Copy this example file to docker-compose.yaml


Copy this example file to docker-compose.yaml.

mikeromard · 2026-03-31T19:45:26Z

...-setup/enterprise-setup/snyk-broker/universal-broker/running-your-universal-broker-client.md

+      - "${EXTERNAL_PORT_2:-8001}:${PORT:-8000}"
+    restart: unless-stopped
 ```
+3. Run `docker compose up -d` to start the containers


Run docker compose up -d to start the containers.

mikeromard · 2026-04-01T12:12:22Z

docs/implementation-and-setup/enterprise-setup/snyk-broker/high-availability-mode.md

 # High availability mode

-Snyk Broker can bring high availability capabilities to both servers and clients, thus increasing the scalability of the current Broker, initially to support the addition of the “git-clone-through-broker” flow for Snyk Code.
+The Snyk Broker client offers high availability capabilities by default for greater scalability of the Broker, initially to support the addition of the “git-clone-through-broker” flow for Snyk Code.


The Snyk Broker client offers high availability (HA) capabilities for greater scalability of the Broker, initially to support the addition of the “git-clone-through-broker” flow for Snyk Code.

That said, if we're past the point where this is just used for “git-clone-through-broker” for Code, we can remove this sentence altogether. The paragraph that follows it is a good intro to the topic.

mikeromard · 2026-04-01T12:20:06Z

docs/implementation-and-setup/enterprise-setup/snyk-broker/high-availability-mode.md

 <figure><img src="../../../.gitbook/assets/snyk-broker-ha-mode.png" alt="Operation of multiple Broker clients in high availability"><figcaption><p>Operation of multiple Broker clients in high availability</p></figcaption></figure>

-To use high availability mode, deploy more than one replica, either by running more than one container or by increasing the replica count in your Kubernetes deployment. Each container must have the exact same parameters.
+To use high availability mode, we recommend using docker-compose to run multiple replicas (see example here) or by increasing the replica count in your Kubernetes deployment. Each container must have the exact same parameters.


"Docker Compose", not "docker-compose". We're also missing a link to the example.

feat: wip broker ha docs

0b9e5e3

chore: clarity updates for broker client docker compose

17a22d0

skyth3r changed the title ~~feat: wip broker ha docs~~ feat: enhance Broker HA mode docs Mar 9, 2026

skyth3r marked this pull request as ready for review March 9, 2026 16:24

skyth3r requested review from a team as code owners March 9, 2026 16:24

chore: add .vscode/settings.json to .gitignore

afb269f

skyth3r force-pushed the feat/update-broker-ha-docs branch from b852732 to afb269f Compare March 10, 2026 15:17

mikeromard requested changes Apr 1, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: enhance Broker HA mode docs#995

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

shuaibmunshi commented Mar 9, 2026 •

edited by skyth3r

Loading

Uh oh!

snyk-io bot commented Mar 9, 2026 •

edited

Loading

Uh oh!

mikeromard Mar 31, 2026

Uh oh!

mikeromard Mar 31, 2026 •

edited

Loading

Uh oh!

mikeromard Mar 31, 2026

Uh oh!

mikeromard Mar 31, 2026

Uh oh!

mikeromard Mar 31, 2026

Uh oh!

mikeromard Mar 31, 2026

Uh oh!

mikeromard Mar 31, 2026

Uh oh!

mikeromard Mar 31, 2026

Uh oh!

mikeromard Apr 1, 2026

Uh oh!

mikeromard Apr 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -20,6 +20,6 @@ Contact your Snyk account team or [Snyk support](https://support.snyk.io/s/) if

		### High Availability Mode


		### Usage

		1. Create a .env file with required and optional configuration variables:

Conversation

shuaibmunshi commented Mar 9, 2026 • edited by skyth3r Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snyk-io bot commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikeromard Mar 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

shuaibmunshi commented Mar 9, 2026 •

edited by skyth3r

Loading

snyk-io bot commented Mar 9, 2026 •

edited

Loading

mikeromard Mar 31, 2026 •

edited

Loading