Installing Cloud Discovery & Visibility on a BDDS - Adaptive Applications - BlueCat Gateway - 25.3

Cloud Discovery & Visibility Administration Guide
ft:locale
en-US
Product name
BlueCat Gateway
Version
25.3

You can deploy deploy Cloud Discovery & Visibility on a BlueCat DNS/DHCP Server (BDDS). This can be useful if you deploy BlueCat Gateway there too.

Attention:

  • Before you begin, review the prerequisites, technical specifications, limitations, and best practices for deploying BlueCat Gateway on a BlueCat DNS/DHCP Server (BDDS). For more information, see Gateway Service on BDDS appliances .

  • When configuring Cloud Discovery & Visibility on a BDDS, you cannot specify the log directory or the workspace directory when starting the container. Log files are always written to the /var/log/gateway/ directory on the BDDS, and workspace data is always mapped to the /root/gwdata/ directory on the BDDS.

Address Manager v9.6.x or earlier

To install Cloud Discovery & Visibility on a BDDS from Gateway and Address Manager v9.6.x or earlier:

  1. Log in to the BlueCat 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 the BlueCat Gateway service.

    • Ports: Enter a list of ports to configure for Cloud Discovery & Visibility.

    • Environment Variables: Enter a list of environment variables to pull to a container during startup.

    • Volumes: You can specify the directory (/root/gwmount/) that will be bind mounted to the container for the CD&V database data (/var/lib/postgresql/) to ensure data persistence during the upgrade:

      /root/gwmount/:/var/lib/postgresql/

      See CD&V container on a BDDS for more details.

  8. Under Repository Settings, set the following parameters:

    If pulling the Cloud Discovery & Visibility image from a local or cloud repository:

    • Repository: Use the following: 
      quay.io/bluecat/cloud_discovery_visibility

    • Tag: Use 25.3.

    • Username: Enter your Docker username.

    • Password: Enter your Docker encrypted password.

    If uploading a Cloud Discovery & Visibility image (Address Manager and DNS/DHCP Server v9.5.0 and greater):

    • Upload Image File: Select to open the upload image section.

    • Choose File: Select the Cloud Discovery & Visibility image file to upload.

      Tip: The format of the Cloud Discovery & Visibility image file must be either tar or tar.gz.
      Attention: There is no file size limit when uploading Gateway or Gateway adaptive app images through the UI. However, we recommend that users make sure 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 the upload the chosen image file. Wait for the page to refresh before proceeding. After a successful upload and page refresh, the image name will be listed under Uploaded Image.

  9. Click Update.

    The Gateway Service initializes, pulls the images from the cloud or local repository, and starts the container. After a short delay while Gateway to register the configuration, 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.

Address Manager v25.1 or later

To install Cloud Discovery & Visibility on a BDDS from Gateway and Address Manager v25.1 or later:

  1. Select the Servers tab in the sidebar, then select Servers.

  2. Select the name of a server.

  3. Select the Services tab.

  4. Under Core services, locate the Gateway service panel and select Edit service.

  5. Under General, set the following parameters:

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

    • If pulling the Gateway image from a local or cloud repository, select Repository. The following fields appear:

      • Gateway image—enter the repository address and image tag. For Cloud Discovery & Visibility v25.3, this is:

        quay.io/bluecat/cloud_discovery_visibility:25.3
        .
        Note: Do not enter latest as the image tag. Address Manager will display an error if you enter latest. As a best practice, BlueCat recommends using an image tag to make sure you know which specific image you are using.

      • Repository username—(optional) enter your docker username if the image is on a private repository, for example, if pulling a BlueCat Adaptive Application.

      • Repository password—(optional) enter your docker password. This can either be your Docker password or an encrypted password.

    • If uploading a Gateway image, select Upload image file. The following field appears:

      • Upload image file—drag and drop or 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.

    • The Delete image on disable and Delete mount point on disable checkboxes are options used when disabling the Gateway service and upgrading Gateway containers, for more information refer to Disabling Gateway service and Upgrading a container.

  6. On the Port mapping tab, set the following parameters:

    • Host port and Container port—enter a list of ports to configure for BlueCat Gateway. Select the Add (+) button to add a port.

  7. On the Environment variables tab, set the following parameters:

    • Name and Value—enter a list of environment variables to pull to a container during startup. Select the Add (+) button to add a variable.

      Note: Enter only the required environment variable(s) in this field. Do not include the -e or --env flags. For example, SESSION_COOKIE_SECURE=False.

  8. On the Volume mounts tab, set the following parameters:

    • Source and Container path—set the directories that will be bind mounted to the container for data and logging. To ensure data persistence when patching or upgrading DNS/DHCP servers, BlueCat recommends 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: Make sure 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.

  9. Select Save.

    After you select Save, the Gateway service initializes, pulls the image from the cloud or local repository (or transfers the uploaded image file), and initiates the container. Allow some time for the configuration to register, after which Address Manager will redirect you to the server Services tab.