diff options
| -rw-r--r-- | docs/clustering.rst | 60 |
1 files changed, 54 insertions, 6 deletions
diff --git a/docs/clustering.rst b/docs/clustering.rst index b3dae0b6..74cfcf42 100644 --- a/docs/clustering.rst +++ b/docs/clustering.rst @@ -3,8 +3,59 @@ Clustering ========== +The cluster feature allows 2 vyos routers to share IP adresses and various services. + VyOS supports multicast clustering. +.. note:: + Please follow the process of the cluster function here. https://phabricator.vyos.net/T985 + + +General cluster configuration +----------------------------- + +In the general cluster configuration the network interfaces used for monitoring and negotiation of the cluster health is defined. +Additionally, the communication interval settings, multicast group (for sending/receiving heartbeat messages), and pre-shared secret used in this monitoring is defined. + +.. code-block:: sh + + vyos@vyos# set cluster + Possible completions: + dead-interval Interval after which a node is considered dead after missing heartbeats (milliseconds) + +> group Name of resource group for clustering [REQUIRED] + + interface Interface(s) for sending/receiving heartbeat packets [REQUIRED] + keepalive-interval Time interval between heartbeat packets (milliseconds) + mcast-group Multicast group for sending/receiving heartbeat packets + monitor-dead-interval Interval after which a monitor node is considered dead (milliseconds) + pre-shared-secret Pre-shared secret for authentication between cluster nodes [REQUIRED] + +Cluster group configuration +--------------------------- + +For the cluster group configuration, the group name must be defined before the groups configuration can be set (See Example below). +After the group name is defined, the specific service to be clustered between primary and secondary nodes is configured. + +.. code-block:: sh + + vyos@vyos# set cluster group GROUPNAME + Possible completions: + auto-failback Fail back to primary node if it recovers from failure + + monitor IP address(es) for monitoring connectivity + primary Host name of the primary node [REQUIRED] + + secondary Host name(s) of the secondary node(s) [REQUIRED] + + service IP address(es) or service name(s) in this resource group [REQUIRED] + +Review cluster status +--------------------- + +.. code-block:: sh + + vyos@vyos:~$ show cluster status + + +Example +------- + In the example below SSH is clustered between two nodes. .. code-block:: sh @@ -13,8 +64,8 @@ In the example below SSH is clustered between two nodes. dead-interval 20000 group cluster { auto-failback false - primary vyos - secondary vyos2 + primary node1 + secondary node2 service ssh service 192.168.0.123/24/eth0 } @@ -22,7 +73,4 @@ In the example below SSH is clustered between two nodes. keepalive-interval 5000 monitor-dead-interval 20000 pre-shared-secret S3cr#t - } - -.. note:: - Please follow the process of the cluster function here. https://phabricator.vyos.net/T985
\ No newline at end of file + }
\ No newline at end of file |