VCS 3.22.x

JeraSoft Documentation Portal

User Guide

Integration Manual

Knowledge Base

Documentation Portal

Release Notes

Docs for all releases

Versions Compared

Old Version 7

changes.mady.by.user Andrii Zinchenko

Saved on

compared with

New Version Current

changes.mady.by.user Anastasiia Kovalinas

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

CommandDescription
start

Start System Service

Takes "--wait" option in order to wait and exit only when service finishes its execution.

stop

Stop System Service

restart
Stop and then start System Service
reload
Send reload (HUP) signal to the System Service (forces reload of settings, connections, etc)
status
Show current status of the System Service
all-start
Start all required System Services (list of services varies depending on the role of the current node in the cluster)
all-stop
Stop all running System Services
all-status
Show status of all System Services on the current node

Usage Examples

Code Block
languagebash
titleRestart RADIUS Server
<APP_PATH>/bin/system/service restart bbradiusd

...

The tool is used to manage nodes in the cluster deployment. It allows to initialize the cluster, add a new node, promote redundancy to master, etc. 

...

The tool requires root permissions. The list of arguments and other requirements depend on the command used. Please refer to the below table for a summary and respective sections for details.

CommandDescriptionNodesRoot Required
status
Show status of the clusterAny nodeNo
init-master
Init Master Node configurationMasterYes
init-slave
Init Slave Node configurationMasterYes
promote
Promote current node to MasterRedundancyYes
sync-files
Sync files from MasterRedundancy, Reporting, ProcessingNo
remove-node
Remove Node from the ClusterMasterYes

Cluster Status

The command shows Cluster Status, including all nodes with their roles, IP addresses, current lag to Master, and overall status.

Code Block
titleBash
<APP_PATH>/bin/system/cluster status

The command can be executed on the Master in order to get the most detailed information about the cluster:

Example of Cluster Status output

Alternatively, the command can be executed at any other node - in this case, only the status of the connection between this particular node and the Master will be shown.

If any node failed and has been disconnected from the cluster it will be shown like this:

Example of Cluster Status output with failed node

In this case, you have to re-check failed node, fix it and then return to the cluster using the "init-slave" command.

Init Master

The command is used for the initial configuration of the Master Node.

...

Command has to be executed on the Master node and requires root permissions. Following The following options are supported:

OptionDescriptionDefault
<IP-ADDRESS>
IP Address of the Master server (required)

--ssh-port=<port>
SSH Port as the master node
22
--pg-data=<path>

Path to PostgreSQL data directory

autodetect

...

The command is used to add a node to the cluster. There are different contexts when it is required:

  • First-time deployment of the cluster
  • Addition on of a new slave node to the cluster
  • Addition of the old master to work as a slave after fail overfailover
Code Block
titleBash
<APP_PATH>/bin/system/cluster init-slave <IP-ADDRESS> [<options>]

Command has to be executed on the Master node and requires root permissions. Following The following options are supported:

OptionDescriptionDefault
<IP-ADDRESS>
IP Address of the Slave server (required)

--role=<role>

Role of the new node:

  • redundancy - fully-featured redundancy, that acts as a hot standby and can be promoted to the Master at any time (may be used for redundancy and load balancing at the same time)
  • reporting - a node that receives most of the requests for the reports, holds a full snapshot of the database, however, it might be delayed from Master depending on the current load and requests (might be used for fail overfailover, as a last resort)
  • processing - lightweight node for processing of real-time requests (authentication, authorization, and routing), can not be used for fail over failover as it does not hold any statistical data
redundancy
--ssh-port=<port>
SSH Port at the remote node
22
--ssh-user=<user>
SSH User at the remote node
jerasupport
--pg-data=<path>

Path to PostgreSQL data directory at the remove node

autodetect

...

The command is used to promote the Redundancy node to Master.

...

Command has to be executed on the Redundancy node and requires root permissions. Reporting node can be used as a last resort if there are no Redundancy node alive. There are no options required.

After the promotion is performed, all required System Services will be started on the current node (new master). After you fix the old Master, you may add it as a new Slave using the "init-slave" command.

Panel
borderColor#ffffb3
bgColor#ffffb3
borderWidth2px

(warning)   Attention

In case when you have more than 2 nodes in the cluster, you need to re-init all other node nodes from this new Master.

Sync Files

...

Command has to be executed on the Redundancy node and by default, it is added to the crontab for automatic synchronisationsynchronization.

Remove Node

The command is used to remove a node from the cluster.

Code Block
titleBash
<APP_PATH>/bin/system/cluster remove-node <IP-ADDRESS>

Command has to be executed on the Master node. The node in question shouldn't have any active database replication. Following The following options are supported:

OptionDescriptionDefault
<IP-ADDRESS>
IP Address of the remote node (required)

...