Installing BlueCat Gateway - Platform - BlueCat Gateway - 18.10.1

Gateway Installation Guide

prodname
BlueCat Gateway
version_custom
18.10.1

Install BlueCat Gateway on a 64-bit Linux client, and install Docker on a provisioned Linux server. BlueCat Gateway runs locally on the Linux client while Docker provides the container for Gateway workflows. This allows for independent upgrade of the BlueCat Gateway container with updated BlueCat APIs and business logics.

If your Linux host machine is behind a firewall, you must first pull the BlueCat Gateway image on a separate Linux machine with Internet connectivity, and then copy the image to the host machine. For complete details about refer to article 10393 on BlueCat Customer Care.

BlueCat Gateway is now delivered as a container image. The image resides in a public repository in the BlueCat cloud registry on Quay.io. You do not need a Quay.io account to pull the BlueCat Gateway image. You must use Docker commands to start, stop, remove containers, and to manage images. For a list of commonly used Docker commands, refer to Common Docker commands.

When you first install BlueCat Gateway v18.10.1, BlueCat recommends setting the BAM IP, mounting a data directory, and a logs directory on your local machine.
Note:
  • You can label the mounted data directory and logs directory anything.
  • BlueCat Gateway saves configuration and workflow data to the mounted data directory, and all execution and session logs to the mounted logging directory. If you do not mount a data directory or a logs directory, all the configuration and logging data is written to the container by default.
  • <bluecat_gateway> is used throughout the BlueCat Gateway documentation to refer to this mounted data directory.
Attention: BEFORE YOU START

BlueCat advises all customers to mount a data directory and a logging directory on your host machine that will be used to save data from BlueCat Gateway. You must manually set rwx (read, write, execute) permissions to those directories before running the container. If you do not mount data or logging directories to your local machine during installation, BlueCat Gateway will write all the data to the container by default. If you then stop or restart the container, all this data will be lost.

To set permissions to external volumes, run the following command:
chmod -R o=rwx <mounted volume>

To obtain the BlueCat Gateway image from the public repository:

Run the following command to pull the image and start the container:
docker run -d -p 80:8000 -p 443:44300 -v <mounted_data_directory>:/
bluecat_gateway/ -v <mounted_log_directory>:/logs/ -e BAM_IP=<your bam ip>
--name bluecat_gateway quay.io/bluecat/gateway:18.10.1
Note: If you are using RHEL-compiled Docker, you must add :Z at the end of the file path for any mounted volume. For example: -v <mounted_data_directory>:/bluecat_gateway/:Z
Tip: If you remove the Gateway docker container and wish to re-install it using the same BAM server IP and the same mounted data and logging volumes, the environment variable does not need to be passed as part of the docker run command.
docker run -d -p 80:8000 -p 443:44300 -v <mounted_data_directory>:/
bluecat_gateway/ -v <mounted_log_directory>:/logs/ --name 
bluecat_gateway quay.io/bluecat/gateway:18.10.1
This completes installation of BlueCat Gateway. Next, go to Address Manager to create the BlueCatGateway UDF and BlueCat Gateway administrators and users.