From 2536e5a97b55556fdd4f5db9253c2e14cc9fb75a Mon Sep 17 00:00:00 2001 From: Pavel Karpy Date: Mon, 16 Aug 2021 12:02:07 +0300 Subject: [PATCH] [#167] netmap: Add attribute escaping description Signed-off-by: Pavel Karpy --- netmap/types.proto | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/netmap/types.proto b/netmap/types.proto index 49ed573..a068938 100644 --- a/netmap/types.proto +++ b/netmap/types.proto @@ -134,6 +134,17 @@ message NodeInfo { // `Attribute` is a Key-Value metadata pair. Key name must be a valid UTF-8 // 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 // calculate object's placement and find a set of nodes satisfying policy // requirements. There are some "well-known" node attributes common to all the