rename reconfigurator packages (#5163)

oxidecomputer · Feb 29, 2024 · 55a0760 · 55a0760
1 parent c42b505
commit 55a0760
Show file tree

Hide file tree

Showing 23 changed files with 97 additions and 83 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -37,14 +37,14 @@ members = [
     "key-manager",
     "nexus",
     "nexus/authz-macros",
-    "nexus/blueprint-execution",
     "nexus/db-macros",
     "nexus/db-model",
     "nexus/db-queries",
     "nexus/defaults",
-    "nexus/deployment",
     "nexus/inventory",
     "nexus/macros-common",
+    "nexus/reconfigurator/execution",
+    "nexus/reconfigurator/planning",
     "nexus/test-interface",
     "nexus/test-utils-macros",
     "nexus/test-utils",
@@ -114,14 +114,14 @@ default-members = [
     "key-manager",
     "nexus",
     "nexus/authz-macros",
-    "nexus/blueprint-execution",
     "nexus/macros-common",
     "nexus/db-macros",
     "nexus/db-model",
     "nexus/db-queries",
     "nexus/defaults",
-    "nexus/deployment",
     "nexus/inventory",
+    "nexus/reconfigurator/execution",
+    "nexus/reconfigurator/planning",
     "nexus/types",
     "oximeter/collector",
     "oximeter/db",
@@ -253,14 +253,14 @@ mockall = "0.12"
 newtype_derive = "0.1.6"
 mg-admin-client = { path = "clients/mg-admin-client" }
 multimap = "0.10.0"
-nexus-blueprint-execution = { path = "nexus/blueprint-execution" }
 nexus-client = { path = "clients/nexus-client" }
 nexus-db-model = { path = "nexus/db-model" }
 nexus-db-queries = { path = "nexus/db-queries" }
 nexus-defaults = { path = "nexus/defaults" }
-nexus-deployment = { path = "nexus/deployment" }
 nexus-inventory = { path = "nexus/inventory" }
 nexus-macros-common = { path = "nexus/macros-common" }
+nexus-reconfigurator-execution = { path = "nexus/reconfigurator/execution" }
+nexus-reconfigurator-planning = { path = "nexus/reconfigurator/planning" }
 omicron-certificates = { path = "certificates" }
 omicron-passwords = { path = "passwords" }
 omicron-workspace-hack = "0.1.0"

diff --git a/nexus/Cargo.toml b/nexus/Cargo.toml
@@ -77,12 +77,12 @@ tough.workspace = true
 trust-dns-resolver.workspace = true
 uuid.workspace = true
 
-nexus-blueprint-execution.workspace = true
 nexus-defaults.workspace = true
 nexus-db-model.workspace = true
 nexus-db-queries.workspace = true
-nexus-deployment.workspace = true
 nexus-inventory.workspace = true
+nexus-reconfigurator-execution.workspace = true
+nexus-reconfigurator-planning.workspace = true
 nexus-types.workspace = true
 omicron-common.workspace = true
 omicron-passwords.workspace = true

diff --git a/nexus/blueprint-execution/tests/config.test.toml b/nexus/blueprint-execution/tests/config.test.toml
diff --git a/nexus/db-queries/Cargo.toml b/nexus/db-queries/Cargo.toml
@@ -69,8 +69,8 @@ gateway-client.workspace = true
 illumos-utils.workspace = true
 internal-dns.workspace = true
 itertools.workspace = true
-nexus-deployment.workspace = true
 nexus-inventory.workspace = true
+nexus-reconfigurator-planning.workspace = true
 nexus-test-utils.workspace = true
 omicron-sled-agent.workspace = true
 omicron-test-utils.workspace = true

diff --git a/nexus/db-queries/src/db/datastore/deployment.rs b/nexus/db-queries/src/db/datastore/deployment.rs
@@ -1055,9 +1055,9 @@ impl RunQueryDsl<DbConnection> for InsertTargetQuery {}
 mod tests {
     use super::*;
     use crate::db::datastore::test_utils::datastore_test;
-    use nexus_deployment::blueprint_builder::BlueprintBuilder;
-    use nexus_deployment::blueprint_builder::Ensure;
     use nexus_inventory::now_db_precision;
+    use nexus_reconfigurator_planning::blueprint_builder::BlueprintBuilder;
+    use nexus_reconfigurator_planning::blueprint_builder::Ensure;
     use nexus_test_utils::db::test_setup_database;
     use nexus_types::deployment::Policy;
     use nexus_types::deployment::SledResources;

diff --git a/nexus/reconfigurator/README.md b/nexus/reconfigurator/README.md
@@ -0,0 +1,13 @@
+# Reconfigurator
+
+**Reconfigurator** is a project and control plane facility for dynamically reconfiguring the software running on the Oxide rack.  This will be used for a variety of use cases:
+
+* Adding, removing, or replacing sleds (gracefully or otherwise)
+* Upgrading any Oxide-delivered software (see below)
+* Scale-up and scale-down of control plane services
+* Automated response to hardware failure
+
+For those with access (primarily, Oxide employees), see:
+
+* [RFD 418 Towards automated system update](https://rfd.shared.oxide.computer/rfd/418).
+* [Reconfigurator GitHub Project](https://github.com/orgs/oxidecomputer/projects/44?pane=info).
diff --git a/nexus/blueprint-execution/Cargo.toml → nexus/reconfigurator/execution/Cargo.toml b/nexus/blueprint-execution/Cargo.toml → nexus/reconfigurator/execution/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "nexus-blueprint-execution"
+name = "nexus-reconfigurator-execution"
 version = "0.1.0"
 edition = "2021"
 
@@ -33,7 +33,7 @@ omicron-workspace-hack.workspace = true
 chrono.workspace = true
 httptest.workspace = true
 ipnet.workspace = true
-nexus-deployment.workspace = true
+nexus-reconfigurator-planning.workspace = true
 nexus-inventory.workspace = true
 nexus-test-utils.workspace = true
 nexus-test-utils-macros.workspace = true

diff --git a/nexus/blueprint-execution/build.rs → nexus/reconfigurator/execution/build.rs b/nexus/blueprint-execution/build.rs → nexus/reconfigurator/execution/build.rs
diff --git a/nexus/blueprint-execution/src/datasets.rs → .../reconfigurator/execution/src/datasets.rs b/nexus/blueprint-execution/src/datasets.rs → .../reconfigurator/execution/src/datasets.rs
diff --git a/nexus/blueprint-execution/src/dns.rs → nexus/reconfigurator/execution/src/dns.rs b/nexus/blueprint-execution/src/dns.rs → nexus/reconfigurator/execution/src/dns.rs
@@ -320,8 +320,8 @@ mod test {
     use crate::Sled;
     use internal_dns::ServiceName;
     use internal_dns::DNS_ZONE;
-    use nexus_deployment::blueprint_builder::BlueprintBuilder;
     use nexus_inventory::CollectionBuilder;
+    use nexus_reconfigurator_planning::blueprint_builder::BlueprintBuilder;
     use nexus_types::deployment::Blueprint;
     use nexus_types::deployment::OmicronZoneConfig;
     use nexus_types::deployment::OmicronZoneType;

diff --git a/nexus/blueprint-execution/src/lib.rs → nexus/reconfigurator/execution/src/lib.rs b/nexus/blueprint-execution/src/lib.rs → nexus/reconfigurator/execution/src/lib.rs
@@ -4,7 +4,7 @@
 
 //! Execution of Nexus blueprints
 //!
-//! See `nexus_deployment` crate-level docs for background.
+//! See `nexus_reconfigurator_planning` crate-level docs for background.
 
 use anyhow::{anyhow, Context};
 use nexus_db_queries::context::OpContext;

diff --git a/.../blueprint-execution/src/omicron_zones.rs → ...nfigurator/execution/src/omicron_zones.rs b/.../blueprint-execution/src/omicron_zones.rs → ...nfigurator/execution/src/omicron_zones.rs
diff --git a/...rint-execution/src/resource_allocation.rs → ...ator/execution/src/resource_allocation.rs b/...rint-execution/src/resource_allocation.rs → ...ator/execution/src/resource_allocation.rs
diff --git a/nexus/reconfigurator/execution/tests/config.test.toml b/nexus/reconfigurator/execution/tests/config.test.toml
@@ -0,0 +1 @@
+../../../tests/config.test.toml
diff --git a/nexus/deployment/Cargo.toml → nexus/reconfigurator/planning/Cargo.toml b/nexus/deployment/Cargo.toml → nexus/reconfigurator/planning/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "nexus-deployment"
+name = "nexus-reconfigurator-planning"
 version = "0.1.0"
 edition = "2021"
 

diff --git a/nexus/deployment/src/blueprint_builder.rs → ...gurator/planning/src/blueprint_builder.rs b/nexus/deployment/src/blueprint_builder.rs → ...gurator/planning/src/blueprint_builder.rs
diff --git a/nexus/deployment/src/ip_allocator.rs → ...configurator/planning/src/ip_allocator.rs b/nexus/deployment/src/ip_allocator.rs → ...configurator/planning/src/ip_allocator.rs
diff --git a/nexus/deployment/src/lib.rs → nexus/reconfigurator/planning/src/lib.rs b/nexus/deployment/src/lib.rs → nexus/reconfigurator/planning/src/lib.rs
diff --git a/nexus/deployment/src/planner.rs → nexus/reconfigurator/planning/src/planner.rs b/nexus/deployment/src/planner.rs → nexus/reconfigurator/planning/src/planner.rs
diff --git a/nexus/src/app/background/blueprint_execution.rs b/nexus/src/app/background/blueprint_execution.rs
@@ -69,7 +69,7 @@ impl BackgroundTask for BlueprintExecutor {
                 });
             }
 
-            let result = nexus_blueprint_execution::realize_blueprint(
+            let result = nexus_reconfigurator_execution::realize_blueprint(
                 opctx,
                 &self.datastore,
                 blueprint,
@@ -258,7 +258,7 @@ mod test {
 
         // Make sure that requests get made to the sled agent.  This is not a
         // careful check of exactly what gets sent.  For that, see the tests in
-        // nexus-blueprint-execution.
+        // nexus-reconfigurator-execution.
         for s in [&mut s1, &mut s2] {
             s.expect(
                 Expectation::matching(all_of![request::method_path(

diff --git a/nexus/src/app/deployment.rs b/nexus/src/app/deployment.rs
@@ -9,8 +9,8 @@ use nexus_db_queries::authz;
 use nexus_db_queries::context::OpContext;
 use nexus_db_queries::db::datastore::SQL_BATCH_SIZE;
 use nexus_db_queries::db::pagination::Paginator;
-use nexus_deployment::blueprint_builder::BlueprintBuilder;
-use nexus_deployment::planner::Planner;
+use nexus_reconfigurator_planning::blueprint_builder::BlueprintBuilder;
+use nexus_reconfigurator_planning::planner::Planner;
 use nexus_types::deployment::Blueprint;
 use nexus_types::deployment::BlueprintMetadata;
 use nexus_types::deployment::BlueprintTarget;

diff --git a/nexus/types/src/deployment.rs b/nexus/types/src/deployment.rs
@@ -4,12 +4,13 @@
 
 //! Types representing deployed software and configuration
 //!
-//! For more on this, see the crate-level documentation for `nexus/deployment`.
+//! For more on this, see the crate-level documentation for
+//! `nexus/reconfigurator/planning`.
 //!
 //! This lives in nexus/types because it's used by both nexus/db-model and
-//! nexus/deployment.  (It could as well just live in nexus/db-model, but
-//! nexus/deployment does not currently know about nexus/db-model and it's
-//! convenient to separate these concerns.)
+//! nexus/reconfigurator/planning.  (It could as well just live in
+//! nexus/db-model, but nexus/reconfigurator/planning does not currently know
+//! about nexus/db-model and it's convenient to separate these concerns.)
 
 use crate::external_api::views::SledPolicy;
 use crate::external_api::views::SledState;
@@ -98,8 +99,8 @@ impl SledResources {
 /// Describes a complete set of software and configuration for the system
 // Blueprints are a fundamental part of how the system modifies itself.  Each
 // blueprint completely describes all of the software and configuration
-// that the control plane manages.  See the nexus/deployment crate-level
-// documentation for details.
+// that the control plane manages.  See the nexus/reconfigurator/planning
+// crate-level documentation for details.
 //
 // Blueprints are different from policy.  Policy describes the things that an
 // operator would generally want to control.  The blueprint describes the