JeraSoft Documentation Portal
Docs for all releases
This section describes shell tools required for management of the system at the very system level. All these tools are shipped with the VCS distributive. You need to use SSH or direct access to the server in order to run any of these tools. Please notice that most of given tools require "root" access and show inline help when run without arguments.
Please use these tools only if you have clear understanding of what you are doing. Misuse of the tools may cause improper function of the system.
The tool is aimed to check minimal requirements and security recommendations at your server before and after installation.
The tool should be run under "root" permissions without any arguments. When the tool is run it will perform a list of checks and show results for each of them. Use it:
The tool checks only minimal requirements. Real hardware requirements highly depend on your traffic and deployment model.
The tool is used for managing the VCS Services. It allows you to correctly start, stop, get status of the VCS Services like RADIUS Server, SIP Server, Calculator, etc.
The tool should be run under "root" or "vcs" user. Service manager takes 2 arguments:
|Short name of the service. Run the tool without arguments to get list of the services at your system.|
Action to perform, one of the following:
Additionally you may pass next options:
|Specify the VCS location. Only if different from /usr/local/vcs.|
|Specify user the VCS runs under. Only if different from "vcs".|
For your convenience there are some examples below:
The tool also complies with LSB Init Scripts standard. It allows you to analyse exit code of each action in case of automated usage.
The tool is used to manage cluster. It allows to init the cluster, add more slaves, promote slave to master, etc.
The tool requires "root" permissions. Cluster Manager takes command as mandatory argument and additional options. Some of commands may be run only on Master and others only on Slave. All extra options for the commands are explained below in the corresponding subsection.
The command is run on the Master and used for:
This command encapsulates 4 sub-commands:
Each of this commands may be performed separately if you know exactly what you need.
The command is run on the Slave and used to promote current Slave to Master.
The command is used for failover. After you fix old Master you may add it as new Slave using "init" command.
In case when you have more than 2 nodes in cluster, you need to re-init all other slaves from this new Master.
The command is run on the Slave and used to synchronise files from the Master. The command is mostly used in crontab for auto-sync.
During initialisation of the cluster tool adds this command to the crontab (/etc/cron.d/vcs-cluster) at the Slave node.
The command may be run on any node and used to get status of the cluster.
When command is run on the Master it shows type of the node and attached Slaves, that are up to date:
When command is run on the Slave it shows type of the node and status of synchronisation.
In case when the Slave is not in synchronisation (NOT-in-sync) with the Master you need to re-initialise.
Some of commands may require additional options:
|IP Address of the master server|
|SSH Port at the master server|
|Path to PostgreSQL data folder|
|IP Address of the slave server|
|SSH Port at the slave server|
|Login to the slave server|
|Path of PostgreSQL data folder|
same as at master
|Path to the VCS location|
init, promote, sync-files
|Show status in JSON format|