Merge branch 'R1.10' into 'master'

Release 1.10.0

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

Author: andreykashcheev

.gitignore

@@ -38,4 +38,6 @@ deployment_info.json
 **/.DS_Store
 .idea/*
 temp_*
-sdk/dist/*
+sdk/dist/*
+env.sh
+test/test/*

.gitlab-ci.yml

@@ -47,6 +47,7 @@ variables:
     # topology var
     CF_ENV_NETWORK_TOPOLOGY: 'same_network'
     CF_ENV_NIC_COUNT: 3
+    CF_ENV_USE_FORWARDING_RULE: 'true'
 
 
 # check for disallowed content within any file in source control, this
@@ -70,6 +71,10 @@ check_content:
 build_package:
     image: ${ARTIFACTORY_SERVER}/dockerhub-remote/f5devcentral/containthedocs:rpmbuild
     stage: build_package
+    except:
+      variables:
+        - $CI_COMMIT_REF_NAME == "docs_production"
+        - $CI_COMMIT_REF_NAME == "docs_staging"
     script:
         - echo 'CI BUILD'
         # install packages: jq
@@ -89,6 +94,10 @@ build_package:
 test_node4:
     stage: test
     image: ${ARTIFACTORY_SERVER}/dockerhub-remote/node:4
+    except:
+      variables:
+        - $CI_COMMIT_REF_NAME == "docs_production"
+        - $CI_COMMIT_REF_NAME == "docs_staging"
     script:
         - npm install --global [email protected]
         - npm install [email protected]
@@ -101,6 +110,11 @@ test_node4:
 # test package
 test_package:
     stage: test
+    image: ${ARTIFACTORY_SERVER}/dockerhub-remote/node:11
+    except:
+      variables:
+        - $CI_COMMIT_REF_NAME == "docs_production"
+        - $CI_COMMIT_REF_NAME == "docs_staging"
     script:
         - apt-get update && apt-get install -y jq && npm install
         # linter
@@ -113,6 +127,10 @@ test_package:
 # audit packages for vulnerabilities
 test_audit:
     stage: test
+    except:
+      variables:
+        - $CI_COMMIT_REF_NAME == "docs_production"
+        - $CI_COMMIT_REF_NAME == "docs_staging"
     script:
         # npm audit - uses custom audit processor wrapper
         - npm install
@@ -128,6 +146,10 @@ test_audit:
 # job must be called coverage
 coverage:
     stage: test
+    except:
+      variables:
+        - $CI_COMMIT_REF_NAME == "docs_production"
+        - $CI_COMMIT_REF_NAME == "docs_staging"
     script:
         - apt-get update && apt-get install -y jq && npm install
         # unit tests + coverage report
@@ -150,7 +172,7 @@ coverage:
         max: 1
     script:
         # deploy environment - required artifacts will be place in output folder
-        - /deployment-tool/deploy.sh --deployment-plan ${CF_ENV_CLOUD} --action create --output-folder env_metadata/${CF_ENV_CLOUD}_${CF_ENV_NETWORK_TOPOLOGY}_${CF_ENV_NIC_COUNT}_${CF_ENV_REGION} --deployment-vars region:\"${CF_ENV_REGION}\"
+        - /deployment-tool/deploy.sh --deployment-plan ${CF_ENV_CLOUD} --action create --output-folder env_metadata/${CF_ENV_CLOUD}_${CF_ENV_NETWORK_TOPOLOGY}_${CF_ENV_NIC_COUNT}_${CF_ENV_REGION} --deployment-vars region:\"${CF_ENV_REGION}\" --skip-requirements "true"
     tags:
         - cm-official-docker-executor
     only:
@@ -272,6 +294,16 @@ test_functional_init_gcp:
         variables:
             - $TESTS_TIER == "2"
 
+# init functional tests: gcp no forwarding
+test_functional_init_gcp_no_forwarding:
+    <<: *test_functional_init_generic
+    variables:
+        CF_ENV_CLOUD: "gcp"
+        CF_ENV_REGION: "us-west1"
+        CF_ENV_USE_FORWARDING_RULE: 'false'
+    except:
+        variables:
+            - $TESTS_TIER == "2"
 # Functional Tests - Execute phase (with no retries)
 .test_functional_execute_generic: &test_functional_execute_generic
     stage: test_functional_execute
@@ -281,7 +313,7 @@ test_functional_init_gcp:
         - apt-get update
         - apt-get install -y jq
         # install node (and package dependencies)
-        - curl -sL https://deb.nodesource.com/setup_10.x | bash - && apt-get -y install nodejs
+        - curl -sL https://deb.nodesource.com/setup_12.x | bash - && apt-get -y install nodejs
         - npm install
         # copying artifacts inherited from functional_test_init target to root directory
         - cp -a env_metadata/${CF_ENV_CLOUD}_${CF_ENV_NETWORK_TOPOLOGY}_${CF_ENV_NIC_COUNT}_${CF_ENV_REGION}/. .
@@ -422,7 +454,7 @@ test_functional_execute_aws_1nic:
             - $TESTS_TIER == "1"
             - $CI_COMMIT_MESSAGE =~ /smart:run_functional_tests/
 
-# run functional tests: gcp
+# run functional tests: gcp with forwarding rule
 test_functional_execute_gcp:
     <<: *test_functional_execute_generic
     variables:
@@ -435,6 +467,19 @@ test_functional_execute_gcp:
         variables:
             - $TESTS_TIER == "2"
 
+# run functional tests: gcp without forwarding rules
+test_functional_execute_gcp_no_forwarding_rule:
+    <<: *test_functional_execute_generic
+    variables:
+        CF_ENV_CLOUD: "gcp"
+        CF_ENV_REGION: "us-west1"
+    dependencies:
+        - test_functional_init_gcp_no_forwarding
+        - build_package
+    except:
+        variables:
+            - $TESTS_TIER == "2"
+
 # Functional Tests - Cleanup phase (executes always with 1 retry in a case of any failures)
 .test_functional_cleanup_generic: &test_functional_cleanup_generic
     stage: test_functional_cleanup
@@ -446,7 +491,7 @@ test_functional_execute_gcp:
         # copying artifacts inherited from functional_test_init target to root directory
         - cp -a env_metadata/${CF_ENV_CLOUD}_${CF_ENV_NETWORK_TOPOLOGY}_${CF_ENV_NIC_COUNT}_${CF_ENV_REGION}/. .
         # teardown environment
-        - /deployment-tool/deploy.sh --deployment-plan ${CF_ENV_CLOUD} --action delete --deployment-vars region:\"${CF_ENV_REGION}\"
+        - /deployment-tool/deploy.sh --deployment-plan ${CF_ENV_CLOUD} --action delete --deployment-vars region:\"${CF_ENV_REGION}\" --skip-requirements "true"
     tags:
         - cm-official-docker-executor
     only:
@@ -578,6 +623,19 @@ test_functional_cleanup_gcp:
         variables:
             - $TESTS_TIER == "2"
 
+# run functional tests: gcp no forwarding rule
+test_functional_cleanup_gcp_no_forwarding_rule:
+    <<: *test_functional_cleanup_generic
+    variables:
+        CF_ENV_CLOUD: "gcp"
+        CF_ENV_REGION: "us-west1"
+        CF_ENV_USE_FORWARDING_RULE: 'false'
+    dependencies:
+        - test_functional_init_gcp_no_forwarding
+    except:
+        variables:
+            - $TESTS_TIER == "2"
+
 ###  End of Functional Tests
 
 build_api_docs:

docs/revision-history.rst

@@ -11,9 +11,17 @@ Document Revision History
         - Description
         - Date
 
+      * - 2.2.2
+        - Updated the documentation for Cloud Failover Extension with the following changes: |br| • Updated a note in :ref:`gcp-iam`.
+        - 11-10-21
+
+      * - 2.2.1
+        - Updated the documentation for Cloud Failover Extension with the following changes: |br| • Updated :ref:`configure` to include version notices, more descriptions, and information on configuration :ref:`config-validation`. |br| • Updated the example declarations for :ref:`aws`, :ref:`aws-same-az`, :ref:`gcp`, and :ref:`azure`. |br| • Updated sections for defining your network infrastructure objects on all clouds.  |br| • Updated the :ref:`faq`. |br| • Updated :ref:`troubleshooting`.
+        - 07-29-21
+
       * - 2.2
-        - Updated the documentation for Cloud Failover Extension v1.9.0 with the following changes: |br| • Added clarifying notes to :ref:`aws` and :ref:'aws-same-az' concerning primary IPs and their associated EIPs. |br| • Added section :ref:`aws-custom-cert` to :ref:`aws` and :ref:`aws-same-az`. |br| • Updated the :ref:`faq`.
-        - 06-24-21
+        - Updated the documentation for Cloud Failover Extension v1.9.0 with the following changes: |br| • Added clarifying notes to :ref:`aws` and :ref:`aws-same-az` concerning primary IPs and their associated EIPs. |br| • Added section :ref:`aws-custom-cert` to :ref:`aws` and :ref:`aws-same-az`. |br| • Updated the :ref:`faq`.
+        - 07-01-21
 
       * - 2.1
         - Updated the documentation for Cloud Failover Extension v1.8.0 with the following changes: |br| • Added :ref:`azure-iso-env` to :ref:`isolated-env`. 
@@ -24,7 +32,7 @@ Document Revision History
         - 01-14-21  
 
       * - 1.9
-        - Updated the documentation for Cloud Failover Extension v1.6.0 with the following changes: |br| • Created a separate section for :ref:`aws-same-az`. Continue using the :ref:`aws` section for across availability zones. |br| • Updated AWS diagrams. |br| • Added an :ref:`azure-as3-example`. |br| • Added more information to the :ref:`performance-sizing` section. |br| • Added more example declarations.  |br| • Updated the :ref:`azure-udrtagging` section. 
+        - Updated the documentation for Cloud Failover Extension v1.6.0 with the following changes: |br| • Created a separate section for :ref:`aws-same-az`. Continue using the :ref:`aws` section for across availability zones. |br| • Updated AWS diagrams. |br| • Added an :ref:`azure-as3-example`. |br| • Added more information to the :ref:`performance-sizing` section. |br| • Added more example declarations.  |br| • Updated the :ref:`azure-define-routes` section. 
         - 10-15-20       
 
       * - 1.8
@@ -52,7 +60,7 @@ Document Revision History
         - 04-16-20
 
       * - 1.2
-        - Updated the documentation for Cloud Failover Extension v1.1.0 with the following changes: |br| • Updated page layout for all clouds to include a task summary. |br| • Added information about tagging GCP routes (see :ref:`gcp-tag-routes`). |br| • Updated ARM template link for :ref:`azure`. |br| • Updated the failover event diagrams for all clouds. |br| • Added a section explaining the :ref:`declaration-components`. |br| • Updated the :ref:`faq`.
+        - Updated the documentation for Cloud Failover Extension v1.1.0 with the following changes: |br| • Updated page layout for all clouds to include a task summary. |br| • Added information about tagging GCP routes (see :ref:`gcp-define-routes`). |br| • Updated ARM template link for :ref:`azure`. |br| • Updated the failover event diagrams for all clouds. |br| • Added a section explaining the :ref:`declaration-components`. |br| • Updated the :ref:`faq`.
         - 03-05-20
 
       * - 1.1