Installing the Cloud Discovery & Visibility AWS on a BDDS - Adaptive Applications - BlueCat Gateway - 21.1

Cloud Discovery & Visibility AWS Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
21.1
Attention: Before you begin, ensure that you have reviewed the prerequisites, technical specifications, limitations, and best practices for deploying BlueCat Gateway on a BDDS. For more information, refer to Gateway service on BDDS appliances in the Address Manager Administration Guide.
Prerequisites:
  • You must have at least 2 CPUs and 8GB of RAM allocated to the host machine that will be running the BlueCat Gateway instance.
  • You must have an Address Manager server configured with the BlueCatGateway UDF and a BlueCat Gateway user. For more information, refer to the 'Configuring BlueCat Gateway' section of the BlueCat Gateway Installation Guide.
  • You must have a BDDS v9.3.0 managed by Address Manager.
  • You must have purchased the Cloud Discovery & Visibility AWS Adaptive Application from BlueCat.
  • You must have a Quay account that has been granted read access to the Cloud Discovery & Visibility AWS private repository.

    For more information on setting up your Quay account, refer to the information that was provided when you purchased the Cloud Discovery & Visibility AWS Adaptive Application, or the Cloud Discovery & Visibility Package from BlueCat.

  • You must have a Docker CLI password.

    You can create one by clicking Generate Encrypted Password under Docker CLI Password on the Account Settings page in Quay.

Before you begin:

When you first install the Cloud Discovery & Visibility AWS Adaptive Application, BlueCat recommends performing the following:
  • Define a workspace:
    • A workspace is the logical location for you to place your workflows and associated data, including configurations, libraries, requirements, permissions, and customizations; a workspace can be a Docker volume (recommended) or a volume on your local machine. For more information, refer to the Workspace section in the BlueCat Gateway Administration Guide.
  • Define a logs directory:
    • A logs directory can be a Docker volume (recommended) or a volume on your local machine
Tip: BlueCat advises all customers to map Docker volumes for their respective workspace and logs directory to save data from the Cloud Discovery & Visibility AWS Adaptive Application. Volumes are completely managed by Docker and you do not need to set permissions manually when using Docker volumes. This is also the recommended practice for Docker containers. However, if you prefer to mount data and log volumes to your local machine, you must manually set rwx (read, write, execute) permissions to those directories before running the container. If you do not map data or log volumes to your local machine during installation, the Cloud Discovery & Visibility AWS Adaptive Application will write all the data to the container by default. If you then stop or restart the container, all this data will be lost.
To set permissions to external volumes, run the following command:
chmod -R o=rwx <mapped volume>
Note:
  • You can name the workspace and logs directory to anything.
  • The Cloud Discovery & Visibility AWS Adaptive Application saves configuration and workflow data to the workspace, and all execution and session logs to the mapped logs directory. If you do not map a workspace or a logs directory, all the configuration and logging data is written to the container by default.
To install Cloud Discovery & Visibility AWS on a BDDS:
  1. Log in to the 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 BlueCat Gateway service.
    • Ports—enter a list of ports to configure for Cloud Discovery & Visibility AWS.
    • Environment Variables—enter a list of environment variables to pull to a container during startup.
  8. Under Repository Settings, set the following parameters:
    • Repository—enter quay.io/bluecat/aws_discovery_visibility
    • Tag—enter 21.1
    • Username—enter your docker username.
    • Password—enter your docker encrypted password.
  9. Click Update.

    After you click Update, 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 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.