Upgrading BlueCat Server Update Services to a new version - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

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

BlueCat periodically releases patches and updates for the BlueCat Server Update Services (BSUS) application itself.

Tip: Instructions for applying an update are also included in release notes for the release in question.

To update BlueCat Server Update Services, you must download the updated custom BlueCat Gateway image that contains the BlueCat Server Update Services workflow. The custom BlueCat Gateway image can be downloaded from Quay.

Before you begin the BSUS upgrade

Ensure that there are no DNS/DHCP Server updates in progress. Any DNS/DHCP Server updates should be completed before updating BlueCat Server Update Services or scheduled ahead of the BlueCat Server Update Services update.

Applying a BlueCat Server Update Services application update

  1. From the host machine, navigate to the dist directory containing the docker-compose.yml file for the current running version.
  2. Turn off the Docker container using the following command:
    docker-compose down

    You can verify that the BlueCat Server Update Services container is turned off by running the docker ps command. The BlueCat Server Update Services container names do not appear in the list if the Docker containers were successfully shut down.

  3. Download the BSUS installer from BlueCat Customer Care. It will have a file name like bsus_installer-<VERSION>-GA.zip, such as bsus_installer-22.1-GA.zip.
  4. Unzip the installer file. The zip file contains the docker-compose.yml and example.env files.
  5. In the same folder as the extracted file docker-compose.yml, create an environment variable file named .env (with no prefix) that contains Address Manager, BlueCat Gateway, and RabbitMQ credentials.
    Tip: Use the provided sample environment file example.env as a template.

    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.

    For example:
    BAM_IP=192.168.88.54
    BSUS_IP=192.168.88.64
    RABBITMQ_DEFAULT_USER=guest
    RABBITMQ_DEFAULT_PASS=guest
    USE_TLS=true
    DB_PASSWORD=MyPassword
    Where
    • 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.
    • DB_PASSWORD is your chosen password for the BSUS search database.
      Note: Until you specify DB_PASSWORD, the search 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.

    Note: If you are installing BlueCat Server Update Services for environments where you must specify the network range to which the BlueCat Server Update Services service containers are assigned, refer to Configuring a dedicated network range for BlueCat Server Update Services.
  6. List the BlueCat Server Update Services Docker volume names using the following command:
    docker volume ls
    By default, BlueCat Server Update Services creates the following four docker volumes:
    • dist_portal_logs
    • dist_portal_medias
    • dist_elasticsearch_data
    • dist_rabbitmq_logs
  7. Edit volumes section of the docker-compose.yml file to include the external and name properties of the volumes.
    The following shows an example of the updated volumes section of the docker-compose.yml file:
    # Copyright 2020 BlueCat Networks. All rights reserved.
    
    version: '3.8'
    
    volumes:
      rabbitmq_logs:
        external: true
        name: dist_rabbitmq_logs
      elasticsearch_data:
        external: true
        name: dist_elasticsearch_data
      portal_logs:
        external: true
        name: dist_portal_logs
      portal_medias:
        external: true
        name: dist_portal_medias
  8. Save the changes to the docker-compose.yml file and exit.
  9. Run the updated BlueCat Server Update Services 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 ]
    [main][ab3ce81ccc3d228c9c8d56d7f16bb605c6d35ff5bca7dd75ed83e6ab37dfa86e] 
    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.