TrueCloudLab/frostfs-api
25
0
Fork 14
Code Issues 10 Pull requests Releases Activity Actions

Add well-known attributes for storage nodes

Browse source 
Adding the list of currently well-known node attributes. More to come later.

Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-10-13 19:37:14 +03:00 committed by Stanislav Bogatyrev
parent c793503167
commit af909ec3eb
1 changed files with 38 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
netmap/types.proto
View file

@ -121,7 +121,42 @@ message NodeInfo {
// Ways to connect to a node
string address = 2;
// Attributes of the NeoFS node.
// Administrator-defined Attributes of the NeoFS Storage Node.
//
// Node's attributes are mostly used during Storage Policy evaluation to
// calculate object's placement and find a set of nodes satisfying policy
// requirements. There are some "well-known" node attributes common to all the
// Storage Nodes in the network and used implicitly with default values if not
// explicitly set:
//
// * Capacity \
// Total available disk space in Gigabytes.
// * Price \
// Price in GAS tokens for storing one GB of data during one Epoch. In node
// attributes it's a string presenting floating point number with comma or
// point delimiter for decimal part. In the Network Map it will be saved as
// 64-bit unsigned integer representing number of minimal token fractions.
// * Subnet \
// String ID of Node's storage subnet. There can be only one subnet served
// by the Storage Node.
// * Locode \
// Node's geographic location in
// [UN/LOCODE](https://www.unece.org/cefact/codesfortrade/codes_index.html)
// format approximated to the nearest point defined in standard.
// * Country \
// Country code in
// [ISO 3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
// format. Calculated automatically from `Locode` attribute
// * Region \
// Country's administative subdivision where node is located. Calculated
// automatically from `Locode` attribute based on `SubDiv` field. Presented
// in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
// * City \
// City, town, village or rural area name where node is located written
// without diacritics . Calculated automatically from `Locode` attribute.
//
// For detailed description of each well-known attribute please see the
// corresponding section in NeoFS Technical specification.
message Attribute {
// Key of the node attribute.
string key = 1;
@ -129,8 +164,8 @@ message NodeInfo {
// Value of the node attribute.
string value = 2;
// Parent keys, if any
// Example: For City it can be Region or Country
// Parent keys, if any. For example for `City` it could be `Region` and
// `Country`.
repeated string parents = 3;
}
// Carries list of the NeoFS node attributes in a string key-value format.