New to Voyager? Please start here.

Using Custom HAProxy Templates

Since 3.2.0, Voyager can use custom templates provided by users to render HAProxy configuration. Voyager comes with a set of GO text/templates found here. These templates are mounted at /srv/voyager/templates. You can mount a ConfigMap with matching template names when installing Voyager operator to a different location and pass that to Voyager operator using --custom-templates flag. Voyager will load the built-in templates first and then load any custom templates if provided. As long as the custom templates have same name as the built-in templates, custom templates will be used render HAProxy config. You can overwrite any number of templates as you wish. Also note that templates are loaded when Voyager operator starts. So, if you want to reload custom templates, you need to restart the running Voyager operator pod (not HAProxy pods).

In this example, we are going to overwrite the defaults.cfg template which is used to render the defaults section of HAProxy config.

$ cat /tmp/defaults.cfg

defaults
	log global

	# my custom template
	# https://cbonte.github.io/haproxy-dconv/1.7/configuration.html#4.2-option%20abortonclose
	option dontlog-normal
	log /dev/log local0 notice alert
	option dontlognull
	option http-server-close

	# Timeout values
	timeout client 5s
	timeout client-fin 5s
	timeout connect 5s
	timeout server 5s
	timeout tunnel 5s

	# default traffic mode is http
	# mode is overwritten in case of tcp services
	mode http

Now create a ConfigMap using the defaults.cfg as key and the file content as the value.

$ kubectl create configmap -n kube-system voyager-templates --from-file=/tmp/defaults.cfg

Now, the ConfigMap voyager-templates has to be mounted in the voyager operator pod and --custom-templates flag has to be set. To do this pass the --template-cfgmap flag to the Voyager installer script.

curl -fsSL https://raw.githubusercontent.com/appscode/voyager/7.4.0/hack/deploy/voyager.sh \
  | bash -s -- --provider=minikube --template-cfgmap=voyager-templates

installer

This will restart the Voyager operator pods. After start, Voyager pod will update any existing HAProxy configuration to the new templates.

Take your team where it needs to go.

Create your cluster in minutes. Our team is here to help and would be happy to chat with you.