Add schema changes for quiescing

Author: smklein

nexus/db-model/src/db_metadata.rs

@@ -18,6 +18,8 @@ pub struct DbMetadata {
     time_modified: DateTime<Utc>,
     version: SemverVersion,
     target_version: Option<SemverVersion>,
+    quiesce_started: bool,
+    quiesce_completed: bool,
 }
 
 impl DbMetadata {
@@ -32,4 +34,12 @@ impl DbMetadata {
     pub fn version(&self) -> &SemverVersion {
         &self.version
     }
+
+    pub fn quiesce_started(&self) -> bool {
+        self.quiesce_started
+    }
+
+    pub fn quiesce_completed(&self) -> bool {
+        self.quiesce_completed
+    }
 }

nexus/db-schema/src/schema.rs

@@ -2251,6 +2251,8 @@ table! {
         time_modified -> Timestamptz,
         version -> Text,
         target_version -> Nullable<Text>,
+        quiesce_started -> Bool,
+        quiesce_completed -> Bool,
     }
 }
 

schema/crdb/dbinit.sql

@@ -5434,6 +5434,35 @@ CREATE TABLE IF NOT EXISTS omicron.public.db_metadata (
     -- (Optional) Semver representation of the DB version to which we're upgrading
     target_version STRING(64),
 
+    -- During the nexus boot process, it must check this table to understand the
+    -- state of the Schema.
+    --
+    -- There are a handful of states to consider:
+    --
+    -- - "db.version = version in binary" + "quiesce_started = true": An
+    --   upgrade is in-progress, and the underlying database should not be used.
+    --   This Nexus should coordinate with other Nexus instances at this version
+    --   (via internal DNS) to set "quiesce_completed" to true.
+    -- - "db.version = version in binary" + "quiesce_completed = true" OR
+    --   "db.version > version in binary"
+    --   This Nexus should avoid accessing the database, but has no need to coordinate
+    --   with other Nexuses.
+    -- - "db.version < version in binary":
+    --   This Nexus should upgrade to the new schema, but only once "quiesce_completed"
+    --   is set to true.
+    --   Once the upgrade is complete, "quiesce_started" and "quiesce_completed"
+    --   should both be set to false. Note that multiple Nexuses may be attempting this
+    --   schema upgrade operation concurrently.
+
+
+    -- Identifies that a schema migration has started.
+    -- Nexuses with "db.version = version in binary" should not access the database any longer.
+    quiesce_started BOOL NOT NULL,
+
+    -- Identifies that a schema migration is ready to hand-off from Old Nexus versions
+    -- to newer Nexus versions.
+    quiesce_completed BOOL NOT NULL,
+
     CHECK (singleton = true)
 );
 
@@ -6173,9 +6202,11 @@ INSERT INTO omicron.public.db_metadata (
     time_created,
     time_modified,
     version,
-    target_version
+    target_version,
+    quiesce_started,
+    quiesce_completed
 ) VALUES
-    (TRUE, NOW(), NOW(), '156.0.0', NULL)
+    (TRUE, NOW(), NOW(), '157.0.0', NULL, FALSE, FALSE)
 ON CONFLICT DO NOTHING;
 
 COMMIT;