Manual Chapter : Data Collection Device Cluster Upgrade Overview

Applies To:

Show Versions Show Versions

BIG-IQ Centralized Management

  • 5.4.0
Manual Chapter

Decide which upgrade guide to use

There are a number of different upgrade guides you can use to upgrade the BIG-IQ® Centralized Management data collection device (DCD) cluster to the latest version. To decide which guide to use, you need to consider a number of factors. First, consider which version you are upgrading from. Then use the appropriate table to determine which guide is most appropriate for your business needs.

Upgrading from version 5.0

To upgrade from version 5.0, use the guide on support.f5.com titled: F5 BIG-IQ Centralized Management: Upgrading Logging Nodes to Version 5.1. When a task instructs you to download and install a v5.1.0 file, download and install a v5.4.0 file instead.

Additionally, after the upgrade is complete, you need to use the 5.4.0 user interface to configure an external storage location for the snapshots created for this cluster. To configure the external storage, you will need the IP address, storage file path, domain name, user name, and password for the location you plan to configure. To access the External Storage screen, click System > BIG-IQ DATA COLLECTION > Big-IQ Data Collection Cluster > Configuration > External Storage & Snapshots and then click Configure. For additional details, refer to Define external storage snapshots location on support.f5.com.

Upgrading from version 5.1

Before you upgrade BIG-IQ from version 5.1, you need to answer a couple of questions.
  • Do you need to preserve the data on your logging node cluster?
  • If so, can you allow your logging node cluster to go offline for an extended period during the upgrade?
Depending on your answers, select one of the following scenarios for further instructions:
I do not need to preserve my data
Use the guide titled: F5 BIG-IQ Centralized Management: Upgrading Logging Nodes to Version 5.2 Without Preserving Existing Data. When a task instructs you to download and install a v5.2.0 file, download and install a v5.4.0 file instead.
I need to preserve my data and I can take my logging node cluster offline during upgrade
Use the guide titled: F5 BIG-IQ Centralized Management: Upgrading Logging Nodes to Version 5.2 While Preserving Existing Data. When a task instructs you to download and install a v5.2.0 file, download and install a v5.4.0 file instead.
I need to preserve my data, I have at least 3 logging nodes, and I need to minimize logging cluster downtime during upgrade
Use the guide titled: F5® BIG-IQ® Centralized Management: Upgrading a Logging Node Cluster from 5.1 to Version 5.4 with Minimal Downtime.

Regardless of which guide you use, after the upgrade is complete, you need to use the 5.4.0 user interface to configure an external storage location for the snapshots created for this cluster. To configure the external storage, you will need the IP address, storage file path, domain name, user name, and password for the location you plan to configure. To access the External Storage screen, click System > BIG-IQ DATA COLLECTION > Big-IQ Data Collection Cluster > Configuration > External Storage & Snapshots and then click Configure. For additional detail, refer to Define external storage snapshots location on support.f5.com.

Upgrading from version 5.2 or 5.3

To decide which guide to use when you upgrade from BIG-IQ ®version 5.2 or 5.3, the main question to answer is whether you can allow your data collection device (DCD) cluster to go offline for an extended period during the upgrade. If you can afford the downtime, the workflow is much more straightforward and takes significantly less effort on your part.
I can take my DCD cluster offline during upgrade
Use the guide titled: F5® BIG-IQ® Centralized Management: Upgrading a Data Collection Cluster to Version 5.4
I need to preserve my data, I have at least 3 DCDs, and I need to minimize logging cluster downtime during upgrade
Use the guide titled: F5® BIG-IQ® Centralized Management: Upgrading a Data Collection Device Cluster from 5.2 or 5.3 to Version 5.4 with Minimal Downtime

How do I upgrade my data collection device cluster to version 5.4?

A data collection device (DCD) cluster comprises your DCDs, the BIG-IQ® Centralized Management device you use to manage them, and an optional BIG-IQ peer device. Additional steps are required when upgrading a DCD cluster.

Important: The upgrade process for a DCD cluster is fully supported by the BIG-IQ user interface. Attempting to upgrade a DCD cluster using a sequence of tmsh commands is not recommended and is likely to result in loss of data.
Important: The following process requires cluster downtime. To prevent losing data, perform this process during a maintenance window. If you cannot take the DCD cluster offline and have at least 3 DCDs in your cluster, you can use the rolling upgrade process. Refer to the guide titled: F5® BIG-IQ® Centralized Management: Upgrading a Data Collection Device Cluster from 5.2 or 5.3 to Version 5.4 with Minimal Downtime for details.

The diagram illustrates the process workflow.

DCD cluster upgrade worfklow

Note: For a successful upgrade, it is essential that you perform the tasks in the sequence detailed here. You cannot perform these tasks in parallel.

Data collection device cluster update requirements

There are a number of items that you need to have ready access to, before you can successfully complete the data collection device cluster update. It might be helpful to use the following table to record the values, so you have them at hand when needed.

Device Information needed Information Recorded
Primary BIG-IQ Centralized Management device Management IP address

admin user name and password

 
  root access password  
Secondary BIG-IQ device Management IP address

root access password

admin user name and password

 
Data collection devices Management IP address

root access password

 

Prepare for Data Collection Device Upgrade

Download the BIG-IQ version 5.4 software image from F5 Networks

Downloading a software image from F5 Networks is the first step toward making it available to install on the BIG-IQ system.
  1. Log in to the F5 Downloads site, downloads.f5.com.
  2. Click the Find a Download button.
  3. Click the name of the product line.
  4. Click the product name, Centralized Management.
  5. Click V5.4.0.
  6. Read the End User Software License agreement and click the I Accept button if you agree with the terms.
  7. Click the BIG-IQ version 5.4 .iso file name.
  8. Click the name of the closest geographical location to you.
    The software image downloads to your local system.
