Use SledUuid (#8991)

Use the typed SledUuid. Make sure to use the schemars trick so that the
APIs dont' change.

Also:

- physical disk uuid and dataset uuid were already used, use that in
more places

- add a few missing MPL headers

Author: jmpesp

Cargo.lock

@@ -260,7 +260,7 @@ impl ScanParams for ScanByName {
 /// Query parameters for pagination by id only
 pub type PaginatedById<Selector = ()> =
     PaginationParams<ScanById<Selector>, PageSelectorById<Selector>>;
-/// Page selector for pagination by name only
+/// Page selector for pagination by id only
 pub type PageSelectorById<Selector = ()> =
     PageSelector<ScanById<Selector>, Uuid>;
 /// Scan parameters for resources that support scanning by id only

common/src/api/external/http_pagination.rs

@@ -24,6 +24,7 @@ pub use error::*;
 use futures::stream::BoxStream;
 use omicron_uuid_kinds::GenericUuid;
 use omicron_uuid_kinds::InstanceUuid;
+use omicron_uuid_kinds::SledUuid;
 use oxnet::IpNet;
 use oxnet::Ipv4Net;
 use parse_display::Display;
@@ -3485,7 +3486,9 @@ pub struct TufRepoGetResponse {
 pub struct Probe {
     #[serde(flatten)]
     pub identity: IdentityMetadata,
-    pub sled: Uuid,
+
+    #[schemars(with = "Uuid")]
+    pub sled: SledUuid,
 }
 
 /// Define policy relating to the import and export of prefixes from a BGP

common/src/api/external/mod.rs

@@ -455,14 +455,14 @@ enum DiskCommands {
 
 #[derive(Debug, Args, Clone)]
 struct DiskInfoArgs {
-    /// The UUID of the volume
+    /// The UUID of the disk
     uuid: Uuid,
 }
 
 #[derive(Debug, Args, Clone)]
 struct DiskPhysicalArgs {
     /// The UUID of the physical disk
-    uuid: Uuid,
+    uuid: PhysicalDiskUuid,
 }
 
 #[derive(Debug, Args, Clone)]
@@ -1641,7 +1641,7 @@ async fn lookup_project(
 #[tabled(rename_all = "SCREAMING_SNAKE_CASE")]
 struct CrucibleDatasetRow {
     // dataset fields
-    id: Uuid,
+    id: DatasetUuid,
     time_deleted: String,
     pool_id: Uuid,
     address: String,
@@ -1710,7 +1710,7 @@ async fn get_crucible_dataset_rows(
 
         result.push(CrucibleDatasetRow {
             // dataset fields
-            id: d.id().into_untyped_uuid(),
+            id: d.id(),
             time_deleted: match d.time_deleted() {
                 Some(t) => t.to_string(),
                 None => String::from(""),
@@ -2151,7 +2151,7 @@ async fn cmd_db_disk_info(
             let my_sled_id = instance.sled_id().unwrap();
 
             let (_, my_sled) = LookupPath::new(opctx, datastore)
-                .sled_id(my_sled_id.into_untyped_uuid())
+                .sled_id(my_sled_id)
                 .fetch()
                 .await
                 .context("failed to look up sled")?;
@@ -2207,7 +2207,7 @@ async fn cmd_db_disk_info(
             .await
             .context("failed to look up zpool")?;
 
-        let my_sled_id = my_zpool.sled_id;
+        let my_sled_id = my_zpool.sled_id();
 
         let (_, my_sled) = LookupPath::new(opctx, datastore)
             .sled_id(my_sled_id)
@@ -2282,7 +2282,7 @@ async fn cmd_db_disk_physical(
     }
 
     let zpools = query
-        .filter(zpool_dsl::physical_disk_id.eq(args.uuid))
+        .filter(zpool_dsl::physical_disk_id.eq(to_db_typed_uuid(args.uuid)))
         .select(Zpool::as_select())
         .load_async(&*conn)
         .await
@@ -2301,7 +2301,7 @@ async fn cmd_db_disk_physical(
     // changes, this code will still work.
     for zp in zpools {
         // zpool has the sled id, record that so we can find the serial number.
-        sled_ids.insert(zp.sled_id);
+        sled_ids.insert(zp.sled_id());
 
         // Next, we find all the Crucible datasets that are on our zpool.
         use nexus_db_schema::schema::crucible_dataset::dsl as dataset_dsl;
@@ -2514,7 +2514,7 @@ struct PhysicalDiskRow {
     serial: String,
     vendor: String,
     model: String,
-    sled_id: Uuid,
+    sled_id: SledUuid,
     policy: PhysicalDiskPolicy,
     state: PhysicalDiskState,
 }
@@ -2526,7 +2526,7 @@ impl From<PhysicalDisk> for PhysicalDiskRow {
             serial: d.serial.clone(),
             vendor: d.vendor.clone(),
             model: d.model.clone(),
-            sled_id: d.sled_id,
+            sled_id: d.sled_id(),
             policy: d.disk_policy.into(),
             state: d.disk_state.into(),
         }
@@ -2746,7 +2746,7 @@ async fn cmd_db_snapshot_info(
                 .await
                 .context("failed to look up zpool")?;
 
-            let my_sled_id = my_zpool.sled_id;
+            let my_sled_id = my_zpool.sled_id();
 
             let (_, my_sled) = LookupPath::new(opctx, datastore)
                 .sled_id(my_sled_id)
@@ -2786,7 +2786,7 @@ async fn cmd_db_snapshot_info(
             .await
             .context("failed to look up zpool")?;
 
-        let my_sled_id = my_zpool.sled_id;
+        let my_sled_id = my_zpool.sled_id();
 
         let (_, my_sled) = LookupPath::new(opctx, datastore)
             .sled_id(my_sled_id)
@@ -3829,7 +3829,7 @@ async fn cmd_db_dry_run_region_allocation(
     struct Row {
         pub region_id: Uuid,
 
-        pub dataset_id: Uuid,
+        pub dataset_id: DatasetUuid,
         pub size_used: i64,
 
         pub pool_id: Uuid,
@@ -3867,7 +3867,7 @@ async fn cmd_db_dry_run_region_allocation(
         rows.push(Row {
             region_id: region.id(),
 
-            dataset_id: dataset.id().into_untyped_uuid(),
+            dataset_id: dataset.id(),
             size_used: dataset.size_used,
 
             pool_id,
@@ -4235,7 +4235,7 @@ struct SledRow {
     role: &'static str,
     policy: SledPolicy,
     state: SledState,
-    id: Uuid,
+    id: SledUuid,
 }
 
 impl From<Sled> for SledRow {
@@ -4733,7 +4733,7 @@ async fn cmd_db_instance_info(
         struct VmmRow {
             #[tabled(inline)]
             state: VmmStateRow,
-            sled_id: Uuid,
+            sled_id: SledUuid,
             #[tabled(display_with = "datetime_rfc3339_concise")]
             time_created: chrono::DateTime<Utc>,
             #[tabled(display_with = "datetime_opt_rfc3339_concise")]
@@ -4775,7 +4775,7 @@ async fn cmd_db_instance_info(
                         state,
                         generation: r#gen.0.into(),
                     },
-                    sled_id,
+                    sled_id: sled_id.into(),
                     time_created,
                     time_deleted,
                 }
@@ -4859,7 +4859,7 @@ async fn cmd_db_instances(
                 h_to_s.entry(i.sled_id().unwrap())
             {
                 let (_, my_sled) = LookupPath::new(opctx, datastore)
-                    .sled_id(i.sled_id().unwrap().into_untyped_uuid())
+                    .sled_id(i.sled_id().unwrap())
                     .fetch()
                     .await
                     .context("failed to look up sled")?;
@@ -7229,13 +7229,13 @@ async fn cmd_db_vmm_info(
         .next()
         .ok_or_else(|| anyhow::anyhow!("no VMM found with ID {uuid}"))?;
     let sled_result =
-        LookupPath::new(opctx, datastore).sled_id(vmm.sled_id).fetch().await;
+        LookupPath::new(opctx, datastore).sled_id(vmm.sled_id()).fetch().await;
     let sled = match sled_result {
         Ok((_, sled)) => Some(sled),
         Err(err) => {
             eprintln!(
                 "WARN: failed to fetch sled with ID {}: {err}",
-                vmm.sled_id
+                vmm.sled_id()
             );
             None
         }
@@ -7513,7 +7513,7 @@ async fn cmd_db_vmm_list(
     struct VerboseVmmRow<'a> {
         #[tabled(inline)]
         inner: VmmRow<'a>,
-        sled_id: Uuid,
+        sled_id: SledUuid,
         address: std::net::SocketAddr,
         #[tabled(display_with = "datetime_rfc3339_concise")]
         time_created: DateTime<Utc>,
@@ -7533,7 +7533,7 @@ async fn cmd_db_vmm_list(
                 ..
             } = it.0;
             VerboseVmmRow {
-                sled_id,
+                sled_id: sled_id.into(),
                 inner: VmmRow::from(it),
                 address: std::net::SocketAddr::new(
                     propolis_ip.ip(),
@@ -7714,8 +7714,8 @@ async fn cmd_db_zpool_list(
     struct ZpoolRow {
         id: Uuid,
         time_deleted: String,
-        sled_id: Uuid,
-        physical_disk_id: Uuid,
+        sled_id: SledUuid,
+        physical_disk_id: PhysicalDiskUuid,
         #[tabled(display_with = "option_impl_display")]
         total_size: Option<i64>,
         control_plane_storage_buffer: i64,
@@ -7731,8 +7731,8 @@ async fn cmd_db_zpool_list(
                     Some(t) => t.to_string(),
                     None => String::from(""),
                 },
-                sled_id: p.sled_id,
-                physical_disk_id: p.physical_disk_id.into_untyped_uuid(),
+                sled_id: p.sled_id(),
+                physical_disk_id: p.physical_disk_id(),
                 total_size: zpool_total_size.get(&zpool_id).cloned(),
                 control_plane_storage_buffer: p
                     .control_plane_storage_buffer()

dev-tools/omdb/src/bin/omdb/db.rs

@@ -3848,7 +3848,7 @@ async fn cmd_nexus_sled_expunge_with_datastore(
 
     // First, we need to look up the sled so we know its serial number.
     let (_authz_sled, sled) = LookupPath::new(opctx, datastore)
-        .sled_id(args.sled_id.into_untyped_uuid())
+        .sled_id(args.sled_id)
         .fetch()
         .await
         .with_context(|| format!("failed to find sled {}", args.sled_id))?;

dev-tools/omdb/src/bin/omdb/nexus.rs

@@ -1313,7 +1313,7 @@ authz_resource! {
 authz_resource! {
     name = "Sled",
     parent = "Fleet",
-    primary_key = Uuid,
+    primary_key = { uuid_kind = SledKind },
     roles_allowed = false,
     polar_snippet = FleetChild,
 }

nexus/auth/src/authz/api_resources.rs

@@ -284,7 +284,7 @@ impl<'a> LookupPath<'a> {
     }
 
     /// Select a resource of type Sled, identified by its id
-    pub fn sled_id(self, id: Uuid) -> Sled<'a> {
+    pub fn sled_id(self, id: SledUuid) -> Sled<'a> {
         Sled::PrimaryKey(Root { lookup_root: self }, id)
     }
 
@@ -774,7 +774,7 @@ lookup_resource! {
     ancestors = [],
     lookup_by_name = false,
     soft_deletes = true,
-    primary_key_columns = [ { column_name = "id", rust_type = Uuid } ]
+    primary_key_columns = [ { column_name = "id", uuid_kind = SledKind } ]
 }
 
 lookup_resource! {

nexus/db-lookup/src/lookup.rs

@@ -5,13 +5,16 @@
 use super::{
     Generation, PhysicalDiskKind, PhysicalDiskPolicy, PhysicalDiskState,
 };
+use crate::DbTypedUuid;
 use crate::collection::DatastoreCollectionConfig;
 use chrono::{DateTime, Utc};
 use db_macros::Asset;
 use nexus_db_schema::schema::{physical_disk, zpool};
 use nexus_types::{external_api::views, identity::Asset};
+use omicron_uuid_kinds::PhysicalDiskKind as PhysicalDiskUuidKind;
 use omicron_uuid_kinds::PhysicalDiskUuid;
-use uuid::Uuid;
+use omicron_uuid_kinds::SledKind;
+use omicron_uuid_kinds::SledUuid;
 
 /// Physical disk attached to sled.
 #[derive(Queryable, Insertable, Debug, Clone, Selectable, Asset)]
@@ -28,7 +31,7 @@ pub struct PhysicalDisk {
     pub model: String,
 
     pub variant: PhysicalDiskKind,
-    pub sled_id: Uuid,
+    pub sled_id: DbTypedUuid<SledKind>,
     pub disk_policy: PhysicalDiskPolicy,
     pub disk_state: PhysicalDiskState,
 }
@@ -41,7 +44,7 @@ impl PhysicalDisk {
         serial: String,
         model: String,
         variant: PhysicalDiskKind,
-        sled_id: Uuid,
+        sled_id: SledUuid,
     ) -> Self {
         Self {
             identity: PhysicalDiskIdentity::new(id),
@@ -51,7 +54,7 @@ impl PhysicalDisk {
             serial,
             model,
             variant,
-            sled_id,
+            sled_id: sled_id.into(),
             disk_policy: PhysicalDiskPolicy::InService,
             disk_state: PhysicalDiskState::Active,
         }
@@ -64,6 +67,10 @@ impl PhysicalDisk {
     pub fn time_deleted(&self) -> Option<DateTime<Utc>> {
         self.time_deleted
     }
+
+    pub fn sled_id(&self) -> SledUuid {
+        self.sled_id.into()
+    }
 }
 
 impl From<PhysicalDisk> for views::PhysicalDisk {
@@ -72,7 +79,7 @@ impl From<PhysicalDisk> for views::PhysicalDisk {
             identity: disk.identity(),
             policy: disk.disk_policy.into(),
             state: disk.disk_state.into(),
-            sled_id: Some(disk.sled_id),
+            sled_id: Some(disk.sled_id.into()),
             vendor: disk.vendor,
             serial: disk.serial,
             model: disk.model,
@@ -82,7 +89,7 @@ impl From<PhysicalDisk> for views::PhysicalDisk {
 }
 
 impl DatastoreCollectionConfig<super::Zpool> for PhysicalDisk {
-    type CollectionId = Uuid;
+    type CollectionId = DbTypedUuid<PhysicalDiskUuidKind>;
     type GenerationNumberColumn = physical_disk::dsl::rcgen;
     type CollectionTimeDeletedColumn = physical_disk::dsl::time_deleted;
     type CollectionIdColumn = zpool::dsl::sled_id;