Flow Enterprise runs on Replicated 2.28.0 and above. This version of Replicated utilizes Docker Swarm and allows us to provide the best experience for our users.
There are two method for installing Replicated inside your environment:
- Standard Installation: This is highly recommended and is the most simple way to install and configure Replicated and Flow Enterprise.
- Airgapped Installation: This method allows customers to install the application on their servers without that server being able to download files from the internet.
Standard installation allows you to quickly and easily install Docker, Replicated, and Flow Enterprise. This method requires that the server you are installing on has access to the Replicated servers and the Docker package repositories.
Replicated provides a list of IP addresses that can be white listed for outbound traffic in this repository. Docker, however, does not provide this list. However, you can find more information about installing docker in Manually Installing Docker.
To install Replicated on your system using the standard installation method, you simply need to follow the steps below. For a more advanced installation, you can read Replicated's documentation.
Step One: Logging In
SSH login for root is disabled and a sudo user has been created for you.
Step Two: Examine the Script
The swarm-init.sh script is located under /opt/gitprime/replicated-installer/
Once you have located swarm-init.sh, examine it to make sure that it doesn't do anything you deem inappropriate for your infrastructure. If you find issues, please contact support at email@example.com. We will work with you to make sure you have an installation process that you are comfortable with.
Step Three: Execute the Script
Once the script is validated, you simply need to execute the script using a sudo-capable user:
sudo bash ./swarm-init.sh
Step Four: Answer Installer Questions
The installer will ask you several questions during the installation. The following are explanations:
- It is possible that the installer will not be able to determine the correct IP address that the administration interface should run on. If not, it will prompt you with:
- You should enter the IP address that you wish to point the DNS hostname of the server to. This IP address should be accessible to users on the ports specified above.
- You will be asked if the machine requires a proxy to access the Internet. This is used for HTTP/HTTPS communication to the outside world for updates and the main installer files. Answer Yes if you utilize a proxy for this process. You will then be prompted for proxy information:
- HTTP proxy address: The address of your HTTP proxy in full URL format. For example, https://proxy.mynetwork.com
Step Five: Finishing Up
The installer will run for some time. During the process it will update several OS packages, install the Docker framework, and Replicated's system. Once that finishes, the installer will present you a link the the Replicated Administration Console. This link will most likely be https://<ip address>:8800. Please browse to that link in your browser, and continue on with the steps from Configuring Replicated.
Optional Step: Lock the Docker Version
Recently, the docker project has been releasing updates that appear as minor upgrades, but have significant, breaking changes. These changes can dramatically conflict with Replicated and Flow Enterprise. To prevent yourself from running into these issues, you need to lock the docker project to the specific version. This can be accomplished on Debian-based Linux servers by executing the following commands:
echo "docker-engine hold" | sudo dpkg --set-selections
sudo apt-mark hold docker-engine
This will prevent the docker engine from updating and keep your system up and running.
Airgapped installation allows you to Replicated, and Flow Enterprise onto a server that is not allowed to download files from the Internet. This method requires that the server you are going to host Flow Enterprise on already contain a working version of Docker that meets the criteria outlined in Requirements. You can learn more about the airgapped installation method from Replicated's website.
Important Note: In the airgapped installation method, Docker must be installed prior to installing Replicated and GitPrime Enterprise. If you have not done so, please do NOT continue.
Step One: Install Docker
Installing Docker is outside the scope of this document. However, more information and useful links can be found in the document Manually Installing Docker.
Step Two: Download the Replicated Installer Bundle
Replicated makes the airgapped installer bundle available on the internet here. You should download this file and transfer it to the server you wish to install Replicated and Flow Enterprise on.
For the purposes of this document, we will assume you have put this file in "/opt/gitprime/replicated-installer/replicated.tar.gz" on the server.
Step Three: Decompress the Replicated Installer Bundle
Login to the server and change directories to the location where you placed the compressed Replicated installer bundle. For example, "/opt/gitprime/replicated-installer". Once you are in the directory with the file, execute the following command:
tar -xzvf replicated.tar.gz
This command should place several files into the directory.
Step Four: Execute the Swarm-based Replicated Installer
The bundle will have created several files when it was decompressed. Contained in this bundle is the "swarm-init.sh" file. This file will install Replicated in the airgapped mode. Execute it as follows:
bash ./swarm-init.sh airgap
This will install the replicated engine into the Docker system that you installed previously. At the end of the installation, you will be presented with a link to go to with your web browser:
Step Five: Create an Update File Location
For airgapped installations, Replicated requires that installation and updates be stored in a directory on the host. You will be given links to these by your sales account executive or customer support and will need to download them and upload them to the airgapped server. To do this, simply create a directory somewhere on the local file system. We recommend "/var/lib/replicated/updates".
Once you have created the directory, you should set the permissions to 0755 using the command:
chmod 0755 <your update file directory>
Step Six: Download the Airgapped Package
You will have been given a download link and a download code for downloading the airgapped package. You should follow the link you have been given and enter the password you were provided on the screen below:
Once you have entered your password, you will be provided with a list of packages to download. Always choose the package at the top of the list, as it will be the latest version.
Once you have downloaded the file, transfer it to the server. Place it in the directory you created in Step Five and make sure that it is set to file mode 0664 or higher.
Step Seven: Configure the Replicated Console
You should now follow the steps outlined in Configuring Replicated. There are a few steps inside that document specific to airgapped installations, and you should follow those steps.
If you need help, please email firstname.lastname@example.org for 24/7 assistance.