___ __ __ _____
/ _ \__ __/ /__ ___ / // / _ |
/ ___/ // / (_-</ -_) _ / __ |
/_/ \_,_/_/___/\__/_//_/_/ |_|
Overview
PulseHA is an active-passive cluster communications manager (CCM) daemon written in GO that provides a means of communication and membership monitoring within a network cluster. By utilising Remote Procedure Calls (RPC) using Google's GRPC, PulseHA provides a reliable method of communication to ensure network high availability.
Why
PulseHA attempts to solve high availability with a more simple approach but without restricting functionality with the use of additional custom plugins.
Features
- Remote procedural calls via GRPC
- Active/Passive cluster membership monitoring
- Failure detection and recovery
- Floating IP fencing (requires network plugin)
- IPv4 & IPv6 support
- Plugin support (for additional health checks and networking logic)
- Command line interface (CLI)
Prerequisites
- Go v1.9 or later
- Protoc v3.4 or later
System Requirements
- Centos 7+
Build & Install
First you will need to clone this repository into $GOPATH/src/github.com/Syleron/PulseHA and execute the following command(s):
$ sudo make
...
Lastly, you can install PulseHA by executing the following:
$ sudo make install
...
Commands
Cluster
Cluster status
$ pulsectl status
Create a cluster
$ pulsectl create <bind ip> <bind port>
Join a cluster
$ pulsectl join -bind-ip=<bind ip> -bind-port=<bind port> -token=<cluster token> <dest ip> <dest port>
Leave a cluster
$ pulsectl leave
Remove from a cluster
$ pulsectl remove <member hostname>
Promote cluster member to become active
$ pulsectl promote <member hostname>
Generate new cluster token
$ pulsectl token
Groups
Create Floating IP Group
$ pulsectl -name=<group name> new
Delete Floating IP Group
$ pulsectl -name=<group name> delete
Assign Floating IP Group
$ pulsectl -name=<group name> -node=<member hostname> -iface=<net iface> assign
Un-assign Floating IP Group
$ pulsectl -name=<group name> -node=<member hostname> -iface=<net iface> unassign
Add Floating IP to a Floating IP Group
$ pulsectl groups -name=<group name> -node=<member hostname> -ips=<ip CIDR> -iface=<net iface> add
Remove Floating IP to a Floating IP Group
$ pulsectl groups -name=<group name> -node=<member hostname> -ips=<ip CIDR> -iface=<net iface> remove
Certificates
Re-generate TLS certificates
$ pulsectl cert <bind ip>
Config
Update/Change config value
$ pulsectl config <config key> <config value>
Network
Re-sync network interfaces
$ pulsectl network resync
Help
Pulsectl help
$ pulsectl help
Pulsectl version
$ pulsectl version
Plugins
PulseHA offers a plugin system to extend the built in functionality available.
Each plugin with configurable options will be stored as part of the main PulseHA config.
The following types of plugins are currently available:
- Health Checks
- Networking
PulseHA-Netcore
PulseHA requires a networking plugin for any floating address fencing.
The default networking plugin can be built using the following command:
$ sudo make netcore
...
Use the following command to install the plugin:
$ sudo install plugin-netcore
...
There are no configurable options for this plugin.
PulseHA-Email-Alerts
The email alerts plugin offers email notifications upon failover.
Use the following command to build this plugin:
$ sudo make genemailalerts
...
Use the following command to install the plugin:
$ sudo install plugin-genemailalerts
...
The following are configurable options:
- SmtpHost (Default: 127.0.0.1) - The network address for your SMTP host.
- SmtpPort (Default: 587) - The network port for your SMTP host.
- Username (Default: ) - Email credentials for sending via SMTP host.
- Password (Default: ) - Email credentials for sending via SMTP host.
- Email (Default: ) - The from address that will be used when sending an email via the SMTP host.
PulseHA-Ping-Groups
The Ping Groups plugin offers you to configure a single or group of network addresses as ICMP health checks.
Note: Currently ONLY has IPv4 support.
Use the following command to build this plugin:
$ sudo make hcping
...
Use the following command to install the plugin:
$ sudo install plugin-hcping
...
The following are configurable options:
- Groups (Default: []) - An array of group objects that contain a name string and network IP array.
- Weight (Default: 10) - The PulseHA score weighting for this plugin if all checks pass.
- Threshold (Default: 1) - The maximum number of address in a group that can fail before the health check fails.
- FailureCount (Default: 1) - The maximum number of ICMP attempts per address before flagging the network IP as unavailable.
PulseHA-Serial
The Serial plugin offers serial as an additional method of communication.
Use the following command to build this plugin:
$ sudo make hcserial
...
Use the following command to install the plugin:
$ sudo install plugin-hcserial
...
The following are configurable options:
- PortName (Default: /dev/ttyS0) - The name serial port on Linux.
- BaudRate (Default: 9600) - The configured baud rate for the specified port.
Acknowledgments
Thank you to all authors who have and continue to contribute to this project.
- Ben Cabot for your contributions.
License
PulseHA source code is available under the AGPL License which can be found in the LICENSE file.
Copyright (c) 2017-2022 Andrew Zak [email protected]