Configuration reference

Backend CRD

On this page

Selected version

Available since

version 1.7

The Backend custom resource extends the Kubernetes API to let you manage how traffic is load balanced across pods.

Install the Backend custom resource Jump to heading

Before you can use the Backend custom resource, you must install its definition into your Kubernetes cluster.

  1. Download the v1-10 Backend custom resource filev1-9 Backend custom resource filev1-8 Backend custom resource filev1-7 Backend custom resource file.

  2. Install the custom resource definition with kubectl apply:

    Community ingress controller

    bash
    kubectl apply -f backends.core.haproxy.org.yaml
    bash
    kubectl apply -f backends.core.haproxy.org.yaml
    bash
    kubectl apply -f backends.core.haproxy.org.yaml
    bash
    kubectl apply -f backends.core.haproxy.org.yaml
    bash
    kubectl apply -f backend.yaml
    bash
    kubectl apply -f backend.yaml
    bash
    kubectl apply -f backend.yaml
    bash
    kubectl apply -f backend.yaml

  3. Verify that the installation worked by listing custom resources defined in your cluster:

    bash
    kubectl get crd
    bash
    kubectl get crd
    output
    bash
    NAME                        CREATED AT
    backends.core.haproxy.org   2022-01-21T20:00:31Z
    output
    bash
    NAME                        CREATED AT
    backends.core.haproxy.org   2022-01-21T20:00:31Z

Use the Backend custom resource Jump to heading

With the Backend custom resource, you can manage how traffic is load balanced across pods. To use it:

  1. Create a YAML file that declares a Backend resource and add properties to its spec.config section.

    In the example below, the balance.algorithm property changes the load balancing algorithm to least connections.

    example-backend.yaml
    yaml
    apiVersion: "core.haproxy.org/v1alpha2"
    kind: Backend
    metadata:
      name: example-backend
      namespace: default
    spec:
      config:
        balance:
          algorithm: "leastconn"
    example-backend.yaml
    yaml
    apiVersion: "core.haproxy.org/v1alpha2"
    kind: Backend
    metadata:
      name: example-backend
      namespace: default
    spec:
      config:
        balance:
          algorithm: "leastconn"
    example-backend.yaml
    yaml
    apiVersion: "core.haproxy.org/v1alpha2"
    kind: Backend
    metadata:
      name: example-backend
      namespace: default
    spec:
      config:
        balance:
          algorithm: "leastconn"
    example-backend.yaml
    yaml
    apiVersion: "core.haproxy.org/v1alpha2"
    kind: Backend
    metadata:
      name: example-backend
      namespace: default
    spec:
      config:
        balance:
          algorithm: "leastconn"
    example-backend.yaml
    yaml
    apiVersion: "core.haproxy.org/v1alpha1"
    kind: Backend
    metadata:
      name: example-backend
      namespace: default
    spec:
      config:
        balance:
          algorithm: "leastconn"
    example-backend.yaml
    yaml
    apiVersion: "core.haproxy.org/v1alpha1"
    kind: Backend
    metadata:
      name: example-backend
      namespace: default
    spec:
      config:
        balance:
          algorithm: "leastconn"
    example-backend.yaml
    yaml
    apiVersion: "core.haproxy.org/v1alpha1"
    kind: Backend
    metadata:
      name: example-backend
      namespace: default
    spec:
      config:
        balance:
          algorithm: "leastconn"
    example-backend.yaml
    yaml
    apiVersion: "core.haproxy.org/v1alpha1"
    kind: Backend
    metadata:
      name: example-backend
      namespace: default
    spec:
      config:
        balance:
          algorithm: "leastconn"

  2. Deploy it to your cluster using kubectl apply.

    bash
    kubectl apply -f example-backend.yaml
    bash
    kubectl apply -f example-backend.yaml

  3. Decide which Kubernetes services the resource should apply to. Do one of the following:

    • To have the properties apply to all services, create a new ConfigMap with the name haproxy-kubernetes-ingress to override the one that ships with the ingress controller. Add the cr-backend key to the data section to implement the backend properties.

      example-configmap.yaml
      yaml
      apiVersion: v1
      kind: ConfigMap
      metadata:
        name: haproxy-kubernetes-ingress
        namespace: haproxy-controller
      data:
        cr-backend: default/example-backend
      example-configmap.yaml
      yaml
      apiVersion: v1
      kind: ConfigMap
      metadata:
        name: haproxy-kubernetes-ingress
        namespace: haproxy-controller
      data:
        cr-backend: default/example-backend

      Update the ConfigMap in your cluster by using kubectl apply:

      bash
      kubectl apply -f  example-configmap.yaml
      bash
      kubectl apply -f  example-configmap.yaml

    • To have the properties apply to all services that the Ingress routes traffic to, add the cr-backend annotation to your Ingress definition. The Ingress below applies to the services example-service1 and example-service2:

      example-ingress.yaml
      yaml
      apiVersion: networking.k8s.io/v1
      kind: Ingress
      metadata:
          name: example-ingress
          annotations:
             haproxy.org/cr-backend: default/example-backend
      spec:
          rules:
          - http:
              paths:
              - path: /example1
                pathType: Prefix
                backend:
                  service:
                    name: example-service1
                    port:
                      number: 80
              - path: /example2
                pathType: Prefix
                backend:
                  service:
                    name: example-service2
                    port:
                      number: 80
      example-ingress.yaml
      yaml
      apiVersion: networking.k8s.io/v1
      kind: Ingress
      metadata:
          name: example-ingress
          annotations:
             haproxy.org/cr-backend: default/example-backend
      spec:
          rules:
          - http:
              paths:
              - path: /example1
                pathType: Prefix
                backend:
                  service:
                    name: example-service1
                    port:
                      number: 80
              - path: /example2
                pathType: Prefix
                backend:
                  service:
                    name: example-service2
                    port:
                      number: 80

      Update the Ingress in your cluster by using kubectl apply:

      bash
      kubectl apply -f  example-ingress.yaml
      bash
      kubectl apply -f  example-ingress.yaml

    • To have the properties apply to only a specific Kubernetes service, add the cr-backend annotation to your Service definition. The Service below applies the properties only to the service named example-service1.

      example-service.yaml
      yaml
      apiVersion: v1
      kind: Service
      metadata:
        labels:
          run: app
        name: example-service1
        annotations:
          haproxy.org/cr-backend: default/example-backend
      spec:
        selector:
          run: app
        ports:
        - name: http
          port: 80
          protocol: TCP
          targetPort: 8080
      example-service.yaml
      yaml
      apiVersion: v1
      kind: Service
      metadata:
        labels:
          run: app
        name: example-service1
        annotations:
          haproxy.org/cr-backend: default/example-backend
      spec:
        selector:
          run: app
        ports:
        - name: http
          port: 80
          protocol: TCP
          targetPort: 8080

      Update the Service in your cluster by using kubectl apply:

      bash
      kubectl apply -f  example-service.yaml
      bash
      kubectl apply -f  example-service.yaml

