Merge pull request #154 from CiscoDevNet/2.1.0

Release 2.1.0
CiscoDevNet · Jul 19, 2022 · 71f2c42 · 71f2c42
2 parents ddec6f9 + 82b998a
commit 71f2c42
Show file tree

Hide file tree

Showing 118 changed files with 22,240 additions and 10,804 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -21,15 +21,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ansible: [2.9.12, 2.10.0]
+        ansible: [2.9.27, 2.10.17, 2.11.12, 2.12.7]
     steps:
     - name: Check out code
       uses: actions/checkout@v2
 
-    - name: Set up Python 3.7
+    - name: Set up Python 3.8
       uses: actions/setup-python@v1
       with:
-        python-version: 3.7
+        python-version: 3.8
 
     - name: Install ansible-base (v${{ matrix.ansible }})
       run: pip install https://github.com/ansible/ansible/archive/v${{ matrix.ansible }}.tar.gz --disable-pip-version-check
@@ -43,19 +43,51 @@ jobs:
         name: collection
         path: .cache/collection-tarballs
 
+
+  sanity:
+    name: Run ansible-sanity tests
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ansible: [2.9.27, 2.10.17, 2.11.12, 2.12.7]
+    steps:
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.8
+
+    - name: Install ansible-base (v${{ matrix.ansible }})
+      run: pip install https://github.com/ansible/ansible/archive/v${{ matrix.ansible }}.tar.gz --disable-pip-version-check
+
+    - name: Download migrated collection artifacts
+      uses: actions/download-artifact@v1
+      with:
+        name: collection
+        path: .cache/collection-tarballs
+
+    - name: Install the collection tarball
+      run: ansible-galaxy collection install .cache/collection-tarballs/*.tar.gz
+
+    - name: Run sanity tests
+      run: ansible-test sanity --docker --python 3.8 -v --color --truncate 0
+      working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/dcnm
+
+
   unit-tests:
     name: Run DCNM Unit Tests
     needs:
     - build
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ansible: [2.9.12, 2.10.0]
+        ansible: [2.9.27, 2.10.17, 2.11.12, 2.12.7]
     steps:
-    - name: Set up Python 3.7
+    - name: Set up Python 3.8
       uses: actions/setup-python@v1
       with:
-        python-version: 3.7
+        python-version: 3.8
 
     - name: Install ansible-base (v${{ matrix.ansible }})
       run: pip install https://github.com/ansible/ansible/archive/v${{ matrix.ansible }}.tar.gz --disable-pip-version-check
@@ -77,12 +109,10 @@ jobs:
 
     - name: Run DCNM Unit tests
       run: coverage run --source=. -m pytest tests/unit/modules/dcnm/. -vvvv
-      #run: ansible-test units --docker -v --color --truncate 0 --coverage
       working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/dcnm
       env:
         PYTHONPATH: /home/runner/.ansible/collections
 
     - name: Generate coverage report
       run: coverage report
       working-directory: /home/runner/.ansible/collections/ansible_collections/cisco/dcnm
-
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,32 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## Unreleased
+## [2.1.0] - 2022-07-19
+
+### Added
+
+* The following new modules are included in this release
+    * `dcnm_resource_manager` - Module for managing dcnm resources.
+      [Reference Info](https://www.cisco.com/c/en/us/td/docs/dcn/ndfc/121x/configuration/fabric-controller/cisco-ndfc-fabric-controller-configuration-guide-121x/lan-fabrics.html#task_fsg_sn4_zqb)
+
+### Fixed
+
+* https://github.com/CiscoDevNet/ansible-dcnm/issues/151
+* https://github.com/CiscoDevNet/ansible-dcnm/issues/143
+* https://github.com/CiscoDevNet/ansible-dcnm/issues/141
+* https://github.com/CiscoDevNet/ansible-dcnm/issues/139
+* https://github.com/CiscoDevNet/ansible-dcnm/issues/137
+* https://github.com/CiscoDevNet/ansible-dcnm/issues/134
+* https://github.com/CiscoDevNet/ansible-dcnm/issues/112
+* Fixed Restapi used in version detection mechanism in module utils.
+* Fixed Restapi used in various modules to support the latest api's.
+* Fixed deploy knob behavior for vrf and network module to align with GUI functionality.
+* Fixed idempotence issue in interface module.
+* Fixed diff generation issue for network deletion with NDFC.
+
+### Deprecated
+
+* Deploy knob for individual attachments in vrf and network modules has been marked for deprecation.
 
 ## [2.0.1] - 2022-01-28
 
@@ -145,6 +170,7 @@ The Ansible Cisco Data Center Network Manager (DCNM) collection includes modules
 * cisco.dcnm.dcnm_network	 - Add and remove Networks from a DCNM managed VXLAN fabric.
 * cisco.dcnm.dcnm_interface - DCNM Ansible Module for managing interfaces.
 
+[2.1.0]: https://github.com/CiscoDevNet/ansible-dcnm/compare/2.0.1...2.1.0
 [2.0.1]: https://github.com/CiscoDevNet/ansible-dcnm/compare/2.0.0...2.0.1
 [2.0.0]: https://github.com/CiscoDevNet/ansible-dcnm/compare/1.2.4...2.0.0
 [1.2.4]: https://github.com/CiscoDevNet/ansible-dcnm/compare/1.2.3...1.2.4

diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ This collection is intended for use with the following release versions:
 <!--start requires_ansible-->
 ## Ansible version compatibility
 
-This collection has been tested against following Ansible versions: **>=2.9.10,<2.12**.
+This collection has been tested against following Ansible versions: **>=2.9.10,<2.13**.
 
 Plugins and modules within a collection may be tested with only specific Ansible versions.
 A collection may contain metadata that identifies these versions.
@@ -36,6 +36,7 @@ Name | Description
 [cisco.dcnm.dcnm_inventory](https://github.com/CiscoDevNet/ansible-dcnm/blob/main/docs/cisco.dcnm.dcnm_inventory_module.rst)|Add and remove Switches from a DCNM managed VXLAN fabric.
 [cisco.dcnm.dcnm_network](https://github.com/CiscoDevNet/ansible-dcnm/blob/main/docs/cisco.dcnm.dcnm_network_module.rst)|Add and remove Networks from a DCNM managed VXLAN fabric.
 [cisco.dcnm.dcnm_policy](https://github.com/CiscoDevNet/ansible-dcnm/blob/main/docs/cisco.dcnm.dcnm_policy_module.rst)|DCNM Ansible Module for managing policies.
+[cisco.dcnm.dcnm_resource_manager](https://github.com/CiscoDevNet/ansible-dcnm/blob/main/docs/cisco.dcnm.dcnm_resource_manager_module.rst)|DCNM ansible module for managing resources.
 [cisco.dcnm.dcnm_rest](https://github.com/CiscoDevNet/ansible-dcnm/blob/main/docs/cisco.dcnm.dcnm_rest_module.rst)|Send REST API requests to DCNM controller.
 [cisco.dcnm.dcnm_service_node](https://github.com/CiscoDevNet/ansible-dcnm/blob/main/docs/cisco.dcnm.dcnm_service_node_module.rst)|Create/Modify/Delete service node based on type and attached interfaces from a DCNM managed VXLAN fabric.
 [cisco.dcnm.dcnm_service_policy](https://github.com/CiscoDevNet/ansible-dcnm/blob/main/docs/cisco.dcnm.dcnm_service_policy_module.rst)|DCNM ansible module for managing service policies.

diff --git a/docs/cisco.dcnm.dcnm_interface_module.rst b/docs/cisco.dcnm.dcnm_interface_module.rst
@@ -293,8 +293,8 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>Min:1</li>
-                                    <li>Max:31</li>
+                                    <li>Min 1</li>
+                                    <li>Max 31</li>
                         </ul>
                         <b>Default:</b><br/><div style="color: blue">8</div>
                 </td>
@@ -333,8 +333,8 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>Min:1</li>
-                                    <li>Max:31</li>
+                                    <li>Min 1</li>
+                                    <li>Max 31</li>
                         </ul>
                         <b>Default:</b><br/><div style="color: blue">8</div>
                 </td>
@@ -379,13 +379,11 @@ Parameters
                     </div>
                 </td>
                 <td>
-                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>default</li>
-                                    <li><div style="color: blue"><b>jumbo</b>&nbsp;&larr;</div></li>
-                        </ul>
                 </td>
                 <td>
-                        <div>Interface MTU</div>
+                        <div>Interface MTU.</div>
+                        <div>Can be specified either &quot;default&quot; or &quot;jumbo&quot; for access and trunk interface types. If not specified, it defaults to &quot;jumbo&quot;</div>
+                        <div>Can be specified with any value within 576 and 9216 for routed interface types. If not specified, it defaults to 9216</div>
                 </td>
             </tr>
             <tr>
@@ -763,8 +761,8 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>Min:1</li>
-                                    <li>Max:31</li>
+                                    <li>Min 1</li>
+                                    <li>Max 31</li>
                         </ul>
                         <b>Default:</b><br/><div style="color: blue">8</div>
                 </td>
@@ -957,8 +955,8 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>Min:8</li>
-                                    <li>Max:31</li>
+                                    <li>Min 8</li>
+                                    <li>Max 31</li>
                         </ul>
                         <b>Default:</b><br/><div style="color: blue">8</div>
                 </td>
@@ -997,8 +995,8 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>Min:1</li>
-                                    <li>Max:31</li>
+                                    <li>Min 1</li>
+                                    <li>Max 31</li>
                         </ul>
                         <b>Default:</b><br/><div style="color: blue">8</div>
                 </td>
@@ -1040,8 +1038,8 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>{&#39;Min&#39;: 576}</li>
-                                    <li>{&#39;Max&#39;: 9216}</li>
+                                    <li>Min 576</li>
+                                    <li>Max 9216</li>
                         </ul>
                         <b>Default:</b><br/><div style="color: blue">9216</div>
                 </td>
@@ -1062,8 +1060,8 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>{&#39;Min&#39;: 2}</li>
-                                    <li>{&#39;Max&#39;: 3967}</li>
+                                    <li>Min 2</li>
+                                    <li>Max 3967</li>
                         </ul>
                         <b>Default:</b><br/><div style="color: blue">0</div>
                 </td>
@@ -1306,8 +1304,8 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>Min:1</li>
-                                    <li>Max:4096</li>
+                                    <li>Min 1</li>
+                                    <li>Max 4096</li>
                         </ul>
                         <b>Default:</b><br/><div style="color: blue">"Default value is the vPC port identifier"</div>
                 </td>
@@ -1423,8 +1421,8 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>Min:1</li>
-                                    <li>Max:4096</li>
+                                    <li>Min 1</li>
+                                    <li>Max 4096</li>
                         </ul>
                         <b>Default:</b><br/><div style="color: blue">"Default value is the vPC port identifier"</div>
                 </td>

diff --git a/docs/cisco.dcnm.dcnm_network_module.rst b/docs/cisco.dcnm.dcnm_network_module.rst
@@ -107,6 +107,7 @@ Parameters
                 </td>
                 <td>
                         <div>Per switch knob to control whether to deploy the attachment</div>
+                        <div>This knob has been deprecated from Ansible NDFC Collection Version 2.1.0 onwards. There will not be any functional impact if specified in playbook.</div>
                 </td>
             </tr>
             <tr>
@@ -164,6 +165,10 @@ Parameters
                 </td>
                 <td>
                         <div>Global knob to control whether to deploy the attachment</div>
+                        <div>Ansible NDFC Collection Behavior for Version 2.0.1 and earlier</div>
+                        <div>This knob will create and deploy the attachment in DCNM only when set to &quot;True&quot; in playbook</div>
+                        <div>Ansible NDFC Collection Behavior for Version 2.1.0 and later</div>
+                        <div>Attachments specified in the playbook will always be created in DCNM. This knob, when set to &quot;True&quot;,  will deploy the attachment in DCNM, by pushing the configs to switch. If set to &quot;False&quot;, the attachments will be created in DCNM, but will not be deployed</div>
                 </td>
             </tr>
             <tr>
@@ -180,6 +185,7 @@ Parameters
                 </td>
                 <td>
                         <div>Loopback ID for DHCP Relay interface</div>
+                        <div>Configured ID value should be in range 0-1023</div>
                 </td>
             </tr>
             <tr>
@@ -532,7 +538,7 @@ Parameters
 Examples
 --------
 
-.. code-block:: yaml+jinja
+.. code-block:: yaml
 
     # This module supports the following states:
     #