From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id A32DD1FF2E0 for ; Mon, 15 Jul 2024 12:16:56 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 6FF141DC; Mon, 15 Jul 2024 12:17:20 +0200 (CEST) From: Christian Ebner To: pbs-devel@lists.proxmox.com Date: Mon, 15 Jul 2024 12:15:57 +0200 Message-Id: <20240715101602.274244-20-c.ebner@proxmox.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240715101602.274244-1-c.ebner@proxmox.com> References: <20240715101602.274244-1-c.ebner@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.021 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [RFC proxmox-backup 19/24] api: config: extend sync job config by sync direction X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" In order for sync jobs to be either pull or push jobs, allow to configure the direction of the job. This implements the required types and methods to parse the configured sync direction, update as well as delete it. Signed-off-by: Christian Ebner --- pbs-api-types/src/jobs.rs | 49 +++++++++++++++++++++++++++++++++++++++ src/api2/config/sync.rs | 9 +++++++ 2 files changed, 58 insertions(+) diff --git a/pbs-api-types/src/jobs.rs b/pbs-api-types/src/jobs.rs index 868702bc0..bdc557787 100644 --- a/pbs-api-types/src/jobs.rs +++ b/pbs-api-types/src/jobs.rs @@ -20,6 +20,8 @@ const_regex! { pub VERIFICATION_JOB_WORKER_ID_REGEX = concatcp!(r"^(", PROXMOX_SAFE_ID_REGEX_STR, r"):"); /// Regex for sync jobs '(REMOTE|\-):REMOTE_DATASTORE:LOCAL_DATASTORE:(?:LOCAL_NS_ANCHOR:)ACTUAL_JOB_ID' pub SYNC_JOB_WORKER_ID_REGEX = concatcp!(r"^(", PROXMOX_SAFE_ID_REGEX_STR, r"|\-):(", PROXMOX_SAFE_ID_REGEX_STR, r"):(", PROXMOX_SAFE_ID_REGEX_STR, r")(?::(", BACKUP_NS_RE, r"))?:"); + /// Regex for sync direction'(pull|push)' + pub SYNC_DIRECTION_REGEX = r"^(pull|push)$"; } pub const JOB_ID_SCHEMA: Schema = StringSchema::new("Job ID.") @@ -498,6 +500,47 @@ pub const TRANSFER_LAST_SCHEMA: Schema = .minimum(1) .schema(); +pub const SYNC_DIRECTION_SCHEMA: Schema = StringSchema::new("Sync job direction (pull|push)") + .format(&ApiStringFormat::Pattern(&SYNC_DIRECTION_REGEX)) + .schema(); + +/// Direction of the sync job, push or pull +#[derive(Clone, Debug, Default, Eq, PartialEq, Ord, PartialOrd, Hash, UpdaterType)] +pub enum SyncDirection { + #[default] + Pull, + Push, +} + +impl ApiType for SyncDirection { + const API_SCHEMA: Schema = SYNC_DIRECTION_SCHEMA; +} + +// used for serialization using `proxmox_serde::forward_serialize_to_display` macro +impl std::fmt::Display for SyncDirection { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + SyncDirection::Pull => f.write_str("pull"), + SyncDirection::Push => f.write_str("push"), + } + } +} + +impl std::str::FromStr for SyncDirection { + type Err = anyhow::Error; + + fn from_str(s: &str) -> Result { + match s { + "pull" => Ok(SyncDirection::Pull), + "push" => Ok(SyncDirection::Push), + _ => bail!("invalid sync direction"), + } + } +} + +proxmox_serde::forward_deserialize_to_from_str!(SyncDirection); +proxmox_serde::forward_serialize_to_display!(SyncDirection); + #[api( properties: { id: { @@ -552,6 +595,10 @@ pub const TRANSFER_LAST_SCHEMA: Schema = schema: TRANSFER_LAST_SCHEMA, optional: true, }, + "sync-direction": { + schema: SYNC_DIRECTION_SCHEMA, + optional: true, + }, } )] #[derive(Serialize, Deserialize, Clone, Updater, PartialEq)] @@ -585,6 +632,8 @@ pub struct SyncJobConfig { pub limit: RateLimitConfig, #[serde(skip_serializing_if = "Option::is_none")] pub transfer_last: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub sync_direction: Option, } impl SyncJobConfig { diff --git a/src/api2/config/sync.rs b/src/api2/config/sync.rs index 6fdc69a9e..fc5e9c148 100644 --- a/src/api2/config/sync.rs +++ b/src/api2/config/sync.rs @@ -231,6 +231,8 @@ pub enum DeletableProperty { MaxDepth, /// Delete the transfer_last property, TransferLast, + /// Delete the sync_direction property (when not set, fallback to default) + SyncDirection, } #[api( @@ -331,6 +333,9 @@ pub fn update_sync_job( DeletableProperty::TransferLast => { data.transfer_last = None; } + DeletableProperty::SyncDirection => { + data.sync_direction = None; + } } } } @@ -368,6 +373,9 @@ pub fn update_sync_job( if let Some(transfer_last) = update.transfer_last { data.transfer_last = Some(transfer_last); } + if let Some(sync_direction) = update.sync_direction { + data.sync_direction = Some(sync_direction); + } if update.limit.rate_in.is_some() { data.limit.rate_in = update.limit.rate_in; @@ -533,6 +541,7 @@ acl:1:/remote/remote1/remotestore1:write@pbs:RemoteSyncOperator schedule: None, limit: pbs_api_types::RateLimitConfig::default(), // no limit transfer_last: None, + sync_direction: Default::default(), }; // should work without ACLs -- 2.39.2 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel