Skip to content

Commit 926083c

Browse files
committed
prep for release 0.4.1
1 parent f5b0db2 commit 926083c

File tree

4 files changed

+113
-7
lines changed

4 files changed

+113
-7
lines changed

CHANGELOG.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,49 @@ This project adheres to `Semantic Versioning <http://semver.org/>`_.
88

99
.. contents:: ``Release Versions``
1010

11+
12+
`0.4.1`_
13+
=====================
14+
15+
**Release Date:** ``2025-04-24``
16+
17+
Added
18+
-----
19+
20+
* Added ability to manage edge connections to external fabrics
21+
* Added support for checking if a fabric is in a multisite domain and disallow management of ``vxlan.overlay.vrfs`` and ``vxlan.overlay.networks`` under the child fabric
22+
23+
Modified
24+
--------
25+
26+
* Added various multisite fixes and introduced new ``child_fabrics`` model key under ``vxlan.multisite.overlay.vrfs`` and ``vxlan.multisite.overlay.networks`` for defining site-specific attributes
27+
28+
Fixed
29+
-----
30+
31+
* https://github.com/netascode/ansible-dc-vxlan/issues/232
32+
* https://github.com/netascode/ansible-dc-vxlan/issues/274
33+
* https://github.com/netascode/ansible-dc-vxlan/issues/292
34+
* https://github.com/netascode/ansible-dc-vxlan/issues/293
35+
* https://github.com/netascode/ansible-dc-vxlan/issues/294
36+
* https://github.com/netascode/ansible-dc-vxlan/issues/295
37+
* https://github.com/netascode/ansible-dc-vxlan/issues/296
38+
* https://github.com/netascode/ansible-dc-vxlan/issues/302
39+
* https://github.com/netascode/ansible-dc-vxlan/issues/303
40+
* https://github.com/netascode/ansible-dc-vxlan/issues/308
41+
* https://github.com/netascode/ansible-dc-vxlan/issues/311
42+
* https://github.com/netascode/ansible-dc-vxlan/issues/314
43+
* https://github.com/netascode/ansible-dc-vxlan/issues/320
44+
* https://github.com/netascode/ansible-dc-vxlan/issues/325
45+
* https://github.com/netascode/ansible-dc-vxlan/issues/327
46+
* https://github.com/netascode/ansible-dc-vxlan/issues/331
47+
* https://github.com/netascode/ansible-dc-vxlan/issues/335
48+
* https://github.com/netascode/ansible-dc-vxlan/issues/336
49+
* https://github.com/netascode/ansible-dc-vxlan/issues/340
50+
* https://github.com/netascode/ansible-dc-vxlan/issues/343
51+
* https://github.com/netascode/ansible-dc-vxlan/issues/345
52+
* https://github.com/netascode/ansible-dc-vxlan/issues/355
53+
1154
`0.4.0`_
1255
=====================
1356

@@ -161,6 +204,7 @@ The following roles have been added to the collection:
161204

162205
This version of the collection includes support for an IPv4 Underlay only. Support for IPv6 Underlay will be available in the next release.
163206

207+
.. _0.4.1: https://github.com/netascode/ansible-dc-vxlan/compare/0.4.0...0.4.1
164208
.. _0.4.0: https://github.com/netascode/ansible-dc-vxlan/compare/0.3.0...0.4.0
165209
.. _0.3.0: https://github.com/netascode/ansible-dc-vxlan/compare/0.2.0...0.3.0
166210
.. _0.2.0: https://github.com/netascode/ansible-dc-vxlan/compare/0.1.0...0.2.0

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ The following quickstart repository is available to provide a step by step guide
306306

307307
This collection is intended for use with the following release versions:
308308

309-
* `NDFC Release 12.2.1` or later.
309+
* `Cisco Nexus Dashboard Fabric Controller (NDFC) Release 12.2.1` or later.
310310

311311
<!--start requires_ansible-->
312312
## Ansible Version Compatibility
@@ -408,10 +408,10 @@ This capability is not available under the following conditions:
408408

409409
### See Also
410410

