Managed Servers Installation - New | ProVision Documentation (PV Local Installs)

The Managed Servers tab allows for DNS, DHCP, and Backup VM servers to be created, installed, managed, and monitored from within ProVision.

Managed Servers is handled via two main areas of the GUI: the Managed Servers Tab and in Admin → Admin Settings - Managed Servers sub-tab. Managed servers actions are also available via APIv2 and the command line.

Requirements

Note: Python3, Docker, and Rabbit MQ services are used to support and run Managed Servers. Local customers planning on utilizing managed servers will need to either install these services, or contact support for assistance to accommodate specific network needs.

Required installations are already included for hosted customers.

Installation & Setup Overview

Managed Server setup begins with determining cloud vs local installation and setting up Managed Servers in the ProVision Admin Settings. Once the services are selected, the installation package will be installed per the install mode.

The necessary packages for installation (if not already installed with your ProVision instance) are:

RabbitMQ,
Python 3.6+: Should be installed on the target VM for the managed server in advance, prior to starting the managed server installation.
Docker: Should be installed on the target VM for the managed server in advance, prior to starting the managed server installation.

If an internet connection is established, Docker will be automatically installed by ProVision scripts.

Logic Flow Chart for Managed Servers Setup

Install Packages

Install necessary packages (RabbitMQ, Python 3.6+, Docker), if not already installed with your ProVision instance.

Step 1: Install RabbitMQ

If RabbitMQ has not already been installed on your ProVision instance / VM, you will need to install it by running the included shell script (Note: Installing RabbitMQ requires internet access.):

1.1) Install RabbitMQ

Run install_rabbitmq.sh.

/usr/bin/sh /path_to_provision/tools/install_rabbitmq_{OS}.sh

Ubuntu RabbitMQ installation script:

install_rabbitmq_ubuntu.sh

Bash

#!/usr/bin/sh
 
# https://www.rabbitmq.com/install-debian.html#apt-quick-start-cloudsmith
 
sudo apt-get install curl gnupg apt-transport-https -y
 
## Team RabbitMQ's main signing key
curl -1sLf "https://keys.openpgp.org/vks/v1/by-fingerprint/0A9AF2115F4687BD29803A206B73A36E6026DFCA" | sudo gpg --dearmor | sudo tee /usr/share/keyrings/com.rabbitmq.team.gpg > /dev/null
## Launchpad PPA that provides modern Erlang releases
curl -1sLf "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xf77f1eda57ebb1cc" | sudo gpg --dearmor | sudo tee /usr/share/keyrings/net.launchpad.ppa.rabbitmq.erlang.gpg > /dev/null
## PackageCloud RabbitMQ repository
curl -1sLf "https://packagecloud.io/rabbitmq/rabbitmq-server/gpgkey" | sudo gpg --dearmor | sudo tee /usr/share/keyrings/io.packagecloud.rabbitmq.gpg > /dev/null
 
## Add apt repositories maintained by Team RabbitMQ
sudo tee /etc/apt/sources.list.d/rabbitmq.list <<EOF
## Provides modern Erlang/OTP releases
##
## "bionic" as distribution name should work for any reasonably recent Ubuntu or Debian release.
## See the release to distribution mapping table in RabbitMQ doc guides to learn more.
deb [signed-by=/usr/share/keyrings/net.launchpad.ppa.rabbitmq.erlang.gpg] http://ppa.launchpad.net/rabbitmq/rabbitmq-erlang/ubuntu focal main
deb-src [signed-by=/usr/share/keyrings/net.launchpad.ppa.rabbitmq.erlang.gpg] http://ppa.launchpad.net/rabbitmq/rabbitmq-erlang/ubuntu focal main
 
## Provides RabbitMQ
##
## "bionic" as distribution name should work for any reasonably recent Ubuntu or Debian release.
## See the release to distribution mapping table in RabbitMQ doc guides to learn more.
deb [signed-by=/usr/share/keyrings/io.packagecloud.rabbitmq.gpg] https://packagecloud.io/rabbitmq/rabbitmq-server/ubuntu/ focal main
deb-src [signed-by=/usr/share/keyrings/io.packagecloud.rabbitmq.gpg] https://packagecloud.io/rabbitmq/rabbitmq-server/ubuntu/ focal main
EOF
 
## Update package indices
sudo apt-get update -y
 
## Install Erlang packages
sudo apt-get install -y erlang-base \
	                        erlang-asn1 erlang-crypto erlang-eldap erlang-ftp erlang-inets \
				                        erlang-mnesia erlang-os-mon erlang-parsetools erlang-public-key \
							                        erlang-runtime-tools erlang-snmp erlang-ssl \
										                        erlang-syntax-tools erlang-tftp erlang-tools erlang-xmerl
 
## Install rabbitmq-server and its dependencies
sudo apt-get install rabbitmq-server -y --fix-missing

