Installing hotfix updates for BAM and BDDS within a Distributed DDNS system - Adaptive Applications - BlueCat Gateway - 23.2.3

BlueCat Distributed DDNS Administration Guide

Locale
English
Product name
BlueCat Gateway
Version
23.2.3
Note: This information is collected here for convenience only. For more complete details about installing and updating BlueCat Address Manager, see the appropriate Integrity Guides.

The following instructions summarize how to apply hotfix updates to systems with installations of BlueCat Address Manager (BAM) that connect to BlueCat DNS/DHCP Servers (BDDS) that are running Distribted DDNS.

Note: Upgrade steps differ slightly depending on whether you're applying a major update (such as from BAM/BDDS 9.3.x to BAM/BDDS 9.5.x), a minor update (such as from BAM/BDDS 9.5.0 to BAM/BDDS 9.5.1), or a Hotfix (where the version number does not necessarily change).

Before starting, download the installation file for the hotfix and extract its tarball file (*.tar.gz) and associated public key file (*.key). Hotfix packages can include files for BAM, for BDDS, or both. Make sure you're using the correct type of file when applying a hotfix.

When performing a hotfix upgrade of Integrity, you'll perform one or more of the following steps:

  1. If the hotfix includes a BAM update, apply the BAM update for the new version.

  2. If the hotfix includes a BDDS update, after the corresponding BAM update is complete, update your BDDS servers in this order:

    1. Apply the BDDS update to the BDDS running the Distributed DDNS Application Node.

    2. Apply the BDDS update to the BDDSes running Distributed DDNS Data Nodes, one at a time.

    3. Apply the BDDS update to the BDDS running the Distributed DDNS Service Node.

Unlike major and minor releases, hotfix updates typically do not increment the version number of BAM or BDDS.

1. Apply the Integrity hotfix to BlueCat Address Manager (BAM)

You need apply the hotfix to BAM only if the hotfix includes a BAM update file. You do not need to stop BAM, the BDDS, or Distributed DDNS before applying a BAM hotfix.

To apply a hotfix to BAM:

  1. If you haven't already done so, extract the tarball file and the associated public key file from the hotfix installation file.

  2. Update BAM using instructions on the hotfix's Release Notes PDF document. Typically, you will do the following:

    1. Log in to the Address Manager user interface as an administrator.

    2. Select the Administration tab.

    3. Under General, click Version Management.

    4. Click Software Update.

      1. In Upload an Address Manager update, click Choose File and select the tarball file.

        Make sure you choose the BAM version of the patch (bam_update_*.*)

      2. In BCN Public Key Security File, click Choose File and select the associated public key file.

    5. Click Submit. The Update Confirmation page opens.

    6. Under Confirm Application of Update, verify that you are applying the tarball file to the Address Manager server.

    7. Click Yes.

  3. To verify that the hotfix installed successfully, run the following command:

    cat /var/patch/patchDb.csv

When you're done, repeat the procedure for any other hotfixes that you want to apply. We recommend applying all hotfixes to BAM before applying them to BlueCat DNS/DHCP Servers (BDDSes)

2. Apply the Integrity hotfix to each BlueCat DNS/DHCP Server (BDDS)

You need apply the hotfix to your BDDSes only if the hotfix includes a BDDS update file. After applying the hotfixes to BlueCat Address Manager (where applicanle), you can apply the patch to the BDDSes in your Distributed DDNS network. When applying the Integrity hotfix to each BDDS, we recommend that you do so in the following order:

  • The Distributed DDNS Application Node

  • The Distributed DDNS Data Nodes (one by one)

  • The Distributed DDNS Service Node

