Merge commit 'cde701ab10a04a25fca2e7c69d8b49e36f439f58' into kstreich-ENT-OS-merge

This commit is contained in:
Katarzyna Streich 2018-04-26 16:30:47 +01:00
commit 627708a63a
2 changed files with 9 additions and 3 deletions

View File

@ -216,6 +216,12 @@ absolute path to the node's base directory.
:prefix: Optional prefix string to identify metrics from this node, will default to a string made up
from Organisation Name and ip address.
:sampleIntervallSeconds: optional wait time between pushing metrics. This will default to 60 seconds.
:extraNetworkMapKeys: An optional list of private network map UUIDs. Your node will fetch the public network and private network maps based on
these keys. Private network UUID should be provided by network operator and lets you see nodes not visible on public network.
.. note:: This is temporary feature for onboarding network participants that limits their visibility for privacy reasons.
Examples
--------

View File

@ -35,7 +35,9 @@ The set of REST end-points for the network map service are as follows.
+----------------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| POST | /network-map/ack-parameters | For the node operator to acknowledge network map that new parameters were accepted for future update. |
+----------------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| GET | /network-map | Retrieve the current signed network map object. The entire object is signed with the network map certificate which is also attached. |
| GET | /network-map | Retrieve the current signed public network map object. The entire object is signed with the network map certificate which is also attached. |
+----------------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| GET | /network-map/{uuid} | Retrieve the current signed private network map object with given uuid. Format is the same as for ``/network-map`` endpoint. |
+----------------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
| GET | /network-map/node-info/{hash} | Retrieve a signed ``NodeInfo`` as specified in the network map object. |
+----------------+-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
@ -170,5 +172,3 @@ shell (see :doc:`shell`):
If the administrator does not accept the update then next time the node polls network map after the deadline, the
advertised network parameters will be the updated ones. The previous set of parameters will no longer be valid.
At this point the node will automatically shutdown and will require the node operator to bring it back again.