411-
* [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
411+
* [Ansible Using Collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
412412

413413
## Multi-Site Domain for VXLAN BGP EVPN Fabrics
414-
A Multi-Site Domain (MSD) is a multifabric container that is created to manage multiple member fabrics. An MSD is a single point of control for definition of overlay networks and VRFs that are shared across member fabrics. When you move fabrics (that are designated to be part of the multifabric overlay network domain) under the MSD as member fabrics, the member fabrics share the networks and VRFs created at the MSD-level. This way, you can consistently provision network and VRFs for different fabrics, at one go. It significantly reduces the time and complexity involving multiple fabric provisionings.
414+
A Multi-Site Domain (MSD) is a multifabric administrative domain that is created to manage multiple member fabrics. An MSD is a single point of control for definition of overlay VRFs and Networks that are shared across member fabrics. When you move fabrics under the MSD as child fabrics, the child fabrics share the VRFs and networks created at the MSD-level. This way, you can consistently provision VRFs and networks for different fabrics, at one go. It significantly reduces the time and complexity involving multiple fabric provisionings.
415415

416416
### To configure and manage MSD fabrics with VXLAN as Code, you should use the following workflow:
417417
1. Create each member/child fabric that will be managed by MSD using the normal data models for each fabric (or use a combined data model with all child fabrics)
@@ -432,9 +432,10 @@ We welcome community contributions to this collection. If you find problems, ple
432432

433433
## More Information
434434

435-
- [NDFC installation and configuration guides](https://www.cisco.com/c/en/us/td/docs/dcn/ndfc/1201/installation/cisco-ndfc-install-and-upgrade-guide-1201.html)
436-
- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
437-
- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
435+
- [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)
436+
- [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)
437+
- [Ansible User Guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
438+
- [Ansible Developer Guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
438439

439440
## Licensing
440441

docs/maintainers.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Maintainers Guide
2+
3+
Guidelines for the core maintainers of the VXLAN as Code Ansible Collection - above and beyond the [general developer guidelines](../CONTRIBUTING.md).
4+
5+
## Release Process Checklist
6+
7+
### Pre-Merge to `main` branch:
8+
9+
When we are considering publishing a new release, all of the following steps must be carried out (using the latest code base in `develop`):
10+
11+
1. Run full fabric profile integration regression tests against `develop`
12+
* Fix all bugs
13+
14+
1. Update [galaxy.yml](https://github.com/netascode/ansible-dc-vxlan/blob/develop/galaxy.yml) file
15+
* Update Version
16+
```diff
17+
- "version": "1.0.0",
18+
+ "version": "1.0.1",
19+
```
20+
* Update authors as required
21+
* Update dependencies as required
22+
23+
1. Update [changelog.](https://github.com/netascode/ansible-dc-vxlan/blob/develop/CHANGELOG.rst)
24+
* Make sure CHANGELOG.md accurately reflects all changes since the last release
25+
* Apply a search filter: `is:issue closed:>=2025-03-01`
26+
* Add any significant changes that weren't documented in the changelog
27+
* Clean up any entries that are overly verbose, unclear, or otherwise could be improved
28+
* Indicate new support (if any)
29+
* Create release tag
30+
```diff
31+
...
32+
+.. _0.4.1: https://github.com/netascode/ansible-dc-vxlan/compare/0.4.0...0.4.1
33+
.. _0.4.0: https://github.com/netascode/ansible-dc-vxlan/compare/0.3.0...0.4.0
34+
```
35+
36+
1. Scrub README docs
37+
* Update README docs for new support and where applicable
38+
39+
1. Pull release branch based on the `develop` branch
40+
* 0.0.x - a bugfix release
41+
* 0.x.0 - new feature(s)
42+
* x.0.0 - backward-incompatible change (if unvoidable!)
43+
44+
1. Open pull request from release branch against the `main` branch.
45+
* Ensure all GitHub Actions tasks have passed
46+
* Merge after approval
47+
48+
### Post-Merge to `main` branch:
49+
50+
1. Create annotated git tag for the release
51+
* [HowTo](https://git-scm.com/book/en/v2/Git-Basics-Tagging#Annotated-Tags)
52+
53+
1. Draft a [new release](https://github.com/netascode/ansible-dc-vxlan/releases) on GitHub
54+
55+
1. Merge `main` branch back into `develop` branch
56+
* Resolve any merge conflicts
57+
* Optional: Delete release branch (May want to keep for reference)
58+
59+
### Publish Release to Ansible Galaxy:
60+
61+
1. Publish to Ansible Galaxy

galaxy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
namespace: cisco
33
name: nac_dc_vxlan
4-
version: 0.4.0
4+
version: 0.4.1
55
readme: README.md
66
authors:
77
- Devendra Gupta <devegupt>

0 commit comments

Comments
 (0)