Enabling Gateway service on a DNS/DHCP Server - BlueCat Integrity - 26.1.0

The following section outlines the steps to configure the Gateway service on a BlueCat DNS/DHCP Server.

1. Select the Servers tab in the sidebar, then select Servers.
2. Select the name of a server.
3. Select the Services tab.
4. Under Core services, locate the Gateway service panel and select Edit service.
5. Under General, set the following parameters:
   • Enabled—select this check box to enable BlueCat Gateway service.
   • If pulling the Gateway image from a local or cloud repository, select Repository. The following fields appear:
     • Gateway image—enter the repository address and image tag, for example quay.io/bluecat/gateway:24.3.1. Do not enter latest as the image tag.
       Tip: BAM will display an error if you enter latest. As a best practice, BlueCat recommends using an image tag to ensure you know which specific image you are using.
     • Repository username—(optional) enter your docker username if the image is on a private repository, for example, if pulling a BlueCat Adaptive Application.
     • Repository password—(optional) enter your docker password. This can either be your Docker password or an encrypted password.
   • If uploading a Gateway image, select Upload image file. The following field appears:
     • Upload image file—drag and drop or select the Gateway image file to upload.
     Tip: The format of the Gateway image file must be either tar or tar.gz.
     Attention: There is no file size limit when uploading Gateway images through the UI, but users are advised to check that Address Manager and DNS/DHCP Servers have sufficient resources and partition sizes to handle larger images, to avoid timeouts and errors.
   • The Delete image on disable and Delete mount point on disable checkboxes are options used when disabling the Gateway service and upgrading Gateway containers, for more information refer to Disabling Gateway service and Upgrading a container.
6. On the Port mapping tab, set the following parameters:
   • Host port and Container port—enter a list of ports to configure for BlueCat Gateway. Select the Add (+) button to add a port.
7. On the Environment variables tab, set the following parameters:
   • Name and Value—enter a list of environment variables to pull to a container during startup. Select the Add (+) button to add a variable.
     Note: Enter only the required environment variable(s) in this field. Do not include the -e or --env flags. For example, SESSION_COOKIE_SECURE=False.
8. On the Volume mounts tab, set the following parameters:
   • Source and Container path—set the directories that will be bind mounted to the container for data and logging. To ensure data persistence when patching or upgrading DNS/DHCP servers, BlueCat recommends using the default directory configuration or designated custom directory location. The recommended default configuration is /root/gwdata/:/bluecat_gateway/ and /var/log/gateway/:/logs/. To set custom directories, click Remove to remove the existing directories, then add the custom data and logs directories.
     Attention: When configuring custom data and logs directories:

     • Specify only two directories, one for data and one for logs.
     • Use the format [SOURCE:]TARGET.
       • The SOURCE is the DNS/DHCP Server directory that will be bind mounted to the container. Custom source directories must be located in /root/gwmount/ (i.e. /root/gwmount/customdir/) to ensure data persistence when patching or upgrading DNS/DHCP servers. For a basic configuration of the Gateway on BDDS service, the TARGET portion determines if the directory is for data and logs, and should be either /bluecat_gateway/ for data, or /logs/ for logs.
       • Example: /root/gwmount/mydata1/:/bluecat_gateway/
       • Example: /root/gwmount/customlogsdir/:/logs/
     Warning: Ensure that the service is configured as detailed above using either the default directories (/root/gwdata/:/bluecat_gateway/ and /var/log/gateway/:/logs/) or designated custom directory location (/root/gwmount/). Data located outside of these directories will be lost upon patch or upgrade of the DNS/DHCP Server.
9. Select Save.
   After you select Save, the Gateway service initializes, pulls the image from the cloud or local repository (or transfers the uploaded image file), and initiates the container. Allow some time for the configuration to register, after which Address Manager will redirect you to the server Services tab.