Shield Services

Shield includes the following services:

• Install Shield
• Prepare Servers
• Add Shield Repository
• Deploy Shield
• Delete Shield
• Shield Support

Please use these services as required during the different processes of installation, modifying an existing cluster, upgrading a version etc.

Install Shield

This service is used to install Shield, or upgade to a new version.

Retrieve the install-shield.sh script:

curl -s -o install-shield.sh https://raw.githubusercontent.com/EricomSoftwareLtd/Shield/master/Kube/scripts/install-shield.sh
chmod +x install-shield.sh

Usage:

sudo ./install-shield.sh -p <PASSWORD> [-v|--version <version-name>] [-r|--releases] [--registry <RegistryIPAddress:Port>] [-n|--namespase <NAMESPACE> (<NAMESPACE>)] [-l|--label] [-h|--help]

Arguments:

-p: Shield repository requires a valid password. Contact Ericom Shield Professional Services to get a password and replace it in the command.
[-v|--version] <version-name>: Install a specific version. The version name format is: Rel-yy.mm.xxx (e.g. Rel-20.03.641)
[-r|--releases]: Display the list of the 3 latest versions that can be installed
[--registry < RegistryIPAddress:port>]: Offline installation only. Use a shield registry for docker images
[-n|--namespace <NS> (<NS>)]: Install only the specified namespace(s). Keep other namespaces unchanged
[-l|--label]: Set Labels
[-h|--help]: display the options menu

Prepare Servers

This service prepares the server nodes before they can be joined into a cluster, e.g. configures the OS settings, installs docker etc.

Usage:

./shield-prepare-servers [-u <USER>] <ServerIPAddress(s)>

<ServerIPAddress(s)> represents the IP addresses of the server nodes. Multiple IP addresses may be entered, separated by a space (” “).

Arguments:

[-u|--user]: a username to use to connect to a node via SSH (should be the same on all the nodes)
[--offline-mode]: Do not execute tasks that require Internet Connection
[--offline-registry] <address:port>: IP address and port of the Offline Registry

E.g.:

sudo ./shield-prepare-servers -u ericom xx.xx.xx.xx yy.yy.yy.yy zz.zz.zz.zz

or - when offline:

./shield-prepare-servers -u ericom --offline-mode --offline-registry vv.vv.vv.vv:5000 xx.xx.xx.xx yy.yy.yy.yy zz.zz.zz.zz)

Note

The Kernel may be updated during this process (if required).

Re-Start Shield

To restart Shield, use the stop.sh and start.sh scripts available under the /ericomshield folder The first script stops and removes all shield namespaces and the second runs them from fresh.

Usage:

stop.sh [-n|--namespace <NAMESPACE>] [-s|--silent] [-k|--keep-namespace] [-h|--help]

Argumets:

-n: Delete a specific namespace: shield-management, shield-proxy, shield-farm, shield-elk
-s: Silent: do not ask for confirmation)
-k: Skip deleting a specific namespace

Usage:

start.sh [-n|--namespace <NAMESPACE>] [-l|--label] [-o|--overwrite] [-f|--force] [-h|--help]

Arguments:

-n: Deploy a specific namespace: shield-management, shield-proxy, shield-farm, shield-elk
-l: Set Labels
-f: Force Option
-o: Overwrite yaml files