public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Stefan Hanreich <s.hanreich@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH pve-network 04/13] sdn: add route map module
Date: Wed, 25 Mar 2026 10:41:29 +0100	[thread overview]
Message-ID: <20260325094142.174364-19-s.hanreich@proxmox.com> (raw)
In-Reply-To: <20260325094142.174364-1-s.hanreich@proxmox.com>

Defines helpers for common operations (reading / writing
configuration) as well as the required formats / schema definitions
for the route map API.

The Route Map ID format currently rejects all IDs that could be
auto-generated by PVE entities, to prevent accidental overrides of
built-in route maps. Instead of re-defining route maps, users can
create a new custom route map and select that in the EVPN / BGP
controller, if they want to override the auto-generated route map.

Signed-off-by: Stefan Hanreich <s.hanreich@proxmox.com>
---
 src/PVE/API2/Network/SDN/Makefile           |   4 +-
 src/PVE/API2/Network/SDN/RouteMaps/Makefile |   8 +
 src/PVE/Network/SDN/RouteMaps.pm            | 173 ++++++++++++++++++++
 3 files changed, 184 insertions(+), 1 deletion(-)
 create mode 100644 src/PVE/API2/Network/SDN/RouteMaps/Makefile
 create mode 100644 src/PVE/Network/SDN/RouteMaps.pm

diff --git a/src/PVE/API2/Network/SDN/Makefile b/src/PVE/API2/Network/SDN/Makefile
index 4349c17..770eef2 100644
--- a/src/PVE/API2/Network/SDN/Makefile
+++ b/src/PVE/API2/Network/SDN/Makefile
@@ -6,7 +6,8 @@ SOURCES=Vnets.pm\
 		Dns.pm\
 		Ips.pm\
 		Fabrics.pm\
-		PrefixLists.pm
+		PrefixLists.pm\
+		RouteMaps.pm
 
 PERL5DIR=${DESTDIR}/usr/share/perl5
 
@@ -15,4 +16,5 @@ install:
 	for i in ${SOURCES}; do install -D -m 0644 $$i ${PERL5DIR}/PVE/API2/Network/SDN/$$i; done
 	make -C Fabrics install
 	make -C Nodes install
+	make -C RouteMaps install
 
