Install and configure Broker using Helm
Before starting installation, review the Prerequisites and other information on the page Prepare Snyk Broker for deployment.
If you are using Kubernetes, Snyk recommends that you install Snyk Broker with the 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.
Multi-tenant settings for regions other than the default When you set up Snyk Broker for use in regions other than the default, additional environment variables with specific URLs are required. For the URLs and examples, see Regional hosting and data residency, Broker URLs.
Install using the Snyk Broker Helm Chart
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 to customize the environment variables for each SCM, registry, or Jira as explained on the following pages:
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
scmType designates the system type. For JFrog and Nexus, this is an artifact repository, For Jira, it is a ticket management system.
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.
Beginning with version 2.0.0, all created objects have a suffix based on the release name, allowing for multiple Brokers in the same namespace. For backward compatibility, 2.1.0 introduces a disableSuffixes flag to revert to the 1.x.x behavior by adding --set disableSuffixes=true.
Additional commands are available to install 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.
Advanced configuration using Helm
You can pass any environment variable of your choice in the Helm command. For details, see Custom additional options for Broker Helm Chart.
For example, if you want to pass BROKER_CLIENT_VALIDATION_URL using the Helm chart, the additional parameters would be:
--set env[0].name=BROKER_CLIENT_VALIDATION_URL \
--set env[0].value=whatever_value_makes_sense
Additional parameters would be:
--set env[1].name=MY_OTHER_ENV_VAR \
--set env[1].value="other env with spaces" \
--set env[2].name=THIRD_ENV_VAR \
--set env[2].value=and_so_on
Follow the instructions for Advanced configuration for Helm Chart installation to make configuration changes as needed.
Last updated