Installing BlueCat Overlay for Microsoft on a BDDS - Adaptive Applications - BlueCat Gateway - 22.7

BlueCat Overlay for Microsoft

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.7
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 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 purchased the BlueCat Overlay for Microsoft Adaptive Application from BlueCat.
  • You must have permissions to import and load the BlueCat Gateway instance.
  • You must have a Quay account.

    For more information on setting up your Quay account, refer to the information that was provided when you purchased the BlueCat Overlay for Microsoft Adaptive Application 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.

To install BlueCat Overlay for Microsoft 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 BlueCat Overlay for Microsoft. The typical ports are 80:8000 and 443:44300.
    • Environment Variables—enter a list of environment variables to pull to a container during startup. When configuring the BlueCat Overlay for Microsoft, you must configure the following environment variables:
      • BAM_IP=<your_bam_ip_address>: The IP address of the Address Manager server that BlueCat Overlay for Microsoft will connect to.
      • username=<your_bam_api_service_account>: The username of the service account used to authenticate with Address Manager.
      • password=<your_bam_api_service_account_password>: The username of the service account used to authenticate with Address Manager.
        Note:

        If you need to configure BlueCat Overlay for Microsoft to use a proxy, refer to Configuring BlueCat Overlay for Microsoft on a BDDS with an HTTP or HTTPS proxy.

  8. Under Repository Settings, set the following parameters:
    • Repository—enter quay.io/bluecat/overlay_microsoft
    • Tag—enter 22.7-GA
    • Username—enter your Quay or local repository username.
    • Password—enter your Quay or local repository 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.

Configuring BlueCat Overlay for Microsoft on a BDDS with an HTTP or HTTPS proxy

When installing BlueCat Overlay for Microsoft , you can configure the Adaptive Application to use a proxy through which outbound connections are made. You can configuring the proxy information using the HTTP_PROXY and HTTPS_PROXY environment variables when defining the Environment Variables.

An example of the HTTP_PROXY and HTTPS_PROXY environment variable definitions is as follows:
  • HTTP_PROXY=http://<proxy_ip_address>:<port>: (Optional) The IP address of the HTTP proxy through which outbound connections are made.
  • HTTPS_PROXY=https://<proxy_ip_address>:<port>: (Optional) The IP address of the HTTPS proxy through which outbound connections are made.