Skip to content

Install overview

Niels Korschinsky edited this page Aug 26, 2021 · 2 revisions

Install-overview

SPPMon consists of 3 different components while requiring up to 10 individual install steps. An install script was created to simplify and streamline this process. Besides semi-automatically installing SPPMon via this script, you may also install SPPMon in a containerized environment. This environment is realized via Docker and prefabricated Python, Grafana, and InfluxDB-images.

User Requirements

In any case, it is required to manually create a REST-API user, as well as provide ssh-access to the SPP-Server, vSnaps, and other components like VADP and Office365-Cloudproxies.

In addition, two users for the InfluxDB need to be created during the install. This is done automatically within the install script. The user for the GrafanaDB is created after the first start.

An overview of all users can be found here.

System Requirements

For all three variants of the installation, some system requirements are presupposed. Using Docker, SPPMon is OS-independent but may also require the same storage spacing as with the other two variants.

Before any install may start, you may get the SPPMon source code via git. Please refer to the clone instructions as they provide an easy and reliable way to upgrade SPPMon onto future versions.

Start the install

Please decide which variant of the installation you want to choose. It is recommended to use the installation script, as it provides good guidance and ensures a quick installation.

  1. Install-Script
  2. Containerized environment
  3. Manual install

What's next?

After installing you may create configuration files per SPP-Server and add them into your crontab configuration for automatic execution. These steps are also executed within the install script but may need to be repeated for additional SPP-Servers.

In any variant of the install, it is required to import the Grafana Dashboards and optionally create a view-only user within Grafana.

After executing these steps you're ready to go and use SPPMon! If you have any feedback, please feel free to contact us

Clone this wiki locally