Installing BlueCat Gateway - Platform - BlueCat Gateway - 19.8.1

Gateway Installation Guide

prodname
BlueCat Gateway
version_custom
19.8.1

BlueCat Gateway is delivered as a container image published in a public BlueCat cloud registry on Quay.io. You do not need a Quay.io account to pull the BlueCat Gateway image. Use Docker commands in the Linux CLI to pull the image, then to run, stop, start, or remove containers. For a list of commonly used Docker commands, refer to Docker commands.

You can also obtain the image as a tar file from BlueCat Customer Care. For more information, refer to Installing BlueCat Gateway from Customer Care on page 9.

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.

Before you Start

When you first install BlueCat Gateway v19.8.1, BlueCat recommends setting the BAM IP as an environment variable, and mapping a Docker data volume and a Docker logs volume.

Tip: BlueCat advises all customers to map a Docker data volume and a Docker logs volume to save data from BlueCat Gateway. This is the recommended best practice for Docker containers. However, if you prefer to mount data and logs directories to your local machine, you must manually set rwx (read, write, execute) permissions to those directories before running the container. If you do not map data or logs 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>
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 logs 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.

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:19.8.1
Attention: If using RedHat Enterprise Linux-compiled Docker
If you are using RHEL-compiled Docker, you must add :Z at the end of the file path for any mapped directory. For example:
-v <mapped_data_directory>:/bluecat_gateway/:Z
Tip: If you remove the Gateway container and wish to re-install it using the same BAM server IP and the same mapped data and logging directory, 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:19.8.1
This completes installation of BlueCat Gateway. Next, go to Address Manager to create the BlueCatGateway UDF and BlueCat Gateway administrators and users.
Table. Understanding the docker run command
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> --dns=<ip address> --name bluecat_gateway quay.io/bluecat/gateway:
<version> --restart unless-stopped
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 Docker data volume (recommended) or a data directory on your local machine. If you are using RHEL-compiled Docker, you must add :Z at the end of the path for any mapped volume.
Note: If using Docker volumes, the command would be: -v <Docker_volume_name>:/bluecat_gateway.
-v <path_to_mapped_log_directory>:/logs/ This variable maps a Docker logs volume (recommended) or a logs directory on your local machine.
-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.
--dns <ip address> (optional) Sets the IP address of the container's nameserver in the /etc/resolv.conf file. A process in the container, when resolving a hostname that is not included in /etc/hosts, will connect to this IP address on port 53 and search for name resolution services.
Note: If you do not include this option in the docker command, the IP address of the DNS server defaults to 8.8.8.8.
--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:19.8.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.