Backend custom resource reference Jump to heading

  • CRD version:
  • API version:

abortonclose

Type: string
Values
  • enabled
  • disabled

accept_invalid_http_response

Type: string
Values
  • enabled
  • disabled

adv_check

Type: string
Values
  • ssl-hello-chk
  • smtpchk
  • ldap-check
  • mysql-check
  • pgsql-check
  • tcp-check
  • redis-check
  • httpchk

allbackups

Type: string
Values
  • enabled
  • disabled

balance

Type: object
Child properties
  • algorithm string
    • Values
    • roundrobin
    • static-rr
    • leastconn
    • first
    • source
    • uri
    • url_param
    • hdr
    • random
    • rdp-cookie
  • hdr_name string
  • hdr_use_domain_only boolean
  • random_draws integer
  • rdp_cookie_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • uri_depth integer
  • uri_len integer
  • uri_path_only boolean
  • uri_whole boolean
  • url_param string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • url_param_check_post integer
  • url_param_max_wait integer

bind_process

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

check_timeout

Type: integer

compression

Type: object
Child properties
  • algorithms array
  • offload boolean
  • types array

connect_timeout

Type: integer

cookie

Type: object
Child properties
  • domain array
  • dynamic boolean
  • httponly boolean
  • indirect boolean
  • maxidle integer
  • maxlife integer
  • name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • nocache boolean
  • postonly boolean
  • preserve boolean
  • secure boolean
  • type string
    • Values
    • rewrite
    • insert
    • prefix

default_server

Type: object
Child properties
  • address string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • agent-addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • agent-check string
    • Values
    • enabled
    • disabled
  • agent-inter integer
  • agent-port integer
  • agent-send string
  • allow_0rtt boolean
  • alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • backup string
    • Values
    • enabled
    • disabled
  • ca_file string
  • check string
    • Values
    • enabled
    • disabled
  • check-send-proxy string
    • Values
    • enabled
    • disabled
  • check-sni string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check-ssl string
    • Values
    • enabled
    • disabled
  • check_alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check_proto string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check_via_socks4 string
    • Values
    • enabled
    • disabled
  • ciphers string
  • ciphersuites string
  • cookie string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • crl_file string
  • disabled string
    • Values
    • enabled
    • disabled
  • downinter integer
  • enabled string
    • Values
    • enabled
    • disabled
  • error_limit integer
  • fall integer
  • fastinter integer
  • force_sslv3 string
    • Values
    • enabled
    • disabled
  • force_tlsv10 string
    • Values
    • enabled
    • disabled
  • force_tlsv11 string
    • Values
    • enabled
    • disabled
  • force_tlsv12 string
    • Values
    • enabled
    • disabled
  • force_tlsv13 string
    • Values
    • enabled
    • disabled
  • health_check_port integer
  • init-addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • inter integer
  • log_proto string
    • Values
    • legacy
    • octet-count
  • max_reuse integer
  • maxconn integer
  • maxqueue integer
  • minconn integer
  • name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • namespace string
  • no_sslv3 string
    • Values
    • enabled
    • disabled
  • no_tlsv10 string
    • Values
    • enabled
    • disabled
  • no_tlsv11 string
    • Values
    • enabled
    • disabled
  • no_tlsv12 string
    • Values
    • enabled
    • disabled
  • no_tlsv13 string
    • Values
    • enabled
    • disabled
  • no_verifyhost string
    • Values
    • enabled
    • disabled
  • npn string
  • observe string
    • Values
    • layer4
    • layer7
  • on-error string
    • Values
    • fastinter
    • fail-check
    • sudden-death
    • mark-down
  • on-marked-down string
    • Values
    • shutdown-sessions
  • on-marked-up string
    • Values
    • shutdown-backup-sessions
  • pool_low_conn integer
  • pool_max_conn integer
  • pool_purge_delay integer
  • port integer
  • proto string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • proxy-v2-options array
  • redir string
  • resolve-net string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • resolve-prefer string
    • Values
    • ipv4
    • ipv6
    Constraints
    • Must match pattern: ^[^\s]+$
  • resolve_opts string
    • Constraints
    • Must match pattern: ^[^,\s][^\,]*[^,\s]*$
  • resolvers string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • rise integer
  • send-proxy string
    • Values
    • enabled
    • disabled
  • send-proxy-v2 string
    • Values
    • enabled
    • disabled
  • send_proxy_v2_ssl string
    • Values
    • enabled
    • disabled
  • send_proxy_v2_ssl_cn string
    • Values
    • enabled
    • disabled
  • slowstart integer
  • sni string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • socks4 string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • source string
  • ssl string
    • Values
    • enabled
    • disabled
  • ssl_certificate string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • ssl_max_ver string
    • Values
    • SSLv3
    • TLSv1.0
    • TLSv1.1
    • TLSv1.2
    • TLSv1.3
  • ssl_min_ver string
    • Values
    • SSLv3
    • TLSv1.0
    • TLSv1.1
    • TLSv1.2
    • TLSv1.3
  • ssl_reuse string
    • Values
    • enabled
    • disabled
  • stick string
    • Values
    • enabled
    • disabled
  • tcp_ut integer
  • tfo string
    • Values
    • enabled
    • disabled
  • tls_tickets string
    • Values
    • enabled
    • disabled
  • track string
  • verify string
    • Values
    • none
    • required
  • verifyhost string
  • weight integer

