Upgrading Cloud Discovery & Visibility using the database export and import - Adaptive Applications - BlueCat Gateway - 23.3.2

Cloud Discovery & Visibility Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
23.3.2
The following section outlines steps to upgrade Cloud Discovery & Visibility that is deployed on a docker instance. The upgrade procedure consists of the following steps:

Exporting the current Cloud Discovery & Visibility container

To export the current CDV database:

  1. Log in to Cloud Discovery & Visibility.

  2. From the Cloud Discovery & Visibility UI, click in the top-right corner of the page.

  3. From the drop-down menu, select Export Database. The Export database window opens.

  4. (Optional) Under Filename, enter the name of the backup file that you want to export. If left empty, the file name is randomly generated.

    Attention: Do not modify the file name after you save it locally. Doing so can cause failures when importing the database.

  5. (Optional) Under Password, enter a password that will be used to encrypt the database file.

  6. Click Export.

Upgrading a Cloud Discovery & Visibility container on a BDDS

Before installing the new Cloud Discovery & Visibility (CDV) image, you must first stop and remove the existing installation of CDV. If your installation of Cloud Discovery & Visibility (CDV) is on a BlueCat DNS/DHCP Server (BDDS), you can do so from BlueCat Address Manager (BAM).

To stop and remove CDV from a BDDS:

  1. Launch BlueCat Address Manager (BAM).

  2. Stop the CDV container on the BDDS. To do so:

    1. From the Configuration list, select the configuration for the BDDS with CDV.

    2. Select the Servers tab.

    3. Under Servers, select the name of the BDDS with CDV.

    4. Click Diagnostics.

    5. From the Actions menu, select Stop Gateway Container.

    6. Click Execute.

    For more details, see Managing containers in the Address Manager Administration Guide.

  3. Disable and remove the Gateway service from the BDDS. To do so:

    1. On the Server Service Configuration page, clear the Enable Gateway Service checkbox.

    2. Select the Remove Image checkbox that appears.

    3. Click Update.

    For more details, see Managing containers in the Address Manager Administration Guide.

After you stop and remove the previous version, install the new version of CDV on the BDDS as follows:

  1. From the Gateway Service page, set the following parameters:

    • Select the Enable Gateway Service checkbox.

    • If needed, in Ports, enter the list of ports for the CDV instance.

    • If needed, in Environment Variables, enter the list of environment variables to pull to the container during startup.

    • In Volumes, set the directories that will be bind mounted to the container for data and logging. These must match the bind mounts for directories on the previous version.

  2. Under Repositories, set the following parameters:

    • In Repository, enter the repository address of the new image:

      quay.io/bluecat/cloud_discovery_visibility:23.3.2

    • In Tag, enter the new version tag.

For more details, see Managing containers in the Address Manager Administration Guide.

Upgrading a Cloud Discovery & Visibility container not on a BDDS

Before installing the new Cloud Discovery & Visibility (CDV) image, you must stop and remove the existing installation of CDV.

To stop and remove CDV from a container that isn't on a BlueCat DNS/DHCP Serve (BDDS):

  1. Stop the CDV container by running the following command:

    docker stop <gateway_container_name>

  2. Remove the CDV container by running the following command:

    docker rm <gateway_container_name>
    Note: Removing the Cloud Discovery & Visibility container will not remove your workspace or logging data, as these are saved via directories mapped to either your local machine or Docker volume.

Upgrading your Cloud Discovery & Visibility container involves executing the same docker run command used for installation and mapping to your existing workspace and logging directories.

Installing the new Cloud Discovery & Visibility image

  1. From the host machine, run the following command:

    docker login quay.io

  2. At the prompt, enter your Quay user name and password obtained when generating the encrypted password.

  3. Download the Cloud Discovery & Visibility Adaptive Application from Quay using the following command:

    docker pull quay.io/bluecat/cloud_discovery_visibility:23.3.2

  4. Start the upgraded Cloud Discovery & Visibility image using the following command:

    docker run -d \
-p 80:8000 \
-p 443:44300 \
-v <path_to_mapped_log_directory>:/logs/ \
-e BAM_IP=<your_bam_ip_address> \
--name <gateway_container_name> \
quay.io/bluecat/cloud_discovery_visibility:23.3.2

Importing the old database into the upgraded Cloud Discovery & Visibility container

To import the CDV database:

  1. Log in to the upgraded Cloud Discovery & Visibility image.

  2. From the Cloud Discovery & Visibility UI, click in the top-right corner of the page.

  3. From the drop-down menu, select Import Database.

    The Import database window opens.

  4. Under File, click Upload and select the database file that you exported.

  5. Under Password, enter the password (if you encrypted the database backup file).

  6. Click Import.

Once you have successfully upgrades to Cloud Discovery & Visibility v23.3.2, re-enable the visibility jobs from the Management tab.