From cde701ab10a04a25fca2e7c69d8b49e36f439f58 Mon Sep 17 00:00:00 2001 From: Katarzyna Streich Date: Thu, 26 Apr 2018 14:26:37 +0100 Subject: [PATCH] Add docs on private networks config and endpoint (#3006) Add docs on private networks config and endpoint --- docs/source/corda-configuration-file.rst | 4 ++++ docs/source/network-map.rst | 6 +++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/source/corda-configuration-file.rst b/docs/source/corda-configuration-file.rst index d57dfbaae8..85310048e7 100644 --- a/docs/source/corda-configuration-file.rst +++ b/docs/source/corda-configuration-file.rst @@ -188,6 +188,10 @@ absolute path to the node's base directory. :attachmentCacheBound: Optionally specify how many attachments should be cached locally. Note that this includes only the key and metadata, the content is cached separately and can be loaded lazily. Defaults to 1024. +: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 -------- diff --git a/docs/source/network-map.rst b/docs/source/network-map.rst index e0986d52f6..c7691e5e33 100644 --- a/docs/source/network-map.rst +++ b/docs/source/network-map.rst @@ -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. - -