ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-03-14 00:06:45 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add more documentation on private networks (#786)

Browse Source 
Add more documentation on private networks
This commit is contained in:
Katarzyna Streich 2018-04-30 16:01:53 +01:00 committed by GitHub
parent e62d1f12c1
commit f25b0bd1c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/source/network-map.rst
View File

@ -172,3 +172,21 @@ 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.
Private networks
----------------
To allow business network operators to onboard nodes in the early period of the Corda Network and not to reveal their membership
to other entities on the network, the concept of private network maps was introduced. This is a temporary solution which will only
be used in the early stages when it's possible to deduce the members of a business network. Once sufficient number of entities have
joined the Network, this feature will be turned off and previously private nodes will be made visible in the public network map.
An additional REST ``/network-map/{uuid}`` endpoint serving private network maps was introduced. For nodes to be able to query
that information automatically you need to change ``node.conf`` to include private network UUIDs in ``extraNetworkMapKeys`` see :doc:`corda-configuration-file`.
From the node operator's perspective the process is simple. During the initial registration the Compatibility Zone operator will
mark the node as belonging to the private network map and will provide the node operator with UUID that should be put in the node's config file.
Then node can be started as usual. At some point in time, nodes will gradually join public network without leaking confidential
information on business relations with operators. Private networks are not separate networks, nodes are still part of bigger
compatibility zone, only hidden. We reuse all the infrastructure of the compatibility zone like notaries, permissioning service,
so the interoperability between nodes is kept.

4
network-management/README.md
View File

@ -348,6 +348,10 @@ set private_network = '<<private_network_id>>'
where status = 'APPROVED'
```
**Important**
If notary is to be used by private network participants add private network UUIDs to notary's ``node.conf`` using
``extraNetworkMapKeys`` list.
### Move a node from its private network and into the global network map**
```