[#167] netmap: Add attribute escaping description
Signed-off-by: Pavel Karpy <carpawell@nspcc.ru>
This commit is contained in:
parent
7f67c378a7
commit
2536e5a97b
1 changed files with 11 additions and 0 deletions
|
@ -134,6 +134,17 @@ message NodeInfo {
|
||||||
// `Attribute` is a Key-Value metadata pair. Key name must be a valid UTF-8
|
// `Attribute` is a Key-Value metadata pair. Key name must be a valid UTF-8
|
||||||
// string. Value can't be empty.
|
// string. Value can't be empty.
|
||||||
//
|
//
|
||||||
|
// Attributes can be constructed into a chain of attributes: any attribute can
|
||||||
|
// have a parent attribute and a child attribute (except the first and the last
|
||||||
|
// one). A string representation of the chain of attributes in NeoFS Storage
|
||||||
|
// Node configuration uses ":" and "/" symbols, e.g.:
|
||||||
|
//
|
||||||
|
// `NEOFS_NODE_ATTRIBUTE_1=key1:val1/key2:val2`
|
||||||
|
//
|
||||||
|
// Therefore the string attribute representation in the Node configuration must
|
||||||
|
// use "\:", "\/" and "\\" escaped symbols if any of them appears in an attribute's
|
||||||
|
// key or value.
|
||||||
|
//
|
||||||
// Node's attributes are mostly used during Storage Policy evaluation to
|
// Node's attributes are mostly used during Storage Policy evaluation to
|
||||||
// calculate object's placement and find a set of nodes satisfying policy
|
// calculate object's placement and find a set of nodes satisfying policy
|
||||||
// requirements. There are some "well-known" node attributes common to all the
|
// requirements. There are some "well-known" node attributes common to all the
|
||||||
|
|
Loading…
Reference in a new issue