[pve-devel] [PATCH manager v2] api: workaround broken 'maxworkers' alias in bulk actions api calls

* [pve-devel] [PATCH manager v2] api: workaround broken 'maxworkers' alias in bulk actions api calls
@ 2025-12-05 10:02 Dominik Csapak
  2025-12-05 10:18 ` Dominik Csapak
  0 siblings, 1 reply; 2+ messages in thread
From: Dominik Csapak @ 2025-12-05 10:02 UTC (permalink / raw)
  To: pve-devel

It seems, that 'alias' schema does not properly work currently for
normal schema definitions (only for property-string), since it does not
verification of the actual schema (checked by calling the api with
maxworkers=1000, which throws no errors). Luckily, this is the only use
of alias for api parameters that I could find. For the new cluster wide
api calls it did not do anything, since we did not actually use
`$param->{maxworkers}`, but for the node specific one broke the UI,
since there we still send 'maxworkers', but the backend did not use that
anymore.

In the long term, we should fix it in JSONSchema, but as a stop-gap,
restore the old 'maxworkers' parameters to a 'real' property and mark it
deprecated.

Also actually use it in the code and fix the error message to the new
variant.

Reported in the forums for the node-specific one:
https://forum.proxmox.com/threads/bulk-migrate-error-in-9-1-2.177326/

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
changes from v1:
* improve commit message/subject
* fix wrong default for the cluster-wide migrate api

 PVE/API2/Cluster/BulkAction/Guest.pm | 33 ++++++++++++++++++++++++----
 PVE/API2/Nodes.pm                    | 14 ++++++++----
 2 files changed, 39 insertions(+), 8 deletions(-)

diff --git a/PVE/API2/Cluster/BulkAction/Guest.pm b/PVE/API2/Cluster/BulkAction/Guest.pm
index 3a53ca60..a55ea2ea 100644
--- a/PVE/API2/Cluster/BulkAction/Guest.pm
+++ b/PVE/API2/Cluster/BulkAction/Guest.pm
@@ -251,6 +251,7 @@ sub get_max_workers {
     my ($param, $default) = @_;
 
     return $param->{'max-workers'} if $param->{'max-workers'};
+    return $param->{maxworkers} if $param->{maxworkers}; # alias
 
     my $datacenter_config = PVE::Cluster::cfs_read_file('datacenter.cfg');
     return $datacenter_config->{max_workers} if $datacenter_config->{max_workers};
@@ -286,7 +287,13 @@ __PACKAGE__->register_method({
                 optional => 1,
             },
             maxworkers => {
-                alias => 'max-workers',
+                description => "Defines the maximum number of tasks running concurrently."
+                    . " Deprecated, use 'max-workers' instead.",
+                optional => 1,
+                default => 4,
+                type => 'integer',
+                minimum => 1,
+                maximum => 64,
             },
             'max-workers' => {
                 description => "Defines the maximum number of tasks running concurrently.",
@@ -422,7 +429,13 @@ __PACKAGE__->register_method({
                 optional => 1,
             },
             maxworkers => {
-                alias => 'max-workers',
+                description => "Defines the maximum number of tasks running concurrently."
+                    . " Deprecated, use 'max-workers' instead.",
+                optional => 1,
+                default => 4,
+                type => 'integer',
+                minimum => 1,
+                maximum => 64,
             },
             'max-workers' => {
                 description => "Defines the maximum number of tasks running concurrently.",
@@ -567,7 +580,13 @@ __PACKAGE__->register_method({
                 optional => 1,
             },
             maxworkers => {
-                alias => 'max-workers',
+                description => "Defines the maximum number of tasks running concurrently."
+                    . " Deprecated, use 'max-workers' instead.",
+                optional => 1,
+                default => 4,
+                type => 'integer',
+                minimum => 1,
+                maximum => 64,
             },
             'max-workers' => {
                 description => "Defines the maximum number of tasks running concurrently.",
@@ -704,7 +723,13 @@ __PACKAGE__->register_method({
                 optional => 1,
             },
             maxworkers => {
-                alias => 'max-workers',
+                description => "Defines the maximum number of tasks running concurrently."
+                    . " Deprecated, use 'max-workers' instead.",
+                optional => 1,
+                default => 1,
+                type => 'integer',
+                minimum => 1,
+                maximum => 64,
             },
             'max-workers' => {
                 description => "Defines the maximum number of tasks running concurrently.",
diff --git a/PVE/API2/Nodes.pm b/PVE/API2/Nodes.pm
index 3ca1c319..6a6465b6 100644
--- a/PVE/API2/Nodes.pm
+++ b/PVE/API2/Nodes.pm
@@ -2559,7 +2559,13 @@ __PACKAGE__->register_method({
             node => get_standard_option('pve-node'),
             target => get_standard_option('pve-node', { description => "Target node." }),
             maxworkers => {
-                alias => 'max-workers',
+                description => "Maximal number of parallel migration job. If not set, uses"
+                    . "'max_workers' from datacenter.cfg. One of both must be set!"
+                    . "Deprecated, use 'max-workers' instead.",
+                optional => 1,
+                type => 'integer',
+                minimum => 1,
+                maximum => 64,
             },
             'max-workers' => {
                 description => "Maximal number of parallel migration job. If not set, uses"
@@ -2613,10 +2619,10 @@ __PACKAGE__->register_method({
 
         my $datacenterconfig = cfs_read_file('datacenter.cfg');
         # prefer parameter over datacenter cfg settings
-        my $max_workers =
-            $param->{'max-workers'}
+        my $max_workers = $param->{'max-workers'}
+            || $param->{'maxworkers'} # alias
             || $datacenterconfig->{max_workers}
-            || die "either 'maxworkers' parameter or max_workers in datacenter.cfg must be set!\n";
+            || die "either 'max-workers' parameter or max_workers in datacenter.cfg must be set!\n";
 
         my $code = sub {
             $rpcenv->{type} = 'priv'; # to start tasks in background
-- 
2.47.3



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


^ permalink raw reply	[flat|nested] 2+ messages in thread