public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Arthur Bied-Charreton <a.bied-charreton@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH pve-firewall v7 07/28] firewall: ipset: add option to handle dangling references on rename
Date: Thu, 12 Nov 2026 16:10:24 +0100	[thread overview]
Message-ID: <20261112151045.577923-8-a.bied-charreton@proxmox.com> (raw)
In-Reply-To: <20261112151045.577923-1-a.bied-charreton@proxmox.com>

Renaming an ipset still referenced by rules leaves dangling references.
The firewall then fails to parse those rules during compilation and
drops them. A rename can therefore effectively disable a whole set of
rules.

Add a 'dangling-references' option to the rename path offering to
'keep' the references around, 'disable' the referencing rules, 'drop'
them, or to 'rename' the references to the new name. For cluster
ipsets, this also covers references in downstream configs (host, guest
and vnet).

A rename that fails partway leaves both the old and the new ipset in
the cluster config. Retrying it chokes on the check against
overwriting an existing ipset. 'force-rename' bypasses that check, so
an interrupted rename can be finished. Avoiding the half-updated state
altogether would need either a transaction across every config in the
cluster or a rollback mechanism, neither of which is really an option
here.

Signed-off-by: Arthur Bied-Charreton <a.bied-charreton@proxmox.com>
---
 src/PVE/API2/Firewall/IPSet.pm | 66 +++++++++++++++++++++++++++-------
 src/PVE/Firewall.pm            | 24 +++++++++++++
 2 files changed, 78 insertions(+), 12 deletions(-)

diff --git a/src/PVE/API2/Firewall/IPSet.pm b/src/PVE/API2/Firewall/IPSet.pm
index 82b9aaf..9d3c562 100644
--- a/src/PVE/API2/Firewall/IPSet.pm
+++ b/src/PVE/API2/Firewall/IPSet.pm
@@ -534,6 +534,7 @@ package PVE::API2::Firewall::BaseIPSetList;
 
 use strict;
 use warnings;
+use PVE::Firewall::References qw(update_refs);
 use PVE::JSONSchema qw(get_standard_option);
 use PVE::Exception qw(raise_param_exc);
 use PVE::Firewall;
@@ -661,6 +662,9 @@ sub register_create {
         },
     );
 
