vip-manager

Manages a virtual IP based on state kept in etcd or Consul. Monitors state in etcd

Building

1. Make sure you have at least version 1.12 of Golang
2. To make sure that internal includes (the vipconfig and the checker package) are satisfied, place the base directory of this project properly into your $GOPATH. The resulting location should be $GOPATH/src/github.com/cybertec-postgresql/vip-manager/. The easiest way to do this is: go get github.com/cybertec-postgresql/vip-manager
3. Build the binary using make.
4. To build your own .deb or .rpm, fpm is required. Install it, add it to your path and try running make package, which will generate a .deb package and will also convert that into a matching .rpm file.

note: on debianoids, rpmbuild will be required to create the rpm package...

Installing on debian

• Install the debian package. Currently you will have to build the package yourself. Prebuilt packages are coming soon.
• Edit /etc/default/vip-manager. See the configuration section for details.
• Start and enable vip-manager service with systemctl.

Installing by hand

• Build the vip-manager binary using go.
• Install service file from package/scripts/vip-manager.service to /etc/systemd/system/
• Install configuration file from package/config/vip-manager.default to /etc/default/vip-manager
• Edit config and start the service.

Configuration

The configuration can be passed to the executable through argument flags or through a YAML config file. Run vip-manager --help to see the available flags.

The location of the YAML config file can be specified with the -config flag. An exemplary config file is installed into /etc/default/vip-manager_default.yml or is available in the vipconfig directory in the repository of the software.

These configuration keys are currently mandatory:

Variable	Example	Description
VIP_IP	10.1.2.3	Virtual IP that is being managed
VIP_MASK	24	Netmask of the virtual IP
VIP_IFACE	eth0	Network interface to configure the IP address on. Usually the primary network interface.
VIP_KEY	/service/batman/leader	Key to monitor. Must match <namespace>/<scope>/leader from Patroni.
VIP_HOST	serverX	Value to trigger on. Must match <name> from Patroni.
VIP_TYPE	etcd	Type of endpoint (etcd or consul)
VIP_ENDPOINT	http://10.1.2.3:2379	Location of one or more endpoints (etcd or consul). Separate multiple endpoints with commas

PostgreSQL side prerequisites

For any virtual IP based solutions to work in general with Postgres you need to make sure that it is configured to automatically scan and bind to all found network interfaces. So something like * or 0.0.0.0 (IPv4 only) is needed for the listen_addresses parameter to activate the automatic binding. This again might not be suitable for all use cases where security is paramount for example.

Configuration - Hetzner

To use vip-manager with Hetzner Robot API you need a Credential file, set hosting_type to hetzner and your Floating-IP must be added on all Servers. The Floating-IP (VIP) will not be added or removed on the current Master node interface, Hetzner will route it to the current one.

Set hosting_type to hetzner in /etc/default/vip-manager.yml

Credential File

Add the File /etc/hetzner with your Username and Password

user="myUsername"
pass="myPassword"

Author

Cybertec Schönig & Schönig GmbH, https://www.cybertec-postgresql.com