Install Broker for Container Registry Agent using Helm

Installing the Broker Container Registry Agent using Docker requires the parameter CR_AGENT_URL, but it is not required to install using Helm. The environment variables are defined for installing with Docker and apply also to installing with Helm.

You must include an accept.json file for this deployment. Copy the new accept.json to the /snyk-broker folder

helm install snyk-broker-chart snyk-broker/snyk-broker \
             --set scmType=container-registry-agent \
             --set brokerClientUrl=http://container-registry-agent-broker-service:8000 \
             --set brokerToken=<ENTER_BROKER_TOKEN> \
             --set crType=<ENTER_CR_TYPE> \
             --set crBase=<ENTER_CR_BASE_URL> \
             --set crUsername=<ENTER_CR_URSERNAME> \
             --set crPassword=<ENTER_CR_PASSWORD> \
             --set acceptJsonFile=accept.json \
             -n snyk-broker --create-namespace

Allowed values for crType:

artifactory-cr harbor-cr acr gcr docker-hub quay-cr nexus-cr github-cr ecr digitalocean-cr

Elastic Container Registry and Digital Ocean Container Registry require specific parameters as explained in the sections that follow.

Elastic Container Registry (ecr)

  • crRoleArn

  • crRegion

  • crExternalId

helm install snyk-broker-chart snyk-broker/snyk-broker \
             --set scmType=container-registry-agent \
             --set brokerClientUrl=http://container-registry-agent-broker-service:8000 \
             --set brokerToken=<ENTER_BROKER_TOKEN> \
             --set crType=ecr \
             --set crRoleArn=<ENTER_CR_ROLE_ARN> \
             --set crRegion=<ENTER_CR_REGION> \
             --set crExternalId=<ENTER_CR_EXTERNAL_ID> \
             --set acceptJsonFile=accept.json \
             -n snyk-broker --create-namespace

DigitalOcean Container Registry (digitalocean-cr)

  • crToken

helm install snyk-broker-chart snyk-broker/snyk-broker \
             --set scmType=container-registry-agent \
             --set brokerClientUrl=http://container-registry-agent-broker-service:8000 \
             --set brokerToken=<ENTER_BROKER_TOKEN> \
             --set crType=digitalocean-cr \
             --set crBase=<ENTER_CR_BASE_URL> \
             --set crToken=<ENTER_CR_TOKEN> \
             --set acceptJsonFile=accept.json \
             -n snyk-broker --create-namespace

Last updated

Was this helpful?

#4707: More info: Update pricing plans page

Change request updated