Upgrading a container via Gateway image upload - BlueCat Integrity - 9.5.0

Address Manager Administration Guide

Product name
BlueCat Integrity

Perform the following upgrade process for containers running on BlueCat DNS/DHCP Server appliances that are unable to access Gateway image repositories.

To upgrade a custom container via Gateway image upload:

  1. Stop the container from the BDDS Diagnostics page.
  2. From the Gateway Service page, deselect the Enable Gateway Service checkbox. The Remove Image and Remove All Volumes and Bind Mounts checkboxes appear.
  3. Select the Remove Image checkbox. Select the Remove All Volumes and Bind Mounts checkbox only if you wish to remove all unused local volumes and the configured data and logs bind mounts. Leave the Remove All Volumes and Bind Mounts unselected if you would like the data and logs bind mounts to persist on the DNS/DHCP Server during the upgrade.
    Attention: If you select Remove All Volumes and Bind Mounts the mounted data and logs directories will be deleted from the DNS/DHCP Server permanently. This is an irrevocable step.
  4. Click Update. Gateway Service removes the image from the BDDS appliance and stops. Once done, BAM returns you to the BDDS Service Type dropdown menu page.
  5. From the Gateway Service page, set the following parameters:
    • Enable Gateway Service—select this check box to start the 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.
    • Volumes—set the directories that will be bind mounted to the container for data and logging (previously referred to as volumes).
      Note: If you left the mounted data and logs directories on the DNS/DHCP Server when disabling the service, ensure that the directories match the previous bind mounts so the new service can access the existing data.
      If you deleted the bind mounts when disabling the service, note the following for configuring new directories: to ensure data persistence when patching or upgrading DNS/DHCP servers, BlueCat recommmends using the default directory configuration or designated custom directory location. The recommended default configuration is /root/gwdata/:/bluecat_gateway/ and /var/log/gateway/:/logs/. To set custom directories, click Remove to remove the existing directories, then add the custom data and logs directories.
      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/) to ensure data persistence when patching or upgrading DNS/DHCP servers. 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/
      Warning: Ensure that the service is configured as detailed above using either the default directories (/root/gwdata/:/bluecat_gateway/ and /var/log/gateway/:/logs/) or designated custom directory location (/root/gwmount/). Data located outside of these directories will be lost upon patch or upgrade of the DNS/DHCP Server.
  6. Under Repositories, set the following parameters:
    • Upload Image File—select to open the upload image section.
    • Choose File—select the Gateway image file to upload.
      Tip: The format of the Gateway image file must be either tar or tar.gz.
      Attention: There is no file size limit when uploading Gateway images through the UI, but users are advised to check that Address Manager and DNS/DHCP Servers have sufficient resources and partition sizes to handle larger images, to avoid timeouts and errors.
    • Upload Gateway Image—select to upload the chosen Gateway image file. Wait for the page to refresh before proceeding. After successful upload and page refresh, the image name will be listed under Uploaded Image.
  7. Click Update.