Helm values reference#

This section describes the values that can be passed to the chart on deployment.

Global#

The following values are of various uses.

Name

Description

Default value

nameOverride

Override for the chart name. Only takes effect if the provided input is not empty.

""

fullnameOverride

Override for the chart full name. Only takes effect if the provided input is not empty.

""

Docker images#

The following values are used to configure which and how Docker images are pulled by the deployments.

Name

Description

Default value

images.registry

Docker registry through which to get the images.

gitea.teapots.fr/teapots-packages

images.pullSecrets

Docker pull secrets to get the images.

[]

images.tag

Tag to use for all pulled Docker images.

latest

images.repositories.webListener

Repository to use for the TeaL Web Listener.

teal-web-listener

images.repositories.websocketDispatcher

Repository to use for the TeaL Websocket Dispatcher.

teal-websocket-dispatcher

Note

You can replace any of the TeaL applications with other applications that are compatible in terms of deployment. An example is if you have integrated the TeaL Web Listener into a website, and accept the same environment variables.

Message queues#

The following values are used to configure which and how the message queuing service is used by the TeaL applications.

Name

Description

Default value

messages.amqp.url

URI used to connect to the AMQP compatible service. See AMQP_URL for more information.

amqp://rabbitmq:5672/

messages.amqp.exchangePrefix

Prefix to add to the AMQP exchange names. See AMQP_EXCHANGE_PREFIX for more information.

""

Redis#

The following values are used to configure which and how the Redis service is used by the TeaL applications.

Name

Description

Default value

redis.url

URI used to connect to the Redis service. See REDIS_URL for more information.

redis://redis:6379/0

TeaL Web Listener#

The following values are used to configure the TeaL Web listener.

Name

Description

Default value

webListener.settings

Configuration array for the application.

Values can be provided as a string, or as a dictionary defining either configMapKeyRef or secretKeyRef.

{}

The following values are used to configure the service for the TeaL Web listener.

Name

Description

Default value

webListener.service.type

Kubernetes service type for the application’s traffic.

ClusterIP

webListener.service.port

Port number for the application’s traffic.

80

The following values are used to configure the ingress for the TeaL Web listener.

Name

Description

Default value

webListener.ingress.enabled

Whether to make an ingress for the application.

false

webListener.ingress.className

Class name for the ingress.

""

webListener.ingress.annotations

Annotations to add to the ingress.

{}

webListener.ingress.hosts

Hosts configuration for the ingress.

 
- host: web-listener-example.local
  paths:
    - path: /
      pathType: ImplementationSpecific

webListener.ingress.tls

TLS configuration for the ingress.

[]

TeaL Websocket Dispatcher#

The following values are used to configure the TeaL Websocket Dispatcher.

Name

Description

Default value

websocketDispatcher.settings

Configuration array for the application.

Values can be provided as a string, or as a dictionary defining either configMapKeyRef or secretKeyRef.

 
PASSWORD:
  secretKeyRef:
    name: teal-secrets
    key: websocket-dispatcher-password

The following values are used to configure the service for the TeaL Websocket Dispatcher.

Name

Description

Default value

webListener.service.type

Kubernetes service type for the application’s traffic.

ClusterIP

webListener.service.port

Port number for the application’s traffic.

80

The following values are used to configure the ingress for the TeaL Websocket Dispatcher.

Name

Description

Default value

websocketDispatcher.ingress.enabled

Whether to make an ingress for the application.

false

websocketDispatcher.ingress.className

Class name for the ingress.

""

websocketDispatcher.ingress.annotations

Annotations to add to the ingress.

{}

websocketDispatcher.ingress.hosts

Hosts configuration for the ingress.

 
- host: websocket-dispatcher-example.local
  paths:
    - path: /
      pathType: ImplementationSpecific

websocketDispatcher.ingress.tls

TLS configuration for the ingress.

[]