frostfs-api-go/state/service.proto

124 lines
6 KiB
Protocol Buffer
Raw Normal View History

2019-11-18 13:34:06 +00:00
syntax = "proto3";
package state;
2020-03-31 07:05:26 +00:00
option go_package = "github.com/nspcc-dev/neofs-api-go/state";
2020-02-05 13:58:06 +00:00
option csharp_namespace = "NeoFS.API.State";
2019-11-18 13:34:06 +00:00
2019-11-18 16:22:08 +00:00
import "service/meta.proto";
import "service/verify.proto";
2019-11-18 13:34:06 +00:00
import "bootstrap/types.proto";
import "github.com/gogo/protobuf/gogoproto/gogo.proto";
option (gogoproto.stable_marshaler_all) = true;
2020-04-20 10:54:34 +00:00
// Status service provides node's healthcheck and status info.
// TODO: decide how to describe auth and were contains permissions.
2019-11-18 13:34:06 +00:00
service Status {
2019-11-20 16:33:10 +00:00
// Netmap request allows to receive current [bootstrap.SpreadMap](bootstrap.md#bootstrap.SpreadMap)
2019-11-18 13:34:06 +00:00
rpc Netmap(NetmapRequest) returns (bootstrap.SpreadMap);
2019-11-20 16:33:10 +00:00
// Metrics request allows to receive metrics in prometheus format
2019-11-18 13:34:06 +00:00
rpc Metrics(MetricsRequest) returns (MetricsResponse);
2019-11-20 16:33:10 +00:00
// HealthCheck request allows to check health status of the node.
// If node unhealthy field Status would contains detailed info.
2019-11-18 13:34:06 +00:00
rpc HealthCheck(HealthRequest) returns (HealthResponse);
// DumpConfig request allows dumping settings for the current node.
// To permit access, used server config options.
// The request should be signed.
rpc DumpConfig(DumpRequest) returns (DumpResponse);
// DumpVars returns debug variables for the current node.
// To permit access, used server config options.
// The request should be signed.
rpc DumpVars(DumpVarsRequest) returns (DumpVarsResponse);
2020-04-20 10:54:34 +00:00
// ChangeState allows to change current node state of node.
// To permit access, used server config options.
// The request should be signed.
rpc ChangeState(ChangeStateRequest) returns (ChangeStateResponse);
2019-11-18 13:34:06 +00:00
}
// NetmapRequest message to request current node netmap
2019-11-18 16:22:08 +00:00
message NetmapRequest {
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
2019-11-18 16:22:08 +00:00
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
2019-11-18 16:22:08 +00:00
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
}
2019-11-18 13:34:06 +00:00
// MetricsRequest message to request node metrics
2019-11-18 16:22:08 +00:00
message MetricsRequest {
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
2019-11-18 16:22:08 +00:00
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
2019-11-18 16:22:08 +00:00
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
}
2019-11-18 13:34:06 +00:00
// MetricsResponse contains [][]byte,
// every []byte is marshaled MetricFamily proto message
// from github.com/prometheus/client_model/metrics.proto
message MetricsResponse {
repeated bytes Metrics = 1;
}
// HealthRequest message to check current state
2019-11-18 16:22:08 +00:00
message HealthRequest {
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
2019-11-18 16:22:08 +00:00
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
2019-11-18 16:22:08 +00:00
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
}
2019-11-18 13:34:06 +00:00
// HealthResponse message with current state
message HealthResponse {
2019-11-20 16:33:10 +00:00
// Healthy is true when node alive and healthy
2019-11-18 13:34:06 +00:00
bool Healthy = 1;
2019-11-20 16:33:10 +00:00
// Status contains detailed information about health status
2019-11-18 13:34:06 +00:00
string Status = 2;
}
// DumpRequest message to fetch current server config.
message DumpRequest {
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
}
// DumpResponse message contains current server config.
// Config stored in JSON encoded into slice of bytes.
message DumpResponse {
bytes Config = 1;
}
// DumpVarsRequest message to fetch current server debug variables.
message DumpVarsRequest {
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
}
// DumpVarsResponse message contains current server debug variables.
// Variables stored in JSON encoded into slice of bytes.
message DumpVarsResponse {
bytes Variables = 1;
}
2020-04-20 10:54:34 +00:00
// ChangeStateRequest contains a new state of node.
message ChangeStateRequest {
enum State {
// Unknown is default value. Does nothing.
Unknown = 0;
// Online used when need to set node to the online state.
Online = 1;
// Offline used when need to set node to the offline state.
Offline = 2;
}
// State is a new state of node.
State state = 1;
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
}
// ChangeStateResponse is an empty response, that returns when RPC invoked without errors.
message ChangeStateResponse {}