README.md

benthos-helm-chart

This chart is a WIP, and isn't yet intended for production workloads. Please feel free to test and provide feedback, report bugs, and/or contribute!

Repository

To add this repo:

helm repo add benthos https://difabion.github.io/benthos-helm-chart/

Then helm search repo benthos for all charts.

Configuration

Common Parameters

Name	Description	Value
image.repository	Docker image repository	jeffail/benthos
image.pullPolicy	Docker image pull policy	IfNotPresent
image.tag	Docker image tag override	""
imagePullSecrets	Docker registry secrets array	[]
service.type	Kubernetes service type	ClusterIP
service.ports	Kubernetes service ports	[]

Benthos Parameters

For more information on configuring the HTTP component, refer to the Benthos HTTP component documentation.

Name	Description	Value
http.enabled	Enables the HTTP server component	true
http.address	HTTP server component binding address	0.0.0.0:4195
http.readTimeout	HTTP server component read timeout	5s
http.rootPath	General Benthos HTTP endpoint prefix	/benthos
http.debugEndpoints	Enables debugging endpoints	false
http.cors.enabled	Enables Cross-Origin Resource Sharing	false
http.cors.allowedOrigins	Allowed source domains for CORS	""
http.tls.enabled	Enables TLS for all Benthos endpoints	false
http.tls.secretName	kubernetes.io/tls secret name	""
extraVolumes	Additional volumes for configMaps and secrets	[]
extraVolumeMounts	Additional volumeMounts for configMaps and secrets	[]
streams.enabled	Enables 'Benthos streams' mode	false
streams.streamsConfigMap	Name of K8s configMap containing streams configs	""
streams.api.enable	Enables streams API	true
config	Benthos component configuration	""

Config

The config parameter should contain the configuration as it would be parsed by the Benthos binary.

For example, the default Helm chart config block looks like this:

# /benthos.yaml configuration
config: |-
  input:
    label: "no_config_in"
    generate:
      mapping: root = "This Benthos instance is unconfigured!"
      interval: 1m
  output:
    label: "no_config_out"
    stdout:
      codec: lines

Adding an http block here is not recommended, please use the Helm directives described above.

TLS

Benthos can be instructed to serve all endpoints exlusively over HTTPS. This means that TLS configured in this way is not terminated at an ingress controller, but handled "end-to-end" at the container/binary. Prerequisites to enable TLS:

• Set service.port to 443 in values.yaml
• Create a Kubernetes secret in the targeted namespace of type kubernetes.io/tls

When TLS is enabled, the Kubernetes readiness and liveness probes will operate over HTTPS to the same container port (default 4195).

Streams mode

When running Benthos in streams mode, all configuration files should be placed in a single Kubernetes configMap, like so:

apiVersion: v1
kind: ConfigMap
metadata:
  name: benthos-streams
data:
  hello.yaml: |
    input:
      generate:
        mapping: root = "hello"
        interval: 5s
        count: 0
    output:
      stdout:
        codec: lines
  aaaaa.yaml: |
    input:
      generate:
        mapping: root = "AAAAAAAAAA"
        interval: 2s
        count: 0
    output:
      stdout:
        codec: lines

Note: This exposes a streams API where configuration can be viewed and altered.

As of benthos version 3.61.0, the streams API can be disabled to prevent changes to the configuration[s] of a running Benthos in streams mode via config files; use .Values.streams.api.enabled = false to toggle the API off.

For this chart, the stream fields configurations should go in the configMap while the shared fields go in the config block (with the exception of HTTP server configs, which are covered by the http block).

From the benthos streams --help context:

In streams mode the stream fields of a root target config (input, buffer,
      pipeline, output) will be ignored. Other fields will be shared across all
      loaded streams (resources, metrics, etc).