Snyk integration to self-hosted container registries

Integration with private container registries allows you to:

• Keep sensitive data such as your access tokens inside your private network, never sharing that information with Snyk.
• Provide controlled access to the network by Snyk, limiting Snyk access and the actions that Snyk can perform.
  

• Broker server: running on Snyk SaaS backend
• Broker client & Container Registry Agent: Two Docker images deployed in your infrastructure, creating two separate services, responsible for sampling your container registries in a secured manner and sending the allowed information to Snyk.

The Broker client provides the Agent with the connection details. The Agent uses these details to connect to the container registry, scan the images, and send the scan results through the brokered communication using callbacks. The brokered communication happens when a Broker Client connects (using your Broker ID) to a Broker server which runs in Snyk environment. See Snyk Broker documentation for more details.  

• Artifactory (type: artifactory-cr)
• Harbor (type: harbor-cr)
• Azure (type: acr)
• GCR (type: gcr)
• Docker Hub (type: docker-hub)
• Quay (type: quay-cr)
• Nexus (type: nexus-cr)
• GitHub (type: github-cr)
• DigitalOcean (type: digitalocean-cr)
• GitLab (type: gitlab-cr)

• Broker Client machine system requirements: 1 CPU, 256MB of Ram.
• Container registry agent machine system requirements should be (given MAX_ACTIVE_OPERATIONS=1):
  
  • CPU: 1 vcpu
  • Memory: 2Gb (should be reflected in node memory setting)
  • Storage: 5Gb
• Docker configured to pull components images from Docker Hub
• Connection between broker and agent
• Agent image can be found for download here
• Broker Client image can be found for download here

To use the Broker client with a container registry agent deployment, run
`docker pull snyk/broker:container-registry-agent`. 

There are different environment variable required to configure the Broker client, which differ between some of the container registries.

The following environment variables are mandatory to configure the Broker client.

For DigitalOcean, GCR and Google Artifact Registry, there are a few values to notice. Specifications to follow. 

• `BROKER_TOKEN`- The Snyk Broker token, obtained from your Container registry integration (provided by Snyk support)
• `BROKER_CLIENT_URL` - The URL of your broker client (including scheme and - port) used by the container registry agent to call back to Snyk, for example: "http://my.broker.client:8000".
• `CR_AGENT_URL` - The URL of your container registry agent, for example "http://my.container-registry-agent".
• `CR_TYPE` - The container registry type as listed in supporter registries, for example "docker-hub", "gcr", "artifactory-cr".
• `CR_BASE` - The hostname of the container registry api to connect to, for example: "cr.host.com".
• `CR_USERNAME` - The username for authenticating to container registry api. 
• `CR_PASSWORD` - The password for authenticating to container registry api. 
• `PORT` - The local port at which the Broker client accepts connections. Default is 7341.

DigitalOcean

To set up Broker Client for DigitalOcean,`CR_USERNAME` and `CR_PASSWORD` are not required. Instead, you need to specify `CR_TOKEN` - authentication token for DigitalOcean container registry.

GCR and Google Artifact Registry

To set up the Broker Client for those container registries, all the above applies.  The only thing to note is that `CR_USERNAME` value is permanent and should be _json_key, and the `CR_PASSWORD` value should be the JSON key used to authenticate to google. 

To run the docker container, provide the relevant configuration:

docker run --restart=always \
       -p 8000:8000 \
       -e BROKER_TOKEN="<secret-broker-token>" \
       -e BROKER_CLIENT_URL="<broker-client-url>" \
       -e CR_AGENT_URL="<agent-url>" \
       -e CR_TYPE="<cr-type>" \
       -e CR_BASE="<cr-hostname>" \
       -e CR_USERNAME="<username>" \
       -e CR_PASSWORD="<password>" \
       -e PORT=8000 \
       snyk/broker:container-registry-agent

The container registry agent can be pulled from Docker Hub using the link provided above in the settings prerequisites. To run the image you can use a single env variable for specifying the port:

docker run --restart=always \
       -p 8081:8081 \
       -e SNYK_PORT=8081 \
       snyk/container-registry-agent:latest

You can use the `/systemcheck` endpoint to verify connectivity between the Broker Client, the Container Registry Agent, and your container registry.

In order to use it, specify the following environment variable when running the broker client:
BROKER_CLIENT_VALIDATION_URL = "<agent-url>/systemcheck"

You can now start scanning your container images directly from your private registry. See scanning images from container registry (Artifactory example) for more details.