sudo rabbitmq-plugins enable rabbitmq_management

sudo rabbitmq-server start -detached

sleep 5

sudo rabbitmqctl add_user pv_rabbitmq S3curePassW0rd!
sudo rabbitmqctl set_user_tags pv_rabbitmq administrator
sudo rabbitmqctl set_permissions -p / pv_rabbitmq ".*" ".*" ".*"

sudo systemctl enable rabbitmq-server

echo "RabbitMQ user is:  pv_rabbitmq"
echo "RabbitMQ password is:  S3curePassW0rd!"
echo "RabbitMQ port is:  5672"
echo "RabbitMQ management port is:  15672"

CentOS RabbitMQ installation script:

install_rabbitmq_centos.sh

Bash

#!/usr/bin/sh

# https://www.rabbitmq.com/install-debian.html#apt-quick-start-cloudsmith

sudo yum install curl gnupg apt-transport-https -y

## Team RabbitMQ's main signing key
curl -1sLf "https://keys.openpgp.org/vks/v1/by-fingerprint/0A9AF2115F4687BD29803A206B73A36E6026DFCA" | sudo gpg --dearmor | sudo tee /usr/share/keyrings/com.rabbitmq.team.gpg > /dev/null
## Launchpad PPA that provides modern Erlang releases
curl -1sLf "https://keyserver.ubuntu.com/pks/lookup?op=get&search=0xf77f1eda57ebb1cc" | sudo gpg --dearmor | sudo tee /usr/share/keyrings/net.launchpad.ppa.rabbitmq.erlang.gpg > /dev/null
## PackageCloud RabbitMQ repository
curl -1sLf "https://packagecloud.io/rabbitmq/rabbitmq-server/gpgkey" | sudo gpg --dearmor | sudo tee /usr/share/keyrings/io.packagecloud.rabbitmq.gpg > /dev/null

## Add apt repositories maintained by Team RabbitMQ
#sudo tee /etc/apt/sources.list.d/rabbitmq.list <<EOF
## Provides modern Erlang/OTP releases
##
## "bionic" as distribution name should work for any reasonably recent Ubuntu or Debian release.
## See the release to distribution mapping table in RabbitMQ doc guides to learn more.
#deb [signed-by=/usr/share/keyrings/net.launchpad.ppa.rabbitmq.erlang.gpg] http://ppa.launchpad.net/rabbitmq/rabbitmq-erlang/ubuntu focal main
#deb-src [signed-by=/usr/share/keyrings/net.launchpad.ppa.rabbitmq.erlang.gpg] http://ppa.launchpad.net/rabbitmq/rabbitmq-erlang/ubuntu focal main

## Provides RabbitMQ
##
## "bionic" as distribution name should work for any reasonably recent Ubuntu or Debian release.
## See the release to distribution mapping table in RabbitMQ doc guides to learn more.
#deb [signed-by=/usr/share/keyrings/io.packagecloud.rabbitmq.gpg] https://packagecloud.io/rabbitmq/rabbitmq-server/ubuntu/ focal main
#deb-src [signed-by=/usr/share/keyrings/io.packagecloud.rabbitmq.gpg] https://packagecloud.io/rabbitmq/rabbitmq-server/ubuntu/ focal main
#EOF

## Update package indices
sudo yum update -y

## Install Erlang packages
sudo yum install -y erlang-base erlang-asn1 erlang-crypto erlang-eldap erlang-ftp erlang-inets erlang-mnesia erlang-os-mon erlang-parsetools erlang-public-key erlang-runtime-tools erlang-snmp erlang-ssl erlang-syntax-tools erlang-tftp erlang-tools erlang-xmerl

## Install rabbitmq-server and its dependencies
sudo yum install rabbitmq-server -y

sudo rabbitmq-plugins enable rabbitmq_management

sudo rabbitmq-server start -detached

sleep 5

sudo rabbitmqctl add_user pv_rabbitmq S3curePassW0rd!
sudo rabbitmqctl set_user_tags pv_rabbitmq administrator
sudo rabbitmqctl set_permissions -p / pv_rabbitmq ".*" ".*" ".*"

sudo systemctl enable rabbitmq-server

echo "RabbitMQ user is:  pv_rabbitmq"
echo "RabbitMQ password is:  S3curePassW0rd!"
echo "RabbitMQ port is:  5672"
echo "RabbitMQ management port is:  15672"

This script is taken from Installing on Debian and Ubuntu — RabbitMQ and may need an update in future.

1.2) Verify Installation

You may verify the installation is working by opening http://your.host:15672

1.3) Enter RabbitMQ Admin Settings

Once confirmed working, go to ProVision Admin Settings → Managed Server Settings. Then, enter the RabbitMQ IP, port, username, and password into the RabbitMQ Settings section. When done, click "Save Changes".