diff --git a/src/PVE/API2/Network/SDN/RouteMaps/Makefile b/src/PVE/API2/Network/SDN/RouteMaps/Makefile
new file mode 100644
index 0000000..3d0a928
--- /dev/null
+++ b/src/PVE/API2/Network/SDN/RouteMaps/Makefile
@@ -0,0 +1,8 @@
+SOURCES=RouteMap.pm\
+
+
+PERL5DIR=${DESTDIR}/usr/share/perl5
+
+.PHONY: install
+install:
+	for i in ${SOURCES}; do install -D -m 0644 $$i ${PERL5DIR}/PVE/API2/Network/SDN/RouteMaps/$$i; done
diff --git a/src/PVE/Network/SDN/RouteMaps.pm b/src/PVE/Network/SDN/RouteMaps.pm
new file mode 100644
index 0000000..1d2f495
--- /dev/null
+++ b/src/PVE/Network/SDN/RouteMaps.pm
@@ -0,0 +1,173 @@
+package PVE::Network::SDN::RouteMaps;
+
+use strict;
+use warnings;
+
+use PVE::Cluster qw(cfs_register_file cfs_read_file cfs_lock_file cfs_write_file);
+use PVE::JSONSchema qw(get_standard_option);
+use PVE::INotify;
+use PVE::Network::SDN;
+use PVE::RS::SDN::RouteMaps;
+
+PVE::JSONSchema::register_format(
+    'pve-sdn-route-map-id',
+    sub {
+        my ($id, $noerr) = @_;
+
+        if ($id =~ m/^(pve_.*|MAP_VTEP_IN|MAP_VTEP_OUT|correct_src)$/) {
+            return undef if $noerr;
+            die "route map ID '$id' is currently reserved and cannot be used\n";
+        }
+
+        if ($id !~ m/^[a-zA-Z0-9][a-zA-Z0-9-_]{0,30}[a-zA-Z0-9]?$/i) {
+            return undef if $noerr;
+            die "route map ID '$id' contains illegal characters\n";
+        }
+
+        return $id;
+    },
+);
+
+PVE::JSONSchema::register_standard_option(
+    'pve-sdn-route-map-id',
+    {
+        description => "The SDN route map identifier",
+        type => 'string',
+        format => 'pve-sdn-route-map-id',
+    },
+);
+
+PVE::JSONSchema::register_standard_option(
+    'pve-sdn-route-map-order',
+    {
+        description => 'The index of this route map entry',
+        type => 'integer',
+        minimum => 0,
+        maximum => 2 ** 32 - 1,
+    },
+);
+
+cfs_register_file(
+    'sdn/route-maps.cfg', \&parse_route_maps_config, \&write_route_maps_config,
+);
+
+sub parse_route_maps_config {
+    my ($filename, $raw) = @_;
+    return $raw // '';
+}
+
+sub write_route_maps_config {
+    my ($filename, $config) = @_;
+    return $config // '';
+}
+
+sub config {
+    my ($running) = @_;
+
+    if ($running) {
+        my $running_config = PVE::Network::SDN::running_config();
+
+        # if the config hasn't yet been applied after the introduction of
+        # route maps then the key does not exist in the running config so we
+        # default to an empty hash
+        my $route_maps_config = $running_config->{'route-maps'}->{ids} // {};
+        return PVE::RS::SDN::RouteMaps->running_config($route_maps_config);
+    }
+
+    my $route_map_config = cfs_read_file("sdn/route-maps.cfg");
+    return PVE::RS::SDN::RouteMaps->config($route_map_config);
+}
+
+sub write_config {
+    my ($config) = @_;
+    cfs_write_file("sdn/route-maps.cfg", $config->to_raw(), 1);
+}
+
+sub route_map_properties {
+    my ($update) = @_;
+
+    my $properties = {
+        'route-map-id' => get_standard_option('pve-sdn-route-map-id'),
+        'order' => get_standard_option('pve-sdn-route-map-order'),
+        digest => get_standard_option('pve-config-digest'),
+        action => {
+            description => 'Matching policy of a route map entry.',
+            type => 'string',
+            enum => ['permit', 'deny'],
+            optional => $update,
+        },
+        set => {
+            type => 'array',
+            items => {
+                type => 'string',
+                format => {
+                    key => {
+                        type => 'string',
+                        enum => [
+                            'ip-next-hop-peer-address',
+                            'ip-next-hop',
+                            'ip-next-hop-unchanged',
+                            'ip6-next-hop-peer-address',
+                            'ip6-next-hop-prefer-global',
+                            'ip6-next-hop',
+                            'local-preference',
+                            'tag',
+                            'weight',
+                            'metric',
+                            'src',
+                        ]
+                    },
+                    value => {
+                        type => 'string',
+                        optional => 1,
+                    }
+                },
+            },
+            optional => 1,
+        },
+        match => {
+            type => 'array',
+            items => {
+                type => 'string',
+                format => {
+                    key => {
+                        type => 'string',
+                        enum => [
+                            'route-type',
+                            'vni',
+                            'ip-address-prefix-list',
+                            'ip6-address-prefix-list',
+                            'ip-next-hop-prefix-list',
+                            'ip6-next-hop-prefix-list',
+                            'ip-next-hop-address',
+                            'ip6-next-hop-address',
+                            'metric',
+                            'local-preference',
+                            'peer',
+                        ]
+                    },
+                    value => {
+                        type => 'string',
+                        optional => 1,
+                    }
+                },
+            },
+            optional => 1,
+        },
+    };
+
+    if ($update) {
+        $properties->{delete} = {
+            type => 'array',
+            optional => 1,
+            items => {
+                type => 'string',
+                enum => ['set', 'match'],
+            }
+        };
+    }
+
+    return $properties;
+}
+
+1;
-- 
2.47.3





  parent reply	other threads:[~2026-03-25  9:49 UTC|newest]

Thread overview: 62+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-25  9:41 [PATCH cluster/network/proxmox{-ve-rs,-perl-rs} 00/27] Add support for route maps / prefix lists to SDN Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-cluster 1/2] cfs: add 'sdn/route-maps.cfg' to observed files Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-cluster 2/2] cfs: add 'sdn/prefix-lists.cfg' " Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 1/9] sdn-types: add common route-map helper types Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 2/9] frr: implement routemap match/set statements via adjacent tagging Stefan Hanreich
2026-03-26 14:44   ` Hannes Laimer
2026-03-27  9:02     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 3/9] frr: allow rendering prefix-lists/route-maps separately Stefan Hanreich
2026-03-25 14:32   ` Gabriel Goller
2026-03-26 12:17     ` Stefan Hanreich
2026-03-27 10:50   ` Hannes Laimer
2026-03-27 11:34     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 4/9] frr-templates: change route maps template to adapt to new types Stefan Hanreich
2026-03-25 14:33   ` Gabriel Goller
2026-03-25 14:58     ` Gabriel Goller
2026-03-27 11:01   ` Hannes Laimer
2026-03-27 11:17     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 5/9] ve-config: add prefix list section config Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 6/9] ve-config: frr: implement frr config generation for prefix lists Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 7/9] ve-config: add route map section config Stefan Hanreich
2026-03-25 14:35   ` Gabriel Goller
2026-03-26 13:49     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 8/9] ve-config: frr: implement frr config generation for route maps Stefan Hanreich
2026-03-25 15:03   ` Gabriel Goller
2026-03-26 13:50     ` Stefan Hanreich
2026-03-27 11:17   ` Hannes Laimer
2026-03-27 11:21     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-ve-rs 9/9] ve-config: fabrics: adapt frr config generation to new format Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-perl-rs 1/3] pve-rs: sdn: add route maps module Stefan Hanreich
2026-03-26 10:32   ` Wolfgang Bumiller
2026-03-26 13:57     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-perl-rs 2/3] pve-rs: sdn: add prefix lists module Stefan Hanreich
2026-03-25  9:41 ` [PATCH proxmox-perl-rs 3/3] sdn: add prefix list / route maps to frr config generation helper Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 01/13] controller: bgp: evpn: adapt to new match / set frr config syntax Stefan Hanreich
2026-03-26 15:19   ` Hannes Laimer
2026-03-27 10:05     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 02/13] sdn: add prefix lists module Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 03/13] api2: add prefix list module Stefan Hanreich
2026-03-26 15:01   ` Hannes Laimer
2026-03-27  9:57     ` Stefan Hanreich
2026-03-25  9:41 ` Stefan Hanreich [this message]
2026-03-25  9:41 ` [PATCH pve-network 05/13] api2: add route maps api module Stefan Hanreich
2026-03-26 15:05   ` Hannes Laimer
2026-03-27  9:57     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 06/13] api2: add route map module Stefan Hanreich
2026-03-26 15:07   ` Hannes Laimer
2026-03-27  9:57     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 07/13] api2: add route map entry module Stefan Hanreich
2026-03-26 15:13   ` Hannes Laimer
2026-03-27 10:01     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 08/13] evpn controller: add route_map_{in,out} parameter Stefan Hanreich
2026-03-27 10:44   ` Hannes Laimer
2026-03-27 11:12     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 09/13] sdn: generate route map / prefix list configuration on sdn apply Stefan Hanreich
2026-03-27 10:47   ` Hannes Laimer
2026-03-27 11:13     ` Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 10/13] tests: add simple route map test case Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 11/13] tests: add bgp evpn route map/prefix list testcase Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 12/13] tests: add route map with prefix " Stefan Hanreich
2026-03-25  9:41 ` [PATCH pve-network 13/13] bgp controller: allow configuring custom route maps Stefan Hanreich
2026-03-25 11:38 ` [PATCH cluster/network/proxmox{-ve-rs,-perl-rs} 00/27] Add support for route maps / prefix lists to SDN Stefan Hanreich
2026-03-27 10:17 ` Stefan Hanreich

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260325094142.174364-19-s.hanreich@proxmox.com \
    --to=s.hanreich@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal