1. Support
  2. Knowledge base
  3. Checkpoints
  4. Install a Docker Private Checkpoint

Install a Docker Private Checkpoint

We’re changing our user interface. Some info may not yet be up to date. Please check From classic to new UI.

In this knowledge base article, we explain how to set up a Windows 2019 server as a host operating system and the steps to set up and start a containerized Docker Private Checkpoint Beta. Uptrends will provide you with the needed files. You’ll find more information about how to get a Private Checkpoint in our Docker Private Checkpoint article.

Requirements

Check the following required hardware specifications for adding a Private Checkpoint. For the best combination of performance and reliability we recommend using three instances, each with specifications as defined below.

Minimum Recommended
CPU 2 cores 4 cores
RAM 4 GB 8 GB
Storage 60 GB 60 GB on fast storage (SSD)
Network 100 Mbps 1 Gbps
OS Windows Server 2019 LTS Standard Windows Server 2019 LTS Standard
Virtualization Enabled Enabled

You will need to meet the following network requirements.

IPv4 Fixed IPv4 address for each Checkpoint server
IPv6 Optional, depending on whether you use IPv6 in the monitored infrastructure.
Network Although we recommend 1 Gbps, the actual usage of this connection is much lower (usually 1 to 10 Mbps 95%) and very constant. A connection to the internet that is well dimensioned to transfer the measurement data to the Uptrends platform.

Network Settings

Firewall

There should not be SSL inspection on the traffic between the Checkpoints and the Uptrends cloud servers. The firewall should allow long living outbound WebSocket connections.

IPv6 requirements

If the internal network is IPv6 enabled, please supply a fixed IPv6 address and gateway for each checkpoint server. The IPv6 IP Address enables us to monitor your infrastructure through IPv6 (with the proper firewall configuration). Without the fixed IPv6 address, Uptrends can only monitor through IPv4.

DNS servers

The Private Checkpoint requires a DNS server to be configured on the Docker Host.

FCrDNS

If you would like to monitor mail servers through an external route, configure reverse DNS using: checkpoint_name@uptrends.net to resolve to the corresponding external IP address.

Prerequisites for Docker Private Checkpoints

First check if Hyper-V is installed, to be able to create a virtual machine. If not, install it from PowerShell (make sure you’re running PowerShell as Administrator): Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Hyper-V -All Confirm that the Windows Feature containers have been installed. If not, install them from PowerShell: Install-WindowsFeature containers

Installing Docker tools

You can skip this step if you are using Docker Desktop

  1. Install Docker Engine Get a link to the most recent version on https://download.docker.com/win/static/stable/x86_64/ and change the line below to match the most recent version.

​Open a PowerShell command line and execute these steps:

  curl.exe -o docker.zip -LO https://download.docker.com/win/static/stable/x86_64/docker-20.10.17.zip 

  Expand-Archive docker.zip -DestinationPath C:\

  [Environment]::SetEnvironmentVariable("Path", "$($env:path);C:\docker", [System. EnvironmentVariableTarget]::Machine)

  $env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine")

  dockerd --register-service

  Start-Service docker  

​ 2. Install Docker Compose (source). Compose is used for defining and running multi-container Docker applications.

  [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

  Invoke-WebRequest "https://github.com/docker/compose/releases/latest/download/docker-compose-Windows-x86_64.exe" -UseBasicParsing -OutFile C:\Docker\docker-compose.exe

Docker Compose file with Checkpoint settings

Uptrends will provide you with a Docker Compose file. Extract the CheckpointSettings_(hostname).zip to C:\Uptrends\Checkpoint (so that the docker-compose.yaml file is located at C:\Uptrends\Checkpoint\docker-compose.yaml) ​

Obtaining the Docker images

  1. Login to the Azure container repository: docker login -u <<uptrends-repository-username>> -p <<uptrends-repository-password>> uptrends.azurecr.io

Uptrends will provide you with the credentials to log in.

  1. Pull the containers from the Checkpoint folder containing docker-compose.yaml by executing docker-compose pull

Starting the containers for the first time

Start the containers from the Checkpoint folder (containing docker-compose.yaml) by executing docker-compose up

Automatic startup

Once everything is running correctly you might even try to start a monitor check at your checkpoint. Please note that the Docker containers do not start automatically when your Hosts' operating system is restarted. To ensure they remain enabled after a reboot use a scheduled task to re-enable the containers:

​ First, create a new task in the Task Scheduler. To access the Task Scheduler, type the word “schedule” in the search box on your taskbar, and then click Task Scheduler to open it. ​

General Settings

>> Run whether user is logged on or not
>> Run with highest privileges

Triggers

>> New Trigger
  >> Begin the task: At startup
  >> Delay task for: 1 minute

Actions

>> New Action
  >> Program: docker-compose.exe
  >> Arguments: down
  >> Start in: C:\Uptrends\Checkpoint (or wherever the docker-compose.yml file is located)

Actions

>> New Action
  >> Program: docker-compose.exe
  >> Arguments: up
  >> Start in: C:\Uptrends\Checkpoint (or wherever the docker-compose.yml file is located)

Conditions

>> Wake the computer to run this task
>> Start only if the following network connection is available: Any connections

Settings

>> Allow the task to be run on demand
>> If the task fails, restart every: 1 minute
>> If the running task does not end when requested, force it to stop.

​ When the task has been created, run it.

Monitoring your Private Checkpoint

Changes will be made to your Uptrends account to assist you in the monitoring of your Private Checkpoint. The Private Checkpoint’s servers, firewall, and Internet connection all belong to you; therefore, it is your responsibility to make sure that the Private Checkpoint and supporting systems remain available. To assist you, modifications in your Uptrends account will be carried out.

During your Private Checkpoint setup, you will notice the changes in your Uptrends account. Please do not delete or alter these additions to your account.

Additional monitors in your account

It is important to make sure that there always is a Private Checkpoint available in your account to perform checks. This is because if there are no locations available Uptrends is unable to detect any disruptions in your own sites. That is; when checks cannot run, there will be no warning because they will not fail.

To be alerted to any disruptions to your Private Checkpoint network the following monitors will be created. Please create an alert definition to ensure that the right people are informed when a Private Checkpoint goes down.

Monitor Name Type
Private CheckpointStatus_Uptrends (Do Not Delete) MSA
PrivateCheckpoint_<Name>_Status_Uptrends (Optional) MSA

Adding new applications and monitors

As you add applications and corresponding monitors to your Uptrends account, please remember to configure them in your firewall.

Questions about your own Private Checkpoints? Read our Frequently Asked Questions.
By using the Uptrends website, you consent to the use of cookies in accordance with our Cookie Policy.