dynamic_cookie_key

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

external_check

Type: string
Values
  • enabled
  • disabled

external_check_command

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

external_check_path

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

forwardfor

Type: object
Child properties
  • enabled string
    • Values
    • enabled
  • except string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • header string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • ifnone boolean

h1_case_adjust_bogus_server

Type: string
Values
  • enabled
  • disabled

hash_type

Type: object
Child properties
  • function string
    • Values
    • sdbm
    • djb2
    • wt6
    • crc32
  • method string
    • Values
    • map-based
    • consistent
  • modifier string
    • Values
    • avalanche

http-buffer-request

Type: string
Values
  • enabled
  • disabled

http-check

Type: object
Child properties
  • addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • body string
  • body_log_format string
  • check_comment string
  • default boolean
  • error_status string
    • Values
    • L7OKC
    • L7RSP
    • L7STS
    • L6RSP
    • L4CON
  • exclamation_mark boolean
  • headers array
  • index integer
  • linger boolean
  • match string
    • Values
    • status
    • rstatus
    • hdr
    • fhdr
    • string
    • rstring
    Constraints
    • Must match pattern: ^[^\s]+$
  • method string
  • min_recv integer
  • ok_status string
    • Values
    • L7OK
    • L7OKC
    • L6OK
    • L4OK
  • on_error string
  • on_success string
  • pattern string
  • port integer
  • port_string string
  • proto string
  • send_proxy boolean
  • sni string
  • ssl boolean
  • status-code string
  • tout_status string
    • Values
    • L7TOUT
    • L6TOUT
    • L4TOUT
  • type string
    • Values
    • comment
    • connect
    • disable-on-404
    • expect
    • send
    • send-state
    • set-var
    • set-var-fmt
    • unset-var
  • uri string
  • uri_log_format string
  • var_expr string
  • var_format string
  • var_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • var_scope string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • version string
  • via_socks4 boolean

http-keep-alive

Type: string
Values
  • enabled
  • disabled

http-no-delay

Type: string
Values
  • enabled
  • disabled

http-server-close

Type: string
Values
  • enabled
  • disabled

http-use-htx

Type: string
Values
  • enabled
  • disabled
Constraints
  • Must match pattern: ^[^\s]+$

http_connection_mode

Type: string
Values
  • httpclose
  • http-server-close
  • http-keep-alive

http_keep_alive_timeout

Type: integer

http_pretend_keepalive

Type: string
Values
  • enabled
  • disabled

http_proxy

Type: string
Values
  • enabled
  • disabled

http_request_timeout

Type: integer

http_reuse

Type: string
Values
  • aggressive
  • always
  • never
  • safe

httpchk_params

Type: object
Child properties
  • method string
    • Values
    • HEAD
    • PUT
    • POST
    • GET
    • TRACE
    • PATCH
  • uri string
    • Constraints
    • Must match pattern: ^[^ ]*$
  • version string

httpclose

Type: string
Values
  • enabled
  • disabled

log_health_checks

Type: string
Values
  • enabled
  • disabled

log_tag

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

mode

Type: string
Values
  • http
  • tcp

mysql_check_params

Type: object
Child properties
  • client_version string
    • Values
    • pre-41
    • post-41
  • username string

name

Type: string
Constraints
  • Must match pattern: ^[A-Za-z0-9-_.:]+$

pgsql_check_params

Type: object
Child properties
  • username string

queue_timeout

Type: integer

redispatch

Type: object
Child properties
  • enabled string
    • Values
    • enabled
    • disabled
  • interval integer

retries

Type: integer

server_timeout

Type: integer

smtpchk_params

Type: object
Child properties
  • domain string
  • hello string

srvtcpka

Type: string
Values
  • enabled
  • disabled

stats_options

Type: object
Child properties
  • stats_admin boolean
  • stats_admin_cond string
    • Values
    • if
    • unless
  • stats_admin_cond_test string
  • stats_enable boolean
  • stats_hide_version boolean
  • stats_maxconn integer
  • stats_refresh_delay integer
  • stats_show_desc string
  • stats_show_legends boolean
  • stats_show_node_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • stats_uri_prefix string
    • Constraints
    • Must match pattern: ^[^\s]+$

stick_table

Type: object
Child properties
  • expire integer
  • keylen integer
  • nopurge boolean
  • peers string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • size integer
  • store string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • type string
    • Values
    • ip
    • ipv6
    • integer
    • string
    • binary

tcpka

Type: string
Values
  • enabled
  • disabled

tunnel_timeout

Type: integer

abortonclose

Type: string
Values
  • enabled
  • disabled

accept_invalid_http_response

Type: string
Values
  • enabled
  • disabled

adv_check

Type: string
Values
  • ssl-hello-chk
  • smtpchk
  • ldap-check
  • mysql-check
  • pgsql-check
  • tcp-check
  • redis-check
  • httpchk

allbackups

Type: string
Values
  • enabled
  • disabled

balance

Type: object
Child properties
  • algorithm string
    • Values
    • roundrobin
    • static-rr
    • leastconn
    • first
    • source
    • uri
    • url_param
    • hdr
    • random
    • rdp-cookie
  • hdr_name string
  • hdr_use_domain_only boolean
  • random_draws integer
  • rdp_cookie_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • uri_depth integer
  • uri_len integer
  • uri_path_only boolean
  • uri_whole boolean
  • url_param string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • url_param_check_post integer
  • url_param_max_wait integer

bind_process

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

check_timeout

Type: integer

compression

Type: object
Child properties
  • algorithms array
  • offload boolean
  • types array

connect_timeout

Type: integer

cookie

Type: object
Child properties
  • domain array
  • dynamic boolean
  • httponly boolean
  • indirect boolean
  • maxidle integer
  • maxlife integer
  • name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • nocache boolean
  • postonly boolean
  • preserve boolean
  • secure boolean
  • type string
    • Values
    • rewrite
    • insert
    • prefix

default_server

Type: object
Child properties
  • address string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • agent-addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • agent-check string
    • Values
    • enabled
    • disabled
  • agent-inter integer
  • agent-port integer
  • agent-send string
  • allow_0rtt boolean
  • alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • backup string
    • Values
    • enabled
    • disabled
  • ca_file string
  • check string
    • Values
    • enabled
    • disabled
  • check-send-proxy string
    • Values
    • enabled
    • disabled
  • check-sni string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check-ssl string
    • Values
    • enabled
    • disabled
  • check_alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check_proto string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check_via_socks4 string
    • Values
    • enabled
    • disabled
  • ciphers string
  • ciphersuites string
  • cookie string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • crl_file string
  • disabled string
    • Values
    • enabled
    • disabled
  • downinter integer
  • enabled string
    • Values
    • enabled
    • disabled
  • error_limit integer
  • fall integer
  • fastinter integer
  • force_sslv3 string
    • Values
    • enabled
    • disabled
  • force_tlsv10 string
    • Values
    • enabled
    • disabled
  • force_tlsv11 string
    • Values
    • enabled
    • disabled
  • force_tlsv12 string
    • Values
    • enabled
    • disabled
  • force_tlsv13 string
    • Values
    • enabled
    • disabled
  • health_check_port integer
  • init-addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • inter integer
  • log_proto string
    • Values
    • legacy
    • octet-count
  • max_reuse integer
  • maxconn integer
  • maxqueue integer
  • minconn integer
  • name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • namespace string
  • no_sslv3 string
    • Values
    • enabled
    • disabled
  • no_tlsv10 string
    • Values
    • enabled
    • disabled
  • no_tlsv11 string
    • Values
    • enabled
    • disabled
  • no_tlsv12 string
    • Values
    • enabled
    • disabled
  • no_tlsv13 string
    • Values
    • enabled
    • disabled
  • no_verifyhost string
    • Values
    • enabled
    • disabled
  • npn string
  • observe string
    • Values
    • layer4
    • layer7
  • on-error string
    • Values
    • fastinter
    • fail-check
    • sudden-death
    • mark-down
  • on-marked-down string
    • Values
    • shutdown-sessions
  • on-marked-up string
    • Values
    • shutdown-backup-sessions
  • pool_low_conn integer
  • pool_max_conn integer
  • pool_purge_delay integer
  • port integer
  • proto string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • proxy-v2-options array
  • redir string
  • resolve-net string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • resolve-prefer string
    • Values
    • ipv4
    • ipv6
    Constraints
    • Must match pattern: ^[^\s]+$
  • resolve_opts string
    • Constraints
    • Must match pattern: ^[^,\s][^\,]*[^,\s]*$
  • resolvers string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • rise integer
  • send-proxy string
    • Values
    • enabled
    • disabled
  • send-proxy-v2 string
    • Values
    • enabled
    • disabled
  • send_proxy_v2_ssl string
    • Values
    • enabled
    • disabled
  • send_proxy_v2_ssl_cn string
    • Values
    • enabled
    • disabled
  • slowstart integer
  • sni string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • socks4 string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • source string
  • ssl string
    • Values
    • enabled
    • disabled
  • ssl_certificate string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • ssl_max_ver string
    • Values
    • SSLv3
    • TLSv1.0
    • TLSv1.1
    • TLSv1.2
    • TLSv1.3
  • ssl_min_ver string
    • Values
    • SSLv3
    • TLSv1.0
    • TLSv1.1
    • TLSv1.2
    • TLSv1.3
  • ssl_reuse string
    • Values
    • enabled
    • disabled
  • stick string
    • Values
    • enabled
    • disabled
  • tcp_ut integer
  • tfo string
    • Values
    • enabled
    • disabled
  • tls_tickets string
    • Values
    • enabled
    • disabled
  • track string
  • verify string
    • Values
    • none
    • required
  • verifyhost string
  • weight integer

