Install and configure Broker using Helm
Snyk Broker is an open-source tool that acts as a proxy between Snyk and special integrations, providing for access to your code by snyk.io to scan it and return results to you. SCM integrations with Broker support Snyk Open Source, Snyk Code, Snyk Container (Dockerfile), and Snyk IaC. For details about Snyk Broker, including how it works, how to deploy it, commit signing, upgrading, and troubleshooting, see the Snyk Broker user documentation.
If you are using Kubernetes, Snyk recommends that you install Snyk Broker with the Broker Helm Chart. For details, see the instructions for each integration listed in the section that follows, "Installation using the Snyk Broker Helm Chart".
For all other environments, you can install Snyk Broker using the Docker images provided by Snyk. For details, see Install and configure Broker using Docker.
Installation using the Snyk Broker Helm Chart
Multi-tenant settings for EU and AU
When you set up Broker, Code Agent, or both for use in EU or AU Multi-tenant environments, additional environment variables with the specific URLs are required.
Example: -e BROKER_SERVER_URL=https://broker.eu.snyk.io
For the URLs, see EU and AU account datacenter creation.
NOTE The Helm chart does not manage connectivity, and thus you will be responsible for managing ingress in the Kubernetes cluster.
To use this chart, you must first add the Snyk Broker Helm Chart by adding the repo:
helm repo add snyk-broker https://snyk.github.io/snyk-broker-helm/
Then run the commands for each SCM, registry, or Jira as explained in the user documentation:
GitHub
scmType:github-comGitHub Enterprise
scmType:github-enterpriseBitbucket Server/Data Center
scmType:bitbucket-serverGitLab
scmType:gitlabAzure Repos
scmType:azure-reposJFrog Artifactory
scmType:artifactoryNexus 3
scmType:nexusNexus 2
scmType:nexus2Jira
scmType:jira
Running the commands for each SCM, registry, or Jira creates a namespace called snyk-broker. To deploy into an existing namespace, adjust the -n parameter and delete the --create-namespace parameter. See also Deploying multiple Brokers in the same namespace.
Additional commands are available to Install the Snyk Broker Code Agent and Container Registry Agent.
Snyk Broker Code Agent (needed to enable SAST analysis)
Snyk Broker - Container Registry Agent (needed to connect to Container Registries;
scmType:container-registry-agent\)
You can verify that the Broker is running by looking at the settings for your brokered integration in the Snyk Web UI to see a confirmation message that you are connected. You can start importing Projects once you are connected.
Set advanced parameters for Snyk Broker using the Helm Chart
When you set up Snyk Broker using Helm, you can set advanced parameters as explained on the following pages:
Last updated
Was this helpful?