Upgrading BlueCat Gateway - Platform - BlueCat Gateway - 24.1

Gateway Administration Guide

Product name
BlueCat Gateway

If you have an existing installation of BlueCat Gateway, you can upgrade to the latest version without completely reinstalling it.

Before upgrading Gateway: Do the following before upgrading BlueCat Gateway:
  1. Stop the Gateway container. To do so, run the following command:
    docker stop bluecat_gateway
  2. Remove the existing Gateway container. To do so, run the following command:
    docker rm bluecat_gateway 
    Tip: Removing the Gateway container will not remove your workspace or logging data. These are saved in separate directories mapped to either your local machine or to Docker volumes.
Note: If you are running BlueCat Gateway on Integrity 9.3 or greater, see the Address Manager Administration Guide for your version for steps on upgrading the container deployed on your BDDS appliance.

To upgrade BlueCat Gateway to the latest version:

When you upgrade BlueCat Gateway, you'll execute the same docker run command you used when Gateway was first installed. You'll also use the same external log directory to which you mapped the container logs.

When upgrading Gateway, you'll keep your existing configuration data and workflows.

  1. Pull the new BlueCat Gateway image from Quay and start the Gateway container. To do so, run the following command:
    docker run -d \
    -p 80:8000 \
    -p 443:44300 \
    -v <path_to_gateway_workspace>:/bluecat_gateway/ \
    -v <path_to_mapped_log_directory>:/logs/ \
    -e BAM_IP=<your bam ip or url> \
    --name bluecat_gateway quay.io/bluecat/gateway:24.1.0
    Note: 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 <path_to_workspace>:/bluecat_gateway/:Z
    Tip: If you want to specify the Address Manager API (and API Client) used by custom Gateway workflows, add the BAM_API_VERSION environment variable. Set the variable to 1 to use the legacy REST v1 API Client. Set the variable to 2 to use the REST v2 API Client. For example:
    -e BAM_API_VERSION=2 \
    For more details, see Setting the Address Manager REST API client version.

    If you're working with Gateway on a BDDS (BlueCat DNS/DHCP Server), there are some additional configuration steps. For more details, see Configuring the Gateway service on a DNS/DHCP Server.

  2. From your browser, connect to BlueCat Gateway.

    Doing so completes the Gateway upgrade process, retaining your previous workflows and configuration.