Skip to content

Commit 47c1025

Browse files
authored
Release 6.0.0 (#425)
1 parent 9ebafb2 commit 47c1025

File tree

56 files changed

+303
-305
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+303
-305
lines changed

CHANGELOG.rst

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,118 @@ Vyos Collection Release Notes
44

55
.. contents:: Topics
66

7+
v6.0.0
8+
======
9+
10+
Release Summary
11+
---------------
12+
13+
This is the first significant release from the VyOS community for these modules.
14+
This release is focussed on 1.3+ of VyOS and will be the last major release to
15+
support 1.3 fully. Although efforts have been made to maintain compatibility
16+
with the existing vyos collection modules, there have breaking changes where
17+
necessary to configuration parameters. Please review all changes carefully before updating.
18+
19+
Major Changes
20+
-------------
21+
22+
- bgp modules - Added support for 1.4+ "system-as". 1.3 embedded as_number is still supported
23+
- vyos bgp modules - Many configuration attributes moved from `bgp_global` to `bgp_address_family` module (see documentation).
24+
- vyos_bgp_address_family - Aligned with version 1.3+ configuration - aggregate_address, maximum_paths, network, and redistribute moved from `bgp_global` module. These are now Address-family specific. Many neighbor attributes also moved from `vyos_bgp_global` to `vyos_bgp_address_family` module.
25+
- vyos_bgp_global - Aligned with version 1.3+ configuration - aggregate_address, maximum_paths, network, and redistribute Removed to `bgp_address_family` module.
26+
- vyos_user - add support for encrypted password specification
27+
- vyos_user - add support for public-key authentication
28+
29+
Minor Changes
30+
-------------
31+
32+
- README.md - Add Communication section with Forum information.
33+
- vyos_bgp_address_family - Redistribute, network stanza - added support for modifiers (metric, backdoor etc as per T6829)
34+
- vyos_bgp_global - Added support for `solo` neighbor attribute
35+
- vyos_config - block get_config call if match is set to "none"
36+
- vyos_facts - added `network_os_major_version` to facts
37+
- vyos_firewall_global - Added support for input, output, and forward chains (1.4+)
38+
- vyos_firewall_global - Added support for log-level in state-policy (1.4+)
39+
- vyos_firewall_global - with 1.4+, use the the global keyword to define global firewall rules
40+
- vyos_firewall_interfaces - added support for VIF interfaces
41+
- vyos_firewall_interfaces - enable support for 1.4 firewall
42+
- vyos_firewall_interfaces - expanded firewall interface types to match existing types
43+
- vyos_firewall_rules - Add support for diff mode for rulesets
44+
- vyos_firewall_rules - Added support for 1.4+ firewall rules
45+
- vyos_firewall_rules - Fixed comparing of firewall rules
46+
- vyos_firewall_rules - added support for 1.5+ firewall `match-ipsec-in`, `match-ipsec-out`, `match-none-in`, `match-none-out`
47+
- vyos_firewall_rules - added support for packet-length-exclude for 1.4+ and the states
48+
- vyos_l3_interfaces - make l3_interfaces pick up loopback interfaces
49+
- vyos_lldp_global - address is now addresses, with appropriate coercion for existing address keys
50+
- vyos_ntp_global - Added ntp options for 1.5+ (interleave, ptp)
51+
- vyos_ntp_global - Added support for VyOS 1.4+ (chronyd vs ntpd)
52+
- vyos_ntp_global - Added syntax for allow_client in 1.4+
53+
- vyos_ospf_interaces - support for 1.4 ospf interfaces
54+
- vyos_ospf_interfaces - add support for VyOS 1.3- virtual interfaces
55+
- vyos_ospf_interfaces - add support for VyOS 1.4+, which moved interface configuration from the interfaces to ospf/ospfv3 interfaces configuration
56+
- vyos_route_maps - add support for as-path-prepend policy option
57+
58+
Breaking Changes / Porting Guide
59+
--------------------------------
60+
61+
- Removed `vyos_logging`. Use `vyos_logging_global` instead.
62+
- lldp_global - if "address" is available, merge will cause it to be added, in contrast to the previous behavior where it was replaced. When used in replace mode, it will remove any existing addresses and replace them with the new one.
63+
- vyos_bgp_address_family - Support for 1.3+ VyOS only
64+
- vyos_bgp_global - Support for 1.3+ VyOS only
65+
- vyos_firewall_rules - removed p2p options as they have been removed prior to 1.3 of VyOS
66+
- vyos_firewall_rules - tcp.flags is now a list with an inversion flag to support 1.4+ firewall rules, but still supports 1.3-
67+
- vyos_lldp_global - civic_address is no longer a valid key (removed prior to 1.3)
68+
- vyos_logging_global - For 1.4, `protocol` is an attribute of the syslog host, not the facility
69+
- vyos_snmp_server - no longer works with versions prior to 1.3
70+
- vyos_snmp_server - parameter `engine_id` is no longer a `user` or `trap_target` parameter and is now a `snmp_v3` parameter
71+
- vyos_snmp_server - parameters `encrypted-key` and `plaintext-key` are now `encrypted-password` and `plaintext-password`
72+
- vyos_user - explicit support for version 1.3+ only
73+
- vyos_user - removed level (and its alias, role) they were removed in 1.3
74+
75+
Deprecated Features
76+
-------------------
77+
78+
- vyos_bgp_global - no_ipv4_unicast - deprecated for use with VyOS 1.4+, use `ipv4_unicast` instead
79+
- vyos_firewall_interfaces - deprecated for use with VyOS 1.4+, firewalls are no longer connected directly to interfaces. See the Firewall Configuration documentation for how to establish a connection betwen the firewall rulesets and the flow, interface, or zone.
80+
- vyos_lldp_global - `address` is deprecated, use `addresses` instead. To be removed in 7.0.0.
81+
- vyos_logging_global - `protocol` is deprecated for 1.4 and later, use `facility` instead. To be removed in next major version where supprot for 1.3 is removed
82+
83+
Bugfixes
84+
--------
85+
86+
- vyos_config - Fix change detection for recent Vyos versions
87+
- vyos_firewall_global - Fix removing last member of a firewall group.
88+
- vyos_firewall_global - Fixed ipv6 route-redirects and tests
89+
- vyos_firewall_global - Fixed parsing of global-options (1.4+)
90+
- vyos_firewall_global - Fixed state-policy deletion (partial and full)
91+
- vyos_firewall_global - fixed behavior for stanzas processing by facts in 1.4+ (e.g. present/absent stanza vs enable/disable)
92+
- vyos_firewall_global - fixed the facts parsers to include state-policies, redirect
93+
- vyos_firewall_rules - Allow deleting of firewall description.
94+
- vyos_firewall_rules - Fix limit parameter processing
95+
- vyos_firewall_rules - fixed behavior for log, disable attributes
96+
- vyos_firewall_rules - fixed behavior for override and replaced states
97+
- vyos_interfaces - fixed bug where 'replace' would delete an active disable and not reinstate it
98+
- vyos_interfaces - fixed over-zealous handling of disable, which could catch other interface items that are disabled.
99+
- vyos_l3_interfaces - fix delete in interfaces to remove vif completely if in affected interface
100+
- vyos_l3_interfaces - fix override in interfaces to remove vif completely if not present in new config
101+
- vyos_l3_interfaces - fix replace in interfaces to remove vif completely if not present in new config
102+
- vyos_logging_global - Fixed v1.3 and before when `protocol` and `level` were set for the same host
103+
- vyos_ospf_interfaces - fixed get_config to cater for unordered command lists in 1.4+
104+
- vyos_ospfv2 - passive-interface processing for 1.3- and 1.4+
105+
- vyos_ospfv3 - added support for adding interfaces to areas
106+
- vyos_static routes - fixed the facts, argspecs, config to include interface-routes
107+
- vyos_user - fix handling of `full-name` in parser and module
108+
109+
Known Issues
110+
------------
111+
112+
- existing code for 1.3 facility protocol and facility level are not compatible, only one will be set and level is the priority.
113+
114+
Documentation Changes
115+
---------------------
116+
117+
- Update module documentation to reflect 1.4+ support
118+
7119
v5.0.0
8120
======
9121

changelogs/changelog.yaml

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,3 +431,194 @@ releases:
431431
- release_500.yaml
432432
- undeprecate.yaml
433433
release_date: "2024-06-25"
434+
6.0.0:
435+
changes:
436+
breaking_changes:
437+
- Removed `vyos_logging`. Use `vyos_logging_global` instead.
438+
- lldp_global - if "address" is available, merge will cause it to be added,
439+
in contrast to the previous behavior where it was replaced. When used in replace
440+
mode, it will remove any existing addresses and replace them with the new
441+
one.
442+
- vyos_bgp_address_family - Support for 1.3+ VyOS only
443+
- vyos_bgp_global - Support for 1.3+ VyOS only
444+
- vyos_firewall_rules - removed p2p options as they have been removed prior
445+
to 1.3 of VyOS
446+
- vyos_firewall_rules - tcp.flags is now a list with an inversion flag to support
447+
1.4+ firewall rules, but still supports 1.3-
448+
- vyos_lldp_global - civic_address is no longer a valid key (removed prior to
449+
1.3)
450+
- vyos_logging_global - For 1.4, `protocol` is an attribute of the syslog host,
451+
not the facility
452+
- vyos_snmp_server - no longer works with versions prior to 1.3
453+
- vyos_snmp_server - parameter `engine_id` is no longer a `user` or `trap_target`
454+
parameter and is now a `snmp_v3` parameter
455+
- vyos_snmp_server - parameters `encrypted-key` and `plaintext-key` are now
456+
`encrypted-password` and `plaintext-password`
457+
- vyos_user - explicit support for version 1.3+ only
458+
- vyos_user - removed level (and its alias, role) they were removed in 1.3
459+
bugfixes:
460+
- vyos_config - Fix change detection for recent Vyos versions
461+
- vyos_firewall_global - Fix removing last member of a firewall group.
462+
- vyos_firewall_global - Fixed ipv6 route-redirects and tests
463+
- vyos_firewall_global - Fixed parsing of global-options (1.4+)
464+
- vyos_firewall_global - Fixed state-policy deletion (partial and full)
465+
- vyos_firewall_global - fixed behavior for stanzas processing by facts in 1.4+
466+
(e.g. present/absent stanza vs enable/disable)
467+
- vyos_firewall_global - fixed the facts parsers to include state-policies,
468+
redirect
469+
- vyos_firewall_rules - Allow deleting of firewall description.
470+
- vyos_firewall_rules - Fix limit parameter processing
471+
- vyos_firewall_rules - fixed behavior for log, disable attributes
472+
- vyos_firewall_rules - fixed behavior for override and replaced states
473+
- vyos_interfaces - fixed bug where 'replace' would delete an active disable
474+
and not reinstate it
475+
- vyos_interfaces - fixed over-zealous handling of disable, which could catch
476+
other interface items that are disabled.
477+
- vyos_l3_interfaces - fix delete in interfaces to remove vif completely if
478+
in affected interface
479+
- vyos_l3_interfaces - fix override in interfaces to remove vif completely if
480+
not present in new config
481+
- vyos_l3_interfaces - fix replace in interfaces to remove vif completely if
482+
not present in new config
483+
- vyos_logging_global - Fixed v1.3 and before when `protocol` and `level` were
484+
set for the same host
485+
- vyos_ospf_interfaces - fixed get_config to cater for unordered command lists
486+
in 1.4+
487+
- vyos_ospfv2 - passive-interface processing for 1.3- and 1.4+
488+
- vyos_ospfv3 - added support for adding interfaces to areas
489+
- vyos_static routes - fixed the facts, argspecs, config to include interface-routes
490+
- vyos_user - fix handling of `full-name` in parser and module
491+
deprecated_features:
492+
- vyos_bgp_global - no_ipv4_unicast - deprecated for use with VyOS 1.4+, use
493+
`ipv4_unicast` instead
494+
- vyos_firewall_interfaces - deprecated for use with VyOS 1.4+, firewalls are
495+
no longer connected directly to interfaces. See the Firewall Configuration
496+
documentation for how to establish a connection betwen the firewall rulesets
497+
and the flow, interface, or zone.
498+
- vyos_lldp_global - `address` is deprecated, use `addresses` instead. To be
499+
removed in 7.0.0.
500+
- vyos_logging_global - `protocol` is deprecated for 1.4 and later, use `facility`
501+
instead. To be removed in next major version where supprot for 1.3 is removed
502+
doc_changes:
503+
- Update module documentation to reflect 1.4+ support
504+
known_issues:
505+
- existing code for 1.3 facility protocol and facility level are not compatible,
506+
only one will be set and level is the priority.
507+
major_changes:
508+
- bgp modules - Added support for 1.4+ "system-as". 1.3 embedded as_number is
509+
still supported
510+
- vyos bgp modules - Many configuration attributes moved from `bgp_global` to
511+
`bgp_address_family` module (see documentation).
512+
- vyos_bgp_address_family - Aligned with version 1.3+ configuration - aggregate_address,
513+
maximum_paths, network, and redistribute moved from `bgp_global` module. These
514+
are now Address-family specific. Many neighbor attributes also moved from
515+
`vyos_bgp_global` to `vyos_bgp_address_family` module.
516+
- vyos_bgp_global - Aligned with version 1.3+ configuration - aggregate_address,
517+
maximum_paths, network, and redistribute Removed to `bgp_address_family` module.
518+
- vyos_user - add support for encrypted password specification
519+
- vyos_user - add support for public-key authentication
520+
minor_changes:
521+
- README.md - Add Communication section with Forum information.
522+
- vyos_bgp_address_family - Redistribute, network stanza - added support for
523+
modifiers (metric, backdoor etc as per T6829)
524+
- vyos_bgp_global - Added support for `solo` neighbor attribute
525+
- vyos_config - block get_config call if match is set to "none"
526+
- vyos_facts - added `network_os_major_version` to facts
527+
- vyos_firewall_global - Added support for input, output, and forward chains
528+
(1.4+)
529+
- vyos_firewall_global - Added support for log-level in state-policy (1.4+)
530+
- vyos_firewall_global - with 1.4+, use the the global keyword to define global
531+
firewall rules
532+
- vyos_firewall_interfaces - added support for VIF interfaces
533+
- vyos_firewall_interfaces - enable support for 1.4 firewall
534+
- vyos_firewall_interfaces - expanded firewall interface types to match existing
535+
types
536+
- vyos_firewall_rules - Add support for diff mode for rulesets
537+
- vyos_firewall_rules - Added support for 1.4+ firewall rules
538+
- vyos_firewall_rules - Fixed comparing of firewall rules
539+
- vyos_firewall_rules - added support for 1.5+ firewall `match-ipsec-in`, `match-ipsec-out`,
540+
`match-none-in`, `match-none-out`
541+
- vyos_firewall_rules - added support for packet-length-exclude for 1.4+ and
542+
the states
543+
- vyos_l3_interfaces - make l3_interfaces pick up loopback interfaces
544+
- vyos_lldp_global - address is now addresses, with appropriate coercion for
545+
existing address keys
546+
- vyos_ntp_global - Added ntp options for 1.5+ (interleave, ptp)
547+
- vyos_ntp_global - Added support for VyOS 1.4+ (chronyd vs ntpd)
548+
- vyos_ntp_global - Added syntax for allow_client in 1.4+
549+
- vyos_ospf_interaces - support for 1.4 ospf interfaces
550+
- vyos_ospf_interfaces - add support for VyOS 1.3- virtual interfaces
551+
- vyos_ospf_interfaces - add support for VyOS 1.4+, which moved interface configuration
552+
from the interfaces to ospf/ospfv3 interfaces configuration
553+
- vyos_route_maps - add support for as-path-prepend policy option
554+
release_summary:
555+
"This is the first significant release from the VyOS community
556+
for these modules.
557+
558+
This release is focussed on 1.3+ of VyOS and will be the last major release
559+
to
560+
561+
support 1.3 fully. Although efforts have been made to maintain compatibility
562+
563+
with the existing vyos collection modules, there have breaking changes where
564+
565+
necessary to configuration parameters. Please review all changes carefully
566+
before updating.
567+
568+
"
569+
fragments:
570+
- 0-readme.yml
571+
- 6.0.0.yml
572+
- T151-prepare-for-release.yaml
573+
- T6817_T6825_ovr_rep.yml
574+
- T6821_route_map_options.yml
575+
- T6829-ospfv3-v1.3-area-interfacces.yml
576+
- T6831_ospf_vif.yml
577+
- T6833_fw_rules_limit.yaml
578+
- T6834-static-routes-interfaces.yml
579+
- T6891-docsite.yaml
580+
- T6894-ntp-integration-tests.yml
581+
- T6987-logging-changes.yml
582+
- T6988-fix-user.yml
583+
- T7002-firewall-global-integration-tests.yml
584+
- T7003-firewall-interface-integration-tests.yml
585+
- T7006-interface-integration-tests.yml
586+
- T7008-l3-interface-integration-tests.yml
587+
- T7010-lag-interfaces-integration-tests.yaml
588+
- T7011-lldp-integration-tests.yaml
589+
- T7012_ospf-integration-tests.yaml
590+
- T7012_ospfv2_integration_tests.yaml
591+
- T7012_ospfv3_integration_tests.yaml
592+
- T7013_route-maps-integration-tests.yml
593+
- T7015_static_routes_integration_tests.yaml
594+
- T7083_firewall_rules.yml
595+
- T7088-codecoverage.yml
596+
- T7127-fix-interface-integration-13.yaml
597+
- T7153-remove-logging.yaml
598+
- T7162-interface-preflight.yaml
599+
- T7236_firewall_rules.yml
600+
- T7238_logging_global.yml
601+
- T7259-get_config.yaml
602+
- T7260-remove-last-firewall-group-member.yaml
603+
- T7284-delete_firewall_description.yml
604+
- T7329_snmp_server_support.yml
605+
- T7391_domain_search.yaml
606+
- bgp_address_family.yaml
607+
- bgp_global.yaml
608+
- cliconf.yml
609+
- firewall_global_14.yml
610+
- firewall_global_parsing.yml
611+
- firewall_interface_types.yml
612+
- firewall_rules.yml
613+
- firewall_rules_diff.yml
614+
- fix-recent-vyos-version-change-detection.yml
615+
- integration_tests_fixes.yml
616+
- interfaces_update.yml
617+
- ntp_global.yaml
618+
- pre-release6.yaml
619+
- resource_updates.yml
620+
- revert-409-paramiko-compatible.yaml
621+
- snmp_server.yml
622+
- test_module_patch.yml
623+
- tests.yml
624+
release_date: "2025-06-25"

changelogs/fragments/0-readme.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/6.0.0.yml

Lines changed: 0 additions & 6 deletions
This file was deleted.

changelogs/fragments/T151-prepare-for-release.yaml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/T6817_T6825_ovr_rep.yml

Lines changed: 0 additions & 8 deletions
This file was deleted.

changelogs/fragments/T6821_route_map_options.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/T6829-ospfv3-v1.3-area-interfacces.yml

Lines changed: 0 additions & 6 deletions
This file was deleted.

changelogs/fragments/T6831_ospf_vif.yml

Lines changed: 0 additions & 3 deletions
This file was deleted.

changelogs/fragments/T6833_fw_rules_limit.yaml

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)