dynamic_cookie_key

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

external_check

Type: string
Values
  • enabled
  • disabled

external_check_command

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

external_check_path

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

forwardfor

Type: object
Child properties
  • enabled string
    • Values
    • enabled
  • except string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • header string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • ifnone boolean

h1_case_adjust_bogus_server

Type: string
Values
  • enabled
  • disabled

hash_type

Type: object
Child properties
  • function string
    • Values
    • sdbm
    • djb2
    • wt6
    • crc32
  • method string
    • Values
    • map-based
    • consistent
  • modifier string
    • Values
    • avalanche

http-buffer-request

Type: string
Values
  • enabled
  • disabled

http-check

Type: object
Child properties
  • addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • body string
  • body_log_format string
  • check_comment string
  • default boolean
  • error_status string
    • Values
    • L7OKC
    • L7RSP
    • L7STS
    • L6RSP
    • L4CON
  • exclamation_mark boolean
  • headers array
  • index integer
  • linger boolean
  • match string
    • Values
    • status
    • rstatus
    • hdr
    • fhdr
    • string
    • rstring
    Constraints
    • Must match pattern: ^[^\s]+$
  • method string
  • min_recv integer
  • ok_status string
    • Values
    • L7OK
    • L7OKC
    • L6OK
    • L4OK
  • on_error string
  • on_success string
  • pattern string
  • port integer
  • port_string string
  • proto string
  • send_proxy boolean
  • sni string
  • ssl boolean
  • status-code string
  • tout_status string
    • Values
    • L7TOUT
    • L6TOUT
    • L4TOUT
  • type string
    • Values
    • comment
    • connect
    • disable-on-404
    • expect
    • send
    • send-state
    • set-var
    • set-var-fmt
    • unset-var
  • uri string
  • uri_log_format string
  • var_expr string
  • var_format string
  • var_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • var_scope string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • version string
  • via_socks4 boolean

http-keep-alive

Type: string
Values
  • enabled
  • disabled

http-no-delay

Type: string
Values
  • enabled
  • disabled

http-server-close

Type: string
Values
  • enabled
  • disabled

http-use-htx

Type: string
Values
  • enabled
  • disabled
Constraints
  • Must match pattern: ^[^\s]+$

http_connection_mode

Type: string
Values
  • httpclose
  • http-server-close
  • http-keep-alive

http_keep_alive_timeout

Type: integer

http_pretend_keepalive

Type: string
Values
  • enabled
  • disabled

http_proxy

Type: string
Values
  • enabled
  • disabled

http_request_timeout

Type: integer

http_reuse

Type: string
Values
  • aggressive
  • always
  • never
  • safe

httpchk_params

Type: object
Child properties
  • method string
    • Values
    • HEAD
    • PUT
    • POST
    • GET
    • TRACE
    • PATCH
  • uri string
    • Constraints
    • Must match pattern: ^[^ ]*$
  • version string

httpclose

Type: string
Values
  • enabled
  • disabled

log_health_checks

Type: string
Values
  • enabled
  • disabled

log_tag

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

mode

Type: string
Values
  • http
  • tcp

mysql_check_params

Type: object
Child properties
  • client_version string
    • Values
    • pre-41
    • post-41
  • username string

name

Type: string
Constraints
  • Must match pattern: ^[A-Za-z0-9-_.:]+$

pgsql_check_params

Type: object
Child properties
  • username string

queue_timeout

Type: integer

redispatch

Type: object
Child properties
  • enabled string
    • Values
    • enabled
    • disabled
  • interval integer

retries

Type: integer

server_timeout

Type: integer

smtpchk_params

Type: object
Child properties
  • domain string
  • hello string

srvtcpka

Type: string
Values
  • enabled
  • disabled

stats_options

Type: object
Child properties
  • stats_admin boolean
  • stats_admin_cond string
    • Values
    • if
    • unless
  • stats_admin_cond_test string
  • stats_enable boolean
  • stats_hide_version boolean
  • stats_maxconn integer
  • stats_refresh_delay integer
  • stats_show_desc string
  • stats_show_legends boolean
  • stats_show_node_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • stats_uri_prefix string
    • Constraints
    • Must match pattern: ^[^\s]+$

stick_table

Type: object
Child properties
  • expire integer
  • keylen integer
  • nopurge boolean
  • peers string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • size integer
  • store string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • type string
    • Values
    • ip
    • ipv6
    • integer
    • string
    • binary

tcpka

Type: string
Values
  • enabled
  • disabled

tunnel_timeout

Type: integer

name

Type: string
Constraints
  • Must match pattern: ^[A-Za-z0-9-_.:]+$

balance

