From 3dd78cddfe90851cb7a6891add8a0973d23da292 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Thu, 4 Feb 2021 00:00:41 +0100 Subject: vrf: T2450: provide full protocol support in XML and Python with new CLI --- data/configd-include.json | 1 + 1 file changed, 1 insertion(+) (limited to 'data/configd-include.json') diff --git a/data/configd-include.json b/data/configd-include.json index 751d8e012..c0263127a 100644 --- a/data/configd-include.json +++ b/data/configd-include.json @@ -40,6 +40,7 @@ "protocols_pim.py", "protocols_rip.py", "protocols_static_multicast.py", +"protocols_vrf.py", "salt-minion.py", "service_console-server.py", "service_ids_fastnetmon.py", -- cgit v1.2.3 From 1f8c257f126d492a3f41eee72728b2c35b6b534e Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Thu, 4 Feb 2021 19:35:18 +0100 Subject: route: static: T2450: provide full protocol support in XML and Python with new CLI --- Makefile | 3 - data/configd-include.json | 1 + data/templates/frr/static.frr.tmpl | 38 +++ data/templates/frr/static_routes_macro.j2 | 15 + data/templates/frr/vrf.frr.tmpl | 34 +-- interface-definitions/arp.xml.in | 37 --- interface-definitions/include/static-route.xml.i | 14 +- interface-definitions/include/static-route6.xml.i | 14 +- interface-definitions/protocols-multicast.xml.in | 1 - interface-definitions/protocols-static-arp.xml.in | 37 +++ interface-definitions/protocols-static.xml.in | 341 +--------------------- src/conf_mode/protocols_static.py | 102 +++++++ src/migration-scripts/quagga/7-to-8 | 122 ++++++++ 13 files changed, 354 insertions(+), 405 deletions(-) create mode 100644 data/templates/frr/static.frr.tmpl create mode 100644 data/templates/frr/static_routes_macro.j2 delete mode 100644 interface-definitions/arp.xml.in create mode 100644 interface-definitions/protocols-static-arp.xml.in create mode 100755 src/conf_mode/protocols_static.py create mode 100755 src/migration-scripts/quagga/7-to-8 (limited to 'data/configd-include.json') diff --git a/Makefile b/Makefile index fbd5d57ce..a984f88db 100644 --- a/Makefile +++ b/Makefile @@ -40,15 +40,12 @@ interface_definitions: $(config_xml_obj) # XXX: delete top level node.def's that now live in other packages rm -f $(TMPL_DIR)/firewall/node.def rm -f $(TMPL_DIR)/interfaces/node.def - rm -f $(TMPL_DIR)/protocols/node.def - rm -f $(TMPL_DIR)/protocols/static/node.def rm -f $(TMPL_DIR)/policy/node.def rm -f $(TMPL_DIR)/system/node.def rm -f $(TMPL_DIR)/vpn/node.def rm -f $(TMPL_DIR)/vpn/ipsec/node.def rm -rf $(TMPL_DIR)/vpn/nipsec rm -rf $(TMPL_DIR)/protocols/nripng - rm -rf $(TMPL_DIR)/protocols/nstatic # XXX: required until OSPF and RIP is migrated from vyatta-cfg-quagga to vyos-1x mkdir $(TMPL_DIR)/interfaces/loopback/node.tag/ipv6 diff --git a/data/configd-include.json b/data/configd-include.json index c0263127a..d2789e285 100644 --- a/data/configd-include.json +++ b/data/configd-include.json @@ -39,6 +39,7 @@ "protocols_ospfv3.py", "protocols_pim.py", "protocols_rip.py", +"protocols_static.py", "protocols_static_multicast.py", "protocols_vrf.py", "salt-minion.py", diff --git a/data/templates/frr/static.frr.tmpl b/data/templates/frr/static.frr.tmpl new file mode 100644 index 000000000..bb0ec80a5 --- /dev/null +++ b/data/templates/frr/static.frr.tmpl @@ -0,0 +1,38 @@ +{% from 'frr/static_routes_macro.j2' import static_routes %} +! +{# IPv4 routing #} +{% if route is defined and route is not none %} +{% for prefix, prefix_config in route.items() %} +{{ static_routes('ip', prefix, prefix_config) }} +{%- endfor -%} +{% endif %} +! +{# IPv6 routing #} +{% if route6 is defined and route6 is not none %} +{% for prefix, prefix_config in route6.items() %} +{{ static_routes('ipv6', prefix, prefix_config) }} +{%- endfor -%} +{% endif %} +! +{# Policy route tables #} +{% if table is defined and table is not none %} +{% for table_id, table_config in table.items() %} +{% if table_config.route is defined and table_config.route is not none %} +{% for prefix, prefix_config in table_config.route.items() %} +{{ static_routes('ip', prefix, prefix_config, table_id) }} +{%- endfor -%} +{% endif %} +! +{% if table_config.route6 is defined and table_config.route6 is not none %} +{% for prefix, prefix_config in table_config.route6.items() %} +{{ static_routes('ipv6', prefix, prefix_config, table_id) }} +{%- endfor -%} +{% endif %} +! +{% endfor %} +{% endif %} +! +{% if route_map is defined and route_map is not none %} +ip protocol static route-map {{ route_map }} +! +{% endif %} diff --git a/data/templates/frr/static_routes_macro.j2 b/data/templates/frr/static_routes_macro.j2 new file mode 100644 index 000000000..aadb2805e --- /dev/null +++ b/data/templates/frr/static_routes_macro.j2 @@ -0,0 +1,15 @@ +{% macro static_routes(ip_ipv6, prefix, prefix_config, table=None) %} +{% if prefix_config.blackhole is defined %} +{{ ip_ipv6 }} route {{ prefix }} blackhole {{ prefix_config.blackhole.distance if prefix_config.blackhole.distance is defined }} {{ 'tag ' + prefix_config.blackhole.tag if prefix_config.blackhole.tag is defined }} {{ 'table ' + table if table is defined and table is not none }} +{% endif %} +{% if prefix_config.interface is defined and prefix_config.interface is not none %} +{% for interface, interface_config in prefix_config.interface.items() if interface_config.disable is not defined %} +{{ ip_ipv6 }} route {{ prefix }} {{ interface }} {{ interface_config.distance if interface_config.distance is defined }} {{ 'nexthop-vrf ' + interface_config.vrf if interface_config.vrf is defined }} {{ 'table ' + table if table is defined and table is not none }} +{% endfor %} +{% endif %} +{% if prefix_config.next_hop is defined and prefix_config.next_hop is not none %} +{% for next_hop, next_hop_config in prefix_config.next_hop.items() if next_hop_config.disable is not defined %} +{{ ip_ipv6 }} route {{ prefix }} {{ next_hop }} {{ next_hop_config.interface if next_hop_config.interface is defined }} {{ next_hop_config.distance if next_hop_config.distance is defined }} {{ 'nexthop-vrf ' + next_hop_config.vrf if next_hop_config.vrf is defined }} {{ 'table ' + table if table is defined and table is not none }} +{% endfor %} +{% endif %} +{% endmacro %} diff --git a/data/templates/frr/vrf.frr.tmpl b/data/templates/frr/vrf.frr.tmpl index 1cb055962..0c8726908 100644 --- a/data/templates/frr/vrf.frr.tmpl +++ b/data/templates/frr/vrf.frr.tmpl @@ -1,3 +1,4 @@ +{% from 'frr/static_routes_macro.j2' import static_routes %} ! {% if vrf is defined and vrf is not none %} {% for vrf_name, vrf_config in vrf.items() %} @@ -5,36 +6,15 @@ vrf {{ vrf_name }} {% if vrf_config.static is defined and vrf_config.static is not none %} {# IPv4 routes #} {% if vrf_config.static.route is defined and vrf_config.static.route is not none %} -{% for route, route_config in vrf_config.static.route.items() %} -{% if route_config.blackhole is defined %} - ip route {{ route }} blackhole {{ route_config.blackhole.distance if route_config.blackhole.distance is defined }} -{% elif route_config.interface is defined and route_config.interface is not none %} -{% for interface, interface_config in route_config.interface.items() if interface_config.disable is not defined %} - ip route {{ route }} {{ interface }} {{ interface_config.distance if interface_config.distance is defined }} {{ 'nexthop-vrf ' + interface_config.vrf if interface_config.vrf is defined }} -{% endfor %} -{% elif route_config.next_hop is defined and route_config.next_hop is not none %} -{% for next_hop, next_hop_config in route_config.next_hop.items() if next_hop_config.disable is not defined %} - ip route {{ route }} {{ next_hop }} {{ next_hop_config.interface if next_hop_config.interface is defined }} {{ next_hop_config.distance if next_hop_config.distance is defined }} {{ 'nexthop-vrf ' + next_hop_config.vrf if next_hop_config.vrf is defined }} -{% endfor %} -{% endif %} -{% endfor %} +{% for prefix, prefix_config in vrf_config.static.route.items() %} + {{ static_routes('ip', prefix, prefix_config) }} +{%- endfor -%} {% endif %} {# IPv6 routes #} {% if vrf_config.static.route6 is defined and vrf_config.static.route6 is not none %} -{% for route, route_config in vrf_config.static.route6.items() %} -{% if route_config.blackhole is defined %} - ipv6 route {{ route }} blackhole {{ route_config.blackhole.distance if route_config.blackhole.distance is defined }} -{% elif route_config.interface is defined and route_config.interface is not none %} -{% for interface, interface_config in route_config.interface.items() if interface_config.disable is not defined %} - ipv6 route {{ route }} {{ interface }} {{ interface_config.distance if interface_config.distance is defined }} {{ 'nexthop-vrf ' + interface_config.vrf if interface_config.vrf is defined }} -{% endfor %} -{% elif route_config.next_hop is defined and route_config.next_hop is not none %} -{% for next_hop, next_hop_config in route_config.next_hop.items() if next_hop_config.disable is not defined %} - ipv6 route {{ route }} {{ next_hop }} {{ next_hop_config.interface if next_hop_config.interface is defined }} {{ next_hop_config.distance if next_hop_config.distance is defined }} {{ 'nexthop-vrf ' + next_hop_config.vrf if next_hop_config.vrf is defined }} -{% endfor %} -{% endif %} - -{% endfor %} +{% for prefix, prefix_config in vrf_config.static.route6.items() %} + {{ static_routes('ipv6', prefix, prefix_config) }} +{%- endfor -%} {% endif %} {% endif %} {% endfor %} diff --git a/interface-definitions/arp.xml.in b/interface-definitions/arp.xml.in deleted file mode 100644 index 082afe00f..000000000 --- a/interface-definitions/arp.xml.in +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - Static ARP translation - - ipv4 - IPv4 destination address - - - - - - - - - mac address to translate to - - macaddr - Hardware (MAC) address - - - - - - - - - - - - - diff --git a/interface-definitions/include/static-route.xml.i b/interface-definitions/include/static-route.xml.i index 9ab3926da..1f79aaca8 100644 --- a/interface-definitions/include/static-route.xml.i +++ b/interface-definitions/include/static-route.xml.i @@ -4,7 +4,7 @@ VRF static IPv4 route ipv4net - VRF static IPv4 route + IPv4 static route @@ -17,6 +17,18 @@ #include + + + Tag value for this route + + u32:1-4294967295 + Tag value for this route + + + + + + diff --git a/interface-definitions/include/static-route6.xml.i b/interface-definitions/include/static-route6.xml.i index d484b285c..1ff6bbead 100644 --- a/interface-definitions/include/static-route6.xml.i +++ b/interface-definitions/include/static-route6.xml.i @@ -4,7 +4,7 @@ VRF static IPv6 route ipv6net - VRF static IPv6 route + IPv6 static route @@ -17,6 +17,18 @@ #include + + + Tag value for this route + + u32:1-4294967295 + Tag value for this route + + + + + + diff --git a/interface-definitions/protocols-multicast.xml.in b/interface-definitions/protocols-multicast.xml.in index a06f2b287..bf0ead78f 100644 --- a/interface-definitions/protocols-multicast.xml.in +++ b/interface-definitions/protocols-multicast.xml.in @@ -1,5 +1,4 @@ - diff --git a/interface-definitions/protocols-static-arp.xml.in b/interface-definitions/protocols-static-arp.xml.in new file mode 100644 index 000000000..e5e8a9ad9 --- /dev/null +++ b/interface-definitions/protocols-static-arp.xml.in @@ -0,0 +1,37 @@ + + + + + + + + + Static ARP translation + + ipv4 + IPv4 destination address + + + + + + + + + Translation MAC address + + macaddr + Hardware (MAC) address + + + + + + + + + + + + + diff --git a/interface-definitions/protocols-static.xml.in b/interface-definitions/protocols-static.xml.in index 3ad6434db..59a7927a5 100644 --- a/interface-definitions/protocols-static.xml.in +++ b/interface-definitions/protocols-static.xml.in @@ -1,193 +1,15 @@ - - + - + Static route parameters - - - Interface based static route - - ipv4net - Interface based static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - #include - #include - #include - - - - - - - Interface based IPv6 static route - - ipv6net - Interface based IPv6 static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - #include - #include - - - - #include - - - Static route - - ipv4net - Static route - - - - - - - - - Silently discard pkts when matched - - - #include - - - Tag value for this route - - u32:1-4294967295 - Tag value for this route - - - - - - - - - - - DHCP interface that supplies the next-hop IP address for this static route - - - - - txt - DHCP interface - - - - - - Next-hop router - - ipv4 - Next-hop router - - - - - - - #include - #include - - - IPv4 gateway interface name - - - - - txt - IPv4 gateway interface name - - - - #include - - - - - - - Static IPv6 route - - ipv6net - Static IPv6 route - - - - - - - - - Silently discard pkts when matched - - - #include - - - - - Next-hop IPv6 router [REQUIRED] - - ipv6 - Next-hop IPv6 router [REQUIRED] - - - - - - - #include - #include - - - IPv6 gateway interface name - - - - - txt - IPv6 gateway interface name - - - - #include - - - - + #include + #include Policy route table number @@ -200,159 +22,8 @@ - - - Interface based static route - - ipv4net - Interface based static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - #include - #include - - - - - - - Interface based IPv6 static route - - ipv6net - Interface based IPv6 static route - - - - - - - - - Next-hop interface [REQUIRED] - - - - - - #include - #include - - - - - - - Static route - - ipv4net - Static route - - - - - - - - - Silently discard pkts when matched - - - #include - - - - - DHCP interface that supplies the next-hop IP address for this static route - - - - - txt - DHCP interface - - - - - - Next-hop router - - ipv4 - Next-hop router - - - - - - - #include - #include - - - IPv4 gateway interface name - - - - - txt - IPv4 gateway interface name - - - - #include - - - - - - - Static IPv6 route - - ipv6net - Static IPv6 route - - - - - - - - - Silently discard pkts when matched - - - #include - - - - - Next-hop IPv6 router [REQUIRED] - - ipv6 - Next-hop IPv6 router [REQUIRED] - - - - - - - #include - #include - - - - + #include + #include diff --git a/src/conf_mode/protocols_static.py b/src/conf_mode/protocols_static.py new file mode 100755 index 000000000..62a3fecd7 --- /dev/null +++ b/src/conf_mode/protocols_static.py @@ -0,0 +1,102 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2021 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import os + +from sys import exit + +from vyos.config import Config +from vyos.template import render +from vyos.template import render_to_string +from vyos.util import call +from vyos.configverify import verify_route_maps +from vyos import ConfigError +from vyos import frr +from vyos import airbag +airbag.enable() + +config_file = r'/tmp/static.frr' +frr_daemon = 'staticd' + +DEBUG = os.path.exists('/tmp/static.debug') +if DEBUG: + import logging + lg = logging.getLogger("vyos.frr") + lg.setLevel(logging.DEBUG) + ch = logging.StreamHandler() + lg.addHandler(ch) + +def get_config(config=None): + if config: + conf = config + else: + conf = Config() + base = ['protocols', 'static'] + static = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True) + return static + +def verify(static): + verify_route_maps(static) + return None + +def generate(static): + # render(config) not needed, its only for debug + render(config_file, 'frr/static.frr.tmpl', static) + static['new_frr_config'] = render_to_string('frr/static.frr.tmpl', static) + + return None + +def apply(static): + # Save original configuration prior to starting any commit actions + frr_cfg = frr.FRRConfig() + frr_cfg.load_configuration(frr_daemon) + frr_cfg.modify_section(r'^ip route .*', '') + frr_cfg.modify_section(r'^ipv6 route .*', '') + frr_cfg.add_before(r'(interface .*|line vty)', static['new_frr_config']) + + # Debugging + if DEBUG: + from pprint import pprint + print('') + print('--------- DEBUGGING ----------') + pprint(dir(frr_cfg)) + print('Existing config:\n') + for line in frr_cfg.original_config: + print(line) + print(f'Replacement config:\n') + print(f'{static["new_frr_config"]}') + print(f'Modified config:\n') + print(f'{frr_cfg}') + + frr_cfg.commit_configuration(frr_daemon) + + # If FRR config is blank, rerun the blank commit x times due to frr-reload + # behavior/bug not properly clearing out on one commit. + if static['new_frr_config'] == '': + for a in range(5): + frr_cfg.commit_configuration(frr_daemon) + + return None + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) diff --git a/src/migration-scripts/quagga/7-to-8 b/src/migration-scripts/quagga/7-to-8 new file mode 100755 index 000000000..9c277a6f1 --- /dev/null +++ b/src/migration-scripts/quagga/7-to-8 @@ -0,0 +1,122 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2021 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# - T2450: drop interface-route and interface-route6 from "protocols static" + +from sys import argv +from sys import exit + +from vyos.configtree import ConfigTree + +def migrate_interface_route(config, base, path, route_route6): + """ Generic migration function which can be called on every instance of + interface-route, beeing it ipv4, ipv6 or nested under the "static table" nodes. + + What we do? + - Drop 'interface-route' or 'interface-route6' and migrate the route unter the + 'route' or 'route6' tag node. + """ + if config.exists(base + path): + for route in config.list_nodes(base + path): + interface = config.list_nodes(base + path + [route, 'next-hop-interface']) + + tmp = base + path + [route, 'next-hop-interface'] + for interface in config.list_nodes(tmp): + new_base = base + [route_route6, route, 'interface'] + config.set(new_base) + config.set_tag(base + [route_route6]) + config.set_tag(new_base) + config.copy(tmp + [interface], new_base + [interface]) + + config.delete(base + path) + +def migrate_route(config, base, path, route_route6): + """ Generic migration function which can be called on every instance of + route, beeing it ipv4, ipv6 or even nested under the static table nodes. + + What we do? + - for consistency reasons rename next-hop-interface to interface + - for consistency reasons rename next-hop-vrf to vrf + """ + if config.exists(base + path): + for route in config.list_nodes(base + path): + next_hop = base + path + [route, 'next-hop'] + if config.exists(next_hop): + for gateway in config.list_nodes(next_hop): + # IPv4 routes calls it next-hop-interface, rename this to + # interface instead so it's consitent with IPv6 + interface_path = next_hop + [gateway, 'next-hop-interface'] + if config.exists(interface_path): + config.rename(interface_path, 'interface') + + # When VRFs got introduced, I (c-po) named it next-hop-vrf, + # we can also call it vrf which is simply shorter. + vrf_path = next_hop + [gateway, 'next-hop-vrf'] + if config.exists(vrf_path): + config.rename(vrf_path, 'vrf') + + +if (len(argv) < 2): + print("Must specify file name!") + exit(1) + +file_name = argv[1] + +with open(file_name, 'r') as f: + config_file = f.read() + +base = ['protocols', 'static'] + +config = ConfigTree(config_file) +if not config.exists(base): + # Nothing to do + exit(0) + +# Migrate interface-route into route +migrate_interface_route(config, base, ['interface-route'], 'route') + +# Migrate interface-route6 into route6 +migrate_interface_route(config, base, ['interface-route6'], 'route6') + +# Cleanup nodes inside route +migrate_route(config, base, ['route'], 'route') + +# Cleanup nodes inside route6 +migrate_route(config, base, ['route6'], 'route6') + +# +# PBR table cleanup +table_path = base + ['table'] +if config.exists(table_path): + for table in config.list_nodes(table_path): + # Migrate interface-route into route + migrate_interface_route(config, table_path + [table], ['interface-route'], 'route') + + # Migrate interface-route6 into route6 + migrate_interface_route(config, table_path + [table], ['interface-route6'], 'route6') + + # Cleanup nodes inside route + migrate_route(config, table_path + [table], ['route'], 'route') + + # Cleanup nodes inside route6 + migrate_route(config, table_path + [table], ['route6'], 'route6') + +try: + with open(file_name, 'w') as f: + f.write(config.to_string()) +except OSError as e: + print("Failed to save the modified config: {}".format(e)) + exit(1) -- cgit v1.2.3