DOC: update README.md

Author: aiharos

README.md

@@ -35,13 +35,14 @@ 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)
+      --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)
+      --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]
@@ -50,7 +51,8 @@ Application Options:
       --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-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
 
@@ -63,16 +65,24 @@ HAProxy options:
   -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)
-      --max-open-transactions=                     Limit for active transaction in pending state (default: 20)
-  -n, --backups-number=                            Number of backup configuration files you want to keep, stored in the config dir with version number suffix (default: 0)
+  -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
   -f=                                              Path to the dataplane configuration file
-      --userlist-file=                             Path to the dataplaneapi userlist file. By default userlist is read from HAProxy conf. When specified userlist would be read from this file
-      --fid=                                       Path to file that will dataplaneapi use to write its id (not a pid) that was given to him after joining a cluster
-  -p, --maps-dir=                                  Path to maps directory (default: /etc/haproxy/maps)
+      --userlist-file=                             Path to the dataplaneapi userlist file. By default userlist is read from HAProxy conf. When specified
+                                                   userlist would be read from this file
+      --fid=                                       Path to file that will dataplaneapi use to write its id (not a pid) that was given to him after joining a
+                                                   cluster
+  -p, --maps-dir=                                  Path to directory of map files managed by dataplane (default: /etc/haproxy/maps)
+      --ssl-certs-dir=                             Path to SSL certificates directory (default: /etc/haproxy/ssl)
       --update-map-files                           Flag used for syncing map files with runtime maps values
       --update-map-files-period=                   Elapsed time in seconds between two maps syncing operations (default: 10)
+      --cluster-tls-dir=                           Path where cluster tls certificates will be stored. Defaults to same directory as dataplane configuration file
+      --spoe-dir=                                  Path to SPOE directory. (default: /etc/haproxy/spoe)
+      --spoe-transaction-dir=                      Path to the SPOE transaction directory (default: /tmp/spoe-haproxy)
+      --master-worker-mode                         Flag to enable helpers when running within HAProxy
+      --max-open-transactions=                     Limit for active transaction in pending state (default: 20)
 
 Logging options:
       --log-to=[stdout|file]                       Log target, can be stdout or file (default: stdout)
@@ -89,6 +99,7 @@ Show version:
 
 Help Options:
   -h, --help                                       Show this help message
+
 ```
 
 ## Example
@@ -99,6 +110,7 @@ You can test it by simply running:
 ./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
 ```
 
+Dataplaneapi will require write permissions to the haproxy configuration file and the directories containing additional managed files (maps, ssl, spoe). The default locations can be overriden with command-line options.
 Test it out with curl, note that you need user/pass combination setup in HAProxy userlist in haproxy configuration (in above example: /etc/haproxy/haproxy.cfg, userlist controller):
 
 ```
@@ -109,7 +121,7 @@ If you are using secure passwords, supported algorithms are: md5, sha-256 and sh
 
 ## Using the Data Plane API
 
-For more docs how to use the Data Plane API check our [documentation](https://www.haproxy.com/documentation/hapee/1-9r1/configuration/dataplaneapi/)
+For more docs how to use the Data Plane API check our [documentation](https://www.haproxy.com/documentation/hapee/2-2r1/reference/dataplaneapi/)
 
 Alternatively, dataplaneapi serves its own interactive documentation relevant for the current build on the `/v2/docs` uri. Just point your browser to the host/port dataplane was started with (i.e. `http://localhost:5555/v2/docs`)