Step 2: Enter Managed Servers Settings

In ProVision, navigate to Admin Settings → Managed Servers and enter or verify settings in the following areas:

2.1) Enter Monitoring Settings

Under Monitoring Settings, select the "Default Monitoring API IP", and enter any additional setting options as follows:

Monitoring Settings for Managed Servers

Default Monitoring API IP: The default IP to be used for API calls (heartbeat, activation, etc.) for managed server monitoring and to send API requests, as multiple IPs may be available depending on the Provision set up.
Note: The Default Monitoring API IP can be set to a default value in this area, but it may also be set individually per managed server as an override.
Verify CA: Toggle to "on" if you wish to enable the CA check.
Communication type: Push (when the server pushes data to ProVision) and pull (when ProVision connects to the server and pulls the data). Push is preferred, but Pull-based may be desirable in cases where a firewall would not allow inbound connections to ProVision.
Monitoring of the system: Toggle to "on" to enable monitoring of system statistics.
System monitoring interval: How often (in seconds) the system will be checked. The smaller the interval, the more data there will be to store.
Monitoring of the DNS: Toggle to "on" to enable gathering statistics from the DNS server.
DNS monitoring interval: How often (in seconds) the DNS server will be monitored. Data will be aggregated for the set period of time and the aggregated results will be sent.
Raw data retention: The number of minutes to retain raw data. By default, this is set to 1440 minutes (1 day). Raw data requires sizable storage needs.
Aggregated data retention: The number of days to retain aggregated data.

2.2) Enter Managed Backup Settings

If in use, enter the password for Managed Backup Servers and click "save changes".

8.3.0 Admin Managed Server Backup Settings.png

2.3) Enter Update Settings

Enter Update settings to use for Managed Servers, starting with API timeout (in milliseconds) and Update Mode.

Fill in the remaining update settings as applicable to the selected update mode:

Internet Docker Update (Recommended) - This uses a Docker update directly from our docker registry. Internet connection is required for the managed server in order this mode to work. When this is chosen, fields to enter tokens for the DNS / DHCP repository will displayed.

Update Settings - Docker Update Mode (Internet)

Update Settings - Docker Update Mode (Internet)

8.3.0 Admin Managed Servers Update Settings- Docker.png

API timeout: Timeout for API calls in milliseconds.

Update Mode: Enter the source for updates, depending on internet accessibility. Two options are available:

Image Download (Local) - This option is to update from ProVision, locally. No internet connection is required from the managed server, but an image file must be manually downloaded from a separate secure site and then uploaded into ProVision.

If "Image Download (Local)" is selected, you must download the image file from a secure site to then upload for this setting. Please contact support for credentials to access the image download area.

Internet Docker Update - This uses a Docker update directly from our docker registry. Internet connection is required for the managed server in order this mode to work. When this is chosen fields for tokens for our gitlab/registry appear to be filled in:
- Update username: Enter the username for updates.
- DNS update token: Enter the token for the DNS repository.
- DHCP update token: Enter the token for the DHCP repository.
- Monitoring update token: Enter the token for the Monitoring repository.
- Backup update token: Enter the token for the Backup Monitoring repository.
Test Tokens: Click to test the applied tokens for DNS, DHCP, and Monitor.

For assistance obtaining repository tokens, please contact support.

ProVision Image Download - If Update Mode is set to "Image Download (Local)", then no internet connection is required from the managed server, but an image file must be manually downloaded from a separate secure site to then upload into ProVision.

Update Settings - Image Download (Local)

Update Settings - Image Download (Local)

If Update Mode is set to "Image Download (Local)", the following settings will display to enter:

Image file: Attach the Image file for upload to ProVision.

If "Image Download (Local)" is selected, you must download the image file from a secure site to then upload for this setting. Please contact support for credentials to access the image download area.

API timeout: Timeout for API calls in milliseconds.

Update Mode: Enter the source for updates - Image Download (Local), or opt to change to Docker Update (Requires Internet).

Images history: Available only after saving changes. Once a history is available, it will display at the top of the module.

8.3.0 Admin Managed Servers Update Settings Image w history.png

Test Tokens: Click to test the applied tokens for DNS, DHCP, and Monitor.

2.4) Enter RabbitMQ Settings into Admin Settings

Enter the RabbitMQ IP, port, username, and password into the RabbitMQ Settings section. To verify the settings, click "Test Credentials".

When done, click "Save Changes".

Step 3: Install Python 3 & Additional Services

Python 3.6+ and Docker should be installed on the target VM for the managed server in advance, prior to starting the managed server installation.

If an internet connection is established, Docker will be automatically installed by ProVision scripts.

3.1) Setup the necessary services:

Run MQ workers

python3 /path_to_provision/pvservers/setup/pv_install/setup_services.py