add storage URI type, make them transparent

Author: korewaChino

Cargo.lock

@@ -34,6 +34,7 @@ odorobo-manager = { path = "odorobo-manager" }
 dotenvy = "0.15"
 clap = { version = "4", features = ["derive", "env"] }
 ipnet = {version = "2.12.0", features = ["serde", "schemars08"]}
+url = { version = "2.3", features = ["serde"] }
 # these are for performance optimizations, based on https://nnethercote.github.io/perf-book/build-configuration.html#optimization-level
 # these options can take a while to compile (up to 5-10 minutes), so its really only necessary for production binaries.
 # also look in .cargo/config.toml for info on microarchitecture optimizations.

Cargo.toml

@@ -33,6 +33,7 @@ ulid = { workspace = true }
 libp2p = { version = "0.56.0", features = ["yamux", "serde", "mdns"] }
 reqwest = { version = "0.13", features = ["json"] }
 ahash = { version = "0.8.12", features = ["serde"] }
+url = { workspace = true }
 # utoipa = { version = "5.4.0", features = ["uuid"] }
 odorobo-shared = { workspace = true }
 stable-eyre = { workspace = true }

odorobo-manager/Cargo.toml

@@ -36,13 +36,31 @@ mod opt_bytesize_as_u64 {
 
 // Newtype so aide can generate a path parameter schema for Ulid.
 /// VM ID, in the format of ULID
+#[repr(transparent)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema, OperationIo, Default, Clone)]
 pub struct VmId(#[schemars(with = "String")] pub Ulid);
 
 /// Volume ID, in the format of ULID
+#[repr(transparent)]
 #[derive(Serialize, Deserialize, Debug, JsonSchema, OperationIo, Default, Clone)]
 pub struct VolumeId(#[schemars(with = "String")] pub Ulid);
 
+/// A URI pointing to the volume's location, e.g an iSCSI URL in `iscsi-inq` format, a local file, or an RBD image.
+/// 
+/// examples:
+/// - `iscsi://[<username>[%<password>]@]<host>[:<port>]/<target-iqn-name>/<lun>`
+/// - `file:///path/to/volume.img`
+/// - `rbd://<pool>/<image>`
+#[repr(transparent)]
+#[derive(Serialize, Deserialize, Debug, JsonSchema, OperationIo, Clone)]
+pub struct StorageUri(#[schemars(with = "String")] pub url::Url);
+
+impl Default for StorageUri {
+    fn default() -> Self {
+        StorageUri(url::Url::parse("file:///tmp").unwrap())
+    }
+}
+
 #[derive(Serialize, Deserialize, Debug, JsonSchema, Default, Clone)]
 pub struct CreateVMRequest {
     /// Data of the VM to create
@@ -51,6 +69,7 @@ pub struct CreateVMRequest {
     pub boot: bool,
 }
 
+
 /// An internal, debug-only request for creating a VM.
 ///
 /// please don't use this in production, this is for debugging
@@ -148,8 +167,16 @@ pub struct Volume {
     #[schemars(with = "u64")]
     #[serde(with = "bytesize_as_u64")]
     pub size: ByteSize,
+    
+    /// A URI pointing to the volume's location, e.g an iSCSI URL in `iscsi-inq` format, a local file, or an RBD image.
+    /// 
+    /// examples:
+    /// - `iscsi://[<username>[%<password>]@]<host>[:<port>]/<target-iqn-name>/<lun>`
+    /// - `file:///path/to/volume.img`
+    /// - `rbd://<pool>/<image>`
+    /// 
+    pub uri: StorageUri,
 }
-
 // for now
 pub type CreateVolumeRequest = Volume;