ipfs / ipfs-cluster
68%
master: 65%

LAST BUILD BRANCH: feat/expvar
DEFAULT BRANCH: master
Repo Added
Files 37
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH feat/promote-consensus
branch: feat/promote-consensus
CHANGE BRANCH
x

2284

push

travis-ci

hsanjuan 
Feat: emancipate Consensus from the Cluster component

This commit promotes the Consensus component (and Raft) to become a fully
independent thing like other components, passed to NewCluster during
initialization. Cluster (main component) no longer creates the consensus
layer internally. This has triggered a number of breaking changes
that I will explain below.

Motivation: Future work will require the possibility of running Cluster
with a consensus layer that is not Raft. The "consensus" layer is in charge
of maintaining two things:
  * The current cluster peerset, as required by the implementation
  * The current cluster pinset (shared state)

While the pinset maintenance has always been in the consensus layer, the
peerset maintenance was handled by the main component (starting by the "peers"
key in the configuration) AND the Raft component (internally)
and this generated lots of confusion: if the user edited the peers in the
configuration they would be greeted with an error.

The bootstrap process (adding a peer to an existing cluster) and configuration
key also complicated many things, since the main component did it, but only
when the consensus was initialized and in single peer mode.

In all this we also mixed the peerstore (list of peer addresses in the libp2p
host) with the peerset, when they need not to be linked.

By initializing the consensus layer before calling NewCluster, all the
difficulties in maintaining the current implementation in the same way
have come to light. Thus, the following changes have been introduced:

* Remove "peers" and "bootstrap" keys from the configuration: we no longer
edit or save the configuration files. This was a very bad practice, requiring
write permissions by the process to the file containing the private key and
additionally made things like Puppet deployments of cluster difficult as
configuration would mutate from its initial version. Needless to say all the
maintenance associated to making sure peers and... (continued)

4846 of 7161 relevant lines covered (67.67%)

390.2 hits per line

Relevant lines Covered
7161 RELEVANT LINES 4846 COVERED LINES
390.2 HITS PER LINE
Source Files on feat/promote-consensus
Coverage ∆ File Lines Relevant Covered Missed Hits/Line

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
2284 feat/promote-consensus Feat: emancipate Consensus from the Cluster component This commit promotes the Consensus component (and Raft) to become a fully independent thing like other components, passed to NewCluster during initialization. Cluster (main component) no longe... push hsanjuan travis-ci pending completion  
2270 feat/promote-consensus Address review (to be squashed) License: MIT Signed-off-by: Hector Sanjuan <code@hector.link> push hsanjuan travis-ci pending completion  
2229 feat/promote-consensus Remove debug println License: MIT Signed-off-by: Hector Sanjuan <code@hector.link> push hsanjuan travis-ci pending completion  
2201 feat/promote-consensus Feat: emancipate Consensus from the Cluster component This commit promotes the Consensus component (and Raft) to become a fully independent thing like other components, passed to NewCluster during initialization. Cluster (main component) no longe... push hsanjuan travis-ci pending completion  
2195 feat/promote-consensus wip License: MIT Signed-off-by: Hector Sanjuan <code@hector.link> push hsanjuan travis-ci pending completion  
2193 feat/promote-consensus wip License: MIT Signed-off-by: Hector Sanjuan <code@hector.link> push hsanjuan travis-ci pending completion  
2163 feat/promote-consensus wip License: MIT Signed-off-by: Hector Sanjuan <code@hector.link> push hsanjuan travis-ci pending completion  
See All Builds (2373)