Use UN/LOCODE as location identity in storage node attributes #101

New issue

Closed

opened 2025-12-28 17:18:26 +00:00 by sami · 2 comments

sami commented

2025-12-28 17:18:26 +00:00

Owner

Originally created by @alexvanin on GitHub (Jan 14, 2021).

Originally assigned to: @cthulhu-rider on GitHub.

NeoFS storage nodes specify their location in node attributes. These attributes presented in the network map, so one can define placement policies with location attributes from there. However there are issues:

attributes do not have strict formatting rules for location,
there is more than one way you can name location, e.g. St. Petersburg or Saint Petersburg.

To deal with these issues we can use UN/LOCODE as location attribute. LOCODEs are XX XXX ids, e.g. CN SGH for Shanghai. They stored in a database maintained by UN in this format:

CN SGH    Shanghai    Shanghai    SH    12345---    AS    1401    3114N 12129E

Example

Storage node won't be included to the network map without LOCODE. So at first the user looks up through LOCODE database or use external service (maybe neofs-cli helper command?) to find proper LOCODE value.
User sets LOCODE in storage node config (NEOFS_NODE_LOCODE=RU LED) and then starts it.
Storage node invokes AddPeer method with storage node attribute /LOCODE:RU LED
Inner ring nodes makes sanity check of the storage node and converts this LOCODE to /Country:Russia/City:Saint Petersburg
Inner ring nodes approve storage node with parsed LOCODE and it gets into network map this way.

Issues

LOCODE encodes country, city or big transport hubs within it such as airports, railway station, etc. However it does not define regions like Europe or Asia.

Originally created by @alexvanin on GitHub (Jan 14, 2021). Originally assigned to: @cthulhu-rider on GitHub. NeoFS storage nodes specify their location in node attributes. These attributes presented in the network map, so one can define placement policies with location attributes from there. However there are issues: - attributes do not have strict formatting rules for location, - there is more than one way you can name location, e.g. `St. Petersburg` or `Saint Petersburg`. To deal with these issues we can use [UN/LOCODE](https://unece.org/unlocode) as location attribute. LOCODEs are `XX XXX` ids, e.g. `CN SGH` for Shanghai. They stored in a database maintained by UN in this format: ``` CN SGH Shanghai Shanghai SH 12345--- AS 1401 3114N 12129E ``` ## Example 1. Storage node won't be included to the network map without LOCODE. So at first the user looks up through LOCODE database or use external service (maybe `neofs-cli` helper command?) to find proper LOCODE value. 2. User sets LOCODE in storage node config (`NEOFS_NODE_LOCODE=RU LED`) and then starts it. 3. Storage node invokes `AddPeer` method with storage node attribute `/LOCODE:RU LED` 4. Inner ring nodes makes sanity check of the storage node and converts this LOCODE to `/Country:Russia/City:Saint Petersburg` 5. Inner ring nodes approve storage node with parsed LOCODE and it gets into network map this way. ## Issues - LOCODE encodes country, city or big transport hubs within it such as airports, railway station, etc. However it does not define regions like `Europe` or `Asia`.

sami

2025-12-28 17:18:26 +00:00

closed this issue
added the
neofs-cli

neofs-storage

neofs-ir
labels

sami commented

2025-12-28 17:18:26 +00:00

Author

Owner

@alexvanin commented on GitHub (Jan 21, 2021):

LOCODE encodes country, city or big transport hubs within it such as airports, railway station, etc. However it does not define regions like Europe or Asia.

We can try to compute region based on country, however there can be inconsistency. In some databases Russia is Asia region, in others Europe. We can try to predict region more precisely based on latitude and longitude from LOCODE database, but this is not trivial.

@alexvanin commented on GitHub (Jan 21, 2021): > LOCODE encodes country, city or big transport hubs within it such as airports, railway station, etc. However it does not define regions like Europe or Asia. We can try to compute region based on country, however there can be inconsistency. In some databases Russia is `Asia` region, in others `Europe`. We can try to predict region more precisely based on latitude and longitude from LOCODE database, but this is not trivial.

sami commented

2025-12-28 17:18:26 +00:00

Author

Owner

@realloc commented on GitHub (Jan 28, 2021):

It looks like we could import coordinates of Polygons representing parts of the worlds' boundaries from OSM and check if the coordinates from LOCODE are in those boundaries locally, without calls to OSM or other external service.

@realloc commented on GitHub (Jan 28, 2021): It looks like we could import coordinates of Polygons representing parts of the worlds' boundaries from OSM and check if the coordinates from LOCODE are in those boundaries locally, without calls to OSM or other external service.