haproxy2.0 dataplaneapi brief description

haproxy2.0 supports dynamic configuration changes take effect, and services based on dataplaneapi of haproxy, earlier you order dynamic
can be dsn-based service discovery model based on confd combined consul dynamically generate configuration and load, now supports based
control api, or very convenient

Help command

 

Usage:

  dataplaneapi [OPTIONS]

​

API for editing and managing haproxy instances

​

Application Options:

      --scheme= the listeners to enable, this can be repeated and defaults to the schemes in the swagger spec

      --cleanup-timeout= grace period for which to wait before killing idle connections (default: 10s)

      --graceful-timeout= grace period for which to wait before shutting down the server (default: 15s)

      --max-header-size= controls the maximum number of bytes the server will read parsing the request header's keys and values, including the request line. It does not limit the size

                                                   of the request body. (default: 1MiB)

      --socket-path= the unix socket to listen on (default: /var/run/data-plane.sock)

      --host= the IP to listen on (default: localhost) [$HOST]

      --port= the port to listen on for insecure connections, defaults to a random value [$PORT]

      --listen-limit= limit the number of outstanding requests

      --keep-alive= sets the TCP keep-alive timeouts on accepted connections. It prunes dead TCP connections ( e.g. closing laptop mid-download) (default: 3m)

      --read-timeout= maximum duration before timing out read of the request (default: 30s)

      --write-timeout= maximum duration before timing out write of the response (default: 60s)

      --tls-host= the IP to listen on for tls, when not specified it's the same as --host [$TLS_HOST]

      --tls-port= the port to listen on for secure connections, defaults to a random value [$TLS_PORT]

      --tls-certificate= the certificate to use for secure connections [$TLS_CERTIFICATE]

      --tls-key= the private key to use for secure connections [$TLS_PRIVATE_KEY]

      --tls-ca= the certificate authority file to be used with mutual tls auth [$TLS_CA_CERTIFICATE]

      --tls-listen-limit= limit the number of outstanding requests

      --tls-keep-alive= sets the TCP keep-alive timeouts on accepted connections. It prunes dead TCP connections ( e.g. closing laptop mid-download)

      --tls-read-timeout= maximum duration before timing out read of the request

      --tls-write-timeout= maximum duration before timing out write of the response

​

HAProxy options:

  -c, --config-file= Path to the haproxy configuration file (default: /etc/haproxy/haproxy.cfg)

  -u, --userlist= Userlist in HAProxy configuration to use for API Basic Authentication (default: controller)

  -b, --haproxy-bin= Path to the haproxy binary file (default: haproxy)

  -d, --reload-delay= Minimum delay between two reloads (in s) (default: 5)

  -r, --reload-cmd= Reload command

  -s, --restart-cmd= Restart command

      --reload-retention= Reload retention in days, every older reload id will be deleted (default: 1)

  -t, --transaction-dir= Path to the transaction directory (default: /tmp/haproxy)

  -n, --backups-number= Number of backup configuration files you want to keep, stored in the config dir with version number suffix (default: 0)

  -m, --master-runtime= Path to the master Runtime API socket

  -i, --show-system-info Show system info on info endpoint

​

Logging options:

      --log-to=[stdout|file] Log target, can be stdout or file (default: stdout)

      --log-file= Location of the log file (default: /var/log/dataplaneapi/dataplaneapi.log)

      --log-level=[trace|debug|info|warning|error] Logging level (default: warning)

      --log-format=[text|JSON] Logging format (default: text)

​

Show version:

  -v, --version Version and build information

​

Help Options:

  -h, --help Show this help message

 

 

<wiz_tmp_tag class="wiz-block-scroll">

 

start up

• Common way

./dataplaneapi --port 5555 -b /usr/sbin/haproxy -c /etc/haproxy/haproxy.cfg -d 5 -r "service haproxy reload" -s "service haproxy restart" -u dataplaneapi -t /tmp/haproxy

• Way container

 ./dataplaneapi --host 0.0.0.0 --port 5555 --haproxy-bin /usr/sbin/haproxy --config-file /etc/haproxy/haproxy.cfg --reload-cmd "kill -SIGUSR2 1" --reload-delay 5 --userlist controller

• api request method

curl -u <user>:<pass> -H "Content-Type: application/json" "http://127.0.0.1:5555/v1/"

• haproxy 2.0 的process manager

   the fire

    command dataplaneapi --host 0.0.0.0 --port 5555 --haproxy-bin /usr/sbin/haproxy --config-file /etc/haproxy/haproxy.cfg --reload-cmd "systemctl reload haproxy" --reload-delay 5 --userlist controller

Explanation

haproxy2.0 expansion capability is still very good, but also open source on github, and follow-up based on dataplaneapi docker run, try the next function

api reference

https://www.haproxy.com/documentation/hapee/1-9r1/configuration/dataplaneapi/
https://github.com/haproxytech/dataplaneapi