Configuring Quick Service on a DNS/DHCP Server - Adaptive Applications - BlueCat Gateway - 24.4

Quick Service Administration Guide

ft:locale
en-US
Product name
BlueCat Gateway
Version
24.4
Before you begin:

Before configuring Quick Service on a BlueCat DNS/DHCP Server (BDDS) appliance, ensure that your environment meets the following requirements:

  • You must have BlueCat Address Manager (BAM) v9.4.0 or greater (hardware or virtual machine).

  • You must have a BDDS (hardware or virtual machine).

  • You must have a Quay account that has been granted Read access to the Quick Service private repository (quay.io/bluecat/<repository>). If you have not yet created a Quay account, create an account and give your Quay account username to a BlueCat representative to be granted access to the private repository.

  • You must have a Docker Command Line Interface (CLI) password.

    You can create one by clicking Generate Encrypted Password under Docker CLI Password on the Account Settings page in Quay.

Procedure

The following section outlines the steps to configure the Quick Service application on a BDDS:

  1. From the configuration drop down list in the BAM UI, select a configuration.
  2. Click 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.
    The Server Name page appears.
  5. Configure the following settings:
    Field Description
    Service Type
    Service Type

    From the drop down list, select BlueCat Gateway.

    BAM queries the server and returns the current values for the service settings.

    General
    Enable Gateway Service

    Select this check box to enable 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.
    Repository
    Repository

    Enter the repository address. For example, quay.io/bluecat/<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

    Enter your Quay username.

    Password Enter your Quay password.
  6. Click Update.
    The Gateway Service initializes, pulls the image from Quay, and loads it onto the BDDS. Allow some time to register the configuration, after which BAM will redirect you to the Service Type drop down list.
Next: Confirm the status of Gateway Service

To confirm the status of Gateway Service:

  1. From the Service Type drop down list, select BlueCat Gateway.

  2. Scroll down to view the Gateway Status section.

    You can find the status of the service under the Status and Description fields. If the Status field shows RUNNING, Gateway Service has been enabled and the container is running.