EricomShield-Setup-Node Switches¶
The addnodes service includes the following optional switches:
Specify the IPs of machines to append, separated by commas (‘,’):
[-ips|--machines-ip]
Allow shield-browser containers to be allocated on this node. Defines the node as browsers farm component:
[-b|--browser]
Allow shield core containers to be allocated on this node. Defines the node as core component:
[-sc|--shield-core]
Allow to shield management container to be allocated on node. Defines the node as management component (and as manager node):
[-mng|--management]
Add the nodes using offline mode only (required for OVA multi-machine deployment):
[--offline]
Define ssl username (if other the domain user):
[-u|--user]
Name of certificate file. Certificate file must be in the same directory as script. Default name is shield_crt. When using default name, no need to specify it:
[-c|--certificate]
Define how to connect to this node, using a password or a certificate. Possible values: password/certificate/cert. Default - password:
[-s| --session-mode]
Usage Examples¶
To add a node that will include browser containers only, run:
sudo ./addnodes.sh -ips xx.xx.xx.xx --browser
To add a node that will include management containers only, run:
sudo ./addnodes.sh -ips xx.xx.xx.xx --management
To add a node that will include shield core containers only, run:
sudo ./addnodes.sh -ips xx.xx.xx.xx --shield-core
Components can be combined on the same node. To add a node with management containers AND core containers in it, run:
sudo ./addnodes.sh -ips xx.xx.xx.xx –management --shield-core
Shield Multi-Machine Use Cases¶
Here are several recommended use cases and how to set them up.
High Availability¶
For high-availability deployment, it is recommended to have 3 machines which include all component types on each one of them.
To create this type of multi-machine system, follow these steps:
Create the leader and activate it.
From the leader, run the addnodes service to create the cluster with the following configuration:
sudo ./addnodes.sh -ips xx.xx.xx.xx,yy.yy.yy.yy --management --shield-core --browser
The newly created cluster will now include 3 machines, all with both management, core and browser components running on them.
Scalability¶
For a scalable system, with a high number of users, it is recommended to have 3 management nodes, 2 core nodes and as many browsers nodes are required.
To create this type of multi-machine system, follow these steps:
Create the leader and activate it.
Add 2 management and core nodes:
sudo ./addnodes.sh -ips xx.xx.xx.xx,yy.yy.yy.yy --management --shield-core
Add the browsers nodes (as many as required):
sudo ./addnodes.sh -ips xx.xx.xx.xx,yy.yy.yy.yy,zz.zz.zz.zz --browser
Make the leader a management node only (no need for it to contain core components and browsers components):
sudo ./nodes.sh -remove-label <LeaderNodeName> shield-core browser
Multi-Machine Deployment Using OVA¶
In this scenario, while creating a cluster using OVA installation, it is highly important to use the --offline
switch:
sudo ./addnodes.sh --offline -ips xx.xx.xx.xx,yy.yy.yy.yy --management --shield-core --browser
Troubleshooting¶
If the service ends with errors, please check the lastoperation.log file (in the same folder) for additional information.
If the service failed due to the pre-installation checks, try to solve the issues that were found in these checks. However, it is possible to run the service again, excluding these checks.
Run the same command, this time use the --no-check
argument to avoid executing these pre-installation checks.