Installing Network Discovery on a BDDS - Adaptive Applications - BlueCat Gateway - 24.1.2

Network Discovery Administration Guide

ft:locale
en-US
Product name
BlueCat Gateway
Version
24.1.2

If you choose to deploy BlueCat Gateway on a BlueCat DNS/DHCP Server (BDDS), you can also deploy Network Discovery on that BDDS.

Before you begin:

Review the detailed prerequisites, technical specifications, limitations, and best practices for deploying BlueCat Gateway on a BlueCat DNS/DHCP Server (BDDS). For details, see Gateway Service on DNS/DHCP Server in the BlueCat Address Manager (BAM) Administration Guide.

Note: When configuring Network Discovery on a BDDS, you cannot specify the log directory when starting the container. Log files are always written to the /var/log/gateway directory on the BDDS.

Procedure

To install Network Discovery on a BDDS from BAM and Gateway:

  1. Log in to the BAM GUI.

  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.

    BAM 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 Network Discovery.

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

    • Volumes: Enter the following paths to be mapped to the container for storing the configuration, data, and output of Network Discovery:
      Note: Starting in Network Discovery v24.1, configuration files are lost during container upgrades or patches. You must complete this step to ensure that existing data is retained and can be re-imported if you want to migrate to a new release (from v24.1 to later versions).
      /root/gwmount/network_discovery_config/:/portal/builtin/workflows/NetworkDiscovery/config/
      /root/gwmount/network_discovery_data/:/portal/builtin/workflows/network_discovery/data/
      /root/gwmount/network_discovery_output/:/portal/builtin/workflows/network_discovery/output/
  8. Under Repository Settings, set the following parameters:

    If pulling the Gateway image from a local or cloud repository:

    • Repository: Use the following:

      quay.io/bluecat/network_discovery
    • Tag: Use 24.1.2.

    • Username: Enter your Quay username.

    • Password: Enter your Quay encrypted password.

    If uploading a Gateway image (BAM and BDDS v9.5.0 and greater):

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

    • Choose File: Select the Network Discovery image file to upload.
      Note:
      • The format of the Network Discovery image file must be either tar or tar.gz.
      • There is no file size limit when uploading Gateway images through the GUI. However, to avoid timeouts and errors, ensure that BAM and BDDS have sufficient resources and partition sizes to handle larger images.
    • 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.

  9. Click Update.

    The Gateway Service initializes, pulls the images from the cloud or local repository, and initiates the container. Allow some time to register the configuration, after which BAM will redirect you to the Service Type dropdown menu page.

    Next: Confirm that the Gateway Service and container are running:
    1. From the Service Type drop down list, select BlueCat Gateway.

    2. Scroll down to view the Gateway Status section.

      You can find the status of the Service under the Status and Description fields. If the Status field displays RUNNING, Gateway Service has been enabled and the container is running.