Merge pull request #613 from netascode/release-0.5.0

Release 0.5.0

Author: mtarking

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -119,6 +119,16 @@ body:
     validations:
       required: true
 
+  - type: textarea
+    id: data-model-yaml
+    attributes:
+      label: Data Model
+      description: Please provide pieces of your relevant data model that is encountering the issue
+      placeholder: Data Model
+      render: yaml
+    validations:
+      required: true
+
   - type: textarea
     id: step-to-reproduce
     attributes:

.github/workflows/main.yml

@@ -25,7 +25,7 @@ jobs:
     steps:
     - name: Check out code
       uses: actions/checkout@v4
-    
+
     - name: Set up Python 3.10.14
       uses: actions/setup-python@v5
       with:

CHANGELOG.rst

@@ -8,6 +8,84 @@ This project adheres to `Semantic Versioning <http://semver.org/>`_.
 
 .. contents:: ``Release Versions``
 
+`0.5.0`_
+=====================
+
+**Release Date:** ``2025-09-22``
+
+Added
+-----
+
+* Added initial support for VXLAN eBGP EVPN fabric type that includes:
+    * Fabric management
+    * Underlay & Overlay configuration using provided documentation and examples: https://netascode.cisco.com/docs/data_models/vxlan/global/global/
+    * Device discovery
+    * vPC
+    * Interfaces
+    * Overlay (VRFs and Networks)
+    * Policy
+    * **Note**: eBGP EVPN fabric type introduces and only supports global configuration under `vxlan.global.ebgp`
+* Added additional backwards compatiability support for NDFC 3.1
+* Added support for creating and managing vPC domain / vPC pair in data model for external fabric
+* Added support for L3VNI without VLAN for iBGP and eBGP EVPN fabric types
+* Added support for additional LACP attributes in data model for port-channels
+* Added support for individual per-switch credentials
+    * Support documentation can be found here: https://github.com/netascode/ansible-dc-vxlan/blob/0.5.0/docs/SWITCH_CREDENTIALS_GUIDE.md
+* Added support for breakout interfaces with pre-provision device workflows
+* Added initial support for unified Nexus Dashboard 4.1 via legacy, backwards compatiable NDFC APIs
+
+Modified
+--------
+
+* Updated iac-validate to use nac-validate in validate role
+* Updated `vxlan.global` keys to align with supported fabric types
+    * iBGP EVPN fabric type should use: `vxlan.global.ibgp`
+    * External fabric type should use: `vxlan.global.external`
+    * eBGP EVPN fabric type introduces properties `vxlan.global.ebgp` starting in this release, `0.5.0`
+    * Backwards compatiability is provided for `vxlan.global` keys for iBGP and External fabric types
+* Updated pointer to defaults used for ISN and MSD fabric types to use `defaults.vxlan.multisite` keys
+
+Fixed
+-----
+* https://github.com/netascode/ansible-dc-vxlan/issues/301
+* https://github.com/netascode/ansible-dc-vxlan/issues/315
+* https://github.com/netascode/ansible-dc-vxlan/issues/337
+* https://github.com/netascode/ansible-dc-vxlan/issues/383
+* https://github.com/netascode/ansible-dc-vxlan/issues/390
+* https://github.com/netascode/ansible-dc-vxlan/issues/407
+* https://github.com/netascode/ansible-dc-vxlan/issues/413
+* https://github.com/netascode/ansible-dc-vxlan/issues/425
+* https://github.com/netascode/ansible-dc-vxlan/issues/430
+* https://github.com/netascode/ansible-dc-vxlan/issues/435
+* https://github.com/netascode/ansible-dc-vxlan/issues/439
+* https://github.com/netascode/ansible-dc-vxlan/issues/441
+* https://github.com/netascode/ansible-dc-vxlan/issues/442
+* https://github.com/netascode/ansible-dc-vxlan/issues/443
+* https://github.com/netascode/ansible-dc-vxlan/issues/445
+* https://github.com/netascode/ansible-dc-vxlan/issues/447
+* https://github.com/netascode/ansible-dc-vxlan/issues/451
+* https://github.com/netascode/ansible-dc-vxlan/issues/457
+* https://github.com/netascode/ansible-dc-vxlan/issues/458
+* https://github.com/netascode/ansible-dc-vxlan/issues/466
+* https://github.com/netascode/ansible-dc-vxlan/issues/468
+* https://github.com/netascode/ansible-dc-vxlan/issues/472
+* https://github.com/netascode/ansible-dc-vxlan/issues/490
+* https://github.com/netascode/ansible-dc-vxlan/issues/505
+* https://github.com/netascode/ansible-dc-vxlan/issues/513
+* https://github.com/netascode/ansible-dc-vxlan/issues/528
+* https://github.com/netascode/ansible-dc-vxlan/issues/532
+* https://github.com/netascode/ansible-dc-vxlan/issues/537
+* https://github.com/netascode/ansible-dc-vxlan/issues/540
+* https://github.com/netascode/ansible-dc-vxlan/issues/545
+* https://github.com/netascode/ansible-dc-vxlan/issues/550
+* https://github.com/netascode/ansible-dc-vxlan/issues/551
+* https://github.com/netascode/ansible-dc-vxlan/issues/553
+* https://github.com/netascode/ansible-dc-vxlan/issues/555
+* https://github.com/netascode/ansible-dc-vxlan/issues/558
+* https://github.com/netascode/ansible-dc-vxlan/issues/566
+* https://github.com/netascode/ansible-dc-vxlan/issues/589
+* https://github.com/netascode/ansible-dc-vxlan/issues/595
+
 `0.4.3`_
 =====================
 
