poanetwork
/
quorum
mirror of https://github.com/poanetwork/quorum.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update DNS document for raft (#912) 

* updating documentation for DNS feature
This commit is contained in:
Peter Fox 2019-12-13 13:33:09 +00:00 committed by Samer Falah
parent 877f85208e
commit 85e2257995
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/Features/dns.md
View File

@ -17,7 +17,15 @@ DNS is not supported for the discovery protocol. Use a bootnode instead, which c
resolved.
## Compatibility
For Raft, the whole network must be on version 2.3.1 of Quorum for DNS to function properly; because of this, DNS must
be explicitly enabled using the `--raftdnsenable` flag.
The network will support older nodes mixed with newer nodes if DNS is not enabled via this flag, and it is safe to
enable DNS only on some nodes if all nodes are on at least version 2.3.1. This allows for a clear upgrade path.
For Raft, the whole network must be on version 2.4.0 of Quorum for DNS to function properly. DNS must
be explicitly enabled using the `--raftdnsenable` flag for each node once the node has migrated to version 2.4.0 of Quorum
The network runs fine when some nodes are in 2.4.0 version and some in older version as long as this feature is not enabled. For safe migration the recommended approach is as below:
* migrate the nodes to `geth` 2.4.0 version without using `--raftdnsenable` flag
* once the network is fully migrated, restart the nodes with `--raftdnsenable` to enable the feature
Please note that in a partially migrated network (where some nodes are on version 2.4.0 and others on lower version) **with DNS feature enabled** for migrated nodes, `raft.addPeer` should not be invoked with Hostname till entire network migrates to 2.4.0 version. If invoked, this call will crash all nodes running in older version and these nodes will have to restarted with `geth` of version 2.4.0 of Quorum. `raft.addPeer` can still be invoked with IP address and network will work fine.
### Note
In a network where all nodes are running on Quorum version 2.4.0, with few nodes enabled for DNS, we recommend the
`--verbosity` to be 3 or below. We have observed that nodes which are not enabled for DNS fail to restart if
`raft.addPeer` is invoked with host name if `--verbosity` is set above 3.