Add support for 'disabling' physical disks to prevent future allocations

Cargo.toml

@@ -411,7 +411,7 @@ unicode-width = "0.1.11"
 update-common = { path = "update-common" }
 update-engine = { path = "update-engine" }
 usdt = "0.5.0"
-uuid = { version = "1.7.0", features = ["serde", "v4"] }
+uuid = { version = "1.7.0", features = ["serde", "v4", "v5"] }
 walkdir = "2.4"
 wicket = { path = "wicket" }
 wicket-common = { path = "wicket-common" }

nexus/db-model/src/lib.rs

@@ -9,6 +9,8 @@ extern crate diesel;
 #[macro_use]
 extern crate newtype_derive;
 
+use uuid::Uuid;
+
 mod address_lot;
 mod bfd;
 mod bgp;
@@ -45,6 +47,7 @@ mod network_interface;
 mod oximeter_info;
 mod physical_disk;
 mod physical_disk_kind;
+mod physical_disk_state;
 mod producer_endpoint;
 mod project;
 mod semver_version;
@@ -144,6 +147,7 @@ pub use network_interface::*;
 pub use oximeter_info::*;
 pub use physical_disk::*;
 pub use physical_disk_kind::*;
+pub use physical_disk_state::*;
 pub use producer_endpoint::*;
 pub use project::*;
 pub use quota::*;
@@ -310,6 +314,15 @@ macro_rules! impl_enum_type {
 
 pub(crate) use impl_enum_type;
 
+/// This is an arbitrary UUID, but it's stable because it's embedded as a
+/// constant. This defines a namespace, according to
+/// <https://www.rfc-editor.org/rfc/rfc4122>, which allows generation of v5
+/// UUIDs which are deterministic.
+///
+/// This UUID is used to identify hardware.
+pub(crate) const HARDWARE_UUID_NAMESPACE: Uuid =
+    Uuid::from_u128(206230429496795504636731999500138461979);
+
 /// Describes a type that's represented in the database using a String
 ///
 /// If you're reaching for this type, consider whether it'd be better to use an

nexus/db-model/src/physical_disk.rs

@@ -2,7 +2,7 @@
 // License, v. 2.0. If a copy of the MPL was not distributed with this
 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
 
-use super::{Generation, PhysicalDiskKind};
+use super::{Generation, PhysicalDiskKind, PhysicalDiskState};
 use crate::collection::DatastoreCollectionConfig;
 use crate::schema::{physical_disk, zpool};
 use chrono::{DateTime, Utc};
@@ -25,6 +25,7 @@ pub struct PhysicalDisk {
 
     pub variant: PhysicalDiskKind,
     pub sled_id: Uuid,
+    pub state: PhysicalDiskState,
 }
 
 impl PhysicalDisk {
@@ -35,15 +36,32 @@ impl PhysicalDisk {
         variant: PhysicalDiskKind,
         sled_id: Uuid,
     ) -> Self {
+        // NOTE: We may want to be more restrictive when parsing the vendor,
+        // serial, and model values, so that we can supply a separator
+        // distinguishing them.
+        //
+        // Theoretically, we could have the following problem:
+        //
+        // - A Disk vendor "Foo" makes a disk with serial "Bar", and model "Rev1".
+        //   - This becomes: "FooBarRev1".
+        // - A Disk vendor "FooBar" makes a disk with serial "Rev", and model "1".
+        //   - This becomes: "FooBarRev1", and conflicts.
+        let interpolated_name = format!("{vendor}{serial}{model}");
+        let disk_id = Uuid::new_v5(
+            &crate::HARDWARE_UUID_NAMESPACE,
+            interpolated_name.as_bytes(),
+        );
+        println!("Physical Disk ID: {disk_id}, from {interpolated_name}");
         Self {
-            identity: PhysicalDiskIdentity::new(Uuid::new_v4()),
+            identity: PhysicalDiskIdentity::new(disk_id),
             time_deleted: None,
             rcgen: Generation::new(),
             vendor,
             serial,
             model,
             variant,
             sled_id,
+            state: PhysicalDiskState::Active,
         }
     }
 
@@ -74,6 +92,7 @@ impl From<PhysicalDisk> for views::PhysicalDisk {
             vendor: disk.vendor,
             serial: disk.serial,
             model: disk.model,
+            state: disk.state.into(),
             form_factor: disk.variant.into(),
         }
     }

nexus/db-model/src/physical_disk_state.rs

@@ -0,0 +1,34 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+use super::impl_enum_type;
+use nexus_types::external_api::views;
+use serde::{Deserialize, Serialize};
+
+impl_enum_type!(
+    #[derive(Clone, SqlType, Debug, QueryId)]
+    #[diesel(postgres_type(name = "physical_disk_state"))]
+    pub struct PhysicalDiskStateEnum;
+
+    #[derive(Clone, Copy, Debug, AsExpression, FromSqlRow, Serialize, Deserialize, PartialEq)]
+    #[diesel(sql_type = PhysicalDiskStateEnum)]
+    pub enum PhysicalDiskState;
+
+    // Enum values
+    Active => b"active"
+    Draining => b"draining"
+    Inactive => b"inactive"
+);
+
+impl From<PhysicalDiskState> for views::PhysicalDiskState {
+    fn from(state: PhysicalDiskState) -> Self {
+        use views::PhysicalDiskState as api;
+        use PhysicalDiskState as db;
+        match state {
+            db::Active => api::Active,
+            db::Draining => api::Draining,
+            db::Inactive => api::Inactive,
+        }
+    }
+}

nexus/db-model/src/queries/region_allocation.rs

@@ -23,6 +23,7 @@
 // a CTE (where we want the alias name to come first).
 
 use crate::schema::dataset;
+use crate::schema::physical_disk;
 use crate::schema::sled;
 use crate::schema::zpool;
 
@@ -151,7 +152,9 @@ diesel::allow_tables_to_appear_in_same_query!(
 diesel::allow_tables_to_appear_in_same_query!(
     do_insert,
     candidate_regions,
+    candidate_zpools,
     dataset,
+    physical_disk,
     zpool,
 );
 
@@ -170,8 +173,6 @@ diesel::allow_tables_to_appear_in_same_query!(
     updated_datasets,
 );
 
-diesel::allow_tables_to_appear_in_same_query!(candidate_zpools, dataset,);
-diesel::allow_tables_to_appear_in_same_query!(candidate_zpools, zpool,);
 diesel::allow_tables_to_appear_in_same_query!(candidate_datasets, dataset);
 
 // == Needed for random region allocation ==

nexus/db-model/src/schema.rs

@@ -892,6 +892,7 @@ table! {
 
         variant -> crate::PhysicalDiskKindEnum,
         sled_id -> Uuid,
+        state -> crate::PhysicalDiskStateEnum,
     }
 }
 
@@ -961,11 +962,6 @@ table! {
     }
 }
 
-allow_tables_to_appear_in_same_query! {
-    zpool,
-    physical_disk
-}
-
 table! {
     dataset (id) {
         id -> Uuid,