System Update API

Cargo.toml

@@ -183,6 +183,7 @@ ring = "0.16"
 rustfmt-wrapper = "0.2"
 samael = { git = "https://github.com/njaremko/samael", features = ["xmlsec"], branch = "master" }
 schemars = "0.8.10"
+semver = { version = "1.0.16", features = ["std", "serde"] }
 serde = { version = "1.0", default-features = false, features = [ "derive" ] }
 serde_derive = "1.0"
 serde_json = "1.0.91"

nexus/Cargo.toml

@@ -54,6 +54,7 @@ reqwest = { workspace = true, features = [ "json" ] }
 ring.workspace = true
 samael.workspace = true
 schemars = { workspace = true, features = ["chrono", "uuid1"] }
+semver.workspace = true
 serde.workspace = true
 serde_json.workspace = true
 serde_urlencoded.workspace = true

nexus/src/external_api/http_entrypoints.rs

@@ -10,8 +10,10 @@ use super::{
     console_api, device_auth, params, views,
     views::{
         GlobalImage, Group, IdentityProvider, Image, Organization, Project,
-        Rack, Role, Silo, Sled, Snapshot, SshKey, User, UserBuiltin, Vpc,
-        VpcRouter, VpcSubnet,
+        Rack, Role, Silo, Sled, Snapshot, SshKey, SystemUpdate,
+        SystemUpdateStatus, SystemVersionRange, SystemVersionStatus,
+        SystemVersionSteadyReason, User, UserBuiltin, Vpc, VpcRouter,
+        VpcSubnet,
     },
 };
 use crate::authz;
@@ -72,6 +74,7 @@ use omicron_common::bail_unless;
 use parse_display::Display;
 use ref_cast::RefCast;
 use schemars::JsonSchema;
+// use semver;
 use serde::Deserialize;
 use serde::Serialize;
 use std::sync::Arc;
@@ -274,6 +277,9 @@ pub fn external_api() -> NexusApiDescription {
         api.register(system_image_delete)?;
 
         api.register(updates_refresh)?;
+        api.register(system_update_status)?;
+        api.register(system_update_list)?;
+        api.register(system_update_view)?;
 
         api.register(user_list)?;
         api.register(silo_users_list)?;
@@ -5048,6 +5054,81 @@ async fn updates_refresh(
     apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
 }
 
+/// List all updates
+#[endpoint {
+     method = GET,
+     path = "/v1/system/update/status",
+     tags = ["system"],
+}]
+async fn system_update_status(
+    rqctx: Arc<RequestContext<Arc<ServerContext>>>,
+) -> Result<HttpResponseOk<SystemUpdateStatus>, HttpError> {
+    let apictx = rqctx.context();
+    let _nexus = &apictx.nexus;
+    let handler = async {
+        let _opctx = OpContext::for_external_api(&rqctx).await?;
+        Ok(HttpResponseOk(SystemUpdateStatus {
+            version_range: SystemVersionRange {
+                // low: semver::Version::new(0, 0, 1),
+                low: String::from("0.0.1"),
+                // high: semver::Version::new(0, 0, 2),
+                high: String::from("0.0.2"),
+            },
+            status: SystemVersionStatus::Steady {
+                reason: SystemVersionSteadyReason::Completed,
+            },
+        }))
+    };
+    apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
+}
+
+/// List all updates
+#[endpoint {
+     method = GET,
+     path = "/v1/system/update/updates",
+     tags = ["system"],
+}]
+async fn system_update_list(
+    rqctx: Arc<RequestContext<Arc<ServerContext>>>,
+) -> Result<HttpResponseOk<ResultsPage<SystemUpdate>>, HttpError> {
+    let apictx = rqctx.context();
+    let _nexus = &apictx.nexus;
+    let handler = async {
+        let _opctx = OpContext::for_external_api(&rqctx).await?;
+        Ok(HttpResponseOk(ResultsPage { items: vec![], next_page: None }))
+    };
+    apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
+}
+
+/// Path parameters for SystemUpdate requests
+#[derive(Deserialize, JsonSchema)]
+struct SystemUpdatePathParam {
+    update_id: Uuid,
+}
+
+/// View update
+#[endpoint {
+     method = GET,
+     path = "/v1/system/update/updates/{update_id}",
+     tags = ["system"],
+}]
+async fn system_update_view(
+    rqctx: Arc<RequestContext<Arc<ServerContext>>>,
+    path_params: Path<SystemUpdatePathParam>,
+) -> Result<HttpResponseOk<SystemUpdate>, 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(HttpResponseOk(SystemUpdate {
+            id: path.update_id,
+            version: String::from("1.0.0"),
+        }))
+    };
+    apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
+}
+
 // Sagas
 
 /// List sagas

nexus/tests/output/nexus_tags.txt

@@ -178,6 +178,9 @@ system_image_delete                      /system/images/{image_name}
 system_image_list                        /system/images
 system_image_view                        /system/images/{image_name}
 system_image_view_by_id                  /system/by-id/images/{id}
+system_update_list                       /v1/system/update/updates
+system_update_status                     /v1/system/update/status
+system_update_view                       /v1/system/update/updates/{update_id}
 system_user_list                         /system/user
 system_user_view                         /system/user/{user_name}
 updates_refresh                          /system/updates/refresh

nexus/types/Cargo.toml

@@ -11,6 +11,7 @@ base64.workspace = true
 openssl.workspace = true
 openssl-sys.workspace = true
 openssl-probe.workspace = true
+semver.workspace = true
 schemars = { workspace = true, features = ["chrono", "uuid1"] }
 serde.workspace = true
 serde_json.workspace = true

nexus/types/src/external_api/views.rs

@@ -14,6 +14,7 @@ use omicron_common::api::external::{
     ObjectIdentity, RoleName,
 };
 use schemars::JsonSchema;
+// use semver;
 use serde::{Deserialize, Serialize};
 use std::net::IpAddr;
 use std::net::SocketAddrV6;
@@ -412,3 +413,47 @@ pub struct DeviceAccessTokenGrant {
 pub enum DeviceAccessTokenType {
     Bearer,
 }
+
+// SYSTEM UPDATES
+
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
+pub struct SystemVersionRange {
+    // TODO: if we want to use semver::Version, I think we have to newtype it
+    // in order to implement JsonSchema. ew
+    // pub low: semver::Version,
+    // pub high: semver::Version,
+    pub low: String,
+    pub high: String,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "snake_case")]
+pub enum SystemVersionSteadyReason {
+    Completed,
+    Stopped,
+    Failed,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "snake_case")]
+pub enum SystemVersionStatus {
+    Updating {
+        // target: semver::Version
+        target: String,
+    },
+    Steady {
+        reason: SystemVersionSteadyReason,
+    },
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
+pub struct SystemUpdateStatus {
+    pub version_range: SystemVersionRange,
+    pub status: SystemVersionStatus,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize, JsonSchema)]
+pub struct SystemUpdate {
+    pub id: Uuid,
+    pub version: String,
+}