Upgrading BlueCat Gateway - Platform - BlueCat Gateway - 24.3.3

Gateway Administration Guide

ft:locale
en-US
Product name
BlueCat Gateway
Version
24.3.3

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

Note: As of Gateway v24.3, Gateway can now authenticate with Micetro. You cannot authenticate with both Micetro and BlueCat Address Manager at the same time. To authenticate with Micetro, in the following instructions, replace the -e BAM_IP environment variable declaration with the following:
-e MICETRO_IP=<Micetro IP or URL> \
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.3.3
    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.