Upgrading BlueCat Gateway - Platform - BlueCat Gateway

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

When upgrading, make sure that you continue to use the same type of authentication that Gateway was initially installed with. If you do not, the workflows that ran on the previous installation will no longer work after upgrade. That is, if you were using Address Manager authentication, continue to authenticate with Address Manager. If you were using Micetro for authentication, continue using Micetro. If you're upgrading Gateway in Standalone authentication mode to a newer version, continue using Standalone authentication.

Before upgrading Gateway: Do the following before upgrading BlueCat Gateway:

Stop the Gateway container. To do so, run the following command:
```
docker stop bluecat_gateway
```
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 with Integrity 9.4 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.

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 mapped workspace directory>:/bluecat_gateway/ \
-v <Path to mapped logs directory>:/logs/ \
<Authentication platform environment variables> \
--name bluecat_gateway quay.io/bluecat/gateway:25.2.0

Where:

<Path to mapped workspace directory>: The path to your desired location for the Gateway folder.

If you are running multiple Gateway instances on the same machine (including separate instances for adaptive applications), you must use a different workspace folder for each instance.
<Path to mapped logs directory>: The path to the location where you want to store Gateway log files.

If you are running multiple Gateway instances on the same machine (including separate instances for adaptive applications), you must use a different logs folder for each instance.
<Authentication platform environment variables>: Environment variable settings specific to the platform you're authenticating with (Address Manager, Micetro, or using Standalone authentication). Use variables from only one authentication platform, and make sure it is the same authentication platform that Gateway was initially installed with.

Authentication platform environment variables are as follows:

Setting Description

Setting	Description
BlueCat Address Manager	Add the following environment variable to the command: `-e BAM_IP=<BAM IP address or URL> \` Where `<BAM IP address or URL>` is the URL of the instance of the Address Manager server that you want to connect to. Tip: If you removed the Gateway container and are reinstalling it with the same BAM server IP, workspace, and logging directory, you do not need to set this environment variable in the docker run command: `docker run -d \ -p 80:8000 \ -p 443:44300 \ -v <Path to mapped workspace directory>:/bluecat_gateway/ \ -v <Path to mapped logs folder>:/logs/ \ --name bluecat_gateway quay.io/bluecat/gateway:25.2.0` 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. To specify multiple Address Manager servers when starting a Gateway container: Within the `docker run` (or `podman run`) command, list all desired IP addresses or URLs when setting the value of the `BAM_IP` environment variable separated by commas. `-e BAM_IP=<BAM URL or IP address 1>,<BAM URL or IP address 2>,...` Each entry can be an IP address or a fully-qualified domain name and must be unique within that list. The list can use a mixture of URLs, IPv4, and IPv6 addresses. For clarity, you can enclose the entire list within quotation marks. For more details, see Connecting to multiple Address Manager servers during installation via the command line.
Micetro	Add the following environment variables to the command: `-e MICETRO_IP=<Micetro IP or URL> \` Where `<Micetro IP or URL>` is the URL of the instance of the Micetro server that you want to connect to.
Standalone authentication	Add the following environment variable to the command: `-e AUTHENTICATION=STANDALONE \ -e STANDALONE_USERNAME=<Standalone account user name> \ -e STANDALONE_PASSWORD=<Standalone account password> \` Where: `<Standalone account user name>`: The username for the account that Gateway will set up for standalone access. `<Standalone account password>`: The password for the account that Gateway will set up for standalone access. During installation, Gateway will set up a single user account with the indicated password. This account will be assigned to the admin group, with access to all Gateway features, workflows, and functionality. Credentials for this account will be stored in the docker container environment.

BlueCat Address Manager

Add the following environment variable to the command:

-e BAM_IP=<BAM IP address or URL> \

Where <BAM IP address or URL> is the URL of the instance of the Address Manager server that you want to connect to.

Tip: If you removed the Gateway container and are reinstalling it with the same BAM server IP, workspace, and logging directory, you do not need to set this environment variable in the docker run command:

docker run -d \
-p 80:8000 \
-p 443:44300 \
-v <Path to mapped workspace directory>:/bluecat_gateway/ \
-v <Path to mapped logs folder>:/logs/ \
--name bluecat_gateway quay.io/bluecat/gateway:25.2.0

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.

To specify multiple Address Manager servers when starting a Gateway container: Within the docker run (or podman run) command, list all desired IP addresses or URLs when setting the value of the BAM_IP environment variable separated by commas.

-e BAM_IP=<BAM URL or IP address 1>,<BAM URL or IP address 2>,...

Each entry can be an IP address or a fully-qualified domain name and must be unique within that list. The list can use a mixture of URLs, IPv4, and IPv6 addresses. For clarity, you can enclose the entire list within quotation marks.

For more details, see Connecting to multiple Address Manager servers during installation via the command line.

Micetro

Add the following environment variables to the command:

-e MICETRO_IP=<Micetro IP or URL> \

Where <Micetro IP or URL> is the URL of the instance of the Micetro server that you want to connect to.

Standalone authentication

Add the following environment variable to the command:

-e AUTHENTICATION=STANDALONE \
-e STANDALONE_USERNAME=<Standalone account user name> \
-e STANDALONE_PASSWORD=<Standalone account password> \

Where:

<Standalone account user name>: The username for the account that Gateway will set up for standalone access.
<Standalone account password>: The password for the account that Gateway will set up for standalone access.

During installation, Gateway will set up a single user account with the indicated password. This account will be assigned to the admin group, with access to all Gateway features, workflows, and functionality. Credentials for this account will be stored in the docker container environment.

Upgrading BlueCat Gateway - Platform - BlueCat Gateway - 25.2

Gateway Installation Guide