To apply the update to a BDDS node:

  1. Determine the next target BDDS node you need to update.

    We recommend that you update BDDS on the Application Node, then on each Data Node one by one, then on the Service Node, in that order.

    CAUTION:
    While you should apply the BDDS hotfix to the Application Node before the Data Nodes, it does not matter which Data Node you update first. However, you must update only one Data Node at a time. Do not try to apply the hotfix to multiple data nodes simultaneously.
  2. Make sure that the hotfix is available in BAM's BlueCat DNS/DHCP Server Patch list.

    1. In BAM, if you haven't done so already, select the appropriate Configuration in the Configuration drop-down menu.

    2. Select the Administration tab.

    3. Under General, click BlueCat DNS/DHCP Server Patches.

    4. If you applied the BAM version of this hotfix to BAM (or if you applied it to another BDDS), the patch files might already be available in BAM. Check the list of available BlueCat DNS/DHCP Server Patch files. If the patch file for the desired hotfix is not available, upload it to BAM as follows:

      1. Under Upload a BlueCat DNS/DHCP Server Patch, click Choose File to locate the tarball file and its associated public key file.

        Make sure you locate the files for the BDDS version of the patch (bdds_update_*.*)

      2. Click Add File. After the upload is complete, the name of the tarball file will appear under Available BlueCat DNS/DHCP Server Patch files.

  3. If you are updating the Application Node: From BlueCat Address Manager (BAM), in the Servers page, stop the DDNS Application Node:

    1. Select the Servers tab.

      Tabs remember the page you last worked on, so click the tab again to make sure you're on the Configuration information page.

    2. Under Servers, click the name of the BDDS with the DDNS Application Node.

    3. In the Details window, do the following:

      • In the Server name menu, select Service Configuration.

      • In Service Type, select BlueCat Gateway.

      • In General Settings, clear the Enable Gateway Service checkbox.

      • Click Update. The Gateway Service is disabled and the Application Node is stopped.

    4. Under Change Control, add comments if you want, then click Yes.

    5. Click Yes.

  4. If you are updating a Data Node: Switch any connections to the target Data Node (that you want to update) to use other Data Nodes.

  5. If you are updating a Data Node or the Service Node: Do the following:

    1. Make sure that the target BDDS is isolated from the Production environment so that no DNS/DHCP update messages can be sent to it.

    2. From a console window on the node that you're updating, stop the docker container.

      For a Data Node, use the following command to stop the container gracefully, giving the MariaDB process time to properly close:

      docker stop -t 90 <Data Node container name>
      For a Service Node, use the following command:
      docker stop <Service Node container name>

      Where the Node container name is the name of the docker container for the Data Node that you're currently updating.

  6. All nodes: From BlueCat Address Manager (BAM), in the Servers page, apply the BDDS update to the target node:

    1. If you haven't done so already, select the appropriate Configuration in the Configuration drop-down menu.

    2. Select the Servers tab.

    3. Under Server, select the check box of the BDDS server for the node that you're currently upgrading.

      Note: Select only one server. When applying BDDS patches to a Distributed DDNS system, BlueCat recommends that you do not upgrade multiple servers at the same time.
    4. Click Action and select Apply Patch.

    5. Under Available Patches, select the BDDS patch for the hotfix release.

    6. Under Change Control, add comments if you want, then click Yes.

    7. Click Yes.

  7. All nodes: Wait until the upgrade finishes. The BDDS might reboot while applying the update. Do not continue to the next step until the BDDS is running with the new version.

    You can monitor the status of an update from the Servers tab in Address Manager. Under Server, select the check box for the BDDS that you're upgrading, click Action, then click Server Upgrade Status.

    For more details, see Viewing the upgrade status in the Address Manager Administration Guide.

    Note: To verify that the hotfix installed successfully, you can also run the following command:
    cat /var/patch/patchDb.csv
    Tip: If you have other hotfixes to apply to the BDDS, you can go back to Step 6 and apply those too (before you move on to restart the node).
  8. If you are updating the Application Node: From BlueCat Address Manager (BAM), in the Servers page, restart the node:

    1. In BAM, if you haven't done so already, select the appropriate Configuration in the Configuration drop-down menu.

    2. Select the Servers tab.

      Tabs remember the page you last worked on, so click the tab again to make sure you're on the Configuration information page.

    3. Under Servers, click the name of the BDDS node you just upgraded.

    4. In the Details window, do the following:

      • In the server name menu, select Service Configuration.

      • In Service Type, select BlueCat Gateway.

      • In General Settings, tick the Enable Gateway Service checkbox.

        Note: Previously, you cleared this checkbox to stop the service. This time, you tick it.
      • Click Update. The Gateway Service is disabled and the node is restarted.

  9. If you are updating a Data Node or the Service Node: Restart the docker service and container as follows:

    1. Restart the docker service:

      systemctl restart docker
    2. From a console window on the Data Node you're updating, restart the docker container. You can use the following command:

      docker start <docker container name>

      Where <docker container name> is the name of the docker container for the target BDDS.

    3. If you are updating a Data Node, wait for it to successfully join the cluster before upgrading other data notes.

  10. You can now repeat these instructions to apply the patch for the next BDDS node.

    If you just upgraded the Application node, you can proceed to upgrade the first Data Node. Upgrade each Data Node one by one.

    After you upgrade the last Data Node, you can upgrade the Service Node.