Docs for all releases
Page History
...
This section describes shell tools required for the deployment management of the system. All these tools are part of the JeraSoft Billing distributive. In order to use the tools you will need either SSH or direct access to the server console. Some of the tools require root permissions to run.
| Panelwarning | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Please use these tools only if you have a clear understanding of what you are doing. Misuse of the tools may cause improper functioning of the system. |
| Panelnote | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Please note For simplification, for simplification we introduced <APP_PATH> variable that refers to the JeraSoft Billing application files location. This location may differ, but typically it is "/opt/jerasoft/vcs". So whenever you see an example with a path like like "<APP_PATH>/bin/system/cluster" it means "/opt/jerasoft/vcs/bin/system/cluster". |
...
The tool is aimed to check the minimal requirements and security recommendations of your server before and after installation.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<APP_PATH>/bin/system/setup-checker |
The tool requires root permissions and takes no arguments. It should be executed before installation of the system in order to check minimal hardware and software requirements.
...
Services Manager
The tool is used forthe management of System Services. It allows you to correctly start, stop, and perform other actions over various JeraSoft Billing Services such as RADIUS Server, SIP Server, Calculator, etc.
...
The tool should be run under root or vcs user. The tool typically takes 2 arguments – action to perform and related system service. Actions prefixed with "all-*" do not require a service name and operate over all services.
| Command | Description |
|---|---|
start | Start a System Service Takes "--wait" option in order to wait and exit only when the service finishes its execution. |
stop | Stop a System Service |
restart | Stop and then start a System Service |
reload | Send reload (HUP) signal to the System Service (forces reload of settings, connections, etc) |
status | Show the current status of the System Service |
all-start | Start all required System Services (the 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 the status of all System Services on the current node |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<APP_PATH>/bin/system/service all-start |
| Info |
|---|
The tool also complies with LSB Init Scripts standard. It allows you to analyze the exit code of each action in case of automated usage. |
Cluster Manager
The tool is used to manage nodes in the cluster deployment. It allows to initialize initialization of the cluster, add adding a new node, promote redundancy promoting slave to master, etc.
| Code Block | ||||
|---|---|---|---|---|
| ||||
<APP_PATH>/bin/system/cluster <COMMAND> [<options>] |
The tool requires root permissions. The list of arguments and other requirements depend on the command used. Please refer to the table below table for a summary and respective sections for details.
...
| Option | Description | Default |
|---|---|---|
<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 |
...
| Option | Description | Default |
|---|---|---|
<IP-ADDRESS> | IP Address of the Slave server (required) | |
--role=<role> | Role of the new node:
| 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 |
...
| Option | Description | Default |
|---|---|---|
<IP-ADDRESS> | IP Address of the remote node (required) | |
Overview
Content Tools