Installing the Distributed DDNS Application Node - Adaptive Applications - BlueCat Gateway - 21.1

BlueCat Distributed DDNS Administration Guide

prodname
BlueCat Gateway
version_custom
21.1
Before you begin, you must download the latest custom BlueCat Gateway image that contains the Distributed DDNS Application Node image.

Prerequisites:

Before proceeding to install the Adaptive Application, ensure that the following prerequisites are met:
  • Make note of the following configuration information from the Distributed DDNS Data Node setup:
    • The IP address of one of the Distributed DDNS Data Nodes in the cluster.
    • The Distributed DDNS Data Node username and password.
    • The port of the Distributed DDNS Data Node. By default, this value is 3306.
    • The name of the Distributed DDNS Data Node database. By default, this value is distributed_ddns.
  • Distributed DDNS uses Kerberos within the container. To persist the Kerberos configuration file, the /etc/krb5.conf file within the container must also be stored on the host machine. A limitation exists where Docker cannot bind a file in a container to a volume on the host machine.
    The file on the host machine must exist before you can run the container. You can either create the /etc/krb5.conf file on the host machine or install the krb5-user package on the host machine. BlueCat recommends installing the krb5-user package to ensure that the correct configuration file format exists on the host machine. You can install Kerberos using the following command on an Ubuntu server:
    apt-get install krb5-user
  • Ensure you have purchased the Distributed DDNS Adaptive Application from BlueCat.
  • 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.

  • A Docker CLI password.

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

Before you begin:

When you first install the Distributed DDNS Adaptive Application, BlueCat recommends performing the following:
  • Define a workspace:
    • A workspace is the logical location for you to place your workflows and associated data, including configurations, libraries, requirements, permissions, and customizations; a workspace can be a Docker volume (recommended) or a volume on your local machine. For more information, refer to the Workspace section in the BlueCat Gateway Administration Guide.
  • Define a logs directory:
    • A logs directory can be a Docker volume (recommended) or a volume on your local machine
Tip: BlueCat advises all customers to map Docker volumes for their respective workspace and logs directory to save data from the Distributed DDNS Adaptive Application. Volumes are completely managed by Docker and you do not need to set permissions manually when using Docker volumes. This is also the recommended practice for Docker containers. However, if you prefer to mount data and log volumes to your local machine, you must manually set rwx (read, write, execute) permissions to those directories before running the container. If you do not map data or log volumes to your local machine during installation, the Distributed DDNS Adaptive Application will write all the data to the container by default. If you then stop or restart the container, all this data will be lost.
To set permissions to external volumes, run the following command:
chmod -R o=rwx <mapped volume>
Note:
  • You can name the workspace and logs directory to anything.
  • The Distributed DDNS Adaptive Application saves configuration and workflow data to the workspace, and all execution and session logs to the mapped logs directory. If you do not map a workspace or a logs directory, all the configuration and logging data is written to the container by default.
To install the custom Gateway image:
  1. From the host machine, run the following command:
    docker login quay.io
  2. At the prompt, enter your Quay user name and password obtained when generating the encrypted password.
  3. Download the Distributed DDNS Application Node container from Quay using the following command:
    docker pull quay.io/bluecat/distributed_ddns_application:21.1
  4. Verify that the docker image has been loaded to the machine using the following command:
    docker image ls
  5. Download and install the custom Gateway image using the following command:
    IPv4
    docker run -d \
    -p 80:8000 \
    -p 443:44300 \
    -v gateway_data:/builtin/ \
    -v gateway_logs:/logs/ \
    -v /etc/krb5.conf:/etc/krb5.conf \
    -e BAM_IP=<your_bam_ip_address> \
    -e MARIADB_IP=<mariadb_node_ip> \
    -e MARIADB_USER=<mariadb_username> \
    -e MARIADB_PASSWORD=<mariadb_password> \
    -e MARIADB_PORT=3306 \
    --name bluecat_gateway \
    quay.io/bluecat/distributed_ddns_application:21.1
    IPv6
    docker run -d \
    --net=host \
    -v gateway_data:/builtin/ \
    -v gateway_logs:/logs/ \
    -v /etc/krb5.conf:/etc/krb5.conf \
    -e BAM_IP=<your_bam_ip_address> \
    -e MARIADB_IP=<mariadb_node_ip> \
    -e MARIADB_USER=<mariadb_username> \
    -e MARIADB_PASSWORD=<mariadb_password> \
    -e MARIADB_PORT=3306 \
    --name bluecat_gateway \
    quay.io/bluecat/distributed_ddns_application:21.1