From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [PATCH proxmox-backup v2 38/43] api/ui: expose default retention setting as datastore config option
Date: Fri, 6 Nov 2026 18:22:30 +0100 [thread overview]
Message-ID: <20261106172235.890542-39-c.ebner@proxmox.com> (raw)
In-Reply-To: <20261106172235.890542-1-c.ebner@proxmox.com>
Allows to set the default retention timespans for the datastore. Used
as fallback for new backups and syncs when no explicit retention is
requested by the client/sync job. The default is always required to
be within the limits of the max. If no max is set, then no default
can be set. This protects against potential misconfiguration.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
src/api2/config/datastore.rs | 39 ++++++++++++++++++++--
www/Makefile | 1 +
www/datastore/OptionView.js | 8 +++++
www/window/DefaultRetentionTimespanEdit.js | 25 ++++++++++++++
4 files changed, 71 insertions(+), 2 deletions(-)
create mode 100644 www/window/DefaultRetentionTimespanEdit.js
diff --git a/src/api2/config/datastore.rs b/src/api2/config/datastore.rs
index 03ff19fc3..d3e710015 100644
--- a/src/api2/config/datastore.rs
+++ b/src/api2/config/datastore.rs
@@ -444,6 +444,8 @@ pub enum DeletableProperty {
MaxSnapshotTimeSkew,
/// Delete the max-retention-timespan
MaxRetentionTimespan,
+ /// Delete the default-retention-timespan
+ DefaultRetentionTimespan,
}
#[api(
@@ -552,7 +554,20 @@ pub fn update_datastore(
DeletableProperty::MaxSnapshotTimeSkew => {
data.max_snapshot_time_skew = None;
}
+ DeletableProperty::DefaultRetentionTimespan => {
+ data.default_retention_timespan = None;
+ }
DeletableProperty::MaxRetentionTimespan => {
+ if update
+ .default_retention_timespan
+ .as_ref()
+ .or(data.default_retention_timespan.as_ref())
+ .is_some()
+ {
+ bail!(
+ "Cannot remove max-retention-timespan while default-retention-timespan still set"
+ );
+ }
data.max_retention_timespan = None;
}
}
@@ -660,8 +675,28 @@ pub fn update_datastore(
data.max_snapshot_time_skew = update.max_snapshot_time_skew;
}
- if update.max_retention_timespan.is_some() {
- data.max_retention_timespan = update.max_retention_timespan;
+ if let Some(max_retention) = update.max_retention_timespan.clone() {
+ let default_retention = update
+ .default_retention_timespan
+ .as_ref()
+ .or(data.default_retention_timespan.as_ref());
+ if let Some(default_retention) = default_retention {
+ if default_retention.as_timespan().as_secs() > max_retention.as_timespan().as_secs() {
+ bail!("New max-retention-timespan smaller than default-retention-timespan");
+ }
+ }
+ data.max_retention_timespan = Some(max_retention);
+ }
+
+ if let Some(default_retention) = update.default_retention_timespan {
+ if let Some(max_retention) = &data.max_retention_timespan {
+ if default_retention.as_timespan().as_secs() > max_retention.as_timespan().as_secs() {
+ bail!("Cannot set default-retention-timespan exceeding max-retention-timespan");
+ }
+ } else {
+ bail!("Cannot set default-retention-timespan without max-retention-timespan");
+ }
+ data.default_retention_timespan = Some(default_retention);
}
config.set_data(&name, "datastore", &data)?;
diff --git a/www/Makefile b/www/Makefile
index 3b2c9a27f..e9696949d 100644
--- a/www/Makefile
+++ b/www/Makefile
@@ -92,6 +92,7 @@ JSSRC= \
window/TrafficControlEdit.js \
window/ThresholdResetScheduleEdit.js \
window/MaxRetentionTimespanEdit.js \
+ window/DefaultRetentionTimespanEdit.js \
window/RetentionEdit.js \
window/NotifyOptions.js \
window/SyncJobEdit.js \
diff --git a/www/datastore/OptionView.js b/www/datastore/OptionView.js
index cf23063d4..ab15ed47b 100644
--- a/www/datastore/OptionView.js
+++ b/www/datastore/OptionView.js
@@ -400,5 +400,13 @@ Ext.define('PBS.Datastore.Options', {
xtype: 'pbsMaxRetentionTimespanEdit',
},
},
+ 'default-retention-timespan': {
+ required: true,
+ header: gettext('Default Retention'),
+ renderer: (timespan) => timespan ?? gettext('None'),
+ editor: {
+ xtype: 'pbsDefaultRetentionTimespanEdit',
+ },
+ },
},
});
diff --git a/www/window/DefaultRetentionTimespanEdit.js b/www/window/DefaultRetentionTimespanEdit.js
new file mode 100644
index 000000000..ae88a25d7
--- /dev/null
+++ b/www/window/DefaultRetentionTimespanEdit.js
@@ -0,0 +1,25 @@
+Ext.define('PBS.window.DefaultRetentionTimespanEdit', {
+ extend: 'Proxmox.window.Edit',
+ alias: 'widget.pbsDefaultRetentionTimespanEdit',
+ mixins: ['Proxmox.Mixin.CBind'],
+
+ subject: gettext('Default Retention Timespan'),
+
+ cbindData: function (initial) {
+ let me = this;
+
+ me.datastore = encodeURIComponent(me.datastore);
+ me.url = `/api2/extjs/config/datastore/${me.datastore}`;
+ me.method = 'PUT';
+ me.autoLoad = true;
+ return {};
+ },
+
+ items: {
+ xtype: 'pbsRetentionTimespan',
+ name: 'default-retention-timespan',
+ fieldLabel: gettext('Retention Timespan'),
+ labelWidth: 150,
+ emptyText: gettext('None'),
+ },
+});
--
2.47.3
next prev parent reply other threads:[~2026-11-06 17:24 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-06 17:21 [PATCH proxmox{-widget-toolkit,,-backup} v2 00/43] append-only sync jobs and snapshot retention timespan Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 01/43] form: date time field: init with now instead of epoch on empty fields Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 02/43] form: date time field: set min/max value limits passed via config Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 03/43] form: date time field: update to new limits when switching day/time Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 04/43] form: date time field: submit combined datetime instead of item fields Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 05/43] form: date time field: track value like other form fields Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox v2 06/43] pbs-api-types: add append only privilege and role Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox v2 07/43] pbs-api-types: add remote datastore append " Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox v2 08/43] pbs-api-types: extend snapshot list items by retention timestamp Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox v2 09/43] pbs-api-types: extend sync job config by retention-timespan parameter Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox v2 10/43] pbs-api-types: add max/default retention timespan property to datastore Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox v2 11/43] pbs-api-types: store: expose max/default retention timespans in status Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 12/43] config/tools: add new fields for sync and snapshot/datastore list items Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 13/43] api: admin: improve code style for status endpoint Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 14/43] client: avoid error in status if user lacks permissions Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 15/43] server: allow iterating contents for Datastore.Append permissions Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 16/43] api: backup: fix possible information leak in multi-tenant datastores Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 17/43] datastore: s3: fix namespace level bulk remove not honoring group locks Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 18/43] api: backup: allow backup for user/token with append permission Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 19/43] api: allow namespace creation on append permissions Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 20/43] api: sync: allow pull to target for user/token with append permission Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 21/43] sync: pull: allow pulling " Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 22/43] sync: push: allow push and ns creation on Remote.DatastoreAppend Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 23/43] datastore: conditionally treat missing manifest as error or benign Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 24/43] api: backup: provide retain-until timestamp for extended prune protection Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 25/43] tools: include retain-until timestamp in snapshot list items Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 26/43] client: backup writer: allow to send retain-until timestamp on backup Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 27/43] sync: push: allow to set retention timestamp for synced snapshots Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 28/43] sync: pull: set retention timestamp from sync job for new snapshots Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 29/43] datastore/config: parse and enforce maximum retention timespan Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 30/43] api: config: allow to set or delete retention timespan for sync jobs Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 31/43] api: admin: allow to modify snapshot retention for root user Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 32/43] tape/s3-refresh: check for retentions outside datastore limits Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 33/43] ui: add retention timespan form and use it for sync job edit window Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 34/43] ui: allow datastore wide max retention timespan configuration Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 35/43] ui: show snapshot retention in datastore contents and allow extension Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 36/43] group: destroy: s3: skip snapshots with active retentions Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 37/43] prune: " Christian Ebner
2026-11-06 17:22 ` Christian Ebner [this message]
2026-11-06 17:22 ` [PATCH proxmox-backup v2 39/43] api: datastore: expose max/default retention timespans in status listing Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 40/43] backup/sync: fallback to datastore default-retention-timespan Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 41/43] client: add flags to set snapshot retention via timestamp/timespan Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 42/43] docs: describe the privileges and roles for append only backup/sync Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 43/43] docs: document snapshot retention for new backup snapshots Christian Ebner
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=20261106172235.890542-39-c.ebner@proxmox.com \
--to=c.ebner@proxmox.com \
--cc=pbs-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