* debian/README.Debian: Add section on vip-manager integration.

debian/README.Debian

@@ -36,7 +36,7 @@ Similar to the postgresql@ service, a patroni@ service unit is provided that
 allows the administration of an arbitrary pg-common cluster without having to
 define a systemd unit for each cluster, e.g.:
 
-# systemctl start patroni@10-main
+ # systemctl start patroni@10-main
 
 Due to systemd limitations, the cluster definition has to be provided with a `-'
 not a `/' between version and cluster name.
@@ -46,6 +46,24 @@ corresponding systemd service (postgresql@10-main) cannot be used anymore.  It
 is possible to reload the Postgres configuration via `pg_ctlcluster 10 main
 reload', though.
 
+Integration of vip-manager
+--------------------------
+
+The vip-manager package allows to expose a virtual ip (VIP) for the leader node
+by monitoring the leader key in the DCS and setting or removing the configured
+VIP for the local node depending on leader status.
+
+The Debian vip-manager package provides a /etc/patroni/vip.in template which
+can be used to write a vip-manager configuration for a patroni cluster via
+the --vip option:
+
+ # pg_createconfig_patroni --vip=10.0.1.1 10 main
+
+Similarly to the patroni package, the vip-manager service can then be started
+via a systemd unit specific for the cluster:
+
+ # systemctl start vip-manager@10-main
+
 Cluster Bootstrap
 -----------------
 

debian/changelog

@@ -10,6 +10,7 @@ patroni (1.6.1-1) UNRELEASED; urgency=medium
     vip-manager configuration if present.
   * debian/config.yml.in: Add @LISTEN_VIP@ tag.
   * debian/control: Add vip-manager to Suggests.
+  * debian/README.Debian: Add section on vip-manager integration.
 
  -- Debian PostgreSQL Maintainers <team+postgresql@tracker.debian.org>  Tue, 08 Oct 2019 12:58:40 +0200