diff options
Diffstat (limited to 'docs/configuration')
| -rw-r--r-- | docs/configuration/cluster/index.rst | 76 | ||||
| -rw-r--r-- | docs/configuration/index.rst | 1 |
2 files changed, 77 insertions, 0 deletions
diff --git a/docs/configuration/cluster/index.rst b/docs/configuration/cluster/index.rst new file mode 100644 index 00000000..97678445 --- /dev/null +++ b/docs/configuration/cluster/index.rst @@ -0,0 +1,76 @@ +.. _clustering: + +Clustering +========== + +The cluster feature allows 2 vyos routers to share IP addresses 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:: none + + 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:: none + + 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:: none + + vyos@vyos:~$ show cluster status + + +Example +------- + +In the example below SSH is clustered between two nodes. + +.. code-block:: none + + cluster { + dead-interval 20000 + group cluster { + auto-failback false + primary node1 + secondary node2 + service ssh + service 192.168.0.123/24/eth0 + } + interface eth0 + keepalive-interval 5000 + monitor-dead-interval 20000 + pre-shared-secret S3cr#t + }
\ No newline at end of file diff --git a/docs/configuration/index.rst b/docs/configuration/index.rst index ee2c6354..afab98a6 100644 --- a/docs/configuration/index.rst +++ b/docs/configuration/index.rst @@ -8,6 +8,7 @@ The following structure respresent the cli structure. :maxdepth: 1 :includehidden: + cluster/index firewall/index highavailability/index interfaces/index |