[sled-agent] use wrapper types for trust quorum responses

clients/sled-agent-client/src/lib.rs

@@ -124,6 +124,7 @@ progenitor::generate_api!(
         SwitchSlot = sled_agent_types_versions::latest::early_networking::SwitchSlot,
         SystemNetworkingConfig = sled_agent_types_versions::latest::system_networking::SystemNetworkingConfig,
         Threshold = trust_quorum_types::types::Threshold,
+        TrustQuorumCoordinatorStatusResponse = sled_agent_types_versions::latest::trust_quorum::TrustQuorumCoordinatorStatusResponse,
         TxEqConfig = sled_agent_types_versions::latest::early_networking::TxEqConfig,
         UplinkAddressConfig = sled_agent_types_versions::latest::early_networking::UplinkAddressConfig,
         VmmRuntimeState = sled_agent_types_versions::latest::instance::VmmRuntimeState,

nexus/mgs-updates/src/test_util/host_phase_2_test_state.rs

@@ -264,6 +264,8 @@ mod api_impl {
     use sled_agent_types::support_bundle::SupportBundleMetadata;
     use sled_agent_types::support_bundle::SupportBundlePathParam;
     use sled_agent_types::support_bundle::SupportBundleTransferQueryParams;
+    use sled_agent_types::trust_quorum::TrustQuorumCoordinatorStatusResponse;
+    use sled_agent_types::trust_quorum::TrustQuorumNetworkConfigResponse;
     use sled_agent_types::zone_bundle::BundleUtilization;
     use sled_agent_types::zone_bundle::CleanupContext;
     use sled_agent_types::zone_bundle::CleanupContextUpdate;
@@ -1003,9 +1005,7 @@ mod api_impl {
         async fn trust_quorum_coordinator_status(
             _request_context: RequestContext<Self::Context>,
         ) -> Result<
-            HttpResponseOk<
-                Option<trust_quorum_types::status::CoordinatorStatus>,
-            >,
+            HttpResponseOk<TrustQuorumCoordinatorStatusResponse>,
             HttpError,
         > {
             unimplemented!()
@@ -1065,14 +1065,8 @@ mod api_impl {
 
         async fn trust_quorum_network_config_get(
             _request_context: RequestContext<Self::Context>,
-        ) -> Result<
-            HttpResponseOk<
-                Option<
-                    sled_agent_types::trust_quorum::TrustQuorumNetworkConfig,
-                >,
-            >,
-            HttpError,
-        > {
+        ) -> Result<HttpResponseOk<TrustQuorumNetworkConfigResponse>, HttpError>
+        {
             unimplemented!()
         }
 

nexus/src/app/background/tasks/trust_quorum.rs

@@ -33,6 +33,7 @@ use sled_agent_client::types::StartSledAgentRequestBody;
 use sled_agent_client::types::{
     ProxyCommitRequest, ProxyPrepareAndCommitRequest,
 };
+use sled_agent_types::trust_quorum::TrustQuorumCoordinatorStatusResponse;
 use sled_hardware_types::BaseboardId;
 use slog::{Logger, error, info, o};
 use slog_error_chain::InlineErrorChain;
@@ -334,7 +335,7 @@ async fn prepare(
         ));
     };
 
-    let status = coordinator_sa
+    let response = coordinator_sa
         .trust_quorum_coordinator_status()
         .await
         .with_context(|| {
@@ -344,6 +345,23 @@ async fn prepare(
             )
         })?
         .into_inner();
+    let status = match response {
+        TrustQuorumCoordinatorStatusResponse::Coordinating { status } => status,
+        TrustQuorumCoordinatorStatusResponse::NotCoordinating {
+            latest_config_epoch,
+        } => {
+            let latest_config_epoch = match latest_config_epoch {
+                Some(epoch) => epoch.to_string(),
+                None => "none".to_string(),
+            };
+            bail!(
+                "Coordinator {} reported no coordinator status: it is not \
+                 currently coordinating a reconfiguration (latest persisted \
+                 configuration epoch: {latest_config_epoch}).",
+                config.coordinator,
+            );
+        }
+    };
 
     // Write state back to DB
     let state = datastore

openapi/sled-agent/sled-agent-60.0.0-f9d5fe.json.gitstub

@@ -0,0 +1 @@
+d31af1e7ce811874957823cb8f731b6f10e35a1b:openapi/sled-agent/sled-agent-60.0.0-f9d5fe.json

openapi/sled-agent/sled-agent-60.0.0-f9d5fe.json → openapi/sled-agent/sled-agent-61.0.0-72ccb2.json

@@ -7,7 +7,7 @@
       "url": "https://oxide.computer",
       "email": "api@oxide.computer"
     },
-    "version": "60.0.0"
+    "version": "61.0.0"
   },
   "paths": {
     "/artifacts": {
@@ -1691,7 +1691,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/CoordinatorStatus"
+                  "$ref": "#/components/schemas/TrustQuorumCoordinatorStatusResponse"
                 }
               }
             }
@@ -1715,7 +1715,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/TrustQuorumNetworkConfig"
+                  "$ref": "#/components/schemas/TrustQuorumNetworkConfigResponse"
                 }
               }
             }
@@ -10422,6 +10422,57 @@
           "rack_network_config"
         ]
       },
+      "TrustQuorumCoordinatorStatusResponse": {
+        "description": "Response type for `trust_quorum_coordinator_status`.",
+        "oneOf": [
+          {
+            "description": "The node is currently coordinating a reconfiguration or LRTQ upgrade.",
+            "type": "object",
+            "properties": {
+              "state": {
+                "type": "string",
+                "enum": [
+                  "coordinating"
+                ]
+              },
+              "status": {
+                "description": "The coordinator status.",
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/CoordinatorStatus"
+                  }
+                ]
+              }
+            },
+            "required": [
+              "state",
+              "status"
+            ]
+          },
+          {
+            "description": "The node is not currently coordinating a reconfiguration or LRTQ upgrade.",
+            "type": "object",
+            "properties": {
+              "latest_config_epoch": {
+                "nullable": true,
+                "description": "The latest configuration epoch this node has persisted.\n\nIf this is greater than or equal to the epoch that Nexus is driving, the coordinator started that epoch and then stopped for some reason, and Nexus can abort this configuration. If lower than the Nexus epoch, then reconfiguration has not started yet.",
+                "type": "integer",
+                "format": "uint64",
+                "minimum": 0
+              },
+              "state": {
+                "type": "string",
+                "enum": [
+                  "not_coordinating"
+                ]
+              }
+            },
+            "required": [
+              "state"
+            ]
+          }
+        ]
+      },
       "TrustQuorumNetworkConfig": {
         "description": "Network configuration used to bring up the control plane.\n\nThis type mirrors `bootstore::schemes::v0::NetworkConfig` but adds `JsonSchema` for API compatibility.",
         "type": "object",
@@ -10441,6 +10492,21 @@
           "generation"
         ]
       },
+      "TrustQuorumNetworkConfigResponse": {
+        "description": "Response type for `trust_quorum_network_config`.",
+        "type": "object",
+        "properties": {
+          "config": {
+            "nullable": true,
+            "description": "The trust quorum network config, or `None` if a config has not been loaded or received since Sled Agent started.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TrustQuorumNetworkConfig"
+              }
+            ]
+          }
+        }
+      },
       "TxEqConfig": {
         "description": "Per-port tx-eq overrides.  This can be used to fine-tune the transceiver equalization settings to improve signal integrity.",
         "type": "object",

openapi/sled-agent/sled-agent-latest.json

@@ -1 +1 @@
-sled-agent-60.0.0-f9d5fe.json
+sled-agent-61.0.0-72ccb2.json

sled-agent/api/Cargo.toml

@@ -27,5 +27,6 @@ sled-hardware-types.workspace = true
 slog-error-chain.workspace = true
 static_assertions.workspace = true
 trust-quorum-types.workspace = true
+trust-quorum-types-versions.workspace = true
 uuid.workspace = true
 x509-cert.workspace = true

sled-agent/api/src/lib.rs

@@ -6,20 +6,20 @@ use std::collections::BTreeMap;
 
 use camino::Utf8PathBuf;
 use dropshot::{
-    Body, FreeformBody, Header, HttpError, HttpResponseAccepted,
-    HttpResponseCreated, HttpResponseDeleted, HttpResponseHeaders,
-    HttpResponseOk, HttpResponseUpdatedNoContent, Path, Query, RequestContext,
-    StreamingBody, TypedBody,
+    Body, ClientErrorStatusCode, FreeformBody, Header, HttpError,
+    HttpResponseAccepted, HttpResponseCreated, HttpResponseDeleted,
+    HttpResponseHeaders, HttpResponseOk, HttpResponseUpdatedNoContent, Path,
+    Query, RequestContext, StreamingBody, TypedBody,
 };
 use dropshot_api_manager_types::api_versions;
 use omicron_common::api::internal::shared::{
     ExternalIpGatewayMap, ResolvedVpcRouteSet, ResolvedVpcRouteState,
     SledIdentifiers, VirtualNetworkInterfaceHost,
 };
 use sled_agent_types_versions::{
-    latest, v1, v11, v14, v18, v20, v22, v24, v25, v26, v28, v29, v30, v31,
-    v32, v33, v34, v37, v39, v40, v41, v42, v43, v44, v46, v47, v48, v49, v50,
-    v51, v52, v53, v55,
+    latest, v1, v11, v14, v15, v18, v20, v22, v24, v25, v26, v28, v29, v30,
+    v31, v32, v33, v34, v37, v39, v40, v41, v42, v43, v44, v46, v47, v48, v49,
+    v50, v51, v52, v53, v55,
 };
 use sled_diagnostics::SledDiagnosticsQueryOutput;
 use slog_error_chain::InlineErrorChain;
@@ -36,6 +36,7 @@ api_versions!([
     // |  example for the next person.
     // v
     // (next_int, IDENT),
+    (61, TRUST_QUORUM_NULLABLE_RESPONSES),
     (60, ADD_MULTIRACK_JOIN_SERVICE_STATUS),
     (59, INSTANCE_ATTACHED_SUBNETS_MAP),
     (58, BYTE_WRAPPER_0_2_BUMP),
@@ -1605,14 +1606,60 @@ pub trait SledAgentApi {
     #[endpoint {
         method = GET,
         path = "/trust-quorum/coordinator-status",
+        versions = VERSION_TRUST_QUORUM_NULLABLE_RESPONSES..,
     }]
     async fn trust_quorum_coordinator_status(
         request_context: RequestContext<Self::Context>,
     ) -> Result<
-        HttpResponseOk<Option<trust_quorum_types::status::CoordinatorStatus>>,
+        HttpResponseOk<
+            latest::trust_quorum::TrustQuorumCoordinatorStatusResponse,
+        >,
         HttpError,
     >;
 
+    /// Get the coordinator status if this node is coordinating a reconfiguration
+    #[endpoint {
+        operation_id = "trust_quorum_coordinator_status",
+        method = GET,
+        path = "/trust-quorum/coordinator-status",
+        versions = ..VERSION_TRUST_QUORUM_NULLABLE_RESPONSES,
+    }]
+    async fn trust_quorum_coordinator_status_v13(
+        request_context: RequestContext<Self::Context>,
+    ) -> Result<
+        HttpResponseOk<
+            trust_quorum_types_versions::v1::status::CoordinatorStatus,
+        >,
+        HttpError,
+    > {
+        // These versions were declared as returning an
+        // Option<CoordinatorStatus>, but their corresponding OpenAPI documents
+        // indicated that the CoordinatorStatus response was non-nullable. (This
+        // is a Dropshot bug; see omicron#11623). We've since changed this API
+        // to return a non-nullable CoordinatorStatus, making the API match the
+        // immutable blessed documents. But that leaves open the question of how
+        // None can be represented on the wire. We return a 404 -- old clients
+        // will receive it as an error and will handle it reasonably well.
+        use latest::trust_quorum::TrustQuorumCoordinatorStatusResponse;
+
+        Self::trust_quorum_coordinator_status(request_context).await?.try_map(
+            |response| match response {
+                TrustQuorumCoordinatorStatusResponse::Coordinating {
+                    status,
+                } => Ok(status),
+                TrustQuorumCoordinatorStatusResponse::NotCoordinating {
+                    latest_config_epoch: _,
+                } => Err(HttpError::for_client_error(
+                    None,
+                    ClientErrorStatusCode::NOT_FOUND,
+                    "this node is not currently coordinating a trust \
+                     quorum reconfiguration"
+                        .to_string(),
+                )),
+            },
+        )
+    }
+
     /// Attempt to prepare and commit a trust quorum configuration
     #[endpoint {
         method = PUT,
@@ -1672,14 +1719,44 @@ pub trait SledAgentApi {
     #[endpoint {
         method = GET,
         path = "/trust-quorum/network-config",
+        versions = VERSION_TRUST_QUORUM_NULLABLE_RESPONSES..,
     }]
     async fn trust_quorum_network_config_get(
         request_context: RequestContext<Self::Context>,
     ) -> Result<
-        HttpResponseOk<Option<latest::trust_quorum::TrustQuorumNetworkConfig>>,
+        HttpResponseOk<latest::trust_quorum::TrustQuorumNetworkConfigResponse>,
         HttpError,
     >;
 
+    /// Get the current network config from trust quorum
+    #[endpoint {
+        operation_id = "trust_quorum_network_config_get",
+        method = GET,
+        path = "/trust-quorum/network-config",
+        versions = ..VERSION_TRUST_QUORUM_NULLABLE_RESPONSES,
+    }]
+    async fn trust_quorum_network_config_get_v15(
+        request_context: RequestContext<Self::Context>,
+    ) -> Result<
+        HttpResponseOk<v15::trust_quorum::TrustQuorumNetworkConfig>,
+        HttpError,
+    > {
+        // See the comment in trust_quorum_coordinator_status_v13.
+        Self::trust_quorum_network_config_get(request_context).await?.try_map(
+            |response| {
+                response.config.ok_or_else(|| {
+                    HttpError::for_client_error(
+                        None,
+                        ClientErrorStatusCode::NOT_FOUND,
+                        "this node does not have a trust quorum network \
+                         config"
+                            .to_string(),
+                    )
+                })
+            },
+        )
+    }
+
     /// Update the network config in trust quorum
     #[endpoint {
         method = PUT,