Skip to content
Draft
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
18 changes: 18 additions & 0 deletions README_nestedapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,21 @@
Response:

The body will contain the NestedAppRuntimeDiskMetric structure in protobuf form.

### Runtime Status

To retrieve the status of config applied to a runtime such as cloud-init networking config

Check failure on line 69 in README_nestedapp.md

View workflow job for this annotation

GitHub Actions / yetus

markdownlint:MD013/line-length Line length [Expected: 80; Actual: 90]
a runtime will return a RuntimeStatus protobuf structure at the following endpoint. EVE

Check failure on line 70 in README_nestedapp.md

View workflow job for this annotation

GitHub Actions / yetus

markdownlint:MD013/line-length Line length [Expected: 80; Actual: 87]
should read the error present in the RuntimeStatus and set it in the ZInfoApp for the

Check failure on line 71 in README_nestedapp.md

View workflow job for this annotation

GitHub Actions / yetus

markdownlint:MD013/line-length Line length [Expected: 80; Actual: 85]
App Instance containing the runtime.

GET /api/v1/runtime/status

Return codes:

* Metric Object Returned: `200`
* Non-Get type request: `405`

Response:

The body will contain the RuntimeStatus structure in protobuf form.
29 changes: 29 additions & 0 deletions proto/nestedappinstancemetrics/runtimestatus.proto
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Copyright(c) 2025 Zededa, Inc.
// SPDX-License-Identifier: Apache-2.0

syntax = "proto3";

import "info/info.proto";
import "google/protobuf/timestamp.proto";

package org.lfedge.eve.nestedappinstancemetrics;
option go_package = "github.com/lf-edge/eve-api/go/nestedappinstancemetrics";

// Errors in response to the application of configuration
message RuntimeErrorInfo {
string description = 1;
google.protobuf.Timestamp timestamp = 2; // Timestamp at which error had occurred
}

// RuntimeStatus represents the status of a runtime on EVE-OS
// which may reside in an AppInstance.
// A single RuntimeStatus in protobuf form will be returned from
// GET /api/v1/runtime/status for every AppInstance where
// AppInstanceConfig.runtime_type!=APP_RUNTIME_TYPE_UNSPECIFIED
message RuntimeStatus {
// Id is the uuid of the runtime app instance
string id = 1;

// Errors reported by a runtime when applying config eg. cloud-init
RuntimeErrorInfo err = 2;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be repeated field since you are mentioning errors in the plural form?

}