Installing the BlueCat REST API image - Adaptive Plugins - BlueCat Gateway - 1.1.0

BlueCat Terraform Plugin Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
1.1.0

Before you begin, you must download and install the BlueCat REST API image from Quay

Downloading and installing from Quay

To install the BlueCat REST API image:

Run the custom Gateway image using the following command:
docker run -d \
-p <http_port>:8000 \
-p <https_port>:44300 \
-v <gateway_log_dir>:/logs/ \
-e BAM_IP=<your_bam_ip_address> \
--name <gateway_container_name> \
quay.io/bluecat/rest:23.2.1
Where:
  • docker run creates a new Docker container.
  • -d indicates that the Docker container runs in the detached mode. The Docker container runs in your terminal background and does not receive any input or display any output.
  • -p <http_port>:8000 represents the allocation of external ports for use. Port 8000 in the container is allocated to the defined <http_port> on the Docker host.
  • -p <https_port>:44300 represents the allocation of external ports for use. Port 44300 in the container is allocated to the defined <https_port> on the Docker host.
  • -v <GATEWAY_LOG_DIR>:/logs/ maps a Docker logs volume (recommended) or a logs directory on your local machine.
  • -e BAM_IP=<your_bam_ip_address> specifies the IP address of the Address Manager server that is integrated with Gateway. You must enter the Address Manager IP address as an environment variable when running the Gateway container for the first time.
  • quay.io/bluecat/rest:23.2.1 represents the Gateway image tag from which the container is created.
    Note: If the image has already been pulled and is available locally, the container is created from that image. If the image is not available locally, the image is pulled from the Quay.io cloud registry.