Installation Requirements

The API Gateway (APIGW) requires Docker and Docker Compose to run, thus, Linux versions and distributions that have been verified to work with Docker are supported. To see a list of supported distributions, please reference this Docker article.

This example will begin with a Docker installation and is completed on an Ubuntu 20.04 VM.

To begin, uninstall any old versions of Docker.

sudo apt-get remove docker docker-engine docker.io containerd runc

Next, update the package lists and install docker.

sudo apt-get update

sudo apt-get install docker.io

Last, install Docker Compose. Note that 1.29.1 is the current stable release at the time this documentation was written and can be changed to install a different version if desired. The version of Docker Compose used must support version 3.7 compose files.

sudo curl -L "https://github.com/docker/compose/releases/download/1.29.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

sudo chmod +x /usr/local/bin/docker-compose

Unpack and Install the APIGW

Once Docker and Docker Compose are installed, the APIGW can be installed. Begin by downloading the latest version of the tarball from the Delphix Download site. Next, transfer the file to the Linux machine where Docker is installed. Run the following commands to extract the containers and load them into Docker.

tar -xzf delphix-api-gateway-*.tar.gz

sudo docker load --input app.tar

sudo docker load --input proxy.tar

Run the APIGW

To run the APIGW, navigate to the location of the extracted docker-compose.yaml file from the tarball and run the following command. 

sudo docker-compose up -d

Using -d in the command will start up the application in the background. Running docker-compose ps should show two containers up and running:

$ docker-compose ps

            Name                           Command               State                  Ports
-------------------------------------------------------------------------------------------------------------
orbital-api-gateway_gateway_1   java -jar /opt/delphix/app.jar   Up
orbital-api-gateway_proxy_1     /bootstrap.sh                    Up      0.0.0.0:443->443/tcp,:::443->443/tcp