Type: object
Child properties
  • algorithm string
    • Values
    • roundrobin
    • static-rr
    • leastconn
    • first
    • source
    • uri
    • url_param
    • hdr
    • random
    • rdp-cookie
  • uri_whole boolean
  • uri_len integer
  • uri_depth integer
  • url_param string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • url_param_check_post integer
  • url_param_max_wait integer
  • hdr_name string
  • hdr_use_domain_only boolean
  • random_draws integer
  • rdp_cookie_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • uri_path_only boolean

hash_type

Type: object
Child properties
  • method string
    • Values
    • map-based
    • consistent
  • function string
    • Values
    • sdbm
    • djb2
    • wt6
    • crc32
  • modifier string
    • Values
    • avalanche

http-check

Type: object
Child properties
  • type string
    • Values
    • disable-on-404
    • expect
    • send-state
  • exclamation_mark boolean
  • match string
    • Values
    • status
    • rstatus
    • string
    • rstring
    Constraints
    • Must match pattern: ^[^\s]+$
  • pattern string

bind_process

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

mode

Type: string
Values
  • http
  • tcp

allbackups

Type: string
Values
  • enabled
  • disabled

http-buffer-request

Type: string
Values
  • enabled
  • disabled

log_tag

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

http_connection_mode

Type: string
Values
  • httpclose
  • http-server-close
  • http-keep-alive

http_pretend_keepalive

Type: string
Values
  • enabled
  • disabled

abortonclose

Type: string
Values
  • enabled
  • disabled

forwardfor

Type: object
Child properties
  • enabled string
    • Values
    • enabled
  • except string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • header string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • ifnone boolean

cookie

Type: object
Child properties
  • name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • type string
    • Values
    • rewrite
    • insert
    • prefix
  • indirect boolean
  • nocache boolean
  • postonly boolean
  • preserve boolean
  • httponly boolean
  • secure boolean
  • domain array
  • maxidle integer
  • maxlife integer
  • dynamic boolean

default_server

Type: object
Child properties
  • init-addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • inter integer
  • fastinter integer
  • downinter integer
  • rise integer
  • fall integer
  • check-sni string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • slowstart integer
  • sni string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check-ssl string
    • Values
    • enabled
    • disabled
  • check-send-proxy string
    • Values
    • enabled
    • disabled
  • ca_file string
  • enabled string
    • Values
    • enabled
    • disabled
  • disabled string
    • Values
    • enabled
    • disabled
  • port integer
  • resolvers string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • resolve-prefer string
    • Values
    • ipv4
    • ipv6
    Constraints
    • Must match pattern: ^[^\s]+$
  • resolve-net string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • address string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • health_check_port integer
  • ssl_certificate string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • agent-check string
    • Values
    • enabled
    • disabled
  • agent-send string
  • agent-inter integer
  • agent-addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • agent-port integer
  • allow_0rtt boolean
  • alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • backup string
    • Values
    • enabled
    • disabled
  • check string
    • Values
    • enabled
    • disabled
  • check_alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check_proto string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check_via_socks4 string
    • Values
    • enabled
    • disabled
  • ciphers string
  • ciphersuites string
  • cookie string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • crl_file string
  • error_limit integer
  • force_sslv3 string
    • Values
    • enabled
    • disabled
  • force_tlsv10 string
    • Values
    • enabled
    • disabled
  • force_tlsv11 string
    • Values
    • enabled
    • disabled
  • force_tlsv12 string
    • Values
    • enabled
    • disabled
  • force_tlsv13 string
    • Values
    • enabled
    • disabled
  • log_proto string
    • Values
    • legacy
    • octet-count
  • maxconn integer
  • maxqueue integer
  • max_reuse integer
  • minconn integer
  • namespace string
  • no_sslv3 string
    • Values
    • enabled
    • disabled
  • no_tlsv10 string
    • Values
    • enabled
    • disabled
  • no_tlsv11 string
    • Values
    • enabled
    • disabled
  • no_tlsv12 string
    • Values
    • enabled
    • disabled
  • no_tlsv13 string
    • Values
    • enabled
    • disabled
  • no_verifyhost string
    • Values
    • enabled
    • disabled
  • npn string
  • observe string
    • Values
    • layer4
    • layer7
  • on-error string
    • Values
    • fastinter
    • fail-check
    • sudden-death
    • mark-down
  • on-marked-down string
    • Values
    • shutdown-sessions
  • on-marked-up string
    • Values
    • shutdown-backup-sessions
  • pool_low_conn integer
  • pool_max_conn integer
  • pool_purge_delay integer
  • proto string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • redir string
  • resolve_opts string
    • Constraints
    • Must match pattern: ^[^,\s][^\,]*[^,\s]*$
  • send-proxy string
    • Values
    • enabled
    • disabled
  • send-proxy-v2 string
    • Values
    • enabled
    • disabled
  • proxy-v2-options array
  • send_proxy_v2_ssl string
    • Values
    • enabled
    • disabled
  • send_proxy_v2_ssl_cn string
    • Values
    • enabled
    • disabled
  • source string
  • ssl string
    • Values
    • enabled
    • disabled
  • ssl_max_ver string
    • Values
    • SSLv3
    • TLSv1.0
    • TLSv1.1
    • TLSv1.2
    • TLSv1.3
  • ssl_min_ver string
    • Values
    • SSLv3
    • TLSv1.0
    • TLSv1.1
    • TLSv1.2
    • TLSv1.3
  • ssl_reuse string
    • Values
    • enabled
    • disabled
  • stick string
    • Values
    • enabled
    • disabled
  • socks4 string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • tcp_ut integer
  • tfo string
    • Values
    • enabled
    • disabled
  • track string
  • tls_tickets string
    • Values
    • enabled
    • disabled
  • verify string
    • Values
    • none
    • required
  • verifyhost string
  • weight integer

