forked from TrueCloudLab/frostfs-api
[#34] bootstrap: Remove Bootstrap service
Remove Bootstrap service with all related types from bootstrap package since it was used to prototype NeoFS system. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich
Stanislav Bogatyrev
parent
7c71813d22
commit
5b410c6915
2 changed files with 0 additions and 113 deletions
|
|
@ -1,42 +0,0 @@
|
||||||
syntax = "proto3";
|
|
||||||
package bootstrap;
|
|
||||||
option go_package = "github.com/nspcc-dev/neofs-api-go/bootstrap";
|
|
||||||
option csharp_namespace = "NeoFS.API.Bootstrap";
|
|
||||||
|
|
||||||
import "service/meta.proto";
|
|
||||||
import "service/verify.proto";
|
|
||||||
import "bootstrap/types.proto";
|
|
||||||
import "github.com/gogo/protobuf/gogoproto/gogo.proto";
|
|
||||||
|
|
||||||
option (gogoproto.stable_marshaler_all) = true;
|
|
||||||
|
|
||||||
// Bootstrap service allows neofs-node to connect to the network. Node should
|
|
||||||
// perform at least one bootstrap request in the epoch to stay in the network
|
|
||||||
// for the next epoch.
|
|
||||||
service Bootstrap {
|
|
||||||
// Process is method that allows to register node in the network and receive actual netmap
|
|
||||||
rpc Process(Request) returns (bootstrap.SpreadMap);
|
|
||||||
}
|
|
||||||
|
|
||||||
message Request {
|
|
||||||
// Node state
|
|
||||||
enum State {
|
|
||||||
// used by default
|
|
||||||
Unknown = 0;
|
|
||||||
// used to inform that node online
|
|
||||||
Online = 1;
|
|
||||||
// used to inform that node offline
|
|
||||||
Offline = 2;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Type is NodeType, can be InnerRingNode (type=1) or StorageNode (type=2)
|
|
||||||
int32 type = 1 [(gogoproto.customname) = "Type" , (gogoproto.nullable) = false, (gogoproto.customtype) = "NodeType"];
|
|
||||||
// Info contains information about node
|
|
||||||
bootstrap.NodeInfo info = 2 [(gogoproto.nullable) = false];
|
|
||||||
// State contains node status
|
|
||||||
State state = 3;
|
|
||||||
// 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];
|
|
||||||
}
|
|
||||||
|
|
@ -3,14 +3,6 @@
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [bootstrap/service.proto](#bootstrap/service.proto)
|
|
||||||
- Services
|
|
||||||
- [Bootstrap](#bootstrap.Bootstrap)
|
|
||||||
|
|
||||||
- Messages
|
|
||||||
- [Request](#bootstrap.Request)
|
|
||||||
|
|
||||||
|
|
||||||
- [bootstrap/types.proto](#bootstrap/types.proto)
|
- [bootstrap/types.proto](#bootstrap/types.proto)
|
||||||
|
|
||||||
- Messages
|
- Messages
|
||||||
|
|
@ -22,69 +14,6 @@
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="bootstrap/service.proto"></a>
|
|
||||||
<p align="right"><a href="#top">Top</a></p>
|
|
||||||
|
|
||||||
## bootstrap/service.proto
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="bootstrap.Bootstrap"></a>
|
|
||||||
|
|
||||||
### Service "bootstrap.Bootstrap"
|
|
||||||
Bootstrap service allows neofs-node to connect to the network. Node should
|
|
||||||
perform at least one bootstrap request in the epoch to stay in the network
|
|
||||||
for the next epoch.
|
|
||||||
|
|
||||||
```
|
|
||||||
rpc Process(Request) returns (SpreadMap);
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Method Process
|
|
||||||
|
|
||||||
Process is method that allows to register node in the network and receive actual netmap
|
|
||||||
|
|
||||||
| Name | Input | Output |
|
|
||||||
| ---- | ----- | ------ |
|
|
||||||
| Process | [Request](#bootstrap.Request) | [SpreadMap](#bootstrap.SpreadMap) |
|
|
||||||
<!-- end services -->
|
|
||||||
|
|
||||||
|
|
||||||
<a name="bootstrap.Request"></a>
|
|
||||||
|
|
||||||
### Message Request
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Label | Description |
|
|
||||||
| ----- | ---- | ----- | ----------- |
|
|
||||||
| type | [int32](#int32) | | Type is NodeType, can be InnerRingNode (type=1) or StorageNode (type=2) |
|
|
||||||
| info | [NodeInfo](#bootstrap.NodeInfo) | | Info contains information about node |
|
|
||||||
| state | [Request.State](#bootstrap.Request.State) | | State contains node status |
|
|
||||||
| Meta | [service.RequestMetaHeader](#service.RequestMetaHeader) | | RequestMetaHeader contains information about request meta headers (should be embedded into message) |
|
|
||||||
| Verify | [service.RequestVerificationHeader](#service.RequestVerificationHeader) | | RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message) |
|
|
||||||
|
|
||||||
<!-- end messages -->
|
|
||||||
|
|
||||||
|
|
||||||
<a name="bootstrap.Request.State"></a>
|
|
||||||
|
|
||||||
### Request.State
|
|
||||||
Node state
|
|
||||||
|
|
||||||
| Name | Number | Description |
|
|
||||||
| ---- | ------ | ----------- |
|
|
||||||
| Unknown | 0 | used by default |
|
|
||||||
| Online | 1 | used to inform that node online |
|
|
||||||
| Offline | 2 | used to inform that node offline |
|
|
||||||
|
|
||||||
|
|
||||||
<!-- end enums -->
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="bootstrap/types.proto"></a>
|
<a name="bootstrap/types.proto"></a>
|
||||||
<p align="right"><a href="#top">Top</a></p>
|
<p align="right"><a href="#top">Top</a></p>
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue