Upgrading the DNS Integrity Gateway - Platform - BlueCat Gateway - 18.2.1

Gateway Installation Guide

prodname
BlueCat Gateway
version_custom
18.2.1

Upgrade your current DNS Integrity Gateway to the latest software version.

Upgrading the DNS Integrity Gateway follows a similar process to a full installation. However, when upgrading you will not need to set the IP address of the Address Manager server.

Upgrading the DNS Integrity Gateway will preserve any custom settings in the permissions.json file in the <dns_integrity_gateway> directory. Custom settings in the config.py file in the <dns_integrity_gateway> directory will also be preserved. Refer to the DNS Integrity Gateway Release Notes for details on any modifications to the available options within the config.py file.

Attention: Before you start
  • You must install Docker and the Python Docker SDK before installing DNS Integrity Gateway. Docker installation is only necessary to run the Gateway application.
  • As part of the installation, you must set the absolute path for your BlueCat DNS Integrity Gateway directory. This path is stored in the /etc/bluecat/gateway.conf  file. If the folder does not exist it will be created as part of the installation. Ensure that you have sufficient privileges to create or edit this file.
  • Make sure that the Gateway user performing the installation belongs to the docker user group. If you receive any "permission denied" errors during installation, it indicates that you have insufficient permissions.
To download the DNS Integrity Gateway installer package:
  1. Download dns_integrity_gateway_18.2.1-404.GA.bcn_amd64.tar.gz from BlueCat Customer Care (log in required).
  2. Extract the TAR file to a local directory. For example:
    tar -zxvf dns_integrity_gateway_18.2.1-404.GA.bcn_amd64.tar.gz -C <target_path>

To upgrade the DNS Integrity Gateway:

  1. Log in to the Linux client as an administrator.
  2. Setup the DNS Integrity Gateway.
    python dns_integrity_gateway.py setup --uid <number>
    Parameters:
    • uid—any valid numerical value (uid cannot be zero); BlueCat recommends a uid of 500 or greater in order to avoid conflicts with internal container users. The uid (user ID) maps the Python Flask user inside the DNS Integrity Gateway container to the Linux client.
  3. At the prompt, enter the absolute path to the BlueCat DNS Integrity Gateway directory. For example, /home/user/dns_integrity_gateway.
    -----------------------------------
    BlueCat DNS Integrity Gateway Setup
    -----------------------------------
    The current BlueCat DNS Integrity Gateway path is /<home>/<user>/<dns_integrity_gateway>
    Would you like to update the BlueCat DNS Integrity Gateway deployment directory path? [Y/N]n
    
    Note: The path to the BlueCat DNS Integrity Gateway directory is absolute and must begin with a slash "/".
  4. At the prompt, type <N/n> to decline the update of the BAM IP address (you will not receive this prompt if running multiple BAM servers). Since you are upgrading the DNS Integrity Gateway, you do not need to change the IP address of the Address Manager server.
  5. At the prompt, type <N/n> to decline import of the basic DNS Integrity Gateway configuration files from the installer package.
    Import basic configuration files to your BlueCat DNS Integrity Gateway directory? [Y/N]n
  6. At the prompt, type <Y/y> to remove the existing container and proceed with the upgrade. Removing the container is necessary to perform the software upgrade. Removing the container will not affect your workflows. If you type <N/n> the upgrade will halt.
    The BlueCat DNS Integrity Gateway container already exists, do you want to remove it? [Y/N]y
    
  7. At the prompt, type <Y/y> to load the latest version of the DNS Integrity Gateway image. You will only receive this prompt if you are not running the latest DNS Integrity Gateway image.
    BlueCat DNS Integrity Gateway image already exists, do you want to overwrite it? [Y/N]y
    
  8. OPTIONAL: At the prompt, type <Y/y> to install third-party Python libraries. You will only receive this prompt if you have created a requirements.txt file in the <dns_integrity_gateway>/packages directory that contains a list of Python modules to install.
    Note: If you have not created a requirements.txtfile, view the README file in <dns_integrity_gateway>/packages for instructions on how to install third-party Python libraries.
  9. At the prompt, type <Y/y> to start the DNS Integrity Gateway.
    Would you like to start the BlueCat DNS Integrity Gateway? [Y/N]y
    
    STARTING BLUECAT DNS INTEGRITY GATEWAY
    --------------------------------------
    BLUECAT_DNS_INTEGRITY_GATEWAY: /home/user/dns_integrity_gateway
    BAM: 192.0.2.10
    BLUECAT_DNS_INTEGRITY_GATEWAY_IMAGE: portal_img:18.2.1-XXX
    VERSION:18.2.1-XXX
    -----------------------------------
    Checking if portal container already exists.
    Setting flask container permissions to dns_integrity_gateway dirs
    You can attach to the BlueCat DNS Integrity Gateway using the following command: 'docker attach portal'
    BlueCat DNS Integrity Gateway container is now running!
    
    Note: Optional—if necessary, run the docker attach portal command to attach the DNS Integrity Gateway container to the DNS Integrity Gateway if you need to run commands within the DNS Integrity Gateway container.