Network Discovery setup and configuration - Adaptive Applications - BlueCat Gateway - 22.1

Network Discovery Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.1

The following steps describe the initial setup steps for deploying the Network Discovery docker container.

When installing Network Discovery, you'll be deploying it from a docker container with an extensive set of settings and parameters. Several sets of docker parameters are optional or are needed only for specific system configurations. We recommend you review all available options described below, then construct and customize the docker command separately before you start.

There are two main system configurations for deploying Network Discovery.

  • Multiple Containers: Each probe is deployed in a separate Network Discovery container, managed by a single deployment of Network Discovery in another ("Management") container.

    If you use this strategy, you will need to deploy one (1) Manager container and one (1) additional container for each probe. We recommend you give a descriptive Docker name for each container (like "multi_manager", "multi_probe1", and "multi_probe2") to make it clear which is which.

    Note: After deploying the containers, you'll also need to add each probe container to the probe list within the Management instance.
  • Single Container: Both the Network Discovery Management UI and Discovery Probes are run from the same container.

    If you use this strategy, you only need to deply one container. Both the discovery probes and Network Discovery's Management features will be run from the same instance.

Tip: After deployment of any container, you can edit most of these settings in the Network Discovery UI, or within Network Discovery configuration files.

To deploy the Gateway docker container from the provided image:
  1. Copy the Network Discovery package to the host machine.
  2. From the Linux console, run the following command on the extracted file net_disc.tar:

    docker load -i net_disc.tar

  3. Run the Gateway Container using the following command, replacing the indicated fields with appropriate values.:
    docker run -d --name <NAME> -p <HTTP_PORT>:8000 -p <HTTPS_PORT>:44300 \
    -e BAM_IP=<BAM_IP> \
    -e SESSION_COOKIE_SECURE=false \
    quay.io/bluecat/network_discovery:22.1
    Where:
    Parameter Description
    <NAME>

    <HTTP_PORT>

    <HTTPS_PORT>

    <NAME>: Docker name

    <HTTP_PORT>: The HTTP port for BlueCat Gateway

    <HTTPS_PORT>: The HTTPS port for BlueCat Gateway

    <BAM_IP> The IP or FQDN for BlueCat Address Manager
    <SESSION_COOKIE_SECURE> If true (the default), Network Discovery will restrict its functions to HTTPS locations and addresses. If false, Network Discovery will operate on both HTTP and HTTPS.

    Optional configuration parameters: If needed, include the following configuration parameters in your docker command.
    Important: Parameters specified in the docker run command override settings made in configuration files. To change parameters specified in the docker run command, you must delete and recreate the container.
  4. -e SSH_USERNAME=<SSH_USER> -e SSH_PASSWORD=<SSH_PASS> \
    -e MGMT_URL=<MGMT_URL>
    -e MGMT_USERNAME=<MGMT_USER> -e MGMT_PASSWORD=<MGMT_PASS>\
    -e MGMT_INTERVAL=<INTERVAL> \
    -e DISCOVERY_PROBE_LIST='<discovery_probes>' \
    -e EXTERNAL_DISCOVERY_LABEL=<external_discovery_label> \
    -e LOG_LEVEL=<log_level> -e MAXBYTES=<max_bytes> -e BACKUPCOUNT=<backup_count> \
    
    Where:
    Parameter Description

    <SSH_USER>

    <SSH_PASS>

    Optional parameters to set the SSH username and password.

    <SSH_USER>: The SSH username

    <SSH_PASS>: The SSH encrypted password

    <MGMT_URL> The URL for the Management instance.

    <MGMT_USERNAME>

    <MGMT_PASSWORD>

    The account for logging in to the Management instance.

    <MGMT_USERNAME>: The username for logging in to the Management instance.

    <MGMT_PASSWORD>: The encrypted password for logging in to the Management instance.

    <MGMT_INTERVAL> The management interval for scanning and deleting discovery log and status files, in minutes
    <discovery_probes> The Discovery Probe List, in JSON format on a single line. For more details, see Discovery Probe List (JSON format).
    Tip: Manipulation of the Discovery Probe JSON file is typically done only during scripted and customized actions, such as automating deployment of Network Discovery probes. Most users can simply add new probes using the Network Discovery UI.
    <external_discovery_label> The external discovery label, as listed in the external_discoveryUser-defined field (UDF) in Address Manager

    <log_level>

    <max_bytes

    <backup_count>

    Settings that determine Network Discovery logging behaviour:

    <log_level>: The integer level at which logging should take place.

    <max_bytes>: The maximum number of bytes for the log file.

    <backup_count>: The number of backups to make.

    Optional troubleshooting folder parameters: We recommend you mount additional folders to the host to ease future maintenance and troubleshooting. To do so, include the following parameters in your docker command:
    -v <GATEWAY_LOG_DIR>:/logs/ \ 
    -v <DISCOVERY_LOG_DIR>:/builtin/workflows/NetworkDiscovery/logs/ \ 
    -v <DISCOVERY_INPUT_DIR>:/builtin/workflows/NetworkDiscovery/scheduler/data/ \ 
    -v <DISCOVERY_OUTPUT_DIR>:/builtin/workflows/NetworkDiscovery/scheduler/output/ \ 
    -v <CONFIG_DIR>:/bluecat_gateway/workflows/NetworkDiscovery/config/ \
    Where:
    Field Description
    <GATEWAY_LOG_DIR> Path for BlueCat Gateway logs.
    <DISCOVERY_LOG_DIR Path for Discovery logs.
    <DISCOVERY_INPUT_DIR> Path for Discovery input data.
    <DISCOVERY_OUTPUT_DIR> Path for Discovery output data (such as JSON files and log files).

    <CONFIG_DIR>

    <CONFIG_DIR>: The path to use for Network Discovery configuration files. If the <CONFIG_DIR> folder does not exist, the Gateway container will use default values.

  5. From Gateway, confirm that the deployment was successful. For more details, see Verifying docker deployment.