Configuring Gateway service on a DNS/DHCP Server - BlueCat Integrity - 9.5.0

Address Manager Administration Guide

Product name
BlueCat Integrity

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

To configure Gateway on a DNS/DHCP Server:

  1. From the configuration drop-down menu, select a configuration.
  2. Select the Servers tab. Tabs remember the page you last worked on, so select the tab again to ensure you're on the Configuration information page.
  3. Under Servers, click the name of a BDDS. The Details tab for the server opens.
  4. Click the server name menu and select Service Configuration.
  5. From the Service Type drop-down menu, select BlueCat Gateway. Address Manager queries the server and returns the current values for the service settings.
  6. Under General Settings, set the following parameters:
    • Enable Gateway Service—select this check box to enable BlueCat Gateway service; deselect this check box to disable BlueCat Gateway service.
    • Ports—enter a list of ports to configure for BlueCat Gateway.
    • Environment Variables—enter a list of environment variables to pull to a container during startup.
      Note: Enter only the required environment variable(s) in this field. Do not include the -e flag. For example, SESSION_COOKIE_SECURE=False.
    • Volumes—set the directories that will be bind mounted to the container for data and logging (previously referred to as volumes). To ensure data persistence when patching or upgrading DNS/DHCP servers, BlueCat recommmends 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.
  7. Under Repository Settings, set the following parameters:

    If pulling the Gateway image from a local or cloud repository:

    • Repository—enter the repository address, for example<repository>
    • Tag—enter the image tag. Do not enter latest.
      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.
    • Username—(optional) enter your docker username if the image is on a private repository, for example, if pulling a BlueCat Adaptive Application.
    • Password—(optional) enter your docker password. This can either be your Docker password or an encrypted password.

    If uploading a Gateway image:

    • Upload Image File—select to open the upload image section.
    • Choose File—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.
    • Upload Gateway Image—select to upload the chosen Gateway image file. Wait for the page to refresh before proceeding. After successful upload and page refresh, the image name will be listed under Uploaded Image.
  8. Click Update.
    After you click Update, 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 to register the configuration, after which Address Manager will redirect you to the Service Type dropdown menu page.