From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <h.laimer@proxmox.com>
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 3B1A7C88E
for <pbs-devel@lists.proxmox.com>; Tue, 12 Apr 2022 07:26:44 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 1AEBFA954
for <pbs-devel@lists.proxmox.com>; Tue, 12 Apr 2022 07:26:14 +0200 (CEST)
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))
(No client certificate requested)
by firstgate.proxmox.com (Proxmox) with ESMTPS id 2ED26A93E
for <pbs-devel@lists.proxmox.com>; Tue, 12 Apr 2022 07:26:13 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 0855140FE9
for <pbs-devel@lists.proxmox.com>; Tue, 12 Apr 2022 07:26:13 +0200 (CEST)
From: Hannes Laimer <h.laimer@proxmox.com>
To: pbs-devel@lists.proxmox.com
Date: Tue, 12 Apr 2022 05:25:56 +0000
Message-Id: <20220412052601.4709-2-h.laimer@proxmox.com>
X-Mailer: git-send-email 2.30.2
In-Reply-To: <20220412052601.4709-1-h.laimer@proxmox.com>
References: <20220412052601.4709-1-h.laimer@proxmox.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.036 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. [lib.rs, datastore.rs, maintenance.rs]
Subject: [pbs-devel] [PATCH proxmox-backup v10 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
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Tue, 12 Apr 2022 05:26:44 -0000
+ bump proxmox-schema dep to 1.2.1 (for quoted property string)
Signed-off-by: Hannes Laimer <h.laimer@proxmox.com>
---
pbs-api-types/Cargo.toml | 2 +-
pbs-api-types/src/datastore.rs | 23 +++++++++++--
pbs-api-types/src/lib.rs | 3 ++
pbs-api-types/src/maintenance.rs | 59 ++++++++++++++++++++++++++++++++
4 files changed, 83 insertions(+), 4 deletions(-)
create mode 100644 pbs-api-types/src/maintenance.rs
diff --git a/pbs-api-types/Cargo.toml b/pbs-api-types/Cargo.toml
index e89c217b..485aee8b 100644
--- a/pbs-api-types/Cargo.toml
+++ b/pbs-api-types/Cargo.toml
@@ -14,7 +14,7 @@ regex = "1.5.5"
serde = { version = "1.0", features = ["derive"] }
proxmox-lang = "1.0.0"
-proxmox-schema = { version = "1.1", features = [ "api-macro" ] }
+proxmox-schema = { version = "1.2.1", features = [ "api-macro" ] }
proxmox-serde = "0.1"
proxmox-time = "1.1.1"
proxmox-uuid = { version = "1.0.0", features = [ "serde" ] }
diff --git a/pbs-api-types/src/datastore.rs b/pbs-api-types/src/datastore.rs
index ea60e023..01e2319a 100644
--- a/pbs-api-types/src/datastore.rs
+++ b/pbs-api-types/src/datastore.rs
@@ -6,9 +6,9 @@ use proxmox_schema::{
};
use crate::{
- Authid, CryptMode, Fingerprint, Userid, DATASTORE_NOTIFY_STRING_SCHEMA, GC_SCHEDULE_SCHEMA,
- PROXMOX_SAFE_ID_FORMAT, PRUNE_SCHEDULE_SCHEMA, SHA256_HEX_REGEX, SINGLE_LINE_COMMENT_SCHEMA,
- UPID,
+ 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! {
@@ -262,6 +262,11 @@ pub const DATASTORE_TUNING_STRING_SCHEMA: Schema = StringSchema::new("Datastore
optional: true,
schema: DATASTORE_TUNING_STRING_SCHEMA,
},
+ "maintenance-mode": {
+ optional: true,
+ format: &ApiStringFormat::PropertyString(&MaintenanceMode::API_SCHEMA),
+ type: String,
+ },
}
)]
#[derive(Serialize, Deserialize, Updater)]
@@ -302,6 +307,18 @@ pub struct DataStoreConfig {
/// Datastore tuning options
#[serde(skip_serializing_if = "Option::is_none")]
pub tuning: Option<String>,
+ /// Maintenance mode, type is either 'offline' or 'read-only', message should be enclosed in "
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub maintenance_mode: Option<String>,
+}
+
+impl DataStoreConfig {
+ pub fn get_maintenance_mode(&self) -> Option<MaintenanceMode> {
+ self.maintenance_mode
+ .as_ref()
+ .and_then(|str| MaintenanceMode::API_SCHEMA.parse_property_string(str).ok())
+ .and_then(|value| MaintenanceMode::deserialize(value).ok())
+ }
}
#[api(
diff --git a/pbs-api-types/src/lib.rs b/pbs-api-types/src/lib.rs
index 03119f4a..d121d26e 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..9b74e9b9
--- /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"^[[:^cntrl:]]*$";
+}
+
+pub const MAINTENANCE_MESSAGE_FORMAT: ApiStringFormat =
+ ApiStringFormat::Pattern(&MAINTENANCE_MESSAGE_REGEX);
+
+
+pub const MAINTENANCE_MESSAGE_SCHEMA: Schema =
+ StringSchema::new("Message describing the reason for the maintenance.")
+ .format(&MAINTENANCE_MESSAGE_FORMAT)
+ .max_length(64)
+ .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 read operations are allowed on the datastore.
+ ReadOnly,
+ /// Neither read nor write 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 maintenance ("read-only" or "offline").
+ #[serde(rename = "type")]
+ ty: MaintenanceType,
+
+ /// Reason for maintenance.
+ #[serde(skip_serializing_if = "Option::is_none")]
+ message: Option<String>,
+}
--
2.30.2