Merge branch 'devel'

F5Networks · Jan 16, 2025 · 85845af · 85845af
2 parents 86a10ac + f64920c
commit 85845af
Show file tree

Hide file tree

Showing 9 changed files with 253 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ uploading security policies, uploading crts/keys, gathering info, etc.
 
 ## Requirements
 
- - ansible >= 2.15
+ - ansible >= 2.14
 
 ## Python Version
 Collection supported on Python 3.9 and above.
@@ -106,10 +106,10 @@ Individuals or business entities who contribute to this project must complete an
 being included in this project.
 
 
-[repoinstall]: https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#installing-a-collection-from-a-git-repository
+[repoinstall]: https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html#installing-a-collection-from-a-git-repository
 [imperative_collection]: https://galaxy.ansible.com/f5networks/f5_modules
 [dailybuild]: https://f5-ansible.s3.amazonaws.com/collections/f5networks-f5_bigip-devel.tar.gz
 [License]: https://www.gnu.org/licenses/gpl-3.0.txt
 [execenv]: https://docs.ansible.com/automation-controller/latest/html/userguide/execution_environments.html
-[f5execenv]: http://clouddocs.f5.com/products/orchestration/ansible/devel/usage/exec-env.html
-[F5 Contributor License Agreement]: http://clouddocs.f5.com/products/orchestration/ansible/devel/usage/contributor.html
+[f5execenv]: https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/exec-env.html
+[F5 Contributor License Agreement]: https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/contributor.html
diff --git a/ansible_collections/f5networks/f5_bigip/CHANGELOG.rst b/ansible_collections/f5networks/f5_bigip/CHANGELOG.rst
@@ -4,6 +4,9 @@ F5Networks F5\_BIGIP Collection Release Notes
 
 .. contents:: Topics
 
+v3.10.0
+=======
+
 v3.9.0
 ======
 

diff --git a/ansible_collections/f5networks/f5_bigip/README.md b/ansible_collections/f5networks/f5_bigip/README.md
@@ -9,7 +9,7 @@ uploading security policies, uploading crts/keys, gathering info, etc.
 
 ## Requirements
 
- - ansible >= 2.15
+ - ansible >= 2.14
 
 ## Python Version
 Collection supported on Python 3.9 and above.
@@ -106,10 +106,10 @@ Individuals or business entities who contribute to this project must complete an
 being included in this project.
 
 
-[repoinstall]: https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#installing-a-collection-from-a-git-repository
+[repoinstall]: https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html#installing-a-collection-from-a-git-repository
 [imperative_collection]: https://galaxy.ansible.com/f5networks/f5_modules
 [dailybuild]: https://f5-ansible.s3.amazonaws.com/collections/f5networks-f5_bigip-devel.tar.gz
 [License]: https://www.gnu.org/licenses/gpl-3.0.txt
 [execenv]: https://docs.ansible.com/automation-controller/latest/html/userguide/execution_environments.html
-[f5execenv]: http://clouddocs.f5.com/products/orchestration/ansible/devel/usage/exec-env.html
-[F5 Contributor License Agreement]: http://clouddocs.f5.com/products/orchestration/ansible/devel/usage/contributor.html
+[f5execenv]: https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/exec-env.html
+[F5 Contributor License Agreement]: https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/contributor.html
diff --git a/ansible_collections/f5networks/f5_bigip/changelogs/changelog.yaml b/ansible_collections/f5networks/f5_bigip/changelogs/changelog.yaml
@@ -544,6 +544,8 @@ releases:
     release_date: '2023-07-19'
   3.1.1:
     release_date: '2023-08-30'
+  3.10.0:
+    release_date: '2025-01-16'
   3.2.1:
     changes:
       bugfixes:

diff --git a/ansible_collections/f5networks/f5_bigip/galaxy.yml b/ansible_collections/f5networks/f5_bigip/galaxy.yml
@@ -29,4 +29,4 @@ tags:
   - networking
   - bigip
   - bigiq
-version: 3.9.0
+version: 3.10.0
diff --git a/ansible_collections/f5networks/f5_bigip/meta/runtime.yml b/ansible_collections/f5networks/f5_bigip/meta/runtime.yml
@@ -1,2 +1,2 @@
 ---
-requires_ansible: '>=2.15.0'
+requires_ansible: '>=2.14.0'
diff --git a/ansible_collections/f5networks/f5_bigip/plugins/module_utils/version.py b/ansible_collections/f5networks/f5_bigip/plugins/module_utils/version.py
@@ -4,4 +4,4 @@
 # GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 # This collection version needs to be updated at each release
