Installing the Distributed DDNS Application Node on a BDDS - Adaptive Applications - BlueCat Gateway - 23.2.3

BlueCat Distributed DDNS Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
23.2.3
Attention: Before you begin, make sure you review the prerequisites, technical specifications, limitations, and best practices for deploying BlueCat Gateway on a BDDS. For more details, see Gateway Service on BDDS appliances in the Address Manager Administration Guide.

Prerequisites:

  • On the Address Manager server, you must have created the BlueCat Gateway user and the BlueCatGateway UDF. For more details, see Additional setup in the BlueCat Gateway Installation Guide.

  • You must have purchase the Distributed DDNS Adaptive Application from BlueCat.

  • You must have a Quay account that has been granted read access to the Distributed DDNS private repository.

    For more information on setting up your Quay account, refer to the information that was provided when you purchased the Distributed DDNS Adaptive Application.

  • You must have a Docker CLI password.

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

BAM User requirements: During setup, you must specify a BAM user that the Distributed DDNS Application node should use to log in to BAM. (You can do so in the BAM Settings section of the Distributed DDNS Configuration tab.) This user must have the following access rights:

  • Configuration | View

  • Start of Authority | Add

  • Generic DNS Option | Full Access

  • Generic Record | Full Access

  • Host Record | Full Access

If you will be using the Distributed DDNS Sync Data service, the specified BAM user account must be an administrator user. This is required for the Distributed DDNS workflow to switch the connecting BAM to the new primary BAM.

Tip: If the specified BAM user is an administrator user, that user will have all listed access rights already.

Installing the DDNS Application Node

For the initial installation, BlueCat recommends installing the Distributed DDNS Application Node from BlueCat Address Manager (BAM):

To install Distributed DDNS Application Node on a BDDS:

  1. Log in to the Address Manager user interface.

  2. From the configuration drop-down menu, select a configuration.

  3. 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.

  4. Under Servers, click the name of a BDDS. The Details tab for the server opens.

  5. Click the server name menu and select Service Configuration.

  6. From the Service Type drop-down menu, select BlueCat Gateway. Address Manager queries the server and returns the current values for the service settings.

  7. Under General Settings, set the following parameters:

    • Enable Gateway Service—select this check box to enable BlueCat Gateway service.

    • Ports—enter a list of ports to configure for Distributed DDNS Application Node. The typical ports are 80:8000 and 443:44300.

    • Environment Variables—enter a list of environment variables to pull to a container during startup. The typical environment variable is BAM_IP=<IP address>.

      Note: If you are configuring the Distributed DDNS Application Node to connect to an existing database, you must configure the following environment variables: 
      MARIADB_IP=<db_node_IP>
MARIADB_USER=<db_username>
MARIADB_PASSWORD=<db_password>

  8. Under Repository Settings, set the following parameters:

    • Repository—enter quay.io/bluecat/distributed_ddns_application

    • Tag—enter 23.2.3

    • Username—enter your Quay or local repository username.

    • Password—enter your Quay or local repository password.

  9. Click Update.

    After you click Update, Gateway Service initializes, pulls the images from the cloud or local repository, 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.

    To confirm that the Gateway Service and container are running, select BlueCat Gateway from the Service Type dropdown menu. At the bottom of the page, you can find the Status and Description fields. If the Status displays RUNNING, the Gateway Service is enabled and the container is running.

    Once you have installed the Distributed DDNS Application Node, you can log in to the UI of the Distributed DDNS Application Node and deploy Data Nodes and Service Nodes. You can access the UI by entering in the browser the IP address and port of the DNS/DHCP Server that the Distributed DDNS Application Node was deployed to. For example: https://<bdds_ip>:443.