add migration table

Author: hawkw

nexus/db-model/src/lib.rs

@@ -42,6 +42,8 @@ pub mod ipv6;
 mod ipv6net;
 mod l4_port_range;
 mod macaddr;
+mod migration;
+mod migration_state;
 mod name;
 mod network_interface;
 mod oximeter_info;
@@ -151,6 +153,8 @@ pub use ipv4net::*;
 pub use ipv6::*;
 pub use ipv6net::*;
 pub use l4_port_range::*;
+pub use migration::*;
+pub use migration_state::*;
 pub use name::*;
 pub use network_interface::*;
 pub use oximeter_info::*;

nexus/db-model/src/migration.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 crate::schema::migration;
+use crate::MigrationState;
+use serde::Deserialize;
+use serde::Serialize;
+use uuid::Uuid;
+
+/// The state of a migration as understood by Nexus.
+#[derive(
+    Clone, Debug, Queryable, Insertable, Selectable, Serialize, Deserialize,
+)]
+#[diesel(table_name = migration)]
+pub struct Migration {
+    /// The migration's UUID.
+    ///
+    /// This is the primary key of the migration table and is referenced by the
+    /// `instance` table's `migration_id` field.
+    pub id: Uuid,
+
+    /// The state of the migration source VMM.
+    pub source_state: MigrationState,
+
+    /// The ID of the migration source VMM.
+    pub source_propolis_id: Uuid,
+
+    /// The state of the migration target VMM.
+    pub target_state: MigrationState,
+
+    /// The ID of the migration target VMM.
+    pub target_propolis_id: Uuid,
+}

nexus/db-model/src/migration_state.rs

@@ -0,0 +1,42 @@
+// 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/.
+
+//! Database representation of a migration's state as understood by Nexus.
+
+use super::impl_enum_type;
+use serde::{Deserialize, Serialize};
+use std::fmt;
+
+impl_enum_type!(
+    #[derive(Clone, SqlType, Debug, QueryId)]
+    #[diesel(postgres_type(name = "migration_state", schema = "public"))]
+    pub struct MigrationStateEnum;
+
+    #[derive(Clone, Copy, Debug, AsExpression, FromSqlRow, Serialize, Deserialize, PartialEq, Eq)]
+    #[diesel(sql_type = MigrationStateEnum)]
+     // match the database representation when serializing
+    #[serde(rename_all = "snake_case")]
+    pub enum MigrationState;
+
+    // Enum values
+    InProgress => b"in_progress"
+    Completed => b"completed"
+    Failed => b"failed"
+);
+
+impl MigrationState {
+    pub fn label(&self) -> &'static str {
+        match self {
+            Self::InProgress => "in_progress",
+            Self::Completed => "completed",
+            Self::Failed => "failed",
+        }
+    }
+}
+
+impl fmt::Display for MigrationState {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        f.write_str(self.label())
+    }
+}

nexus/db-model/src/schema.rs

@@ -1751,6 +1751,19 @@ table! {
     }
 }
 
+table! {
+    migration (id) {
+        id -> Uuid,
+        source_state -> crate::MigrationStateEnum,
+        source_propolis_id -> Uuid,
+        target_state -> crate::MigrationStateEnum,
+        target_propolis_id -> Uuid,
+    }
+}
+
+allow_tables_to_appear_in_same_query!(instance, migration);
+joinable!(instance -> migration (migration_id));
+
 allow_tables_to_appear_in_same_query!(
     ip_pool_range,
     ip_pool,

nexus/db-model/src/schema_versions.rs

@@ -17,7 +17,7 @@ use std::collections::BTreeMap;
 ///
 /// This must be updated when you change the database schema.  Refer to
 /// schema/crdb/README.adoc in the root of this repository for details.
-pub const SCHEMA_VERSION: SemverVersion = SemverVersion::new(68, 0, 0);
+pub const SCHEMA_VERSION: SemverVersion = SemverVersion::new(69, 0, 0);
 
 /// List of all past database schema versions, in *reverse* order
 ///
@@ -29,6 +29,7 @@ static KNOWN_VERSIONS: Lazy<Vec<KnownVersion>> = Lazy::new(|| {
         // |  leaving the first copy as an example for the next person.
         // v
         // KnownVersion::new(next_int, "unique-dirname-with-the-sql-files"),
+        KnownVersion::new(69, "add-migration-state-enum"),
         KnownVersion::new(68, "filter-v2p-mapping-by-instance-state"),
         KnownVersion::new(67, "add-instance-updater-lock"),
         KnownVersion::new(66, "blueprint-crdb-preserve-downgrade"),

schema/crdb/add-migration-table/up01.sql

@@ -0,0 +1,5 @@
+CREATE TYPE IF NOT EXISTS omicron.public.migration_state AS ENUM (
+  'in_progress',
+  'failed',
+  'completed'
+);

schema/crdb/add-migration-table/up02.sql

@@ -0,0 +1,7 @@
+CREATE TABLE IF NOT EXISTS omicron.public.migration (
+    id UUID PRIMARY KEY,
+    source_state omicron.public.migration_state NOT NULL,
+    source_propolis_id UUID NOT NULL,
+    target_state omicron.public.migration_state NOT NULL,
+    target_propolis_id UUID NOT NULL
+);

schema/crdb/dbinit.sql

@@ -4008,6 +4008,20 @@ VALUES (
 ON CONFLICT (id)
 DO NOTHING;
 
+CREATE TYPE IF NOT EXISTS omicron.public.migration_state AS ENUM (
+  'in_progress',
+  'failed',
+  'completed'
+);
+
+-- A table of the states of current migrations.
+CREATE TABLE IF NOT EXISTS omicron.public.migration (
+    id UUID PRIMARY KEY,
+    source_state omicron.public.migration_state NOT NULL,
+    source_propolis_id UUID NOT NULL,
+    target_state omicron.public.migration_state NOT NULL,
+    target_propolis_id UUID NOT NULL
+);
 
 /*
  * Keep this at the end of file so that the database does not contain a version
@@ -4020,7 +4034,7 @@ INSERT INTO omicron.public.db_metadata (
     version,
     target_version
 ) VALUES
-    (TRUE, NOW(), NOW(), '68.0.0', NULL)
+    (TRUE, NOW(), NOW(), '69.0.0', NULL)
 ON CONFLICT DO NOTHING;
 
 COMMIT;