Installing SPPMon via Install Script

SPPMon install via script

To simplify and streamline the install process, an install script was created. This script installs python3, InfluxDB, and Grafana. It also supports setting up the configuration files per SPP-Server and creating the crontab execution. This script requires internet access and does not work offline.

All install steps can also be executed manually if any error occurs. After the setup, you may import the Grafana Dashboards and set up additional Grafana users. It is also possible to set up alerts via Slack or mail.

You can skip individual steps if the InfluxDB or Grafana is already installed.

To add another SPP-Server to monitor after executing the install script, you may either do it manually by following the wiki instructions or by using a stand-alone script of the install script:

• python3 ./scripts/addConfigFile.py
• python3 ./scripts/addCrontabConfig.py

If you have any manual created config files, please place them in the folder spectrum-protect-sppmon/config_files

Preparations

Please refer to the page System Requirements for the initial system setup.

You may clone the SPPMon source code by following the "Getting SPPMon source code" instructions.
Please move into this folder: cd ~/spectrum-protect-sppmon.

It is required to manually create REST-API and SSH-Users before executing the install script.

Sensitive data

WARNING: This install script saves sensitive data like passwords. This information is may also available via the log of the console.

Any sensitive data is saved within the file ./scripts/delete_me_auth.txt. It is only readable for the user who started the install script or root.

You may use the file to transfer your passwords to a secure password repository: sudo cat ./scripts/delete_me_auth.txt

The last step of the script is prompt to display the data and delete the file if desired.
Please make sure to delete the file if the script is aborted.

Starting the install script

The install script is a half-automatic install process, requiring the user's input for configuration options, hostnames as well as usernames and passwords. It is required to have sudo-permissions on the system.

The script will display multiple breakpoints at which you may stop the execution and continue later. There is no guarantee for the script to work if stopped in between breakpoints.

If there are prompts, the default value will be displayed within [brackets]. Leave empty and hit enter to automatically take the value.

It is possible to execute the install script with the argument --alwaysConfirm to reduce the amount of confirming messages.

Start the script by executing following command.
./spectrum-protect-sppmon/installer

To run with less confirms use the --alwaysConfirm option:
./spectrum-protect-sppmon/installer --alwaysConfirm

Troubleshooting

If any errors occur while executing the install script, you may try to restart it. In case the error still occurs, please switch to manually installing the affected section. You may continue the script thereafter, view skip installation step to do so.

Most common errors occur when installing Python3. Please refer to the python3 install instruction and continue the script for the InfluxDB install.