Initial configuration of the Universal Broker

The high-level steps in implementing the Universal Broker are the same regardless of the configuration method you use. Using the Snyk Broker snyk-broker-config command walks you through these steps, easing the onboarding, while direct API calls require a better understanding of the overall Universal Broker models. The steps follow:

• One time: Install the Snyk Broker App iin your Organization. This returns an install ID, a client ID, and a client secret, all needed to interact with the Snyk platform. The Organization ID is required to create the deployment.

• One time: Define a deployment for your tenant ID and install ID.

• One time: Define credentials references needed for your connections.

• One time: Define your desired connection or connections.

• One time for each Organization integration: Configure the Organizations and integrations that should use the connection.

Illustration of steps in implementing the Universal Broker

Configuration using the snyk-broker-config command (recommended)

Follow these steps to configure the Universal Broker using the snyk-broker-config command.

To use this command, you must install Node 18 or higher.

1. Run npm i -g snyk-broker-config.

2. Set the necessary environment variables:

   • SNYK_TOKEN if not already set

   • SNYK_API_HOSTNAME if not targeting https://api.snyk.io, for example,export SNYK_API_HOSTNAME=https://api.eu.snyk.io

3. Set more environment variables as needed to ensure the experience proceeds smoothly:

   • TENANT_ID so you do not have to enter it on every command

   • INSTALL_ID if you have one, otherwise the tool will walk you through the installation process

4. Run snyk-broker-config commands to list the available commands.

5. Run snyk-broker-config workflows to list the available interactive workflows.

6. Create a deployment.

   • Run snyk-broker-config workflows deployments create.

   • Add any metadata key-value pair or pairs that are needed.

   • Optional: When the workflow deployment has been created, view your deployment using snyk-broker-config workflows deployments get.

7. Create and configure your connection or connections.

   • Run snyk-broker-config workflows connections create to create a connection.

   • In response to the prompt Which Deployment do you want to use?, select your deployment from the list presented.

   • In response to the prompt Which Connection type do you want to create?, select the type of connection you want to create from the list pesented. Options include artifactory-cr, docker-hub, gcr, github-cr, gitlab-cr and so on.

   • Provide the configuration for each required field in response to the prompts:

     • Enter a human-friendly name for your connection. Note that no spaces are allowed.

     • Enter the broker_client-url.

     • Enter the credential reference or choose the option CreateNew in response to a prompt like github-token (Sensitive): Which Credential Reference do you want to use? Or create New?

   • When you see the messages Connection created and Ready to configure integrations to use this connection, you can run the Broker client.

8. After the connection is created, use snyk-broker-config workflows connections integrate to configure an integration to use the newly created connection. In response to the prompts, enter the deployment you want to use, the connection you want to use, the OrgID of the Organization you want to integrate, and the integration ID of the type github.

Example: first-time configuration of a new connection

1. Start by creating the first-time setup and connection, as explained in the preceding section. See the First time setup and connection recording.

2. Integrate your connection with an Organization ID and Integration ID. See the Integration recording.

3. List the Organization IDs and integration IDs for your connection. See the List Organization IDs and integration IDs recording.

4. Run the Broker client.

Run your Broker deployment on your container engine or Kubernetes cluster

Target your desired environment with the usual -e BROKER_SERVER_URL=https://broker, REGION.snyk.io \ if you are not using broker.snyk.io.

docker run --restart=always \ -p 8000:8000 \ -e ACCEPT_CODE=true \ -e DEPLOYMENT_ID=<DEPLOYMENTID> \ -e CLIENT_ID=<CLIENTID> \ -e CLIENT_SECRET=<CLIENTSECRET> \ -e UNIVERSAL_BROKER_ENABLED=true \ -e PORT=8000 \ -e BROKER_HA_MODE_ENABLED=true \ snyk/broker:universal