-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ππ½πΏ] changes to main this commit is based on
Created using spr 1.3.6-beta.1 [skip ci]
- Loading branch information
1 parent
fe60eb9
commit 85ebaf5
Showing
31 changed files
with
340 additions
and
531 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
.../installinator-artifact-client/Cargo.toml β clients/installinator-client/Cargo.toml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| // 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/. | ||
|
|
||
| //! The REST API that installinator is a client of. | ||
| //! | ||
| //! Note that most of our APIs are named by their server. This one is instead | ||
| //! named by the client, since it is expected that multiple services will | ||
| //! implement it. | ||
| use anyhow::{anyhow, Result}; | ||
| use dropshot::{ | ||
| ConfigDropshot, FreeformBody, HandlerTaskMode, HttpError, | ||
| HttpResponseHeaders, HttpResponseOk, HttpResponseUpdatedNoContent, | ||
| HttpServerStarter, Path, RequestContext, TypedBody, | ||
| }; | ||
| use hyper::{header, Body, StatusCode}; | ||
| use installinator_common::EventReport; | ||
| use omicron_common::update::ArtifactHashId; | ||
| use schemars::JsonSchema; | ||
| use serde::Deserialize; | ||
| use uuid::Uuid; | ||
|
|
||
| #[derive(Debug, Deserialize, JsonSchema)] | ||
| pub struct ReportQuery { | ||
| /// A unique identifier for the update. | ||
| pub update_id: Uuid, | ||
| } | ||
|
|
||
| #[dropshot::api_description] | ||
| pub trait InstallinatorApi { | ||
| type Context; | ||
|
|
||
| /// Fetch an artifact by hash. | ||
| #[endpoint { | ||
| method = GET, | ||
| path = "/artifacts/by-hash/{kind}/{hash}", | ||
| }] | ||
| async fn get_artifact_by_hash( | ||
| rqctx: RequestContext<Self::Context>, | ||
| path: Path<ArtifactHashId>, | ||
| ) -> Result<HttpResponseHeaders<HttpResponseOk<FreeformBody>>, HttpError>; | ||
|
|
||
| /// Report progress and completion to the server. | ||
| /// | ||
| /// This method requires an `update_id` path parameter. This update ID is | ||
| /// matched against the server currently performing an update. If the | ||
| /// server is unaware of the update ID, it will return an HTTP 422 | ||
| /// Unprocessable Entity code. | ||
| #[endpoint { | ||
| method = POST, | ||
| path = "/report-progress/{update_id}", | ||
| }] | ||
| async fn report_progress( | ||
| rqctx: RequestContext<Self::Context>, | ||
| path: Path<ReportQuery>, | ||
| report: TypedBody<EventReport>, | ||
| ) -> Result<HttpResponseUpdatedNoContent, HttpError>; | ||
| } | ||
|
|
||
| /// Add a content length header to a response. | ||
| /// | ||
| /// Intended to be called by `get_artifact_by_hash` implementations. | ||
| pub fn body_to_artifact_response( | ||
| size: u64, | ||
| body: Body, | ||
| ) -> HttpResponseHeaders<HttpResponseOk<FreeformBody>> { | ||
| let mut response = | ||
| HttpResponseHeaders::new_unnamed(HttpResponseOk(body.into())); | ||
| let headers = response.headers_mut(); | ||
| headers.append(header::CONTENT_LENGTH, size.into()); | ||
| response | ||
| } | ||
|
|
||
| /// The result of processing an installinator event report. | ||
| #[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Hash)] | ||
| #[must_use] | ||
| pub enum EventReportStatus { | ||
| /// This report was processed by the server. | ||
| Processed, | ||
|
|
||
| /// The update ID was not recognized by the server. | ||
| UnrecognizedUpdateId, | ||
|
|
||
| /// The progress receiver is closed. | ||
| ReceiverClosed, | ||
| } | ||
|
|
||
| impl EventReportStatus { | ||
| /// Convert this status to an HTTP result. | ||
| /// | ||
| /// Intended to be called by `report_progress` implementations. | ||
| pub fn to_http_result( | ||
| self, | ||
| update_id: Uuid, | ||
| ) -> Result<HttpResponseUpdatedNoContent, HttpError> { | ||
| match self { | ||
| EventReportStatus::Processed => Ok(HttpResponseUpdatedNoContent()), | ||
| EventReportStatus::UnrecognizedUpdateId => { | ||
| Err(HttpError::for_client_error( | ||
| None, | ||
| StatusCode::UNPROCESSABLE_ENTITY, | ||
| format!( | ||
| "update ID {update_id} unrecognized by this server" | ||
| ), | ||
| )) | ||
| } | ||
| EventReportStatus::ReceiverClosed => { | ||
| Err(HttpError::for_client_error( | ||
| None, | ||
| StatusCode::GONE, | ||
| format!("update ID {update_id}: receiver closed"), | ||
| )) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Creates a default `ConfigDropshot` for the installinator API. | ||
| pub fn default_config(bind_address: std::net::SocketAddr) -> ConfigDropshot { | ||
| ConfigDropshot { | ||
| bind_address, | ||
| // Even though the installinator sets an upper bound on the number of | ||
| // items in a progress report, they can get pretty large if they | ||
| // haven't gone through for a bit. Ensure that hitting the max request | ||
| // size won't cause a failure by setting a generous upper bound for the | ||
| // request size. | ||
| // | ||
| // TODO: replace with an endpoint-specific option once | ||
| // https://github.com/oxidecomputer/dropshot/pull/618 lands and is | ||
| // available in omicron. | ||
| request_body_max_bytes: 4 * 1024 * 1024, | ||
| default_handler_task_mode: HandlerTaskMode::Detached, | ||
| } | ||
| } | ||
|
|
||
| /// Make an `HttpServerStarter` for the installinator API with default settings. | ||
| pub fn make_server_starter<T: InstallinatorApi>( | ||
| context: T::Context, | ||
| bind_address: std::net::SocketAddr, | ||
| log: &slog::Logger, | ||
| ) -> Result<HttpServerStarter<T::Context>> { | ||
| let dropshot_config = dropshot::ConfigDropshot { | ||
| bind_address, | ||
| // Even though the installinator sets an upper bound on the number | ||
| // of items in a progress report, they can get pretty large if they | ||
| // haven't gone through for a bit. Ensure that hitting the max | ||
| // request size won't cause a failure by setting a generous upper | ||
| // bound for the request size. | ||
| // | ||
| // TODO: replace with an endpoint-specific option once | ||
| // https://github.com/oxidecomputer/dropshot/pull/618 lands and is | ||
| // available in omicron. | ||
| request_body_max_bytes: 4 * 1024 * 1024, | ||
| default_handler_task_mode: HandlerTaskMode::Detached, | ||
| }; | ||
|
|
||
| let api = crate::installinator_api::api_description::<T>()?; | ||
| let server = | ||
| dropshot::HttpServerStarter::new(&dropshot_config, api, context, &log) | ||
| .map_err(|error| { | ||
| anyhow!(error) | ||
| .context("failed to create installinator artifact server") | ||
| })?; | ||
|
|
||
| Ok(server) | ||
| } |
Oops, something went wrong.