helm-chart-snyk-broker

Helm chart used to deploy a Snyk Broker into Kubernetes. Currently only supports GitLab as the SCM.

Requirements

This chart requires already having generated a Snyk Broker token and GitLab token.

Installing the Chart

To install the chart with the release name my-broker-release:

helm upgrade [-i] --name my-broker-release . -f <your-config-file>.yaml

Uninstalling the Chart

To uninstall the my-broker-release deployment:

helm delete my-broker-release

Configuration

The following table lists the configurable parameters of the Event Exporter chart and their default values.

Parameter	Description	Default value
name	Release name	snyk-broker
image.tag	Broker image tag	4.71.0-gitlab
image.repository	Image repository	snyk/broker
image.pullPolicy	Image pull policy	IfNotPresent
replicas	Desired number of Broker pods	1
resources	Broker pod CPU/memory resource requests/limits	{requests: {cpu: 200m, memory: 200Mi}, limits: {cpu: 300m, memory: 300Mi }}
gitlab.url	Hostname of your GitLab deployment	None
gitlab.token	GitLab personal access token with api scope	None
gitlab.useExistingSecret	Whether a GitLab token secret already exists, if set to false one will be automatically generated	false
gitlab.secretName	GitLab token secret name	gitlab-token
gitlab.secretKey	Key under which the GitLab token is found in the secret	token
broker.url	The address at which the Broker client will be accessible	None
broker.token	Snyk Broker token	None
broker.useExistingSecret	Whether a Broker token secret already exists, if set to false one will be automatically generated	false
broker.secretName	Broker token secret name	broker-token
broker.secretKey	Key under which the Broker token is found in the secret	token
ca	Location (within the Broker image) to provide an internal CA certificate.	None
deployment.annotations	Deployment annotations	{}
deployment.labels	Deployment labels	{}
service.type	Kubernetes service type	ClusterIP
service.port	Kubernetes service port	8000
service.targetPort	Kubernetes service target port, the PORT environment variable in Broker will also be set to this value	8000
service.nodePort	Kubernetes service node port	None
service.annotations	Kubernetes service annotations	{}
service.labels	Kubernetes service labels	{}
ingress.enabled	Enables Ingress	false
ingress.annotations	Ingress annotations	{}
ingress.labels	Ingress labels	{}
ingress.hosts	Ingress host names	None
ingress.tls	Ingress TLS configurations	None