From: Hannes Laimer <h.laimer@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v10 1/6] api-types: add maintenance type
Date: Tue, 12 Apr 2022 05:25:56 +0000 [thread overview]
Message-ID: <20220412052601.4709-2-h.laimer@proxmox.com> (raw)
In-Reply-To: <20220412052601.4709-1-h.laimer@proxmox.com>
+ 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
next prev parent reply other threads:[~2022-04-12 5:26 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-12 5:25 [pbs-devel] [PATCH proxmox-backup v10 0/6] closes #3071: maintenance mode for datastore Hannes Laimer
2022-04-12 5:25 ` Hannes Laimer [this message]
2022-04-12 5:25 ` [pbs-devel] [PATCH proxmox-backup v10 2/6] datastore: add check for maintenance in lookup Hannes Laimer
2022-04-12 5:25 ` [pbs-devel] [PATCH proxmox-backup v10 3/6] pbs-datastore: add active operations tracking Hannes Laimer
2022-04-12 5:25 ` [pbs-devel] [PATCH proxmox-backup v10 4/6] api: make maintenance_type updatable Hannes Laimer
2022-04-12 5:26 ` [pbs-devel] [PATCH proxmox-backup v10 5/6] api: add get_active_operations endpoint Hannes Laimer
2022-04-12 5:26 ` [pbs-devel] [PATCH proxmox-backup v10 6/6] ui: add option to change the maintenance type Hannes Laimer
2022-04-12 5:40 ` [pbs-devel] [PATCH proxmox-backup v10 0/6] closes #3071: maintenance mode for datastore Dylan Whyte
2022-04-12 15:00 ` [pbs-devel] applied-series: " Thomas Lamprecht
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=20220412052601.4709-2-h.laimer@proxmox.com \
--to=h.laimer@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