check_timeout

Type: integer

adv_check

Type: string
Values
  • ssl-hello-chk
  • smtpchk
  • ldap-check
  • mysql-check
  • pgsql-check
  • tcp-check
  • redis-check
  • httpchk

smtpchk_params

Type: object
Child properties
  • hello string
  • domain string

mysql_check_params

Type: object
Child properties
  • username string
  • client_version string
    • Values
    • pre-41
    • post-41

pgsql_check_params

Type: object
Child properties
  • username string

external_check

Type: string
Values
  • enabled
  • disabled

external_check_path

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

external_check_command

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

queue_timeout

Type: integer

connect_timeout

Type: integer

http_request_timeout

Type: integer

http_keep_alive_timeout

Type: integer

retries

Type: integer

redispatch

Type: object
Child properties
  • enabled string
    • Values
    • enabled
    • disabled
  • interval integer

server_timeout

Type: integer

tunnel_timeout

Type: integer

httpchk_params

Type: object
Child properties
  • method string
    • Values
    • HEAD
    • PUT
    • POST
    • GET
    • TRACE
    • PATCH
  • uri string
    • Constraints
    • Must match pattern: ^[^ ]*$
  • version string

http_reuse

Type: string
Values
  • aggressive
  • always
  • never
  • safe

stick_table

Type: object
Child properties
  • type string
    • Values
    • ip
    • ipv6
    • integer
    • string
    • binary
  • keylen integer
  • size integer
  • expire integer
  • nopurge boolean
  • peers string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • store string
    • Constraints
    • Must match pattern: ^[^\s]+$

http-use-htx

Type: string
Values
  • enabled
  • disabled
Constraints
  • Must match pattern: ^[^\s]+$

stats_options

Type: object
Child properties
  • stats_enable boolean
  • stats_hide_version boolean
  • stats_maxconn integer
  • stats_refresh_delay integer
  • stats_show_desc string
  • stats_show_legends boolean
  • stats_show_node_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • stats_uri_prefix string
    • Constraints
    • Must match pattern: ^[^\s]+$

name

Type: string
Constraints
  • Must match pattern: ^[A-Za-z0-9-_.:]+$

balance

Type: object
Child properties
  • algorithm string
    • Values
    • roundrobin
    • static-rr
    • leastconn
    • first
    • source
    • uri
    • url_param
    • hdr
    • random
    • rdp-cookie
  • uri_whole boolean
  • uri_len integer
  • uri_depth integer
  • url_param string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • url_param_check_post integer
  • url_param_max_wait integer
  • hdr_name string
  • hdr_use_domain_only boolean
  • random_draws integer
  • rdp_cookie_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • uri_path_only boolean

hash_type

Type: object
Child properties
  • method string
    • Values
    • map-based
    • consistent
  • function string
    • Values
    • sdbm
    • djb2
    • wt6
    • crc32
  • modifier string
    • Values
    • avalanche

http-check

Type: object
Child properties
  • type string
    • Values
    • disable-on-404
    • expect
    • send-state
  • exclamation_mark boolean
  • match string
    • Values
    • status
    • rstatus
    • string
    • rstring
    Constraints
    • Must match pattern: ^[^\s]+$
  • pattern string

bind_process

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

mode

Type: string
Values
  • http
  • tcp

allbackups

Type: string
Values
  • enabled
  • disabled

http-buffer-request

Type: string
Values
  • enabled
  • disabled

log_tag

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

http_connection_mode

Type: string
Values
  • httpclose
  • http-server-close
  • http-keep-alive

http_pretend_keepalive

Type: string
Values
  • enabled
  • disabled

abortonclose

Type: string
Values
  • enabled
  • disabled

forwardfor

Type: object
Child properties
  • enabled string
    • Values
    • enabled
  • except string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • header string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • ifnone boolean

cookie

Type: object
Child properties
  • name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • type string
    • Values
    • rewrite
    • insert
    • prefix
  • indirect boolean
  • nocache boolean
  • postonly boolean
  • preserve boolean
  • httponly boolean
  • secure boolean
  • domain array
  • maxidle integer
  • maxlife integer
  • dynamic boolean

default_server

Type: object
Child properties
  • init-addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • inter integer
  • fastinter integer
  • downinter integer
  • rise integer
  • fall integer
  • check-sni string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • slowstart integer
  • sni string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check-ssl string
    • Values
    • enabled
    • disabled
  • check-send-proxy string
    • Values
    • enabled
    • disabled
  • ca_file string
  • enabled string
    • Values
    • enabled
    • disabled
  • disabled string
    • Values
    • enabled
    • disabled
  • port integer
  • resolvers string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • resolve-prefer string
    • Values
    • ipv4
    • ipv6
    Constraints
    • Must match pattern: ^[^\s]+$
  • resolve-net string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • address string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • health_check_port integer
  • ssl_certificate string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • agent-check string
    • Values
    • enabled
    • disabled
  • agent-send string
  • agent-inter integer
  • agent-addr string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • agent-port integer
  • allow_0rtt boolean
  • alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • backup string
    • Values
    • enabled
    • disabled
  • check string
    • Values
    • enabled
    • disabled
  • check_alpn string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check_proto string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • check_via_socks4 string
    • Values
    • enabled
    • disabled
  • ciphers string
  • ciphersuites string
  • cookie string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • crl_file string
  • error_limit integer
  • force_sslv3 string
    • Values
    • enabled
    • disabled
  • force_tlsv10 string
    • Values
    • enabled
    • disabled
  • force_tlsv11 string
    • Values
    • enabled
    • disabled
  • force_tlsv12 string
    • Values
    • enabled
    • disabled
  • force_tlsv13 string
    • Values
    • enabled
    • disabled
  • log_proto string
    • Values
    • legacy
    • octet-count
  • maxconn integer
  • maxqueue integer
  • max_reuse integer
  • minconn integer
  • namespace string
  • no_sslv3 string
    • Values
    • enabled
    • disabled
  • no_tlsv10 string
    • Values
    • enabled
    • disabled
  • no_tlsv11 string
    • Values
    • enabled
    • disabled
  • no_tlsv12 string
    • Values
    • enabled
    • disabled
  • no_tlsv13 string
    • Values
    • enabled
    • disabled
  • no_verifyhost string
    • Values
    • enabled
    • disabled
  • npn string
  • observe string
    • Values
    • layer4
    • layer7
  • on-error string
    • Values
    • fastinter
    • fail-check
    • sudden-death
    • mark-down
  • on-marked-down string
    • Values
    • shutdown-sessions
  • on-marked-up string
    • Values
    • shutdown-backup-sessions
  • pool_low_conn integer
  • pool_max_conn integer
  • pool_purge_delay integer
  • proto string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • redir string
  • resolve_opts string
    • Constraints
    • Must match pattern: ^[^,\s][^\,]*[^,\s]*$
  • send-proxy string
    • Values
    • enabled
    • disabled
  • send-proxy-v2 string
    • Values
    • enabled
    • disabled
  • proxy-v2-options array
  • send_proxy_v2_ssl string
    • Values
    • enabled
    • disabled
  • send_proxy_v2_ssl_cn string
    • Values
    • enabled
    • disabled
  • source string
  • ssl string
    • Values
    • enabled
    • disabled
  • ssl_max_ver string
    • Values
    • SSLv3
    • TLSv1.0
    • TLSv1.1
    • TLSv1.2
    • TLSv1.3
  • ssl_min_ver string
    • Values
    • SSLv3
    • TLSv1.0
    • TLSv1.1
    • TLSv1.2
    • TLSv1.3
  • ssl_reuse string
    • Values
    • enabled
    • disabled
  • stick string
    • Values
    • enabled
    • disabled
  • socks4 string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • tcp_ut integer
  • tfo string
    • Values
    • enabled
    • disabled
  • track string
  • tls_tickets string
    • Values
    • enabled
    • disabled
  • verify string
    • Values
    • none
    • required
  • verifyhost string
  • weight integer

check_timeout

Type: integer

adv_check

Type: string
Values
  • ssl-hello-chk
  • smtpchk
  • ldap-check
  • mysql-check
  • pgsql-check
  • tcp-check
  • redis-check
  • httpchk

smtpchk_params

Type: object
Child properties
  • hello string
  • domain string

mysql_check_params

Type: object
Child properties
  • username string
  • client_version string
    • Values
    • pre-41
    • post-41

pgsql_check_params

Type: object
Child properties
  • username string

external_check

Type: string
Values
  • enabled
  • disabled

external_check_path

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

external_check_command

Type: string
Constraints
  • Must match pattern: ^[^\s]+$

queue_timeout

Type: integer

connect_timeout

Type: integer

http_request_timeout

Type: integer

http_keep_alive_timeout

Type: integer

retries

Type: integer

redispatch

Type: object
Child properties
  • enabled string
    • Values
    • enabled
    • disabled
  • interval integer

server_timeout

Type: integer

tunnel_timeout

Type: integer

httpchk_params

Type: object
Child properties
  • method string
    • Values
    • HEAD
    • PUT
    • POST
    • GET
    • TRACE
    • PATCH
  • uri string
    • Constraints
    • Must match pattern: ^[^ ]*$
  • version string

http_reuse

Type: string
Values
  • aggressive
  • always
  • never
  • safe

stick_table

Type: object
Child properties
  • type string
    • Values
    • ip
    • ipv6
    • integer
    • string
    • binary
  • keylen integer
  • size integer
  • expire integer
  • nopurge boolean
  • peers string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • store string
    • Constraints
    • Must match pattern: ^[^\s]+$

http-use-htx

Type: string
Values
  • enabled
  • disabled
Constraints
  • Must match pattern: ^[^\s]+$

stats_options

Type: object
Child properties
  • stats_enable boolean
  • stats_hide_version boolean
  • stats_maxconn integer
  • stats_refresh_delay integer
  • stats_show_desc string
  • stats_show_legends boolean
  • stats_show_node_name string
    • Constraints
    • Must match pattern: ^[^\s]+$
  • stats_uri_prefix string
    • Constraints
    • Must match pattern: ^[^\s]+$

If this page was useful, please, Leave the feedback.

Previous page Configuration reference Next page Defaults CRD
© 2023 HAProxy Technologies, LLC. All Rights Reserved
Manage Cookie Preferences