The software image is now available for you to upload.

Upload the latest version of the BIG-IQ software image

Before you can upload the software image to the BIG-IQ® system, you must have first downloaded it from the F5 Downloads site.

Upload the BIG-IQ version software image to the primary BIG-IQ system to make it available for this upgrade.

  1. At the top of the screen, click System.
  2. On the left, click THIS DEVICE > SOFTWARE MANAGEMENT > Available Images .
  3. Click the Upload Image button.
  4. Click the Choose File button and go to the location to which you downloaded the image, and click the Open button to upload it to BIG-IQ.
  5. Click the Upload button.
    The screen refreshes to display the progress of the upload.
When the image is finished uploading, it shows in the Available Images list.

Remove the secondary BIG-IQ from the HA pair

If the F5®BIG-IQ® Centralized Management system is configured in an HA pair, you must remove the secondary BIG-IQ system before you upgrade the primary BIG-IQ.
  1. Log in to the primary BIG-IQ with your admin user name and password.
  2. At the top of the screen, click System.
  3. On the left, click BIG-IQ HA.
  4. Click Remove Secondary.
    A dialog box opens, prompting you to confirm that you want to remove the HA secondary device from this group.
  5. Click Remove to confirm you want to take the HA secondary device out of the group.
    The system logs you out of the BIG-IQ while it removes the secondary device.
  6. Log back in to the primary BIG-IQ with your admin user name and password.
    For a while, both the primary and the secondary BIG-IQ devices continue to display. After a few minutes, the screen updates to display a single standalone device.

Prepare the DCD cluster for upgrade

Before you can perform the upgrade preparation task, you must:
  • Download the BIG-IQ version 5.4 software image from the F5 downloads site.
  • Upload the BIG-IQ version 5.4 software to your primary BIG-IQ.
  • Remove the secondary BIG-IQ from your HA pair.
Warning: These procedures require that the BIG-IQ system is temporarily unavailable, and unable to manage BIG-IP® devices until the upgrade is complete. BIG-IP devices can continue to manage traffic during this time. This process can take up to an hour.

The upgrade preparation process readies your data collection device cluster for the upgrade process. You can opt to back up your data or discard it.

  1. Log in to the primary BIG-IQ with your admin user name and password.
  2. At the top of the screen, click System.
  3. On the left, click THIS DEVICE > SOFTWARE MANAGEMENT > Available Images .
  4. In the list of images, select the check box next to the image you want to install, and click the Install button at the top of the screen
  5. From the Target Volume list, select the volume you want to install the image on.
    Note: If the Target Volume list is empty, the machine you are upgrading does not have a second volume available for you to install the upgrade. You must create one to proceed.
    • If you selected a target volume, complete the remaining steps to finish the upgrade.
    • If you do not have a second volume, use the following steps to create one:
      • Use SSH to log in to the machine you want to upgrade. You must log in as root to perform this procedure.
      • Create the new volume using the command /usr/libexec/bigpipe software desired <volume name> add, for example: /usr/libexec/bigpipe software desired HD1.3 add.
      • After the command executes, repeat this step; however, this time the Target Volume list will not be empty.
  6. Click the Install button.
    A dialog box opens to give you the option of saving or discarding your data.
  7. Decide whether to save your data or discard it.
    • To back up the data on your data collection device, select Yes, snapshot first and proceed with deactivating services (Recommended) and then click Continue.
    • To discard the data on your data collection device, select No, proceed directly to deactivating services and then click Continue.
    If you are backing up your data, the system creates a snapshot on an external storage location, and then deactivates the services on your BIG-IQ system. Depending on the amount of accumulated data, this step takes some time. If you do not save your data, the system begins deactivating services immediately.
  8. If you chose to back up your data, but have not yet defined an external storage location, a dialog box opens so you can configure it.
    1. In the User name and Password fields, type the user name and password for the user account configured on the external storage device.
    2. For the Domain, type in the domain name for the user account configured on the external storage device.
    3. For the Storage Path, type the path to the external storage location.
      You can specify the device using the IP address or the host name. Additionally, you need to specify the path to the folder on the external storage device. For example:
      //<storage machine ip-address>/<storage-file-path>
      Note: Remember, the folder you specify must have full read, write, and execute permissions.
    4. To test the settings just specified, click Test.
      A message displays to tell you whether the test completes successfully. If it does not, correct the settings and permissions until it completes successfully.
    5. When the external storage is specified successfully, click Save.
  9. Wait while BIG-IQ creates a snapshot.
    Depending on the amount of data you have, this could take up to an hour. During this time, it is important that you not interrupt the installation process by restarting services or the server.
    Note: If this is the first time you have created a snapshot, this step takes significantly more time. If you have been creating regular backups, the snapshot step completes relatively quickly.
    When the process completes, a message displays to tell you that the snapshot and deactivation have finished.
  10. Click Close to close the deactivating services message.
  11. If you used a self IP address to discover your data collection devices, you need to stop the elasticsearch service before proceeding.
    If you use the management IP address to discover the DCDs in your cluster, you can skip this step.
    1. Use SSH to log in to the DCD as root.
    2. Use the bigstart stop elasticsearch command to stop the elasticsearch service. Type bigstart stop elasticsearch, and press Enter.
    Note: You must perform this task for each DCD in the cluster.
Although the upgrade preparation process is now complete, you can not yet upgrade the BIG-IQ. You must upgrade your data collection devices before you can upgrade the BIG-IQ.