Skip to content
This repository was archived by the owner on Mar 24, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions docs/docs/api/platform-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -3585,7 +3585,7 @@ The rollout model.

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| num_updated | [uint32](#uint32) | | The number of updated instances. |
| num_upgrading | [uint32](#uint32) | | The number of updated instances. |
| num_ready | [uint32](#uint32) | | The number of ready instances. |
| num_stuck | [uint32](#uint32) | | The number of stuck instances. |
| num_wrong_version | [uint32](#uint32) | | The number of instances with the wrong version. |
Expand Down Expand Up @@ -3631,6 +3631,27 @@ The rollout model.



<a name="api-v1-capsule-RolloutStatus"></a>

### RolloutStatus



| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| rollout_id | [uint64](#uint64) | | |
| state | [rollout.State](#api-v1-capsule-rollout-State) | | |
| error_message | [string](#string) | | The error message if the rollout failed |
| commit_hash | [string](#string) | | The hash of the commit containing the changes |
| commit_url | [string](#string) | | The url to the commit (if known. May be empty) |
| created_at | [google.protobuf.Timestamp](#google-protobuf-Timestamp) | | |
| created_by | [model.Author](#model-Author) | | |






<a name="api-v1-capsule-Status"></a>

### Status
Expand All @@ -3641,7 +3662,7 @@ The rollout model.
| ----- | ---- | ----- | ----------- |
| namespace | [string](#string) | | |
| capsule | [CapsuleStatus](#api-v1-capsule-CapsuleStatus) | | |
| rollout | [rollout.Status](#api-v1-capsule-rollout-Status) | | |
| rollout | [RolloutStatus](#api-v1-capsule-RolloutStatus) | | |
| container_config | [ContainerConfig](#api-v1-capsule-ContainerConfig) | | |
| instances | [InstancesStatus](#api-v1-capsule-InstancesStatus) | | |
| interfaces | [InterfaceStatus](#api-v1-capsule-InterfaceStatus) | repeated | |
Expand Down
19 changes: 17 additions & 2 deletions proto/rig/api/v1/capsule/status.proto
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@ import "api/v1/capsule/rollout/status.proto";
import "api/v1/capsule/change.proto";
import "operator/api/v1/pipeline/object_status.proto";
import "api/v1/capsule/job.proto";
import "google/protobuf/timestamp.proto";
import "model/author.proto";

message Status {
string namespace = 1;
CapsuleStatus capsule = 2;
api.v1.capsule.rollout.Status rollout = 3;
RolloutStatus rollout = 3;
ContainerConfig container_config = 4;
InstancesStatus instances = 5;
repeated InterfaceStatus interfaces = 6;
Expand All @@ -22,9 +24,22 @@ message CapsuleStatus {
repeated api.v1.pipeline.ObjectStatus statuses = 1;
}

message RolloutStatus {
uint64 rollout_id = 1;
api.v1.capsule.rollout.State state = 2;
// The error message if the rollout failed
string error_message = 3;
// The hash of the commit containing the changes
string commit_hash = 4;
// The url to the commit (if known. May be empty)
string commit_url = 5;
google.protobuf.Timestamp created_at = 6;
model.Author created_by = 7;
}

message InstancesStatus {
// The number of updated instances.
uint32 num_updated = 1;
uint32 num_upgrading = 1;
// The number of ready instances.
uint32 num_ready = 2;
// The number of stuck instances.
Expand Down