pipeline-manager: track pipeline lifecycle history #4593
There are no files selected for viewing
This file contains hidden or 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,12 @@ | ||
| CREATE TABLE IF NOT EXISTS pipeline_lifecycle_events ( | ||
| event_id uuid PRIMARY KEY DEFAULT gen_random_uuid(), | ||
| pipeline_id uuid NOT NULL, | ||
| tenant_id uuid NOT NULL, | ||
| deployment_resources_status varchar NOT NULL, | ||
| deployment_runtime_status varchar, | ||
| deployment_runtime_desired_status varchar, | ||
|
Contributor
There was a problem hiding this comment. storage_status |
||
| info text, | ||
| recorded_at TIMESTAMP NOT NULL DEFAULT now(), | ||
| FOREIGN KEY (pipeline_id) REFERENCES pipeline(id) ON DELETE CASCADE, | ||
| FOREIGN KEY (tenant_id) REFERENCES tenant(id) ON DELETE CASCADE | ||
| ); | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,80 @@ | ||
| use actix_web::{ | ||
| get, | ||
| web::{self, Data as WebData, ReqData}, | ||
| HttpResponse, | ||
| }; | ||
|
|
||
| use crate::{ | ||
| api::{examples, main::ServerState}, | ||
| db::{storage::Storage, types::tenant::TenantId}, | ||
| error::ManagerError, | ||
| }; | ||
|
|
||
| /// Query parameters for lifecycle events endpoint. | ||
| #[derive(serde::Deserialize)] | ||
| pub struct EventsParameters { | ||
| pub max_events: u32, | ||
|
Contributor
There was a problem hiding this comment. Default? I think last 20 makes sense. |
||
| } | ||
|
|
||
| /// Get lifecycle events for a pipeline. | ||
| /// | ||
| /// Returns a list of lifecycle events for the specified pipeline. | ||
| /// The number of events returned is controlled by the `max_events` query parameter. | ||
| /// | ||
| /// # Parameters | ||
| /// - `pipeline_name`: Unique pipeline name (path parameter) | ||
| /// - `max_events`: Maximum number of events to return (query parameter, required) | ||
|
|
||
| /// | ||
| /// # Returns | ||
| /// - 200 OK: List of lifecycle events for the pipeline | ||
| /// - 404 NOT_FOUND: Pipeline with that name does not exist | ||
| /// - 503 SERVICE_UNAVAILABLE: Disconnected or timeout during response | ||
|
Contributor
There was a problem hiding this comment. I don't think this specific 503 can happen, nothing is being HTTP interacted with? |
||
| /// - 500 INTERNAL_SERVER_ERROR: Internal error | ||
| #[utoipa::path( | ||
| context_path = "/v0", | ||
| security(("JSON web token (JWT) or API key" = [])), | ||
| params( | ||
| ("pipeline_name" = String, Path, description = "Unique pipeline name"), | ||
| ("max_events" = u32, Query, description = "Maximum number of events to return") | ||
| ), | ||
| responses( | ||
| (status = OK | ||
| , description = "List of lifecycle events for the pipeline" | ||
| , content_type = "application/json" | ||
| , body = Vec<PipelineLifecycleEvent>), | ||
| (status = NOT_FOUND | ||
| , description = "Pipeline with that name does not exist" | ||
| , body = ErrorResponse | ||
| , example = json!(examples::error_unknown_pipeline_name())), | ||
| (status = SERVICE_UNAVAILABLE | ||
| , body = ErrorResponse | ||
| , examples( | ||
| ("Disconnected during response" = (value = json!(examples::error_pipeline_interaction_disconnected()))), | ||
| ("Response timeout" = (value = json!(examples::error_pipeline_interaction_timeout()))) | ||
| ) | ||
| ), | ||
| (status = INTERNAL_SERVER_ERROR, body = ErrorResponse), | ||
| ), | ||
| tag = "Pipeline interaction" | ||
| )] | ||
| #[get("/pipelines/{pipeline_name}/lifecycle_events")] | ||
| pub(crate) async fn get_pipeline_lifecycle_events( | ||
| state: WebData<ServerState>, | ||
| tenant_id: ReqData<TenantId>, | ||
| path: web::Path<String>, | ||
| query: web::Query<EventsParameters>, | ||
| ) -> Result<HttpResponse, ManagerError> { | ||
| let pipeline_name = path.into_inner(); | ||
| let max_events = query.max_events; | ||
|
|
||
| let events = state | ||
| .db | ||
| .lock() | ||
| .await | ||
| .get_pipeline_lifecycle_events(*tenant_id, &pipeline_name, max_events) | ||
| .await?; | ||
|
|
||
| Ok(HttpResponse::Ok() | ||
| .content_type("application/json") | ||
|
Contributor
There was a problem hiding this comment. I think .json() already sets the content type by itself. |
||
| .json(events)) | ||
| } | ||
This file contains hidden or 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,15 @@ | ||
| use chrono::NaiveDateTime; | ||
| use serde::{Deserialize, Serialize}; | ||
| use utoipa::ToSchema; | ||
| use uuid::Uuid; | ||
|
|
||
| // Pipeline Lifecycle Events | ||
|
Contributor
There was a problem hiding this comment. Description of what it represent? |
||
| #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, ToSchema)] | ||
| pub struct PipelineLifecycleEvent { | ||
| pub event_id: Uuid, | ||
| pub deployment_resources_status: String, | ||
| pub deployment_runtime_status: Option<String>, | ||
| pub deployment_runtime_desired_status: Option<String>, | ||
| pub info: Option<String>, | ||
| pub recorded_at: NaiveDateTime, | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also:
deployment_resources_desired_status