From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 1E06E638A7 for ; Tue, 15 Feb 2022 13:11:21 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1210D2CC80 for ; Tue, 15 Feb 2022 13:10:51 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id B2FEF2CC6A for ; Tue, 15 Feb 2022 13:10:49 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 74B7C41671 for ; Tue, 15 Feb 2022 13:10:49 +0100 (CET) From: Hannes Laimer To: pbs-devel@lists.proxmox.com Date: Tue, 15 Feb 2022 12:10:34 +0000 Message-Id: <20220215121039.19168-2-h.laimer@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220215121039.19168-1-h.laimer@proxmox.com> References: <20220215121039.19168-1-h.laimer@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.044 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% 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 T_SCC_BODY_TEXT_LINE -0.01 - URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [maintenance.rs, lib.rs, datastore.rs] Subject: [pbs-devel] [PATCH proxmox-backup v8 1/6] api-types: add maintenance type 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: , X-List-Received-Date: Tue, 15 Feb 2022 12:11:21 -0000 Signed-off-by: Hannes Laimer --- pbs-api-types/src/datastore.rs | 26 +++++++++++--- pbs-api-types/src/lib.rs | 3 ++ pbs-api-types/src/maintenance.rs | 59 ++++++++++++++++++++++++++++++++ 3 files changed, 84 insertions(+), 4 deletions(-) create mode 100644 pbs-api-types/src/maintenance.rs diff --git a/pbs-api-types/src/datastore.rs b/pbs-api-types/src/datastore.rs index 36279b3a..e765aed3 100644 --- a/pbs-api-types/src/datastore.rs +++ b/pbs-api-types/src/datastore.rs @@ -6,10 +6,9 @@ use proxmox_schema::{ }; use crate::{ - PROXMOX_SAFE_ID_FORMAT, SHA256_HEX_REGEX, SINGLE_LINE_COMMENT_SCHEMA, CryptMode, UPID, - Fingerprint, Userid, Authid, - GC_SCHEDULE_SCHEMA, DATASTORE_NOTIFY_STRING_SCHEMA, PRUNE_SCHEDULE_SCHEMA, - + Authid, CryptMode, Fingerprint, MaintenanceMode, Userid, DATASTORE_NOTIFY_STRING_SCHEMA, + GC_SCHEDULE_SCHEMA, PROXMOX_SAFE_ID_FORMAT, PRUNE_SCHEDULE_SCHEMA, SHA256_HEX_REGEX, + SINGLE_LINE_COMMENT_SCHEMA, UPID, }; const_regex!{ @@ -224,6 +223,11 @@ pub struct PruneOptions { optional: true, type: bool, }, + "maintenance-mode": { + optional: true, + format: &ApiStringFormat::PropertyString(&MaintenanceMode::API_SCHEMA), + type: String, + }, } )] #[derive(Serialize,Deserialize,Updater)] @@ -261,6 +265,20 @@ pub struct DataStoreConfig { /// Send notification only for job errors #[serde(skip_serializing_if="Option::is_none")] pub notify: Option, + /// Maintenance mode, type is either 'offline' or 'read-only', message has to be URL encoded + #[serde(skip_serializing_if = "Option::is_none")] + pub maintenance_mode: Option, +} + +impl DataStoreConfig { + pub fn get_maintenance_mode(&self) -> Option { + self.maintenance_mode + .as_ref() + .map(|str| MaintenanceMode::API_SCHEMA.parse_property_string(str).ok()) + .flatten() + .map(|value| MaintenanceMode::deserialize(value).ok()) + .flatten() + } } #[api( diff --git a/pbs-api-types/src/lib.rs b/pbs-api-types/src/lib.rs index 754e7b22..efb01c3e 100644 --- a/pbs-api-types/src/lib.rs +++ b/pbs-api-types/src/lib.rs @@ -49,6 +49,9 @@ pub use jobs::*; mod key_derivation; pub use key_derivation::{Kdf, KeyInfo}; +mod maintenance; +pub use maintenance::*; + mod network; pub use network::*; diff --git a/pbs-api-types/src/maintenance.rs b/pbs-api-types/src/maintenance.rs new file mode 100644 index 00000000..2926d32d --- /dev/null +++ b/pbs-api-types/src/maintenance.rs @@ -0,0 +1,59 @@ +use serde::{Deserialize, Serialize}; + +use proxmox_schema::{api, ApiStringFormat, const_regex, Schema, StringSchema}; + +const_regex!{ + pub MAINTENANCE_MESSAGE_REGEX = r"^[a-zA-Z0-9%]*$"; +} + +pub const MAINTENANCE_MESSAGE_FORMAT: ApiStringFormat = + ApiStringFormat::Pattern(&MAINTENANCE_MESSAGE_REGEX); + + +pub const MAINTENANCE_MESSAGE_SCHEMA: Schema = + StringSchema::new("URL encoded message describing the reason for the maintenance.") + .format(&MAINTENANCE_MESSAGE_FORMAT) + .max_length(32) + .schema(); + +#[derive(Clone, Copy, Debug)] +/// Operation requirements, used when checking for maintenance mode. +pub enum Operation { + Read, + Write, +} + +#[api] +#[derive(Deserialize, Serialize)] +#[serde(rename_all="kebab-case")] +/// Maintenance type. +pub enum MaintenanceType { + /// Only reading operations are allowed on the datastore. + ReadOnly, + /// Neither reading nor writing operations are allowed on the datastore. + Offline, +} + +#[api( + properties: { + type: { + type: MaintenanceType, + }, + message: { + optional: true, + schema: MAINTENANCE_MESSAGE_SCHEMA, + } + }, + default_key: "type", +)] +#[derive(Deserialize, Serialize)] +/// Maintenance mode +pub struct MaintenanceMode { + /// Type of the maintenance + #[serde(rename = "type")] + ty: MaintenanceType, + + /// Reason for the maintenance mode. + #[serde(skip_serializing_if = "Option::is_none")] + message: Option, +} -- 2.30.2