Deploy Enterprise-Edition on an offline server¶
This tutorial explains how to setup OctoPerf's Enterprise-Edition on an offline server.
Prerequisites¶
This tutorial requires:
- A computer with docker installed and an Internet access preferably with the same OS than the offline server (for compatibility purposes),
- A possibility to transfer files to the offline server:
- you have access remotely to the offline server from your local machine:
scpor any alternative can be used to transfer files to the remote server - you have no connection at all to the offline server: you need to transfer files physically - for example using a USB key
- you have access remotely to the offline server from your local machine:
If one of these elements is missing it will not be possible to perform an offline installation of OctoPerf's Enterprise-Edition.
Overview¶
The tutorials will teach you how to deploy an OctoPerf's Enterprise-Edition server offline. This involves:
- Docker offline installation,
- docker-compose offline installation,
- Download OctoPerf's configuration files,
- Download OctoPerf's docker images as a file.
For each one of these files, we will proceed to transfer the package to the offline server and then run the installation process as usual.
The next sections of this tutorial will be divided between the Enterprise-Edition installation and the On premise agents installation, both have similar prerequisites, but the agent machines will require less files to be transferred so we handle them in a different section.
Enterprise edition installation¶
Docker¶
Docker provides an installation procedure that relies on downloading a package.
Just make sure to transfer the package to the offline server before you unpack it. Docker will be required for the next steps of this procedure so make sure to install it first.
Docker compose¶
Download the package:
wget https://github.com/docker/compose/releases/download/1.28.4/docker-compose-Linux-x86_64
See latest docker-compose releases to check if a newer version is available.
Now you can rename the package:
mv docker-compose-Linux-x86_64 docker-compose
After having copied the docker-compose to your offline server, move it to a relevant location and make it executable:
sudo mv docker-compose /usr/local/bin/
sudo chmod +x /usr/local/bin/docker-compose
Enterprise edition config files¶
The Zip containing all the required configuration files is available here. This file will be used by docker-compose to execute and configure all the required components.
Enterprise edition docker images¶
We are going to use docker save to download the required images into a .tar file. The command lines below are for version 12.10.0 of OctoPerf.
Warning
To get the latest version of these images check our changelog or the docker-compose.yml file inside the enterprise-edition.zip. The haproxy image version is located inside the dockerfile of the haproxy folder. Do not use the tag "latest" as it may cause some inconsistencies.
If you haven't pulled the images locally, make sure to do so first:
docker pull octoperf/enterprise-edition:12.10.0 octoperf/enterprise-ui:12.10.0 octoperf/octoperf-ui:12.10.0 octoperf/enterprise-documentation:12.10.0 octoperf/enterprise-documentation:12.10.0-beta docker.elastic.co/elasticsearch/elasticsearch:7.17.5 haproxy:alpine
Alternatively you can simply launch the makefile in order to get all the images downloaded and use docker images -a to list them.
Then use docker save to make a tar file out of all of them:
docker save -o enterprise.tar octoperf/enterprise-edition:12.10.0 octoperf/enterprise-ui:12.10.0 octoperf/octoperf-ui:12.10.0 octoperf/enterprise-documentation:12.10.0 octoperf/enterprise-documentation:12.10.0-beta docker.elastic.co/elasticsearch/elasticsearch:7.17.5 haproxy:alpine
Now we must transfer the enterprise.tar file to the offline host and execute the docker load command:
docker load -i enterprise.tar octoperf/enterprise-edition:12.10.0 octoperf/enterprise-ui:12.10.0 octoperf/octoperf-ui:12.10.0 octoperf/enterprise-documentation:12.10.0 octoperf/enterprise-documentation:12.10.0-beta docker.elastic.co/elasticsearch/elasticsearch:7.17.5 haproxy:alpine
Installation¶
Now that all the prerequisites are in place, you can proceed with the usual installation procedure.
Agent installation¶
Docker¶
Docker provides an installation procedure that relies on downloading a package.
Just make sure to transfer the package to the offline server before you unpack it. Docker will be required for the next steps of this procedure so make sure to install it first.
Agent docker images¶
We are going to use docker save to download the required images into a .tar file. Here's the command line for version 12.10.0 of OctoPerf.
Warning
Make sure to check our changelog to get the latest version of these images. Do not use the tag "latest" as it may cause some inconsistencies in case we have released a preview of our next version.
If you haven't first pulled the images locally, make sure to do so first:
docker pull octoperf/docker-agent:12.8.0 octoperf/jmeter-standard:12.9.1 octoperf/jmeter-webdriver:12.9.1
Then use docker save to make a tar file out of all of them:
docker save -o agent.tar octoperf/docker-agent:12.8.0 octoperf/jmeter-standard:12.9.1 octoperf/jmeter-webdriver:12.9.1
Now we must transfer the agent.tar file to the offline host and execute the docker load command:
docker load -i agent.tar octoperf/docker-agent:12.8.0 octoperf/jmeter-standard:12.9.1 octoperf/jmeter-webdriver:12.9.1
Installation¶
Now that all the prerequisites are in place, you can proceed with the usual installation procedure.