Download and Install Cloud Failover Extension

The Cloud Failover Extension package is an RPM file you download, and then upload to the BIG-IP system using the iControl/iApp LX framework. Alternatively, you can see the Quickstart section.


Download the RPM file

The first task is to download the latest RPM file. Go to the F5 Cloud Failover Extension site on GitHub, and download the latest (highest numbered) RPM file, found in the Release section.

Verify the integrity of the Cloud Failover Extension RPM package

F5 Networks provides a checksum for each Cloud Failover Extension release so you can confirm the integrity of the RPM package.

You can get a checksum for a particular RPM by running one of the following commands, depending on your operating system:

  • Linux: sha256sum <path_to_rpm>
  • Windows using CertUtil: CertUtil –hashfile <path_to_rpm> SHA256

You can compare the checksum produced by that command against the .sha256 file (https://github.com/F5Networks/f5-cloud-failover-extension/releases).

Warning

Do not continue if the hash does not match.


Upload and install the Cloud Failover Extension file on each BIG-IP

After you download the RPM, you must upload and then install it on each BIG-IP system. You can use the BIG-IP Configuration utility or cURL (alternatively, you can use SCP to upload the file to /var/config/rest/downloads, but you will still have to use the cURL command to install the package). Use only one of the following procedures.

Install CFE using the BIG-IP Configuration utility

From the Configuration utility:

  1. Click iApps > Package Management LX.
  2. Click the Import button.
  3. Click Choose File and then browse to the location you saved the RPM file, and then click Ok.
  4. Click the Upload button.

Install CFE using cURL from the Linux shell

If you want to use cURL to install Cloud Failover Extension, use the following command syntax.

  1. Set the file name and the BIG-IP IP address and credentials, making sure you use the appropriate RPM file name, including build number, and BIG-IP credentials.

    FN=f5-cloud-failover-1.0.0-1.noarch.rpm
    
    CREDS=admin:password
    
    IP=IP address of BIG-IP
    
  2. Copy the following commands to upload the package. If you uploaded the RPM by another method, you can skip these commands.

    LEN=$(wc -c $FN | cut -f 1 -d ' ')
    
    curl -kvu $CREDS https://$IP/mgmt/shared/file-transfer/uploads/$FN -H 'Content-Type: application/octet-stream' -H "Content-Range: 0-$((LEN - 1))/$LEN" -H "Content-Length: $LEN" -H 'Connection: keep-alive' --data-binary @$FN
    
  3. Copy the following commands to install the package.

    DATA="{\"operation\":\"INSTALL\",\"packageFilePath\":\"/var/config/rest/downloads/$FN\"}"
    
    
    curl -kvu $CREDS "https://$IP/mgmt/shared/iapp/package-management-tasks" -H "Origin: https://$IP" -H 'Content-Type: application/json;charset=UTF-8' --data $DATA
    

Increase Memory Allocated to Restjavad

When using the BIG-IP API, F5 recommends increasing the memory allocated to the process called restjavad. Note that this process will cause service interruption.

Add additional memory for restjavad using following procedure:

  1. In the BIG-IP user interface, navigate to System > Resource Provisioning. Set Management provisioning to Large.

  2. Modify sys db variables using following commands in the CLI (bash):

    tmsh modify sys db provision.extramb value 1000

    tmsh modify sys db restjavad.useextramb value true

  3. Restart restjavad daemons:

    bigstart restart restjavad restnoded

See K26427018: Overview of Management provisioning for more on the memory allocation.


Update Cloud Failover Extension

When F5 releases a new version of Cloud Failover Extension, use the same procedure you used to initially install the RPM. For example, if you used the Configuration utility, when you click Import and then select the new RPM, the system recognizes you are upgrading Cloud Failover Extension.


Note

To provide feedback on Cloud Failover Extension or this documentation, you can file a GitHub Issue.