Quickstart

If you are familiar with the BIG-IP system, and generally familiar with REST and using APIs, this section contains the minimum amount of information to get you up and running with Cloud Failover.

  1. Download the latest RPM package from F5 Cloud Failover site on GitHub.
  2. Upload and install the RPM package on the using the BIG-IP GUI:
  • Main tab > iApps > Package Management LX > Import
../_images/cloud-failover-import.png
  1. Be sure to see the Known Issues on GitHub to review any known issues and other important information before you attempt to use Cloud Failover.

  2. Provide authorization (basic auth) to the BIG-IP system:

  3. Using a RESTful API client like Postman, send a GET request to the URI https://{{host}}/mgmt/shared/cloud-failover/info to ensure Cloud Failover is running properly. You should receive an expect response of Success after you have posted this declaration. For example:

    {
        "message": "success"
    }
    
  4. Copy one of the example declarations which best matches the configuration you want to use. There are example declarations in the sections for Azure, AWS, and Google Cloud.

  5. Paste the declaration into your API client, and modify names and IP addresses as applicable. The key and value pair can be arbitrary but they must match the tags that you assign to the infrastructure within the cloud provider. You can craft your declaration with any key and value pair as long as it matches what is in the configuration. For example:

"failoverAddresses": {
        "scopingTags": {
          "i_am_an_arbitrary_key": "i_am_an_arbitrary_value"
        }
  1. POST to the URI https://<BIG-IP>/mgmt/shared/cloud-failover/declare
  2. To stream the output of restnoded, use the tail command: tail –f /var/log/restnoded/restnoded.log

Quick Start Example

Here is an example declaration for Microsoft Azure.

{
    "class": "Cloud_Failover",
    "environment": "azure",
      "externalStorage": {
        "scopingTags": {
          "f5_cloud_failover_label": "mydeployment"
        }
    },
      "failoverAddresses": {
        "scopingTags": {
          "f5_cloud_failover_label": "mydeployment"
        }
    },
    "failoverRoutes": {
      "scopingTags": {
        "f5_cloud_failover_label": "mydeployment"
      },
      "scopingAddressRanges": [
        "0.0.0.0/0"
      ]
    }
}

You will receive a response from Postman that looks like this example:

{"message":"success","declaration":{"class":"Cloud_Failover","environment":"azure","externalStorage":{"scopingTags":{"f5_cloud_failover_label":"mydeployment"}},"failoverAddresses":{"scopingTags":{"f5_cloud_failover_label":"mydeployment"}},"failoverRoutes":{"scopingTags":{"f5_cloud_failover_label":"mydeployment"},"scopingAddressRanges":["0.0.0.0/0"]},"schemaVersion":"0.9.0"}}