From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [45.144.208.40]) by lore.proxmox.com (Postfix) with ESMTPS id 277F71FF0E7 for ; Thu, 13 Aug 2026 19:10:44 +0200 (CEST) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id ACF8921A6C; Thu, 13 Aug 2026 19:10:35 +0200 (CEST) From: Christian Ebner To: pbs-devel@lists.proxmox.com Subject: [PATCH proxmox 04/28] pbs-api-types: extend sync job config by retention-timespan parameter Date: Thu, 13 Aug 2026 19:09:38 +0200 Message-ID: <20260813171002.809441-5-c.ebner@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260813171002.809441-1-c.ebner@proxmox.com> References: <20260813171002.809441-1-c.ebner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1786641013501 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.217 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust RDNS_NONE 1.274 Delivered to internal network by a host with no rDNS SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: HVIKZ2A7WNKYDI5CRLY7W4IHZALTVRWM X-Message-ID-Hash: HVIKZ2A7WNKYDI5CRLY7W4IHZALTVRWM X-MailFrom: c.ebner@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox Backup Server development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Allows to configure a sync job which sets a retention timestamp on synced snapshots based on the start time of the sync. Signed-off-by: Christian Ebner --- pbs-api-types/src/jobs.rs | 64 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/pbs-api-types/src/jobs.rs b/pbs-api-types/src/jobs.rs index 9a5d2b77..6aa4e3a0 100644 --- a/pbs-api-types/src/jobs.rs +++ b/pbs-api-types/src/jobs.rs @@ -1,7 +1,8 @@ -use std::str::FromStr; +use std::{fmt, str::FromStr}; use anyhow::bail; use const_format::concatcp; +use proxmox_time::TimeSpan; use regex::Regex; use serde::{Deserialize, Serialize}; @@ -94,6 +95,61 @@ pub const SYNC_WORKER_THREADS_SCHEMA: Schema = threads_schema( 1, ); +pub const RETENTION_TIMESPAN_FORMAT: ApiStringFormat = ApiStringFormat::VerifyFn(|s| { + RetentionTimespan::from_str(s)?; + Ok(()) +}); + +pub const RETENTION_TIMESPAN_SCHEMA: Schema = StringSchema::new("Retention timespan") + .format(&RETENTION_TIMESPAN_FORMAT) + .schema(); + +#[derive(Clone, Debug, PartialEq, UpdaterType)] +pub struct RetentionTimespan { + timespan: TimeSpan, +} + +impl std::str::FromStr for RetentionTimespan { + type Err = anyhow::Error; + + fn from_str(s: &str) -> Result { + let timespan: TimeSpan = s.parse()?; + if timespan.subsec_nanos() > 0 { + bail!("Sub-second precision not supported by retention timespan"); + } + Ok(Self { timespan }) + } +} + +impl fmt::Display for RetentionTimespan { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "{}", self.timespan) + } +} + +impl ApiType for RetentionTimespan { + const API_SCHEMA: Schema = RETENTION_TIMESPAN_SCHEMA; +} + +impl RetentionTimespan { + /// Provide the retention timespan as plain timespan + pub fn as_timespan(&self) -> &TimeSpan { + &self.timespan + } + + /// Calculate the unix epoch for given retenition timespan relative to now from system time. + pub fn to_timestamp_from_systemtime(&self) -> Result { + // no sub-second precision allowed by parser, safe to skip + match proxmox_time::epoch_i64().checked_add_unsigned(self.timespan.as_secs()) { + Some(timestamp) => Ok(timestamp), + None => bail!("retention timestamp calculation failed with overflow"), + } + } +} + +serde_plain::derive_serialize_from_display!(RetentionTimespan); +serde_plain::derive_deserialize_from_fromstr!(RetentionTimespan, "retention timespan"); + #[api( properties: { "next-run": { @@ -690,6 +746,10 @@ pub const UNMOUNT_ON_SYNC_DONE_SCHEMA: Schema = }, optional: true, }, + "retention-timespan": { + type: RetentionTimespan, + optional: true, + }, } )] #[derive(Serialize, Deserialize, Clone, Updater, PartialEq)] @@ -741,6 +801,8 @@ pub struct SyncJobConfig { pub active_encryption_key: Option, #[serde(skip_serializing_if = "Option::is_none")] pub associated_key: Option>, + #[serde(skip_serializing_if = "Option::is_none")] + pub retention_timespan: Option, } impl SyncJobConfig { -- 2.47.3