-CURRENT_COLL_VERSION = "3.9.0"
+CURRENT_COLL_VERSION = "3.10.0"
diff --git a/ansible_collections/f5networks/f5_bigip/plugins/modules/bigip_as3_deploy.py b/ansible_collections/f5networks/f5_bigip/plugins/modules/bigip_as3_deploy.py
@@ -59,7 +59,7 @@
         type: bool
       log_level:
         description:
-          - If set to C(true), BIG-IP AS3 creates a detailed trace of the configuration process for the tenant
+          - Controls the amount of detail in logs produced while configuring the tenant.
         type: str
         choices:
           - emergency
@@ -72,11 +72,11 @@
           - debug
       trace:
         description:
-          - "If C(true), the declaration is traced."
+          - If C(true), BIG-IP AS3 creates a detailed trace of the configuration process for this Tenant for subsequent analysis.
         type: bool
       trace_response:
         description:
-          - If set to C(true), the response will contain the trace files
+          - If set to C(true), the response will contain the trace files.
         type: bool
       user_agent:
         description:
@@ -99,6 +99,11 @@
     Per-Application deployments is supported from AS3 versions>=3.50.0
     Tenant parameter is mandatory for Per-Application Deployments
     More infotmation can be found here https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/userguide/per-app-declarations.html
+  - Regarding the controls parameter, in this document,
+    https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/refguide/as3-api.html#query-parameters-for-controls-objects,
+    it is mentioned that controls parameters specified in the url as query parameters will override the controls parameters specified in the declaration,
+    but due to a bug that behaviour is not seen, so it is recommended that the user should specify controls options either in the module parameters or in
+    the AS3 declaration. Note that using the controls parameter in this module uses url query parameters behind the scenes.
 author:
   - Wojciech Wypior (@wojtek0806)
   - Prateek Ramani (@ramani)
