Installation & update

Supervisor is a containerized application, provided as a docker image.

In order to perform the application deployment, the following elements are necessary:

• docker installed and running;
• Profitap Supervisor docker image (provided);
• Profitap Supervisor license file (provided).

Minimum:

• Processor: Any physical x86_64 CPU with 4 threads capability and a top frequency of 2.40 GHz;
• System RAM: 4 GB;
• Available disk space: 2 GB.

Suggested:

• Processor: Any physical x86_64 CPU with 8 threads capability and a top frequency of 3 GHz;
• System RAM: 8 GB;
• Available disk space: 4 GB.

The installation can be performed using the following commands in order:

1. Create a directory to be used to store the supervisor configuration and license:

mkdir -p /home/user/supervisor-data/

This is only a reference path used for this documentation. If a different path is used, edit the following commands accordingly.

2. Copy the provided license file in the data directory:

cp SFM-010010-10.lic /home/user/supervisor-data/license.lic

Replace the name of the file in this command with the actual license file provided.

3. Load the provided Supervisor docker container (replace X.Y.Z with the appropriate version number):

docker load -i profitap-supervisor-vX.Y.Z.tar

4. Run the Supervisor docker container, specifying the correct data directory (replace X.Y.Z with the appropriate version number):

docker run -v /home/user/supervisor-data:/data:Z --network host --name supervisor -d profitap-supervisor:vX.Y.Z

At this point, the Supervisor application should be running. If you wish to verify that deployment has proceeded correctly, you can check the running containers using the following command:

docker ps

The Profitap Supervisor container should appear.

The Supervisor container is designed to operate optimally using limited available resources. In the case of big deployments, the resources allocated by default may not be sufficient. In this case, it’s possible to scale up the performance of the Supervisor application using the environment variable SUPERVISOR_THREADS. The default value for this parameter is 4, but it can be increased to up to 16 to take advantage of the performance offered by a CPU with a high number of cores.

The variable can be used when running the container, like in the following command:

docker run -v /home/user/supervisor-data:/data:Z -e SUPERVISOR_THREADS=8 --network host --name supervisor -d profitap-supervisor:vX.Y.Z

1. Stop the Supervisor container:

docker stop supervisor

2. Replace the certificate (cert.pem) and key (key.pem) files in the data directory with the one you want to use.

3. Restart the Supervisor container:

docker run -v /home/user/supervisor-data:/data:Z --network host --name supervisor -d profitap-supervisor:vX.Y.Z

If you wish to recreate a new self-signed certificate, in step 2, remove the cert.pem and key.pem files.

In order to use certain Supervisor functionalities, you may need to import a custom CA certificate. This is done by copying the certificate to a 'ca' directory in the Supervisor data directory.

1. Stop the Supervisor container:

docker stop supervisor

2. Create the 'ca' directory if necessary:

mkdir -p /home/user/supervisor-data/ca/

3. Copy the custom CA certificate to the 'ca' directory:

cp private-ca-cert.crt /home/user/supervisor-data/ca/

4. Restart the Supervisor container:

docker run -v /home/user/supervisor-data:/data:Z --network host --name supervisor -d profitap-supervisor:vX.Y.Z

When using the Supervisor docker container, the update process simply consists of shutting down the currently-running docker container, and starting the new updated docker container using the same data directory. The new instance will perform all of the necessary data migration. It is good practice to perform a backup of the Supervisor configuration before proceeding with the update (see Configuration Backup and Restore).

In order to perform the update, the following elements are necessary:

• Currently installed Supervisor docker container;
• Data directory (we are using /home/user/supervisor-data for this example);
• Supervisor license file.

The steps for updating Supervisor are as follows:

1. (Optional) Backup the current Supervisor configuration (see Configuration Backup and Restore).

2. Load the new docker container in your local registry (replace X.Y.Z with the appropriate version number):

docker load -i profitap-supervisor-vX.Y.Z.tar

3. Stop previous instance using the following command:

docker stop supervisor

4. Start a new docker container instance (replace X.Y.Z with the appropriate version number):

docker run -v /home/user/supervisor-data:/data:Z --network host --name supervisor -d profitap-supervisor:vX.Y.Z

Once deployed, Supervisor is accessible through the following ports:

• 443: HTTPS GUI and API access;
• 80: HTTP redirection to HTTPS GUI;
• 8080: HTTP API access (docker container only).

The first access is possible using the following default credentials:

• username: admin
• password: admin

Note: It is strongly recommended to change the default administrator password when first accessing Supervisor.

To access the GUI, open a web browser and enter the Supervisor address in the address bar:

https://<ip_addr>

<ip_addr> being the IP address of the machine running the docker container.

Login, using the appropriate account credentials.

To change the default password, click the Default Admin link at the bottom left of the screen and enter a new password in the Edit User window.