@@ -286,6 +364,7 @@ The following roles have been added to the collection:
 
 This version of the collection includes support for an IPv4 Underlay only.  Support for IPv6 Underlay will be available in the next release.
 
+.. _0.5.0: https://github.com/netascode/ansible-dc-vxlan/compare/0.4.3...0.5.0
 .. _0.4.3: https://github.com/netascode/ansible-dc-vxlan/compare/0.4.2...0.4.3
 .. _0.4.2: https://github.com/netascode/ansible-dc-vxlan/compare/0.4.1...0.4.2
 .. _0.4.1: https://github.com/netascode/ansible-dc-vxlan/compare/0.4.0...0.4.1

README.md

@@ -26,7 +26,7 @@ Role: [cisco.nac_dc_vxlan.validate](https://github.com/netascode/ansible-dc-vxla
 
 The `validate` role ensures that the data model is correct and that the data model can be processed by the subsequent roles. The validate role reads all the files in the `host_vars` directory and creates a single data model in memory for execution.
 
-As part of the VXLAN as Code service from Cisco, you will also be able to utilize the semantic validation feature to make sure that the data model matches the intended expected values. This is a powerful feature that allows you to ensure that the data model is correct before it is deployed to the network. Additonally the validate role allows creation of rules that can be used to prevent operators from making specific configurations that are not allowed in the network. These can be as simple as enforcing proper naming conventions to more complex rules for interconnectivity issues that should be avoided. These rules are coded in Python and can be constructed as part of the Services as Code offer. 
+As part of the VXLAN as Code service from Cisco, you will also be able to utilize the semantic validation feature to make sure that the data model matches the intended expected values. This is a powerful feature that allows you to ensure that the data model is correct before it is deployed to the network. Additonally the validate role allows creation of rules that can be used to prevent operators from making specific configurations that are not allowed in the network. These can be as simple as enforcing proper naming conventions to more complex rules for interconnectivity issues that should be avoided. These rules are coded in Python and can be constructed as part of the Services as Code offer.
 
 ### Create Role
 
@@ -82,7 +82,7 @@ The following control variables are available in this collection.
 
 | Variable | Description | Default Value |
 | -------- | ------- | ------- |
-| `force_run_all` | Force all roles in the collection to run | `false` | 
+| `force_run_all` | Force all roles in the collection to run | `false` |
 | `interface_delete_mode` | Remove interface state as part of the remove role | `false` |
 | `inventory_delete_mode` | Remove inventory state as part of the remove role | `false` |
 | `link_vpc_delete_mode` | Remove vpc link state as part of the remove role | `false` |
@@ -164,7 +164,7 @@ If you wish to install the galaxy collection inside the repository you are creat
 ansible-galaxy collection install -p collections/ansible_collections/ -r requirements.yaml
 ```
 
-The `ansible.cfg` file needs to be configured to point to the location of the collection. 
+The `ansible.cfg` file needs to be configured to point to the location of the collection.
 
 This is the path for all the python modules and libraries of the virtual environment that were created. If you look in that directory, you will find the collections package locations. Here is the base ansible.cfg, you will need to adjust the collections_path to your environment paths:
 
@@ -186,7 +186,7 @@ bin_ansible_callbacks = True
 
 #### Step 6 - Verify the Installation
 
-Verify that the ansible configuration file is being read and all the paths are correct inside of this virtual environment. 
+Verify that the ansible configuration file is being read and all the paths are correct inside of this virtual environment.
 
 ```bash
 ansible --version
@@ -300,18 +300,39 @@ export NDFC_SW_USERNAME=admin
 export NDFC_SW_PASSWORD=Admin_123
 ```
 
+##### Switch Credential Management
+
+This collection supports flexible credential management for network switches with three security levels:
+
+- **🔐 Ansible Vault**: Encrypted credentials for production deployments
+- **✅ Environment Variables**: Secure credential injection for CI/CD pipelines
+- **⚠️ Plain Text**: Simple credentials for lab testing only
+
+The system supports both switch-specific credentials and group-level defaults with automatic fallback. Environment variable lookups can be configured in group_vars for enhanced security and automation compatibility.
+
+**📖 Complete Guide**: [Switch Credentials Configuration](docs/SWITCH_CREDENTIALS_GUIDE.md)
+
+## Quick Start Guide
+
 The following quickstart repository is available to provide a step by step guide for using this collection.
 
 [Quick Start Guide Repo](https://github.com/netascode/ansible-dc-vxlan-example)
 
 This collection is intended for use with the following release versions:
 
-* `Cisco Nexus Dashboard Fabric Controller (NDFC) Release 12.2.1` or later.
+* `Cisco Nexus Dashboard Fabric Controller (NDFC) Release 12.2.1`
+* `Cisco Nexus Dashboard Fabric Controller (NDFC) Release 12.2.2`
+* `Cisco Nexus Dashboard Fabric Controller (NDFC) Release 12.2.3`
+* `Cisco Nexus Dashboard Release 4.1.1g` - Unified Nexus Dashboard Tech Preview
 
 <!--start requires_ansible-->
 ## Ansible Version Compatibility
 
-This collection has been tested against following Ansible versions: **>=2.14.15**.
+This collection has been tested against following Ansible Core versions: 
+* `2.14.x`
+* `2.15.x`
+* `2.16.x`
+* `2.17.x`
 
 Plugins, roles and modules within a collection may be tested with only specific Ansible versions.
 A collection may contain metadata that identifies these versions.
@@ -432,7 +453,7 @@ We welcome community contributions to this collection. If you find problems, ple
 
 ## More Information
 
-- [Cisco Nexus Dashboard and Services Deployment and Upgrade Guide](https://www.cisco.com/c/en/us/td/docs/dcn/nd/3x/deployment/cisco-nexus-dashboard-and-services-deployment-guide-321.html) 
+- [Cisco Nexus Dashboard and Services Deployment and Upgrade Guide](https://www.cisco.com/c/en/us/td/docs/dcn/nd/3x/deployment/cisco-nexus-dashboard-and-services-deployment-guide-321.html)
 - [Cisco Nexus Dashboard Fabric Controller (NDFC) User Content for LAN Configuration Guide](https://www.cisco.com/c/en/us/td/docs/dcn/ndfc/1222/collections/ndfc-user-content-1222-lan.html)
 - [Ansible User Guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
 - [Ansible Developer Guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)