BlueCat Gateway - BlueCat Integrity - 9.5.0

Address Manager Legacy v1 API Guide

Locale
English
Product name
BlueCat Integrity
Version
9.5.0

By configuring BlueCat Gateway on a supported DNS/DHCP Server appliance, you can automate and transform mission-critical business requirements into DNS, DHCP, and IPAM workflows, and deploy value-add BlueCat Adaptive Applications and Plugins. Using zero-touch automation frees IT teams from time-consuming, error-prone, and repetitive network configuration and provisioning tasks so they can focus on the innovation your business needs. With everyday network tasks and functions automated and repetitive processes controlled and managed automatically, network service availability and application performance improves.

Attention:

This service cannot be configured on DNS/DHCP Servers operating in an xHA pair.

Address Manager v9.5.0 introduces a new removeVolume field to remove all unused local volumes and the data and logs bind mounts when disabling the service. Users must follow service configuration schema v1.2.0 to use the full feature 9.5 Gateway on BDDS service.

Address Manager v9.5.0 introduces a new method to upload a Docker image file that will be transferred to the DNS/DHCP Server for deployment of the Gateway service. This feature is intended for users with servers that are unable to access image repositories, or who wish to upload custom Docker images. For more information, refer to POST /v1/uploadDockerImage.

Example



{
   "version":"1.2.0",
   "server-version":"9.5.0-100.GA.bcn",
   "services":{
      "gateway":{
         "configurations":[
            {
               "gatewayConfiguration":{
                  "removeImage":false,
                  "removeVolumes":false,
                  "username":"user1",
                  "password":"user1pass",
                  "data":{
                     "version":1,
                     "enable":true,
                     "containers":[
                        {
                           "image":"quay.io/bluecat/gateway:20.12.1",
                           "name":"gw",
                           "ports":[
                              "80:8000",
                              "443:44300"
                           ],
                           "environment":[
                              "BAM_IP=172.16.70.40"
                           ],
                           "volumes":[
                              "/root/gwdata/:/bluecat_gateway/",
                              "/var/log/gateway/:/logs/"
                           ]
                        }
                     ]
                  }
               }
            }
         ]
      }
   }
}
Parameters
  • username—this field is required if pulling an image from a private repository. Enter the Docker registry username.
  • password—this field is required if pulling an image from a private repository. Enter the Docker registry password. This can either be your Docker password or an encrypted password.
  • removeImage—include this field when disabling service to remove the Gateway image. Set to true to remove the image; set to false to keep the image. As a best practice, BlueCat recommends removing the image as part of a container upgrade. This field is ignored if enable is set to true.
    Attention: Removing the image deletes the image from the BDDS permanently. This is an irrevocable step.
    • If you remove the image by mistake, you can recover it by re-enabling Gateway Service and pulling the same image tag from the same repository.
    • If you uploaded the image using uploadDockerImage, you will need to re-upload the image.
  • removeVolumes—include this field when disabling service to remove unused local volumes and the mounted data and logs directories. Set to true to remove the volumes and bind mounts; set to false to keep the volumes/mounts. This field is ignored if enable is set to true. If disabling Gateway service for BDDS maintenance, do not remove the volumes and bind mounts. Leaving the bind mounts on the BDDS ensures that the Gateway data and logs persist during maintenance and upgrading. BlueCat recommends enabling this option only if you intentionally want to delete the mounted data and logs directories from the BDDS appliance.
    Attention: If this field is set to true the mounted data and logs directories will be deleted from the DNS/DHCP Server permanently. This is an irrevocable step.
  • data—enter the BlueCat Gateway configuration information.
    • enable—set to true to enable BlueCat Gateway service; set to false to disable BlueCat Gateway service.
    • version—required for service configuration, can be left as 1.
    • containers—enter the BlueCat Gateway container instance information. Only a single container is supported.
      • environment—enter the Address Manager IP address on which to enable Gateway service. This field cannot be empty.
      • ports—enter the ports to be configured for the BlueCat Gateway instance. This field cannot be empty.
      • volumes—enter the directories that will be bind mounted to the container for data and logging (previously referred to as volumes). As a best practice, BlueCat recommends using the default directories listed in the example JSON. This field cannot be empty.
        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/). 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/
      • image—enter the name of the Docker image to load. This field cannot be empty.
      • name—enter the name of the BlueCat Gateway container instance.
Note: There are no API methods to start or stop the container. Gateway Service can only be configured, enabled, or disabled via the API. Enabling Gateway Service starts the container; disabling Gateway Service stops the container and stops Gateway Service.