Merge branch 'develop' into 'master'

Release 1.8.0

See merge request automation-sdk/f5-cloud-failover!252

Author: andreykashcheev

docs/userguide/aws.rst

@@ -85,9 +85,25 @@ In order to successfully implement CFE in AWS, you need an AWS Identity and Acce
 
 #. In AWS, go to **IAM > Roles** and create a policy with the following permissions:
 
-   - EC2 Read/Write
-   - S3 Read/Write
-   - STS Assume Role
+   - ec2:DescribeInstances
+   - ec2:DescribeInstanceStatus
+   - ec2:DescribeAddresses
+   - ec2:AssociateAddress
+   - ec2:DisassociateAddress
+   - ec2:DescribeNetworkInterfaces
+   - ec2:DescribeNetworkInterfaceAttribute
+   - ec2:DescribeRouteTables
+   - ec2:AssignPrivateIpAddresses
+   - s3:ListAllMyBuckets
+   - ec2:UnassignPrivateIpAddresses
+   - s3:ListBucket
+   - s3:GetBucketTagging
+   - s3:PutObject
+   - s3:GetObject
+   - s3:DeleteObject
+   - ec2:CreateRoute
+   - ec2:ReplaceRoute
+   - sts:AssumeRole
 
    |
 

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "f5-cloud-failover",
-    "version": "1.7.1",
+    "version": "1.8.0",
     "author": "F5 Networks",
     "license": "Apache-2.0",
     "repository": {

package.json

@@ -1,6 +1,6 @@
 openapi: "3.0.0"
 info:
-  version: 1.7.1
+  version: 1.8.0
   title: Cloud Failover (CF) Extension
   description: F5 Cloud Failover (CFE) is an iControl LX Extension delivered as a TMOS-independent RPM file. Installing the CFE Extension on BIG-IP enables you to declaratively configure BIG-IP devices for automatic failover in cloud environments by POSTing a single JSON declaration to CF’s declarative REST API endpoint.
   license:
@@ -21,9 +21,9 @@ paths:
               schema:
                 $ref: "#/components/schemas/InformationResponse"
               example:
-                version: "1.7.1"
+                version: "1.8.0"
                 release: "1"
-                schemaCurrent: "1.7.1"
+                schemaCurrent: "1.8.0"
                 schemaMinimum: "0.9.1"
         default:
           description: Unexpected Error

specs/openapi.yaml

@@ -759,14 +759,13 @@ class FailoverClient {
      */
     _discoverAddresses(addresses) {
         const updateActions = [];
-        updateActions.push(this.isAddressOperationsEnabled ? this.cloudProvider.updateAddresses({
+        updateActions.push(this.isAddressOperationsEnabled ? this.cloudProvider.discoverAddresses({
             localAddresses: addresses.localAddresses,
             failoverAddresses: addresses.failoverAddresses,
             forwardingRules: {
                 type: 'address',
                 ipAddresses: addresses.failoverAddresses
-            },
-            discoverOnly: true
+            }
         }) : {});
         return updateActions;
     }

src/nodejs/failover.js

@@ -77,6 +77,10 @@ class AbstractCloud {
         throw new Error('Method must be implemented in child class!');
     }
 
+    discoverAddresses() {
+        throw new Error('Method must be implemented in child class!');
+    }
+
     discoverAddressOperationsUsingDefinitions() {
         throw new Error('Method must be implemented in child class!');
     }

src/nodejs/providers/abstract/cloud.js

@@ -127,7 +127,6 @@ class Cloud extends AbstractCloud {
     * @param {Object} options                     - function options
     * @param {Object} [options.localAddresses]    - object containing local (self) addresses [ '192.0.2.1' ]
     * @param {Object} [options.failoverAddresses] - object containing failover addresses [ '192.0.2.1' ]
-    * @param {Boolean} [options.discoverOnly]     - only perform discovery operation
     * @param {Object} [options.updateOperations]  - skip discovery and perform 'these' update operations
     *
     * @returns {Object}
@@ -136,16 +135,10 @@ class Cloud extends AbstractCloud {
         options = options || {};
         const localAddresses = options.localAddresses || [];
         const failoverAddresses = options.failoverAddresses || [];
-        const discoverOnly = options.discoverOnly || false;
         const updateOperations = options.updateOperations;
 
         this.logger.silly('updateAddresses: ', options);
 
-        // discover only logic
-        if (discoverOnly === true) {
-            return this._discoverAddressOperations(localAddresses, failoverAddresses)
-                .catch(err => Promise.reject(err));
-        }
         // update only logic
         if (updateOperations) {
             return this._updateAddresses(updateOperations)
@@ -157,6 +150,24 @@ class Cloud extends AbstractCloud {
             .catch(err => Promise.reject(err));
     }
 
+    /**
+     * Discover Addresses - discovers addresses
+     *
+     * @param {Object} options                     - function options
+     * @param {Object} [options.localAddresses]    - object containing local (self) addresses [ '192.0.2.1' ]
+     * @param {Object} [options.failoverAddresses] - object containing failover addresses [ '192.0.2.1' ]
+     *
+     * @returns {Object}
+     */
+    discoverAddresses(options) {
+        options = options || {};
+        const localAddresses = options.localAddresses || [];
+        const failoverAddresses = options.failoverAddresses || [];
+        this.logger.silly('discoverAddresses: ', options);
+        return this._discoverAddressOperations(localAddresses, failoverAddresses)
+            .catch(err => Promise.reject(err));
+    }
+
     /**
      * Discover addresses using provided definitions
      *