Installing BlueCat Gateway - Platform - BlueCat Gateway - 18.12.1

Gateway Installation Guide

prodname
BlueCat Gateway
version_custom
18.12.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 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.12.1 , BlueCat recommends setting the BAM IP as an environment variable, and mapping a data directory and a logs directory on your local machine or as Docker volumes.
Note:
  • You can name the mapped data directory and logs directory to anything.
  • BlueCat Gateway saves configuration and workflow data to the mapped data directory, and all execution and session logs to the mapped logging directory. If you do not map 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 mapped data directory.
Attention: BEFORE YOU START

BlueCat advises all customers to map 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 map 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 <mapped 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 <path_to_mapped_data_directory>:/
bluecat_gateway/ -v <path_to_mapped_log_directory>:/logs/ -e BAM_IP=<your bam ip>
--name bluecat_gateway quay.io/bluecat/gateway:18.12.1
Attention: If using RHEL-compiled Docker
If you are using RHEL-compiled Docker, you must add :Z at the end of the file path for any mapped volume. For example:
-v <mapped_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 mapped 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 <path_to_mapped_data_directory>:/
                            bluecat_gateway/ -v <path_to_mapped_log_directory>:/logs/ --name 
                            bluecat_gateway quay.io/bluecat/gateway:18.12.1
This completes installation of BlueCat Gateway. Next, go to Address Manager to create the BlueCatGateway UDF and BlueCat Gateway administrators and users.

Understanding the docker run command:

Table.
Docker run command:
docker run -d -p 80:8000 -p 443:44300 -v <path_to_mapped_data_directory>:/
bluecat_gateway/ -v <path_to_mapped_log_directory>:/logs/ -e BAM_IP=<your bam ip>
--name bluecat_gateway quay.io/bluecat/gateway:<version>
Note: If using Docker volumes, the command would be: -v <Docker_volume_name>:/bluecat_gateway.
Code Segment: Function:
docker run Is used to run a command in a new container.
-d The -d flag indicates to run the Docker container in detached mode. This means that the Docker container will run in the background of your terminal and will not receive any input or display output.
-p 80:8000 -p 443:44300 This code segment specifies the allocation of the ports being used:
  • Port 8000 in the container is allocated to port 80 on the Docker host.
  • Port 44300 in the container is allocated to port 443 on the Docker host.
-v <path_to_mapped_data_directory>:/ bluecat_gateway/ This variable maps a data directory on your host machine. The directory that you assigned rwx permissions to should be used. If you are using RHEL-compiled Docker, you must add :Z at the end of the path for any mapped volume.
-v <path_to_mapped_log_directory>:/logs/ This variable maps a logging directory on your host machine. The directory that you assigned rwx permissions to should be used.
-e BAM_IP=<your bam ip> The environment variable is used to specify the IP address of the BAM you wish to integrate with Gateway. You must enter the BAM IP as an environment variable when running the Gateway container for the first time.
--name bluecat_gateway Indicates the name of the container. By default, the name of the container is bluecat_gateway; however, this can be changed to reflect the needs of your environment.
quay.io/bluecat/gateway:18.12.1 Refers to the Gateway image tag from which the container will be created. If the image has already been pulled and is available locally, the container will be created from that image. If the image is not available locally, it will be pulled from the Quay.io cloud registry.