+    $properties->{'dangling-references'} = get_standard_option('pve-dangling-references-rename');
+    $properties->{'force-rename'} = get_standard_option('pve-dangling-references-force-rename');
+
     $class->register_method({
         name => 'create_ipset',
         path => '',
@@ -681,6 +685,11 @@ sub register_create {
                 sub {
                     my ($param) = @_;
 
+                    my $dangling_refs = $param->{'dangling-references'}
+                        // $properties->{'dangling-references'}->{default};
+                    my $force = $param->{'force-rename'}
+                        // $properties->{'force-rename'}->{default};
+
                     my ($cluster_conf, $fw_conf) = $class->load_config($param);
 
                     if ($param->{rename}) {
@@ -690,19 +699,52 @@ sub register_create {
                         raise_param_exc({ name => "IPSet '$param->{rename}' does not exist" })
                             if !$fw_conf->{ipset}->{ $param->{rename} };
 
-                        # prevent overwriting existing ipset
-                        raise_param_exc({ name => "IPSet '$param->{name}' does already exist" })
-                            if $fw_conf->{ipset}->{ $param->{name} }
-                            && $param->{name} ne $param->{rename};
-
-                        my $data = delete $fw_conf->{ipset}->{ $param->{rename} };
-                        $fw_conf->{ipset}->{ $param->{name} } = $data;
-                        if (
-                            my $comment =
-                            delete $fw_conf->{ipset_comments}->{ $param->{rename} }
-                        ) {
-                            $fw_conf->{ipset_comments}->{ $param->{name} } = $comment;
+                        if ($param->{name} ne $param->{rename}) {
+                            # prevent overwriting existing ipset
+                            raise_param_exc({ name => "IPSet '$param->{name}' already exists" })
+                                if $fw_conf->{ipset}->{ $param->{name} }
+                                && !$force;
+
+                            $fw_conf->{ipset}->{ $param->{name} } =
+                                $fw_conf->{ipset}->{ $param->{rename} };
+
+                            my $saved = 0;
+                            my $save = sub {
+                                $class->save_config($param, $fw_conf);
+                                $saved = 1;
+                            };
+
+                            eval {
+                                update_refs({
+                                    conf => $fw_conf,
+                                    kind => 'ipset',
+                                    old => $param->{rename},
+                                    new => $param->{name},
+                                    env => $class->rule_env(),
+                                    action => $dangling_refs eq 'keep' ? undef : $dangling_refs,
+                                    subject =>
+                                        "ipset '$param->{rename}' renamed to '$param->{name}'",
+                                    save => $save,
+                                });
+                            };
+                            if (my $err = $@) {
+                                die "rename interrupted, the IPSet exists under both names; "
+                                    . "retry with 'force-rename' to finish: $err"
+                                    if $saved;
+                                die "could not update references to IPSet "
+                                    . "'$param->{rename}': $err";
+                            }
+
+                            delete $fw_conf->{ipset}->{ $param->{rename} };
+
+                            if (
+                                my $comment =
+                                delete $fw_conf->{ipset_comments}->{ $param->{rename} }
+                            ) {
+                                $fw_conf->{ipset_comments}->{ $param->{name} } = $comment;
+                            }
                         }
+
                         $fw_conf->{ipset_comments}->{ $param->{name} } = $param->{comment}
                             if defined($param->{comment});
                     } else {
diff --git a/src/PVE/Firewall.pm b/src/PVE/Firewall.pm
index 6ce5306..d4e1ad9 100644
--- a/src/PVE/Firewall.pm
+++ b/src/PVE/Firewall.pm
@@ -210,6 +210,30 @@ PVE::JSONSchema::register_standard_option(
     },
 );
 
+PVE::JSONSchema::register_standard_option(
+    'pve-dangling-references-rename',
+    {
+        type => 'string',
+        enum => ['keep', 'disable', 'drop', 'rename'],
+        optional => 1,
+        description => "Handle references that renaming this object would leave dangling. Use "
+            . "'rename' to point them at the new name, 'disable' to disable the referencing rules, or "
+            . "'drop' to remove them entirely.",
+        default => 'keep',
+    },
+);
+
+PVE::JSONSchema::register_standard_option(
+    'pve-dangling-references-force-rename',
+    {
+        type => 'boolean',
+        optional => 1,
+        description => "Go on with the rename even if an object with the target name already "
+            . "exists, overwriting it. 'dangling-references' is still applied the same.",
+        default => 0,
+    },
+);
+
 my $feature_ipset_nomatch = 0;
 eval {
     my (undef, undef, $release) = POSIX::uname();
-- 
2.47.3





  parent reply	other threads:[~2026-11-12 15:12 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-12 15:10 [PATCH container/docs/firewall/manager/network/qemu-server v7 00/28] handle dangling references when firewall objects go away Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 01/28] firewall: run make tidy Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 02/28] firewall: move object reference helpers to their own module Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 03/28] firewall: references: add helpers to update object references Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 04/28] firewall: references: log the references an object update touched Arthur Bied-Charreton
2026-11-13  7:15   ` Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 05/28] firewall: references: add wrappers for the SDN-generated IPSets Arthur Bied-Charreton
2026-11-13  7:19   ` Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 06/28] firewall: parser: do not log errors for disabled rules Arthur Bied-Charreton
2026-11-12 15:10 ` Arthur Bied-Charreton [this message]
2026-11-12 15:10 ` [PATCH pve-firewall v7 08/28] firewall: ipset: add option to handle dangling references on delete Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 09/28] firewall: aliases: add option to handle dangling references on rename Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 10/28] firewall: aliases: add option to handle dangling references on delete Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 11/28] firewall: api: run reference updates as tasks Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 12/28] firewall: tests: add tests for object reference updates Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 13/28] firewall: references: handle security groups Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 14/28] firewall: groups: add option to handle dangling references on rename Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-firewall v7 15/28] fix #8176: firewall: groups: handle dangling references on delete Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-network v7 16/28] apply: add option to handle dangling references on VNet deletion Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH qemu-server v7 17/28] api: destroy_vm: add option to handle dangling IPSet references Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-container v7 18/28] " Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-manager v7 19/28] ui: firewall: add a common widget for handling dangling references Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-manager v7 20/28] ui: firewall: ipset: add controls for " Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-manager v7 21/28] ui: firewall: aliases: " Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-manager v7 22/28] ui: sdn: apply: add control for dangling IPSet references Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-manager v7 23/28] ui: guest destroy: use let for non-constant variable bindings Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-manager v7 24/28] ui: guest destroy: add control for dangling IPSet references Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-manager v7 25/28] ui: firewall: show the task for reference updates Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-manager v7 26/28] ui: firewall: groups: add controls for dangling references Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-docs v7 27/28] firewall: remove trailing spaces Arthur Bied-Charreton
2026-11-12 15:10 ` [PATCH pve-docs v7 28/28] firewall: document renaming and removing objects Arthur Bied-Charreton

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=20261112151045.577923-8-a.bied-charreton@proxmox.com \
    --to=a.bied-charreton@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