Installing BlueCat Server Update Services - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

English (United States)
Product name
BlueCat Gateway
Before you begin, you must download the custom BlueCat Gateway image that contains the BlueCat Server Update Services (BSUS) workflow. The custom BlueCat Gateway image can be downloaded from Quay or BlueCat Customer Care.
Attention: The following section outlines steps to download and install the BlueCat Server Update Services Adaptive Application from Quay. To download and install the offline BlueCat Server Update Services package from BlueCat Customer Care, contact your BlueCat Customer Care representative for additional information.
  • You must have Docker installed on the host machine that will be running the BlueCat Gateway instance. For more information, refer to the 'Requirements' section of the BlueCat Gateway Installation Guide.
  • 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 Quay account that has been granted read access to the BlueCat Server Update Services private repository. If you have not yet created a Quay account, create an account and give your Quay account username to a BlueCat representative to be granted access to the private repository.
  • You must have a Docker CLI (Command Line Interface) password.

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

To install BlueCat Server Update Services from Quay:
  1. From the host machine, run the following command:
    docker login
  2. At the prompt, enter your Quay user name and password obtained when generating the encrypted password.
  3. Download the installer file from BlueCat Customer Care.

    Typically, this file has a name like, where 2X.X is the latest version number.

  4. Unzip the installer file.
  5. In the same folder as docker-compose.yml, create an environment variable file named .env (with no prefix) that contains Address Manager, BlueCat Gateway, and RabbitMQ credentials.
    Tip: You can use the provided sample environment file example.env as a template.
    The following shows an example of the content of an .env environment variable file:
    • BAM_IP variable is the IP address of Address Manager.
    • BSUS_IP is the IP address of the BlueCat Gateway instance that will be running BlueCat Server Update Services.
    • RABBITMQ_DEFAULT_USER is the default username of the RabbitMQ service.
    • RABBITMQ_DEFAULT_PASS is the default password of the RabbitMQ service.
    • USE_TLS specifies whether or not to use TLS encryption for communications between BSUS containers. For more details, see Configuring BSUS for TLS encryption.
    • DB_PASSWORD is your chosen password for the BSUS database.
      Note: Until you specify DB_PASSWORD, the BSUS database will be unprotected. If no password is set on the database, BSUS will set the database password the first time it sees the DB_PASSWORD setting in the .env file.

      If the database is already password-protected, BSUS will attempt to use the password specified in DB_PASSWORD. Therefore, after adding DB_PASSWORD to the .env file, do not change it again.

    If you will be using BSUS in environments where you must specify the network range to which the BSUS service containers are assigned, refer to Configuring a dedicated network range for BlueCat Server Update Services.
    Tip: A standard installation includes a sample environment file named example.env. You can copy this file as a template to use for your .env file.

    Make sure you change the passwords for the RabbitMQ service and DB Search database from the default values and update them in your .env file, before running the docker-compose command in the next step.

  6. Run the docker container using the following command:
    docker-compose up -d

    The BlueCat Server Update Services Adaptive Application starts up. You can proceed to access the BlueCat Server Update Services Adaptive Application from the browser window once the service has started.

    To verify that the service has started, run the following command:
    docker-compose logs -f | grep "Declaring"
    The following log message indicates that the service has started:
    logstash_1       | [2021-05-17T16:06:42,205][INFO ][logstash.inputs.rabbitmq ]
    Declaring exchange 'bsus' with type topic
    Important: You must wait for the BlueCat Server Update Services Adaptive Application to start before attempting to access the UI. If you do not wait for the Declaring exchange 'bsus' with type topic message to appear and attempt to access the UI before the service has started, you will receive the following error:
    Get Batches Error: NotFoundError(404, 'index_not_found_exception', 'no such index [batch], batch, index_or_alias)

    If you receive this error, you must stop the current BlueCat Batch Update Services container, delete the container, and install a new container.