Introduce sled-agent-scrimlet-reconcilers crate (#10313)

This is groundwork for #10167, and introduces the skeleton of network
config reconcilers for use within sled-agent. None of this is wired up
yet and all the service-specific reconcilers are placeholders, but it
does have the real setup for how these tasks get started and how they
report status.

The PR is pretty big but hopefully not too bad to review; more than half
the code falls into either "tests", "status type definitions", or
"placeholder/dummy reconcilers". A tentative suggestion for review order
is:

1. The crate-level docs in `lib.rs`; these are written assuming #10167
is complete, not based on the current state of the crate.
2. `handle.rs`, particularly `ScrimletReconcilers` - this is the entry
point for sled-agent. It will hold a `ScrimletReconcilers` in its set of
long-running tasks.
3. `reconciler_task.rs` - this implements the common control flow for
all of the service-specific reconcilers in the crate; handling periodic
reactivation, activation when the config changes, transitioning to inert
if we stop being a scrimlet because the sidecar goes away at runtime,
and transitioning out of inert if it comes back.

~~The only production-affecting change here is that the
`ThisSledSwitchZoneUnderlayIpAddr` type moved out of sled-agent and into
this crate, so sled-agent depends on this crate just for that type.~~
Edit: As of #10340, `ThisSledSwitchZoneUnderlayIpAddr` has moved to
`sled-agent-types`, so now this PR uses it from there and makes no
changes to sled-agent proper.

Author: jgallagher

Cargo.lock

@@ -147,6 +147,7 @@ members = [
     "sled-agent/bootstrap-agent-lockstep-api",
     "sled-agent/bootstrap-agent-lockstep-types",
     "sled-agent/config-reconciler",
+    "sled-agent/scrimlet-reconcilers",
     "sled-agent/health-monitor",
     "sled-agent/measurements",
     "sled-agent/rack-setup",
@@ -333,6 +334,7 @@ default-members = [
     "sled-agent/bootstrap-agent-lockstep-api",
     "sled-agent/bootstrap-agent-lockstep-types",
     "sled-agent/config-reconciler",
+    "sled-agent/scrimlet-reconcilers",
     "sled-agent/health-monitor",
     "sled-agent/measurements",
     "sled-agent/rack-setup",
@@ -727,7 +729,7 @@ propolis_api_types = { git = "https://github.com/oxidecomputer/propolis", rev =
 propolis-client = { git = "https://github.com/oxidecomputer/propolis", rev = "bc489ddf0f38f75e0c194b86cf6f0de377f68845" }
 propolis-mock-server = { git = "https://github.com/oxidecomputer/propolis", rev = "bc489ddf0f38f75e0c194b86cf6f0de377f68845" }
 # NOTE: see above!
-proptest = "1.7.0"
+proptest = "1.11.0"
 qorb = "0.4.1"
 quote = "1.0"
 # Some dependencies still require rand 0.8.x.
@@ -792,6 +794,7 @@ sled-agent-config-reconciler = { path = "sled-agent/config-reconciler" }
 sled-agent-health-monitor = { path = "sled-agent/health-monitor" }
 sled-agent-measurements = { path = "sled-agent/measurements" }
 sled-agent-rack-setup = { path = "sled-agent/rack-setup" }
+sled-agent-scrimlet-reconcilers = { path = "sled-agent/scrimlet-reconcilers" }
 sled-agent-types = { path = "sled-agent/types" }
 sled-agent-types-versions = { path = "sled-agent/types/versions" }
 sled-agent-resolvable-files = { path = "sled-agent/resolvable-files" }

Cargo.toml

@@ -0,0 +1,36 @@
+[package]
+name = "sled-agent-scrimlet-reconcilers"
+version = "0.1.0"
+edition.workspace = true
+license = "MPL-2.0"
+
+[lints]
+workspace = true
+
+[dependencies]
+chrono.workspace = true
+dpd-client.workspace = true
+gateway-client.workspace = true
+gateway-types.workspace = true
+mg-admin-client.workspace = true
+omicron-common.workspace = true
+reqwest.workspace = true
+sled-agent-types.workspace = true
+slog.workspace = true
+slog-error-chain.workspace = true
+thiserror.workspace = true
+tokio.workspace = true
+
+omicron-workspace-hack.workspace = true
+
+[dev-dependencies]
+assert_matches.workspace = true
+dropshot.workspace = true
+gateway-messages.workspace = true
+gateway-test-utils.workspace = true
+httpmock.workspace = true
+omicron-test-utils.workspace = true
+serde_json.workspace = true
+
+[features]
+testing = []

sled-agent/scrimlet-reconcilers/Cargo.toml

@@ -0,0 +1,58 @@
+// 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/.
+
+//! Reconciler responsible for configuration of `dpd` within a scrimlet's switch
+//! zone.
+
+use crate::handle::ScrimletReconcilersMode;
+use crate::reconciler_task::Reconciler;
+use crate::switch_zone_slot::ThisSledSwitchSlot;
+use dpd_client::Client;
+use sled_agent_types::system_networking::SystemNetworkingConfig;
+use slog::Logger;
+use std::time::Duration;
+
+#[derive(Debug, Clone)]
+pub struct DpdReconcilerStatus {
+    pub todo_status: (),
+}
+
+impl slog::KV for DpdReconcilerStatus {
+    fn serialize(
+        &self,
+        _record: &slog::Record<'_>,
+        serializer: &mut dyn slog::Serializer,
+    ) -> slog::Result {
+        serializer.emit_str("dpd-reconciler".into(), "not yet implemented")
+    }
+}
+
+#[derive(Debug)]
+pub(crate) struct DpdReconciler {
+    _client: Client,
+    _switch_slot: ThisSledSwitchSlot,
+}
+
+impl Reconciler for DpdReconciler {
+    type Status = DpdReconcilerStatus;
+
+    const LOGGER_COMPONENT_NAME: &'static str = "DpdReconciler";
+    const RE_RECONCILE_INTERVAL: Duration = Duration::from_secs(30);
+
+    fn new(
+        mode: ScrimletReconcilersMode,
+        switch_slot: ThisSledSwitchSlot,
+        parent_log: &Logger,
+    ) -> Self {
+        Self { _client: mode.dpd_client(parent_log), _switch_slot: switch_slot }
+    }
+
+    async fn do_reconciliation(
+        &mut self,
+        _system_networking_config: &SystemNetworkingConfig,
+        _log: &Logger,
+    ) -> Self::Status {
+        DpdReconcilerStatus { todo_status: () }
+    }
+}