Speed Test

Speed Test Container Detail

Getting Started with VNS3 Plugin System

The Speed Test container is deployed to VNS3 as a plugin using the container system.

Please be familiar with the VNS3 Plug-In Configuration Guide.

Speed Test Container - What does it do?

Following initial setup, the container runs an nginx web server on TCP port 80.

This webserver hosts a modified version of LibreSpeed Speedtest (https://github.com/librespeed/speedtest).

Users can use the application from a web browser to test their connection speed to the VNS3 instance, whether over the internet or OpenVPN or IPsec.

Speed Test Container - What does it need?

The Speed Test container needs only a VNS3 controller on which to run.

Deploying the Speed Test Container

Getting the Speed Test Container

The Linux-based (Ubuntu 18.04) Speed Test Container Image is accessible at the following URL:
https://vns3-containers-read-all.s3.amazonaws.com/speedtest/SpeedTest.20190330.tar.gz

This is a read-only Amazon S3 storage location. Only Cohesive Networks can update or modify files stored in this location.

This URL can be used directly in a VNS3 Controller via the Web UI or API to import the container image for use in that controller. General screenshot walkthrough and help available in the Plug-In Configuration Document.

Uploading the Container Image to VNS3

From the Container —> Images page, choose Upload Image.

Provide a name for the image and a short description if you wish.

Select Image File URL and enter the Speed Test Container Image file URL:
https://vns3-containers-read-all.s3.amazonaws.com/speedtest/SpeedTest.20190330.tar.gz

Click Upload.

Uploading the Container Image to VNS3

Allocating a Container from the Image

When the Image has imported successfully, its state will be Ready in the Status Column.

To launch a container from the image, choose Allocate from the Image’s Action menu.

Allocating a Container from the Image

Launching the Speed Test Container

After selecting Allocate from the Actions menu, name your container, provide a description (optional), and /usr/bin/supervisord as the Command to start the container.

You can allow VNS3 to auto-assign a container network IP, but it is recommended that you choose one explicitly. Take note of this address for the following steps.

Launching the Speed Test Container

Speed Test Container Firewall Rules

The Speed Test Container requires the following firewall rules be added to the VNS3 controller:

# DNAT tcp80 traffic to the Speed Test container
PREROUTING_CUST -p tcp --dport 80 -d <vns3 eth0 ip>,<vns3 overlay vip> -j DNAT --to <container_ip>:80
# Allow tcp80 packets to the Speed Test container
FORWARD_CUST -p tcp --dport 80 -d <container_ip> -j ACCEPT
# Allow response packets from the Speed Test container
FORWARD_CUST -p tcp --sport 80 -s <container_ip> -j ACCEPT

### OPTIONAL
# DNAT tcp44 to the Speed Test container for SSH
PREROUTING_CUST -p tcp --dport 44 -d <vns3 eth0 ip>,<vns3 overlay vip> -j DNAT --to <container_ip>:22
# Allow SSH to the Speed Test container
FORWARD_CUST -p tcp --dport 22 -d <container_ip> -j ACCEPT
# Allow SSH response from the Speed Test container
FORWARD_CUST -p tcp --sport 22 -s <container_ip> -j ACCEPT

Anywhere it appears, replace <container_ip> with the container IP you noted in the previous step.

Also replace with VNS3’s private IP and with the “Controller VIP” found on the Status page.

Configuring the Speed Test Container

After allocating the container and applying the necessary firewall rules to VNS3, you have the option to ssh into the container on port 44.

The username is container_admin, and the default password is container_admin_123!

We recommend that you change this password immediately, using the following command:
sudo passwd container_admin

No other configuration is necessary.

Using the Speed Test Container

Users can access the Speed Test UI by navigating to http://<vns3 private ip> or http://<vns3 overlay vip>.

Clicking the Start button will initiate the test, first calculating latency and jitter, then upload/download bandwidth.

Using the Speed Test Container

Export a Container Image

In the event that your VNS3 controller needs to be replaced or upgraded, you will need a copy of your configured Speed Test Container. We recommend creating and downloading an image of your container as a final step of the deployment process:

From the Containers page in the VNS3 web UI, select Action > Save as Image for your new Speed Test Container. Once that process is complete, you’ll be brought to the Images page. Select Action > Export on the new image, and provide a name.

Once Exporting is complete, you will have the option to download the image locally.