[#1250] *: Reformat proto filets with clang-format
All checks were successful
DCO action / DCO (pull_request) Successful in 3m12s
Vulncheck / Vulncheck (pull_request) Successful in 4m9s
Build / Build Components (1.21) (pull_request) Successful in 4m31s
Build / Build Components (1.22) (pull_request) Successful in 4m30s
Tests and linters / Staticcheck (pull_request) Successful in 4m54s
Tests and linters / gopls check (pull_request) Successful in 4m56s
Tests and linters / Lint (pull_request) Successful in 6m28s
Pre-commit hooks / Pre-commit (pull_request) Successful in 8m13s
Tests and linters / Tests (1.21) (pull_request) Successful in 8m59s
Tests and linters / Tests (1.22) (pull_request) Successful in 9m8s
Tests and linters / Tests with -race (pull_request) Successful in 9m15s

Signed-off-by: Evgenii Stratonikov <e.stratonikov@yadro.com>
This commit is contained in:
Evgenii Stratonikov 2024-07-16 15:20:07 +03:00
parent d5dc14c639
commit 9724e84778
4 changed files with 99 additions and 109 deletions

View file

@ -6,106 +6,108 @@ import "pkg/services/control/ir/types.proto";
option go_package = "git.frostfs.info/TrueCloudLab/frostfs-node/pkg/services/ir/control";
// `ControlService` provides an interface for internal work with the Inner Ring node.
// `ControlService` provides an interface for internal work with the Inner Ring
// node.
service ControlService {
// Performs health check of the IR node.
rpc HealthCheck (HealthCheckRequest) returns (HealthCheckResponse);
// Forces a new epoch to be signaled by the IR node with high probability.
rpc TickEpoch (TickEpochRequest) returns (TickEpochResponse);
// Forces a node removal to be signaled by the IR node with high probability.
rpc RemoveNode (RemoveNodeRequest) returns (RemoveNodeResponse);
// Forces a container removal to be signaled by the IR node with high probability.
rpc RemoveContainer(RemoveContainerRequest) returns (RemoveContainerResponse);
// Performs health check of the IR node.
rpc HealthCheck(HealthCheckRequest) returns (HealthCheckResponse);
// Forces a new epoch to be signaled by the IR node with high probability.
rpc TickEpoch(TickEpochRequest) returns (TickEpochResponse);
// Forces a node removal to be signaled by the IR node with high probability.
rpc RemoveNode(RemoveNodeRequest) returns (RemoveNodeResponse);
// Forces a container removal to be signaled by the IR node with high
// probability.
rpc RemoveContainer(RemoveContainerRequest) returns (RemoveContainerResponse);
}
// Health check request.
message HealthCheckRequest {
// Health check request body.
message Body {}
// Health check request body.
message Body {}
// Body of health check request message.
Body body = 1;
// Body of health check request message.
Body body = 1;
// Body signature.
// Should be signed by node key or one of
// the keys configured by the node.
Signature signature = 2;
// Body signature.
// Should be signed by node key or one of
// the keys configured by the node.
Signature signature = 2;
}
// Health check response.
message HealthCheckResponse {
// Health check response body
message Body {
// Health status of IR node application.
HealthStatus health_status = 1;
}
// Health check response body
message Body {
// Health status of IR node application.
HealthStatus health_status = 1;
}
// Body of health check response message.
Body body = 1;
// Body of health check response message.
Body body = 1;
// Body signature.
Signature signature = 2;
// Body signature.
Signature signature = 2;
}
message TickEpochRequest {
message Body{
// Valid until block value override.
uint32 vub = 1;
}
message Body {
// Valid until block value override.
uint32 vub = 1;
}
Body body = 1;
Signature signature = 2;
Body body = 1;
Signature signature = 2;
}
message TickEpochResponse {
message Body{
// Valid until block value for transaction.
uint32 vub = 1;
}
message Body {
// Valid until block value for transaction.
uint32 vub = 1;
}
Body body = 1;
Signature signature = 2;
Body body = 1;
Signature signature = 2;
}
message RemoveNodeRequest {
message Body{
bytes key = 1;
// Valid until block value override.
uint32 vub = 2;
}
message Body {
bytes key = 1;
// Valid until block value override.
uint32 vub = 2;
}
Body body = 1;
Signature signature = 2;
Body body = 1;
Signature signature = 2;
}
message RemoveNodeResponse {
message Body{
// Valid until block value for transaction.
uint32 vub = 1;
}
message Body {
// Valid until block value for transaction.
uint32 vub = 1;
}
Body body = 1;
Signature signature = 2;
Body body = 1;
Signature signature = 2;
}
message RemoveContainerRequest {
message Body{
bytes container_id = 1;
bytes owner = 2;
// Valid until block value override.
uint32 vub = 3;
}
message Body {
bytes container_id = 1;
bytes owner = 2;
// Valid until block value override.
uint32 vub = 3;
}
Body body = 1;
Signature signature = 2;
Body body = 1;
Signature signature = 2;
}
message RemoveContainerResponse {
message Body{
// Valid until block value for transaction.
uint32 vub = 1;
}
message Body {
// Valid until block value for transaction.
uint32 vub = 1;
}
Body body = 1;
Signature signature = 2;
Body body = 1;
Signature signature = 2;
}

View file

@ -6,24 +6,24 @@ option go_package = "git.frostfs.info/TrueCloudLab/frostfs-node/pkg/services/ir/
// Signature of some message.
message Signature {
// Public key used for signing.
bytes key = 1 [json_name = "key"];
// Public key used for signing.
bytes key = 1 [ json_name = "key" ];
// Binary signature.
bytes sign = 2 [json_name = "signature"];
// Binary signature.
bytes sign = 2 [ json_name = "signature" ];
}
// Health status of the IR application.
enum HealthStatus {
// Undefined status, default value.
HEALTH_STATUS_UNDEFINED = 0;
// Undefined status, default value.
HEALTH_STATUS_UNDEFINED = 0;
// IR application is starting.
STARTING = 1;
// IR application is starting.
STARTING = 1;
// IR application is started and serves all services.
READY = 2;
// IR application is started and serves all services.
READY = 2;
// IR application is shutting down.
SHUTTING_DOWN = 3;
// IR application is shutting down.
SHUTTING_DOWN = 3;
}

View file

@ -28,25 +28,25 @@ service TreeService {
// Otherwise, a request is denied.
// Add adds new node to the tree. Invoked by a client.
rpc Add (AddRequest) returns (AddResponse);
rpc Add(AddRequest) returns (AddResponse);
// AddByPath adds new node to the tree by path. Invoked by a client.
rpc AddByPath (AddByPathRequest) returns (AddByPathResponse);
rpc AddByPath(AddByPathRequest) returns (AddByPathResponse);
// Remove removes node from the tree. Invoked by a client.
rpc Remove (RemoveRequest) returns (RemoveResponse);
rpc Remove(RemoveRequest) returns (RemoveResponse);
// Move moves node from one parent to another. Invoked by a client.
rpc Move (MoveRequest) returns (MoveResponse);
rpc Move(MoveRequest) returns (MoveResponse);
// GetNodeByPath returns list of IDs corresponding to a specific filepath.
rpc GetNodeByPath (GetNodeByPathRequest) returns (GetNodeByPathResponse);
rpc GetNodeByPath(GetNodeByPathRequest) returns (GetNodeByPathResponse);
// GetSubTree returns tree corresponding to a specific node.
rpc GetSubTree (GetSubTreeRequest) returns (stream GetSubTreeResponse);
rpc GetSubTree(GetSubTreeRequest) returns (stream GetSubTreeResponse);
// TreeList return list of the existing trees in the container.
rpc TreeList (TreeListRequest) returns (TreeListResponse);
rpc TreeList(TreeListRequest) returns (TreeListResponse);
/* Synchronization API */
// Apply pushes log operation from another node to the current.
// The request must be signed by a container node.
rpc Apply (ApplyRequest) returns (ApplyResponse);
rpc Apply(ApplyRequest) returns (ApplyResponse);
// GetOpLog returns a stream of logged operations starting from some height.
rpc GetOpLog(GetOpLogRequest) returns (stream GetOpLogResponse);
// Healthcheck is a dummy rpc to check service availability
@ -85,7 +85,6 @@ message AddResponse {
Signature signature = 2;
};
message AddByPathRequest {
message Body {
// Container ID in V2 format.
@ -122,7 +121,6 @@ message AddByPathResponse {
Signature signature = 2;
};
message RemoveRequest {
message Body {
// Container ID in V2 format.
@ -142,8 +140,7 @@ message RemoveRequest {
}
message RemoveResponse {
message Body {
}
message Body {}
// Response body.
Body body = 1;
@ -151,7 +148,6 @@ message RemoveResponse {
Signature signature = 2;
};
message MoveRequest {
message Body {
// TODO import neo.fs.v2.refs.ContainerID directly.
@ -176,8 +172,7 @@ message MoveRequest {
}
message MoveResponse {
message Body {
}
message Body {}
// Response body.
Body body = 1;
@ -185,7 +180,6 @@ message MoveResponse {
Signature signature = 2;
};
message GetNodeByPathRequest {
message Body {
// Container ID in V2 format.
@ -235,7 +229,6 @@ message GetNodeByPathResponse {
Signature signature = 2;
};
message GetSubTreeRequest {
message Body {
message Order {
@ -307,7 +300,6 @@ message TreeListResponse {
Signature signature = 2;
}
message ApplyRequest {
message Body {
// Container ID in V2 format.
@ -325,8 +317,7 @@ message ApplyRequest {
}
message ApplyResponse {
message Body {
}
message Body {}
// Response body.
Body body = 1;
@ -334,7 +325,6 @@ message ApplyResponse {
Signature signature = 2;
};
message GetOpLogRequest {
message Body {
// Container ID in V2 format.
@ -366,8 +356,7 @@ message GetOpLogResponse {
};
message HealthcheckResponse {
message Body {
}
message Body {}
// Response body.
Body body = 1;
@ -376,8 +365,7 @@ message HealthcheckResponse {
};
message HealthcheckRequest {
message Body {
}
message Body {}
// Request body.
Body body = 1;

View file

@ -10,25 +10,25 @@ option go_package = "git.frostfs.info/TrueCloudLab/frostfs-node/pkg/services/tre
// KeyValue represents key-value pair attached to an object.
message KeyValue {
// Attribute name.
string key = 1 [json_name = "key"];
string key = 1 [ json_name = "key" ];
// Attribute value.
bytes value = 2 [json_name = "value"];
bytes value = 2 [ json_name = "value" ];
}
// LogMove represents log-entry for a single move operation.
message LogMove {
// ID of the parent node.
uint64 parent_id = 1 [json_name = "parentID"];
uint64 parent_id = 1 [ json_name = "parentID" ];
// Node meta information, including operation timestamp.
bytes meta = 2 [json_name = "meta"];
bytes meta = 2 [ json_name = "meta" ];
// ID of the node to move.
uint64 child_id = 3 [json_name = "childID"];
uint64 child_id = 3 [ json_name = "childID" ];
}
// Signature of a message.
message Signature {
// Serialized public key as defined in FrostFS API.
bytes key = 1 [json_name = "key"];
bytes key = 1 [ json_name = "key" ];
// Signature of a message body.
bytes sign = 2 [json_name = "signature"];
bytes sign = 2 [ json_name = "signature" ];
}