@@ -107,30 +112,240 @@
 EXAMPLES = r"""
 - name: Declaration with 2 Tenants - AS3
   bigip_as3_deploy:
-    content: "{{ lookup('file', 'two_tenants.json') }}"
-
-- name: Declaration with 2 Tenants with controls parameters - AS3
-  bigip_as3_deploy:
-    content: "{{ lookup('file', 'two_tenants.json') }}"
-    controls:
-      log_level: debug
-      trace: true
-      trace_response: true
+    content: |
+      {
+        "class": "AS3",
+        "action": "deploy",
+        "persist": true,
+        "declaration": {
+          "class": "ADC",
+          "schemaVersion": "3.0.0",
+          "id": "urn:uuid:33045210-3ab8-4636-9b2a-c98d22ab915d",
+          "label": "Sample 1",
+          "remark": "Simple HTTP application with RR pool",
+          "Sample_01": {
+            "class": "Tenant",
+            "A1": {
+              "class": "Application",
+              "template": "http",
+              "serviceMain": {
+                "class": "Service_HTTP",
+                "virtualAddresses": [
+                  "10.0.1.10"
+                ],
+                "pool": "web_pool"
+              },
+              "web_pool": {
+                "class": "Pool",
+                "monitors": [
+                  "http"
+                ],
+                "members": [{
+                  "servicePort": 80,
+                  "serverAddresses": [
+                    "192.0.1.10",
+                    "192.0.1.11"
+                  ]
+                }]
+              }
+            }
+          },
+          "Sample_02": {
+            "class": "Tenant",
+            "A1": {
+              "class": "Application",
+              "template": "http",
+              "serviceMain": {
+                "class": "Service_HTTP",
+                "virtualAddresses": [
+                  "10.0.1.11"
+                ],
+                "pool": "web_pool2"
+              },
+              "web_pool2": {
+                "class": "Pool",
+                "monitors": [
+                  "http"
+                ],
+                "members": [{
+                  "servicePort": 80,
+                  "serverAddresses": [
+                    "192.0.1.12",
+                    "192.0.1.13"
+                  ]
+                }]
+              }
+            }
+          }
+        }
+      }
 
 - name: Deploying Per-App Declaration
   bigip_as3_deploy:
-    content: "{{ lookup('file', 'per-app-dec.json') }}"
+    content: |
+      {
+        "schemaVersion": "3.48.0",
+        "Application1": {
+          "class": "Application",
+          "service": {
+            "class": "Service_HTTP",
+            "virtualAddresses": [
+              "192.0.10.1"
+            ],
+            "pool": "pool"
+          },
+          "pool": {
+            "class": "Pool",
+            "members": [
+              {
+                "servicePort": 80,
+                "serverAddresses": [
+                  "192.0.10.1",
+                  "192.0.10.2"
+                ]
+              }
+            ]
+          }
+        }
+      }
     tenant: sample
 
-- name: Deploying Per-App Declaration with controls parameters
+- name: Declaration with 2 Tenants with controls parameters - AS3
   bigip_as3_deploy:
-    content: "{{ lookup('file', 'per-app-dec.json') }}"
-    tenant: sample
+    content: |
+      {
+        "class": "AS3",
+        "action": "deploy",
+        "persist": true,
+        "declaration": {
+          "class": "ADC",
+          "schemaVersion": "3.0.0",
+          "id": "urn:uuid:33045210-3ab8-4636-9b2a-c98d22ab915d",
+          "label": "Sample 1",
+          "remark": "Simple HTTP application with RR pool",
+          "Sample_01": {
+            "class": "Tenant",
+            "A1": {
+              "class": "Application",
+              "template": "http",
+              "serviceMain": {
+                "class": "Service_HTTP",
+                "virtualAddresses": [
+                  "10.0.1.10"
+                ],
+                "pool": "web_pool"
+              },
+              "web_pool": {
+                "class": "Pool",
+                "monitors": [
+                  "http"
+                ],
+                "members": [{
+                  "servicePort": 80,
+                  "serverAddresses": [
+                    "192.0.1.10",
+                    "192.0.1.11"
+                  ]
+                }]
+              }
+            }
+          },
+          "Sample_02": {
+            "class": "Tenant",
+            "A1": {
+              "class": "Application",
+              "template": "http",
+              "serviceMain": {
+                "class": "Service_HTTP",
+                "virtualAddresses": [
+                  "10.0.1.11"
+                ],
+                "pool": "web_pool2"
+              },
+              "web_pool2": {
+                "class": "Pool",
+                "monitors": [
+                  "http"
+                ],
+                "members": [{
+                  "servicePort": 80,
+                  "serverAddresses": [
+                    "192.0.1.12",
+                    "192.0.1.13"
+                  ]
+                }]
+              }
+            }
+          }
+        }
+      }
     controls:
       log_level: debug
       trace: true
       trace_response: true
 
+- name: Controls parameter in declaration as well as module parameters will result in error, NOT RECOMMENDED
+  bigip_as3_deploy:
+    controls:
+      dry_run: true
+    content: |
+      {
+        "action": "deploy",
+        "class": "AS3",
+        "declaration": {
+          "Sample_xyz": {
+            "A1": {
+              "class": "Application",
+              "serviceMain": {
+                "class": "Service_HTTP",
+                "pool": "web_pool",
+                "virtualAddresses": [
+                  "10.0.1.10"
+                ]
+              },
+              "template": "http",
+              "web_pool": {
+                "class": "Pool",
+                "members": [
+                  {
+                    "serverAddresses": [
+                      "192.0.1.10",
+                      "192.0.1.11"
+                    ],
+                    "servicePort": 80
+                  }
+                ],
+                "monitors": [
+                  "http"
+                ]
+              }
+            },
+            "class": "Tenant"
+          },
+          "class": "ADC",
+          "id": "urn:uuid:33045210-3ab8-4636-9b2a-c98d22ab915d",
+          "label": "Sample 1",
+          "remark": "Simple HTTP application with RR pool",
+          "schemaVersion": "3.0.0",
+          "controls": {
+            "class": "Controls",
+            "dryRun": false
+          }
+        },
+        "persist": true
+      }
+  ignore_errors: true
+  register: result
+
+- name: Assert expect error due to controls parameter conflict
+  assert:
+    that:
+      - result is failed
+      - >
+        "'Controls parameters provided in both, the AS3 declaration
+        and module parameters. Please provide the controls parameters
+        in only one place.' in result.msg"
+
 - name: Remove one tenant - AS3
   bigip_as3_deploy:
     tenant: "Sample_01"
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,9 @@ F5Networks F5\_BIGIP Collection Release Notes @@
     .. contents:: Topics
+    v3.10.0
+    =======
     v3.9.0
     ======
@@ Expand Down @@