From d06522c13871a3dd0286da5dbe05eae91271acf2 Mon Sep 17 00:00:00 2001 From: Kerry Meyer Date: Fri, 2 Sep 2022 17:01:42 -0700 Subject: [PATCH] Release notes 2.0.0 (#108) * Provide release note documentation and changelog fragments for the 2.0.0 release of the Dell Enterprise SONiC Ansible collection. * Correct the "version_added" field for the sonic_prefix_lists module. (Change the specified version from 1.2.0 to 2.0.0.) * Delete blank lines at the bottom of fragment files to fix sanity warnings. --- changelogs/.plugin-cache.yaml | 170 ++++++++++++++++ changelogs/CHANGELOG.rst | 133 ++++++++++--- .../100-prefix_lists-resource-module.yaml | 2 + .../2.0.0/101-bgp-prefix_lists.yaml | 3 + .../2.0.0/102-playbook-example-updates.yaml | 3 + ...d-interface-naming-and-other-bugfixes.yaml | 3 + .../2.0.0/105-vxlan-regression-test-fix.yaml | 2 + changelogs/archive_fragments/2.0.0/2.0.0.yaml | 2 + .../2.0.0/53-oc-yang-compliance.yaml | 2 + .../2.0.0/58-vxlan-primary-ip.yaml | 2 + .../2.0.0/60-bgp-regression-test_fixes.yaml | 4 + .../2.0.0/62-bgp-vxlan-primary-ip.yaml | 2 + .../2.0.0/63-bgp_af-route_advertise_list.yaml | 2 + ...ors-auth_pwd-and-neighbor_description.yaml | 2 + .../72-bgp_neighbors-add-attributes.yaml | 5 + .../76-CLI-command-prompt-answer-fix.yaml | 2 + .../2.0.0/78-aaa-regression-fix.yaml | 2 + .../81-add-bgp-peer-group-attributes.yaml | 5 + .../2.0.0/82-static_routes.yaml | 2 + .../2.0.0/85-regression-test-fixes.yaml | 2 + ...rt_breakout-and-execution-environment.yaml | 5 + .../2.0.0/90-aaa-and-users-bugfix.yaml | 6 + .../2.0.0/98-vlans-description.yaml | 2 + .../2.0.0/99-ntp-resource-module.yaml | 2 + changelogs/changelog.yaml | 188 ++++++++++++++---- changelogs/config.yaml | 6 +- galaxy.yml | 5 +- plugins/modules/sonic_prefix_lists.py | 2 +- 28 files changed, 488 insertions(+), 78 deletions(-) create mode 100644 changelogs/.plugin-cache.yaml create mode 100644 changelogs/archive_fragments/2.0.0/100-prefix_lists-resource-module.yaml create mode 100644 changelogs/archive_fragments/2.0.0/101-bgp-prefix_lists.yaml create mode 100644 changelogs/archive_fragments/2.0.0/102-playbook-example-updates.yaml create mode 100644 changelogs/archive_fragments/2.0.0/103-standard-interface-naming-and-other-bugfixes.yaml create mode 100644 changelogs/archive_fragments/2.0.0/105-vxlan-regression-test-fix.yaml create mode 100644 changelogs/archive_fragments/2.0.0/2.0.0.yaml create mode 100644 changelogs/archive_fragments/2.0.0/53-oc-yang-compliance.yaml create mode 100644 changelogs/archive_fragments/2.0.0/58-vxlan-primary-ip.yaml create mode 100644 changelogs/archive_fragments/2.0.0/60-bgp-regression-test_fixes.yaml create mode 100644 changelogs/archive_fragments/2.0.0/62-bgp-vxlan-primary-ip.yaml create mode 100644 changelogs/archive_fragments/2.0.0/63-bgp_af-route_advertise_list.yaml create mode 100644 changelogs/archive_fragments/2.0.0/67-bgp_neighbors-auth_pwd-and-neighbor_description.yaml create mode 100644 changelogs/archive_fragments/2.0.0/72-bgp_neighbors-add-attributes.yaml create mode 100644 changelogs/archive_fragments/2.0.0/76-CLI-command-prompt-answer-fix.yaml create mode 100644 changelogs/archive_fragments/2.0.0/78-aaa-regression-fix.yaml create mode 100644 changelogs/archive_fragments/2.0.0/81-add-bgp-peer-group-attributes.yaml create mode 100644 changelogs/archive_fragments/2.0.0/82-static_routes.yaml create mode 100644 changelogs/archive_fragments/2.0.0/85-regression-test-fixes.yaml create mode 100644 changelogs/archive_fragments/2.0.0/88-port_breakout-and-execution-environment.yaml create mode 100644 changelogs/archive_fragments/2.0.0/90-aaa-and-users-bugfix.yaml create mode 100644 changelogs/archive_fragments/2.0.0/98-vlans-description.yaml create mode 100644 changelogs/archive_fragments/2.0.0/99-ntp-resource-module.yaml diff --git a/changelogs/.plugin-cache.yaml b/changelogs/.plugin-cache.yaml new file mode 100644 index 000000000..9d3d51d00 --- /dev/null +++ b/changelogs/.plugin-cache.yaml @@ -0,0 +1,170 @@ +objects: + role: {} +plugins: + become: {} + cache: {} + callback: {} + cliconf: + sonic: + description: Use sonic cliconf to run command on Dell OS10 platform + name: sonic + version_added: null + connection: {} + httpapi: + sonic: + description: HttpApi Plugin for devices supporting Restconf SONIC API + name: sonic + version_added: 1.0.0 + inventory: {} + lookup: {} + module: + sonic_aaa: + description: Manage AAA and its parameters + name: sonic_aaa + namespace: '' + version_added: 1.1.0 + sonic_api: + description: Manages REST operations on devices running Enterprise SONiC + name: sonic_api + namespace: '' + version_added: 1.0.0 + sonic_bgp: + description: Manage global BGP and its parameters + name: sonic_bgp + namespace: '' + version_added: 1.0.0 + sonic_bgp_af: + description: Manage global BGP address-family and its parameters + name: sonic_bgp_af + namespace: '' + version_added: 1.0.0 + sonic_bgp_as_paths: + description: Manage BGP autonomous system path (or as-path-list) and its parameters + name: sonic_bgp_as_paths + namespace: '' + version_added: 1.0.0 + sonic_bgp_communities: + description: Manage BGP community and its parameters + name: sonic_bgp_communities + namespace: '' + version_added: 1.0.0 + sonic_bgp_ext_communities: + description: Manage BGP extended community-list and its parameters + name: sonic_bgp_ext_communities + namespace: '' + version_added: 1.0.0 + sonic_bgp_neighbors: + description: Manage a BGP neighbor and its parameters + name: sonic_bgp_neighbors + namespace: '' + version_added: 1.0.0 + sonic_bgp_neighbors_af: + description: Manage the BGP neighbor address-family and its parameters + name: sonic_bgp_neighbors_af + namespace: '' + version_added: 1.0.0 + sonic_command: + description: Runs commands on devices running Enterprise SONiC + name: sonic_command + namespace: '' + version_added: 1.0.0 + sonic_config: + description: Manages configuration sections on devices running Enterprise SONiC + name: sonic_config + namespace: '' + version_added: 1.0.0 + sonic_facts: + description: Collects facts on devices running Enterprise SONiC + name: sonic_facts + namespace: '' + version_added: 1.0.0 + sonic_interfaces: + description: Configure Interface attributes on interfaces such as, Eth, LAG, + VLAN, and loopback. (create a loopback interface if it does not exist.) + name: sonic_interfaces + namespace: '' + version_added: 1.0.0 + sonic_l2_interfaces: + description: Configure interface-to-VLAN association that is based on access + or trunk mode + name: sonic_l2_interfaces + namespace: '' + version_added: 1.0.0 + sonic_l3_interfaces: + description: Configure the IPv4 and IPv6 parameters on Interfaces such as, Eth, + LAG, VLAN, and loopback + name: sonic_l3_interfaces + namespace: '' + version_added: 1.0.0 + sonic_lag_interfaces: + description: Manage link aggregation group (LAG) interface parameters + name: sonic_lag_interfaces + namespace: '' + version_added: 1.0.0 + sonic_mclag: + description: Manage multi chassis link aggregation groups domain (MCLAG) and + its parameters + name: sonic_mclag + namespace: '' + version_added: 1.0.0 + sonic_ntp: + description: Manage NTP configuration on SONiC. + name: sonic_ntp + namespace: '' + version_added: 2.0.0 + sonic_port_breakout: + description: Configure port breakout settings on physical interfaces + name: sonic_port_breakout + namespace: '' + version_added: 1.0.0 + sonic_prefix_lists: + description: prefix list configuration handling for SONiC + name: sonic_prefix_lists + namespace: '' + version_added: 2.0.0 + sonic_radius_server: + description: Manage RADIUS server and its parameters + name: sonic_radius_server + namespace: '' + version_added: 1.0.0 + sonic_static_routes: + description: Manage static routes configuration on SONiC + name: sonic_static_routes + namespace: '' + version_added: 2.0.0 + sonic_system: + description: Configure system parameters + name: sonic_system + namespace: '' + version_added: 1.0.0 + sonic_tacacs_server: + description: Manage TACACS server and its parameters + name: sonic_tacacs_server + namespace: '' + version_added: 1.1.0 + sonic_users: + description: Manage users and its parameters + name: sonic_users + namespace: '' + version_added: 1.1.0 + sonic_vlans: + description: Manage VLAN and its parameters + name: sonic_vlans + namespace: '' + version_added: 1.0.0 + sonic_vrfs: + description: Manage VRFs and associate VRFs to interfaces such as, Eth, LAG, + VLAN, and loopback + name: sonic_vrfs + namespace: '' + version_added: 1.0.0 + sonic_vxlans: + description: Manage VxLAN EVPN and its parameters + name: sonic_vxlans + namespace: '' + version_added: 1.0.0 + netconf: {} + shell: {} + strategy: {} + vars: {} +version: 2.0.0 diff --git a/changelogs/CHANGELOG.rst b/changelogs/CHANGELOG.rst index 06452c900..c9a571cd8 100644 --- a/changelogs/CHANGELOG.rst +++ b/changelogs/CHANGELOG.rst @@ -1,50 +1,119 @@ -================================================================================= -Ansible Network Collection for Enterprise SONiC Distribution by Dell Technologies -================================================================================= +====================================== +Dellemc.Enterprise_Sonic Release Notes +====================================== .. contents:: Topics + +v2.0.0 +====== + +Release Summary +--------------- + +This release provides Dell SONiC Enterprise Ansible Collection support for SONiC 4.x images. It is the first release for the 2.x branch of the collection. Subsequent enhancements for support of SONiC 4.x images will also be provided as needed on the 2.x branch. This release also contains bugfixes and enhancements to supplement the Ansible functionality provided previously for SONiC 3.x images. The changelog describes changes made to the modules and plugins included in this collection since release 1.1.0. + + +Major Changes +------------- + +- Added 'static_routes' module to collection (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/82). +- Added a resource module for NTP support (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/99). +- Added a resource module for support of prefix lists (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/100). +- Updated backend REST API request formats in all applicable modules for compatibility with SONiC 4.x openconfig YANG compliant REST APIs. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/53) + +Minor Changes +------------- + +- Added an execution-environment.yml file to the "meta" directory to enable use of Ansible execution environment infrastructure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/88). +- bgp_af - Added support for BGP options to configure usage and advertisement of vxlan primary IP address related attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/62). +- bgp_as_paths - updated module examples with 'permit' attribute (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/102) +- bgp_neighbors - Add BGP peer group support for multiple attributes. The added attributes correspond to the same set of attributes added for BGP neighbors with PR 72 (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/81). +- bgp_neighbors - Add support for multiple attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/72). +- bgp_neighbors - add an auth_pwd dictionary and nbr_description attribute to the argspec (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/67). +- bgp_neighbors - added prefix-list related peer-group attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/101). +- bgp_neighbors_af - added prefix-list related neighbor attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/101). +- playbook - updated examples to reflect module changes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/102) +- sonic_vxlans - Add configuration capability for the primary IP address of a vxlan vtep to facilitate vxlan path redundundancy (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/58). +- vlans - Added support for the vlan "description" attribute (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/98). +- workflow - Added stable-2.13 to the sanity test matrix (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/90). + +Breaking Changes / Porting Guide +-------------------------------- + +- bgp_af - Add the route_advertise_list dictionary to the argspec to replace the deleted, obsolete advertise_prefix attribute used for SONiC 3.x images on the 1.x branch of this collection. This change corresponds to a SONiC 4.0 OC YANG REST compliance change for the BGP AF REST API. It enables specification of a route map in conjunction with each route advertisement prefix (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/63). +- bgp_af - remove the obsolete 'advertise_prefix' attribute from argspec and config code. This and subsequent co-req replacement with the new route advertise list argument structure require corresponding changes in playbooks previoulsly used for configuring route advertise prefixes for SONiC 3.x images. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/60) +- bgp_neighbors - Replace the previously defined standalone "bfd" attribute with a bfd dictionary containing multiple attributes. This change corresponds to the revised SONiC 4.x implementation of OC YANG compatible REST APIs. Playbooks previously using the bfd attributes for SONiC 3.x images must be modified for useon SONiC 4.0 images to use the new definition for the bfd attribute argspec structure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/72). +- bgp_neighbors - Replace, for BGP peer groups, the previously defined standalone "bfd" attribute with a bfd dictionary containing multiple attributes. This change corresponds to the revised SONiC 4.x implementation of OC YANG compatible REST APIs. Playbooks previously using the bfd attributes for SONiC 3.x images must be modified for useon SONiC 4.0 images to use the new definition for the bfd attribute argspec structure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/81). + +Bugfixes +-------- + +- Fixed regression test bugs in multiple modules (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/103). +- Fixed regression test sequencing and other regression test bugs in multiple modules (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/85). +- aaa - Fixed a bug in facts gathering by providing required conditional branching (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/90) +- aaa - Modify regression test sequencing to enable correct testing of the functionality for this module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/78). +- bgp_neighbors - remove string conversion of timer attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/60) +- port_breakout - Fixed a bug in formulation of port breakout REST APIs (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/88). +- sonic - Fix a bug in handling of interface names in standard interface naming mode (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/103). +- sonic_command - Fix bugs in handling of CLI commands involving a prompt and answer sequence (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/76/files). +- users - Fixed a bug in facts gathering (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/90). +- vxlan - update Vxlan test cases to comply with SONiC behavior (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/105). + +New Modules +----------- + +- dellemc.enterprise_sonic.sonic_ntp - Manage NTP configuration on SONiC. +- dellemc.enterprise_sonic.sonic_prefix_lists - prefix list configuration handling for SONiC +- dellemc.enterprise_sonic.sonic_static_routes - Manage static routes configuration on SONiC + +v1.1.0 +====== + +New Modules +----------- + +- dellemc.enterprise_sonic.sonic_aaa - AAA resource module. +- dellemc.enterprise_sonic.sonic_radius_server - RADIUS resource module. +- dellemc.enterprise_sonic.sonic_system - SYSTEM resource module. +- dellemc.enterprise_sonic.sonic_tacacs_server - TACACS Server resource module. + v1.0.0 ====== New Plugins ----------- -CLICONF +Cliconf ~~~~~~~ -- sonic - Use Ansible CLICONF to run commands on Enterprise SONiC. +- dellemc.enterprise_sonic.sonic - Use Ansible CLICONF to run commands on Enterprise SONiC. -HTTPAPI +Httpapi ~~~~~~~ -- sonic - Use Ansible HTTPAPI to run commands on Enterprise SONiC. - +- dellemc.enterprise_sonic.sonic - Use Ansible HTTPAPI to run commands on Enterprise SONiC. New Modules ----------- -- sonic_command - Run commands through Management Framework CLI. -- sonic_config - Manage configuration through the Management Framework CLI. -- sonic_api - Perform REST operations through the Management Framework REST API. - -New Resource modules --------------------- - -- sonic_interfaces - Interface resource module -- sonic_l2_interfaces - Layer 2 interface resource module -- sonic_l3_interfaces - Layer 3 interface resource module -- sonic_lag_interfaces - Link aggregation (LAG) resource module -- sonic_vlans - VLAN resource module -- sonic_bgp - BGP configuration -- sonic_bgp_af - BGP AF configuration -- sonic_bgp_neighbors - BGP neighbors configuration -- sonic_bgp_neighbors_af - BGP neighbors AF configuration -- sonic_bgp_as_paths - BGP AS path configuration -- sonic_bgp_communities - BGP communities configuration -- sonic_bgp_ext_communities - BGP Ext communities configuration -- sonic_mclag - MLAG configuration -- sonic_vrfs - VRF configuration -- sonic_vxlan - VxLAN EVPN configuration - -(c) 2020 Dell Inc. or its subsidiaries. All Rights Reserved. \ No newline at end of file +- dellemc.enterprise_sonic.sonic_api - Perform REST operations through the Management Framework REST API. +- dellemc.enterprise_sonic.sonic_bgp - BGP resource module. +- dellemc.enterprise_sonic.sonic_bgp_af - BGP AF resource module. +- dellemc.enterprise_sonic.sonic_bgp_as_paths - BGP AS path resource module. +- dellemc.enterprise_sonic.sonic_bgp_communities - BGP communities resource module. +- dellemc.enterprise_sonic.sonic_bgp_ext_communities - BGP Ext communities resource module. +- dellemc.enterprise_sonic.sonic_bgp_neighbors - BGP neighbors resource module. +- dellemc.enterprise_sonic.sonic_bgp_neighbors_af - BGP neighbors AF resource module. +- dellemc.enterprise_sonic.sonic_command - Run commands through Management Framework CLI. +- dellemc.enterprise_sonic.sonic_config - Manage configuration through the Management Framework CLI. +- dellemc.enterprise_sonic.sonic_interfaces - Interface resource module. +- dellemc.enterprise_sonic.sonic_l2_interfaces - Layer 2 interface resource module. +- dellemc.enterprise_sonic.sonic_l3_interfaces - Layer 3 interface resource module. +- dellemc.enterprise_sonic.sonic_lag_interfaces - Link aggregation (LAG) resource module. +- dellemc.enterprise_sonic.sonic_mclag - MCLAG resource module. +- dellemc.enterprise_sonic.sonic_port_breakout - port breakout resource module. +- dellemc.enterprise_sonic.sonic_users - USERS resource module. +- dellemc.enterprise_sonic.sonic_vlans - VLAN resource module. +- dellemc.enterprise_sonic.sonic_vrfs - VRF resource module. +- dellemc.enterprise_sonic.sonic_vxlans - VxLAN EVPN resource module. diff --git a/changelogs/archive_fragments/2.0.0/100-prefix_lists-resource-module.yaml b/changelogs/archive_fragments/2.0.0/100-prefix_lists-resource-module.yaml new file mode 100644 index 000000000..25321ab1e --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/100-prefix_lists-resource-module.yaml @@ -0,0 +1,2 @@ +major_changes: + - Added a resource module for support of prefix lists (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/100). diff --git a/changelogs/archive_fragments/2.0.0/101-bgp-prefix_lists.yaml b/changelogs/archive_fragments/2.0.0/101-bgp-prefix_lists.yaml new file mode 100644 index 000000000..7a37ef89a --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/101-bgp-prefix_lists.yaml @@ -0,0 +1,3 @@ +minor_changes: + - bgp_neighbors - added prefix-list related peer-group attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/101). + - bgp_neighbors_af - added prefix-list related neighbor attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/101). diff --git a/changelogs/archive_fragments/2.0.0/102-playbook-example-updates.yaml b/changelogs/archive_fragments/2.0.0/102-playbook-example-updates.yaml new file mode 100644 index 000000000..a82f06e0c --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/102-playbook-example-updates.yaml @@ -0,0 +1,3 @@ +minor_changes: + - bgp_as_paths - updated module examples with 'permit' attribute (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/102) + - playbook - updated examples to reflect module changes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/102) diff --git a/changelogs/archive_fragments/2.0.0/103-standard-interface-naming-and-other-bugfixes.yaml b/changelogs/archive_fragments/2.0.0/103-standard-interface-naming-and-other-bugfixes.yaml new file mode 100644 index 000000000..ef97e26b7 --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/103-standard-interface-naming-and-other-bugfixes.yaml @@ -0,0 +1,3 @@ +bugfixes: + - sonic - Fix a bug in handling of interface names in standard interface naming mode (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/103). + - Fixed regression test bugs in multiple modules (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/103). diff --git a/changelogs/archive_fragments/2.0.0/105-vxlan-regression-test-fix.yaml b/changelogs/archive_fragments/2.0.0/105-vxlan-regression-test-fix.yaml new file mode 100644 index 000000000..480f11aad --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/105-vxlan-regression-test-fix.yaml @@ -0,0 +1,2 @@ +bugfixes: + - vxlan - update Vxlan test cases to comply with SONiC behavior (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/105). diff --git a/changelogs/archive_fragments/2.0.0/2.0.0.yaml b/changelogs/archive_fragments/2.0.0/2.0.0.yaml new file mode 100644 index 000000000..c73fafa57 --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/2.0.0.yaml @@ -0,0 +1,2 @@ +release_summary: | + This release provides Dell SONiC Enterprise Ansible Collection support for SONiC 4.x images. It is the first release for the 2.x branch of the collection. Subsequent enhancements for support of SONiC 4.x images will also be provided as needed on the 2.x branch. This release also contains bugfixes and enhancements to supplement the Ansible functionality provided previously for SONiC 3.x images. The changelog describes changes made to the modules and plugins included in this collection since release 1.1.0. diff --git a/changelogs/archive_fragments/2.0.0/53-oc-yang-compliance.yaml b/changelogs/archive_fragments/2.0.0/53-oc-yang-compliance.yaml new file mode 100644 index 000000000..fba15e6bc --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/53-oc-yang-compliance.yaml @@ -0,0 +1,2 @@ +major_changes: +- Updated backend REST API request formats in all applicable modules for compatibility with SONiC 4.x openconfig YANG compliant REST APIs. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/53) diff --git a/changelogs/archive_fragments/2.0.0/58-vxlan-primary-ip.yaml b/changelogs/archive_fragments/2.0.0/58-vxlan-primary-ip.yaml new file mode 100644 index 000000000..e7bf9858e --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/58-vxlan-primary-ip.yaml @@ -0,0 +1,2 @@ +minor_changes: + - sonic_vxlans - Add configuration capability for the primary IP address of a vxlan vtep to facilitate vxlan path redundundancy (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/58). diff --git a/changelogs/archive_fragments/2.0.0/60-bgp-regression-test_fixes.yaml b/changelogs/archive_fragments/2.0.0/60-bgp-regression-test_fixes.yaml new file mode 100644 index 000000000..444826028 --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/60-bgp-regression-test_fixes.yaml @@ -0,0 +1,4 @@ +bugfixes: + - bgp_neighbors - remove string conversion of timer attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/60) +breaking_changes: + - bgp_af - remove the obsolete 'advertise_prefix' attribute from argspec and config code. This and subsequent co-req replacement with the new route advertise list argument structure require corresponding changes in playbooks previoulsly used for configuring route advertise prefixes for SONiC 3.x images. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/60) diff --git a/changelogs/archive_fragments/2.0.0/62-bgp-vxlan-primary-ip.yaml b/changelogs/archive_fragments/2.0.0/62-bgp-vxlan-primary-ip.yaml new file mode 100644 index 000000000..2d8b6ab9e --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/62-bgp-vxlan-primary-ip.yaml @@ -0,0 +1,2 @@ +minor_changes: +- bgp_af - Added support for BGP options to configure usage and advertisement of vxlan primary IP address related attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/62). diff --git a/changelogs/archive_fragments/2.0.0/63-bgp_af-route_advertise_list.yaml b/changelogs/archive_fragments/2.0.0/63-bgp_af-route_advertise_list.yaml new file mode 100644 index 000000000..ea75c732d --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/63-bgp_af-route_advertise_list.yaml @@ -0,0 +1,2 @@ +breaking_changes: + - bgp_af - Add the route_advertise_list dictionary to the argspec to replace the deleted, obsolete advertise_prefix attribute used for SONiC 3.x images on the 1.x branch of this collection. This change corresponds to a SONiC 4.0 OC YANG REST compliance change for the BGP AF REST API. It enables specification of a route map in conjunction with each route advertisement prefix (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/63). diff --git a/changelogs/archive_fragments/2.0.0/67-bgp_neighbors-auth_pwd-and-neighbor_description.yaml b/changelogs/archive_fragments/2.0.0/67-bgp_neighbors-auth_pwd-and-neighbor_description.yaml new file mode 100644 index 000000000..95e82941d --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/67-bgp_neighbors-auth_pwd-and-neighbor_description.yaml @@ -0,0 +1,2 @@ +minor_changes: + - bgp_neighbors - add an auth_pwd dictionary and nbr_description attribute to the argspec (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/67). diff --git a/changelogs/archive_fragments/2.0.0/72-bgp_neighbors-add-attributes.yaml b/changelogs/archive_fragments/2.0.0/72-bgp_neighbors-add-attributes.yaml new file mode 100644 index 000000000..c92d315b5 --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/72-bgp_neighbors-add-attributes.yaml @@ -0,0 +1,5 @@ +minor_changes: + - bgp_neighbors - Add support for multiple attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/72). + +breaking_changes: + - bgp_neighbors - Replace the previously defined standalone "bfd" attribute with a bfd dictionary containing multiple attributes. This change corresponds to the revised SONiC 4.x implementation of OC YANG compatible REST APIs. Playbooks previously using the bfd attributes for SONiC 3.x images must be modified for useon SONiC 4.0 images to use the new definition for the bfd attribute argspec structure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/72). diff --git a/changelogs/archive_fragments/2.0.0/76-CLI-command-prompt-answer-fix.yaml b/changelogs/archive_fragments/2.0.0/76-CLI-command-prompt-answer-fix.yaml new file mode 100644 index 000000000..762759e0c --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/76-CLI-command-prompt-answer-fix.yaml @@ -0,0 +1,2 @@ +bugfixes: + - sonic_command - Fix bugs in handling of CLI commands involving a prompt and answer sequence (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/76/files). diff --git a/changelogs/archive_fragments/2.0.0/78-aaa-regression-fix.yaml b/changelogs/archive_fragments/2.0.0/78-aaa-regression-fix.yaml new file mode 100644 index 000000000..941e9625f --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/78-aaa-regression-fix.yaml @@ -0,0 +1,2 @@ +bugfixes: + - aaa - Modify regression test sequencing to enable correct testing of the functionality for this module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/78). diff --git a/changelogs/archive_fragments/2.0.0/81-add-bgp-peer-group-attributes.yaml b/changelogs/archive_fragments/2.0.0/81-add-bgp-peer-group-attributes.yaml new file mode 100644 index 000000000..f47ebe53f --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/81-add-bgp-peer-group-attributes.yaml @@ -0,0 +1,5 @@ +minor_changes: + - bgp_neighbors - Add BGP peer group support for multiple attributes. The added attributes correspond to the same set of attributes added for BGP neighbors with PR 72 (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/81). + +breaking_changes: + - bgp_neighbors - Replace, for BGP peer groups, the previously defined standalone "bfd" attribute with a bfd dictionary containing multiple attributes. This change corresponds to the revised SONiC 4.x implementation of OC YANG compatible REST APIs. Playbooks previously using the bfd attributes for SONiC 3.x images must be modified for useon SONiC 4.0 images to use the new definition for the bfd attribute argspec structure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/81). diff --git a/changelogs/archive_fragments/2.0.0/82-static_routes.yaml b/changelogs/archive_fragments/2.0.0/82-static_routes.yaml new file mode 100644 index 000000000..2b9ccf882 --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/82-static_routes.yaml @@ -0,0 +1,2 @@ +major_changes: + - Added 'static_routes' module to collection (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/82). diff --git a/changelogs/archive_fragments/2.0.0/85-regression-test-fixes.yaml b/changelogs/archive_fragments/2.0.0/85-regression-test-fixes.yaml new file mode 100644 index 000000000..fe54f7bc4 --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/85-regression-test-fixes.yaml @@ -0,0 +1,2 @@ +bugfixes: + - Fixed regression test sequencing and other regression test bugs in multiple modules (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/85). diff --git a/changelogs/archive_fragments/2.0.0/88-port_breakout-and-execution-environment.yaml b/changelogs/archive_fragments/2.0.0/88-port_breakout-and-execution-environment.yaml new file mode 100644 index 000000000..6c5775f4d --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/88-port_breakout-and-execution-environment.yaml @@ -0,0 +1,5 @@ +bugfixes: + - port_breakout - Fixed a bug in formulation of port breakout REST APIs (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/88). + +minor_changes: + - Added an execution-environment.yml file to the "meta" directory to enable use of Ansible execution environment infrastructure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/88). diff --git a/changelogs/archive_fragments/2.0.0/90-aaa-and-users-bugfix.yaml b/changelogs/archive_fragments/2.0.0/90-aaa-and-users-bugfix.yaml new file mode 100644 index 000000000..c61d09ad2 --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/90-aaa-and-users-bugfix.yaml @@ -0,0 +1,6 @@ +bugfixes: + - aaa - Fixed a bug in facts gathering by providing required conditional branching (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/90) + - users - Fixed a bug in facts gathering (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/90). + +minor_changes: + - workflow - Added stable-2.13 to the sanity test matrix (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/90). diff --git a/changelogs/archive_fragments/2.0.0/98-vlans-description.yaml b/changelogs/archive_fragments/2.0.0/98-vlans-description.yaml new file mode 100644 index 000000000..0895b5ea4 --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/98-vlans-description.yaml @@ -0,0 +1,2 @@ +minor_changes: + - vlans - Added support for the vlan "description" attribute (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/98). diff --git a/changelogs/archive_fragments/2.0.0/99-ntp-resource-module.yaml b/changelogs/archive_fragments/2.0.0/99-ntp-resource-module.yaml new file mode 100644 index 000000000..f858bf8b8 --- /dev/null +++ b/changelogs/archive_fragments/2.0.0/99-ntp-resource-module.yaml @@ -0,0 +1,2 @@ +major_changes: + - Added a resource module for NTP support (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/99). diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 3f3053d75..0ce34f5e4 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -1,46 +1,16 @@ ancestor: null releases: 1.0.0: - release_summary: This collection includes Ansible core modules, network resource modules, - and plugins needed to provision and manage Dell EMC PowerSwitch platforms running - Enterprise SONiC Distribution by Dell Technologies modules: - - description: Run commands through Management Framework CLI. - name: sonic_command - namespace: '' - - description: Manage configuration through the Management Framework CLI. - name: sonic_config - namespace: '' - description: Perform REST operations through the Management Framework REST API. name: sonic_api namespace: '' - - description: Interface resource module. - name: sonic_interfaces - namespace: '' - - description: Layer 2 interface resource module. - name: sonic_l2_interfaces - namespace: '' - - description: Layer 3 interface resource module. - name: sonic_l3_interfaces - namespace: '' - - description: Link aggregation (LAG) resource module. - name: sonic_lag_interfaces - namespace: '' - - description: VLAN resource module. - name: sonic_vlans - namespace: '' - description: BGP resource module. name: sonic_bgp namespace: '' - description: BGP AF resource module. name: sonic_bgp_af namespace: '' - - description: BGP neighbors resource module. - name: sonic_bgp_neighbors - namespace: '' - - description: BGP neighbors AF resource module. - name: sonic_bgp_neighbors_af - namespace: '' - description: BGP AS path resource module. name: sonic_bgp_as_paths namespace: '' @@ -50,21 +20,48 @@ releases: - description: BGP Ext communities resource module. name: sonic_bgp_ext_communities namespace: '' - - description: VxLAN EVPN resource module. - name: sonic_vxlans + - description: BGP neighbors resource module. + name: sonic_bgp_neighbors + namespace: '' + - description: BGP neighbors AF resource module. + name: sonic_bgp_neighbors_af + namespace: '' + - description: Run commands through Management Framework CLI. + name: sonic_command + namespace: '' + - description: Manage configuration through the Management Framework CLI. + name: sonic_config + namespace: '' + - description: Interface resource module. + name: sonic_interfaces + namespace: '' + - description: Layer 2 interface resource module. + name: sonic_l2_interfaces + namespace: '' + - description: Layer 3 interface resource module. + name: sonic_l3_interfaces + namespace: '' + - description: Link aggregation (LAG) resource module. + name: sonic_lag_interfaces namespace: '' - description: MCLAG resource module. name: sonic_mclag namespace: '' + - description: port breakout resource module. + name: sonic_port_breakout + namespace: '' - description: USERS resource module. name: sonic_users namespace: '' - - description: port breakout resource module. - name: sonic_port_breakout + - description: VLAN resource module. + name: sonic_vlans namespace: '' - description: VRF resource module. name: sonic_vrfs namespace: '' + - description: VxLAN EVPN resource module. + name: sonic_vxlans + namespace: '' plugins: cliconf: - description: Use Ansible CLICONF to run commands on Enterprise SONiC. @@ -74,22 +71,127 @@ releases: - description: Use Ansible HTTPAPI to run commands on Enterprise SONiC. name: sonic namespace: null - release_date: '2020-12-07' + release_date: '2020-12-07' 1.1.0: - release_summary: Supports AAA, Users, System and Port breakout - resource modules modules: - - description: TACACS Server resource module. - name: sonic_tacacs_server + - description: AAA resource module. + name: sonic_aaa namespace: '' - description: RADIUS resource module. name: sonic_radius_server namespace: '' - - description: AAA resource module. - name: sonic_aaa - namespace: '' - description: SYSTEM resource module. name: sonic_system namespace: '' + - description: TACACS Server resource module. + name: sonic_tacacs_server + namespace: '' release_date: '2021-05-28' - + 2.0.0: + changes: + breaking_changes: + - bgp_af - Add the route_advertise_list dictionary to the argspec to replace + the deleted, obsolete advertise_prefix attribute used for SONiC 3.x images + on the 1.x branch of this collection. This change corresponds to a SONiC 4.0 + OC YANG REST compliance change for the BGP AF REST API. It enables specification + of a route map in conjunction with each route advertisement prefix (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/63). + - bgp_af - remove the obsolete 'advertise_prefix' attribute from argspec and + config code. This and subsequent co-req replacement with the new route advertise + list argument structure require corresponding changes in playbooks previoulsly + used for configuring route advertise prefixes for SONiC 3.x images. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/60) + - bgp_neighbors - Replace the previously defined standalone "bfd" attribute + with a bfd dictionary containing multiple attributes. This change corresponds + to the revised SONiC 4.x implementation of OC YANG compatible REST APIs. Playbooks + previously using the bfd attributes for SONiC 3.x images must be modified + for useon SONiC 4.0 images to use the new definition for the bfd attribute + argspec structure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/72). + - bgp_neighbors - Replace, for BGP peer groups, the previously defined standalone + "bfd" attribute with a bfd dictionary containing multiple attributes. This + change corresponds to the revised SONiC 4.x implementation of OC YANG compatible + REST APIs. Playbooks previously using the bfd attributes for SONiC 3.x images + must be modified for useon SONiC 4.0 images to use the new definition for + the bfd attribute argspec structure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/81). + bugfixes: + - Fixed regression test bugs in multiple modules (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/103). + - Fixed regression test sequencing and other regression test bugs in multiple + modules (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/85). + - aaa - Fixed a bug in facts gathering by providing required conditional branching + (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/90) + - aaa - Modify regression test sequencing to enable correct testing of the functionality + for this module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/78). + - bgp_neighbors - remove string conversion of timer attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/60) + - port_breakout - Fixed a bug in formulation of port breakout REST APIs (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/88). + - sonic - Fix a bug in handling of interface names in standard interface naming + mode (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/103). + - sonic_command - Fix bugs in handling of CLI commands involving a prompt and + answer sequence (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/76/files). + - users - Fixed a bug in facts gathering (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/90). + - vxlan - update Vxlan test cases to comply with SONiC behavior (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/105). + major_changes: + - Added 'static_routes' module to collection (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/82). + - Added a resource module for NTP support (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/99). + - Added a resource module for support of prefix lists (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/100). + - Updated backend REST API request formats in all applicable modules for compatibility + with SONiC 4.x openconfig YANG compliant REST APIs. (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/53) + minor_changes: + - Added an execution-environment.yml file to the "meta" directory to enable + use of Ansible execution environment infrastructure (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/88). + - bgp_af - Added support for BGP options to configure usage and advertisement + of vxlan primary IP address related attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/62). + - bgp_as_paths - updated module examples with 'permit' attribute (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/102) + - bgp_neighbors - Add BGP peer group support for multiple attributes. The added + attributes correspond to the same set of attributes added for BGP neighbors + with PR 72 (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/81). + - bgp_neighbors - Add support for multiple attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/72). + - bgp_neighbors - add an auth_pwd dictionary and nbr_description attribute to + the argspec (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/67). + - bgp_neighbors - added prefix-list related peer-group attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/101). + - bgp_neighbors_af - added prefix-list related neighbor attributes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/101). + - playbook - updated examples to reflect module changes (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/102) + - sonic_vxlans - Add configuration capability for the primary IP address of + a vxlan vtep to facilitate vxlan path redundundancy (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/58). + - vlans - Added support for the vlan "description" attribute (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/98). + - workflow - Added stable-2.13 to the sanity test matrix (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/90). + release_summary: 'This release provides Dell SONiC Enterprise Ansible Collection + support for SONiC 4.x images. It is the first release for the 2.x branch of + the collection. Subsequent enhancements for support of SONiC 4.x images will + also be provided as needed on the 2.x branch. This release also contains bugfixes + and enhancements to supplement the Ansible functionality provided previously + for SONiC 3.x images. The changelog describes changes made to the modules + and plugins included in this collection since release 1.1.0. + + ' + fragments: + - 100-prefix_lists-resource-module.yaml + - 101-bgp-prefix_lists.yaml + - 102-playbook-example-updates.yaml + - 103-standard-interface-naming-and-other-bugfixes.yaml + - 105-vxlan-regression-test-fix.yaml + - 2.0.0.yaml + - 53-oc-yang-compliance.yaml + - 58-vxlan-primary-ip.yaml + - 60-bgp-regression-test_fixes.yaml + - 62-bgp-vxlan-primary-ip.yaml + - 63-bgp_af-route_advertise_list.yaml + - 67-bgp_neighbors-auth_pwd-and-neighbor_description.yaml + - 72-bgp_neighbors-add-attributes.yaml + - 76-CLI-command-prompt-answer-fix.yaml + - 78-aaa-regression-fix.yaml + - 81-add-bgp-peer-group-attributes.yaml + - 82-static_routes.yaml + - 85-regression-test-fixes.yaml + - 88-port_breakout-and-execution-environment.yaml + - 90-aaa-and-users-bugfix.yaml + - 98-vlans-description.yaml + - 99-ntp-resource-module.yaml + modules: + - description: Manage NTP configuration on SONiC. + name: sonic_ntp + namespace: '' + - description: prefix list configuration handling for SONiC + name: sonic_prefix_lists + namespace: '' + - description: Manage static routes configuration on SONiC + name: sonic_static_routes + namespace: '' + release_date: '2022-09-02' diff --git a/changelogs/config.yaml b/changelogs/config.yaml index 0826e05a6..b857f936f 100644 --- a/changelogs/config.yaml +++ b/changelogs/config.yaml @@ -2,12 +2,15 @@ changelog_filename_template: CHANGELOG.rst changelog_filename_version_depth: 0 changes_file: changelog.yaml changes_format: combined +ignore_other_fragment_extensions: true keep_fragments: false +archive_path_template: changelogs/archive_fragments/{version} mention_ancestor: true new_plugins_after_name: removed_features notesdir: fragments prelude_section_name: release_summary prelude_section_title: Release Summary +sanitize_changelog: true sections: - - major_changes - Major Changes @@ -25,5 +28,6 @@ sections: - Bugfixes - - known_issues - Known Issues -title: Ansible Network Collection for Enterprise SONiC Distribution by Dell Technologies +title: Dellemc.Enterprise_Sonic trivial_section_name: trivial +use_fqcn: true diff --git a/galaxy.yml b/galaxy.yml index 7419bc961..dad9a3d22 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: dellemc name: enterprise_sonic -version: 1.1.0 +version: 2.0.0 readme: README.md authors: - Senthil Kumar Ganesan @@ -8,6 +8,9 @@ authors: - Dhivya - Mohamed Javeed - Nirai Madai +- Shade Talabi +- Kerry Meyer +- Mingjun Zhang description: Ansible Network Collection for Enterprise SONiC Distribution by Dell Technologies license_file: LICENSE diff --git a/plugins/modules/sonic_prefix_lists.py b/plugins/modules/sonic_prefix_lists.py index 5f788d8d2..5a734e8b2 100644 --- a/plugins/modules/sonic_prefix_lists.py +++ b/plugins/modules/sonic_prefix_lists.py @@ -32,7 +32,7 @@ DOCUMENTATION = """ --- module: sonic_prefix_lists -version_added: "1.2.0" +version_added: "2.0.0" author: Kerry Meyer (@kerry-meyer) short_description: prefix list configuration handling for SONiC description: