add update start and stop without deciding what their responses are

Author: david-crespo

nexus/src/external_api/http_entrypoints.rs

@@ -280,6 +280,8 @@ pub fn external_api() -> NexusApiDescription {
         api.register(system_component_version_list)?;
         api.register(system_update_list)?;
         api.register(system_update_view)?;
+        api.register(system_update_start)?;
+        api.register(system_update_stop)?;
         api.register(system_update_components_list)?;
 
         api.register(user_list)?;
@@ -5120,6 +5122,9 @@ async fn system_update_list(
 /// Path parameters for SystemUpdate requests
 #[derive(Deserialize, JsonSchema)]
 struct SystemUpdatePathParam {
+    // TODO: do updates have names? Should this therefore be NameOrId? Do we
+    // allow access by some other string identifier (like version) which, like
+    // Name, is disjoint with the set of Uuids? NameOrVersion?
     update_id: Uuid,
 }
 
@@ -5166,6 +5171,52 @@ async fn system_update_components_list(
     apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
 }
 
+// TODO: 204 isn't the right response
+
+/// Start system update
+#[endpoint {
+    method = POST,
+    path = "/v1/system/update/updates/{update_id}/start",
+    tags = ["system"],
+}]
+async fn system_update_start(
+    rqctx: Arc<RequestContext<Arc<ServerContext>>>,
+    path_params: Path<SystemUpdatePathParam>,
+) -> Result<HttpResponseUpdatedNoContent, HttpError> {
+    let apictx = rqctx.context();
+    let _nexus = &apictx.nexus;
+    let _path = path_params.into_inner();
+    let handler = async {
+        let _opctx = OpContext::for_external_api(&rqctx).await?;
+        Ok(HttpResponseUpdatedNoContent())
+    };
+    apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
+}
+
+// TODO: since there can only be one system update going at a time, does /stop
+// even need to hang off the detail endpoint? `POST /system/update/stop` would
+// be sufficient, and if the system is currently steady, it would be a noop
+
+/// Stop system update
+#[endpoint {
+    method = POST,
+    path = "/v1/system/update/updates/{update_id}/stop",
+    tags = ["system"],
+}]
+async fn system_update_stop(
+    rqctx: Arc<RequestContext<Arc<ServerContext>>>,
+    path_params: Path<SystemUpdatePathParam>,
+) -> Result<HttpResponseUpdatedNoContent, HttpError> {
+    let apictx = rqctx.context();
+    let _nexus = &apictx.nexus;
+    let _path = path_params.into_inner();
+    let handler = async {
+        let _opctx = OpContext::for_external_api(&rqctx).await?;
+        Ok(HttpResponseUpdatedNoContent())
+    };
+    apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
+}
+
 // Sagas
 
 /// List sagas

nexus/tests/output/nexus_tags.txt

@@ -181,6 +181,8 @@ system_image_view                        /system/images/{image_name}
 system_image_view_by_id                  /system/by-id/images/{id}
 system_update_components_list            /v1/system/update/updates/{update_id}/components
 system_update_list                       /v1/system/update/updates
+system_update_start                      /v1/system/update/updates/{update_id}/start
+system_update_stop                       /v1/system/update/updates/{update_id}/stop
 system_update_view                       /v1/system/update/updates/{update_id}
 system_user_list                         /system/user
 system_user_view                         /system/user/{user_name}

nexus/types/src/external_api/views.rs

@@ -479,6 +479,8 @@ pub enum VersionStatus {
 pub struct SystemVersion {
     pub version_range: VersionRange,
     pub status: VersionStatus,
+    // TODO: time_released? time_last_applied? I got a fever and the only
+    // prescription is more timestamps
 }
 
 #[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
@@ -502,8 +504,9 @@ pub struct ComponentUpdate {
     pub device_id: String,
     pub device_type: DeviceType,
     pub version: SemverVersion,
-    /// ID of the parent component, e.g., the sled a disk belongs to. Value will
-    /// be `None` for top-level components whose "parent" is the rack.
+    // TODO: parent ID doesn't need to be optional if we say top-level
+    // components have the rack as their parent
+    /// ID of the parent component. Not present for top-level components.
     pub parent_id: Option<Uuid>,
 }
 

openapi/nexus.json

@@ -8598,6 +8598,68 @@
         }
       }
     },
+    "/v1/system/update/updates/{update_id}/start": {
+      "post": {
+        "tags": [
+          "system"
+        ],
+        "summary": "Start system update",
+        "operationId": "system_update_start",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "update_id",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "resource updated"
+          },
+          "4XX": {
+            "$ref": "#/components/responses/Error"
+          },
+          "5XX": {
+            "$ref": "#/components/responses/Error"
+          }
+        }
+      }
+    },
+    "/v1/system/update/updates/{update_id}/stop": {
+      "post": {
+        "tags": [
+          "system"
+        ],
+        "summary": "Stop system update",
+        "operationId": "system_update_stop",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "update_id",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "resource updated"
+          },
+          "4XX": {
+            "$ref": "#/components/responses/Error"
+          },
+          "5XX": {
+            "$ref": "#/components/responses/Error"
+          }
+        }
+      }
+    },
     "/v1/system/update/version": {
       "get": {
         "tags": [
@@ -8858,7 +8920,7 @@
           },
           "parent_id": {
             "nullable": true,
-            "description": "ID of the parent component, e.g., the sled a disk belongs to. Value will be `None` for top-level components whose \"parent\" is the rack.",
+            "description": "ID of the parent component. Not present for top-level components.",
             "type": "string",
             "format": "uuid"
           },