cascade/ipfs-cluster
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix #27: Add captain's log and ROADMAP

Browse Source 
License: MIT
Signed-off-by: Hector Sanjuan <hector@protocol.ai>
This commit is contained in:
Hector Sanjuan 2017-01-23 13:16:20 +01:00
parent 9c80bc03a9
commit 2983544561
3 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -29,6 +29,7 @@ Current functionality only allows pinning in all cluster members, but more strat
## Table of Contents
- [Background](#background)
- [Captain](#captain)
- [Install](#install)
- [Usage](#usage)
- [API](#api)
@ -41,6 +42,10 @@ Since the start of IPFS it was clear that a tool to coordinate a number of diffe
`ipfs-cluster` aims to address this issues by providing a IPFS node wrapper which coordinates multiple cluster members via a consensus algorithm. This ensures that the desired state of the system is always agreed upon and can be easily maintained by the members of the cluster. Thus, every cluster member knows which content is tracked, can decide whether asking IPFS to pin it and can react to any contingencies like server reboots.
## Captain
This project is captained by [@hsanjuan](https://github.com/hsanjuan). See the [captain's log](captain.log.md) for information about current status and upcoming features. You can also check out the project's [Roadmap](ROADMAP.md).
## Install
In order to install the `ipfscluster-server` the `ipfscluster` tool simply download this repository and run `make` as follows:

27
ROADMAP.md Normal file
View File

@ -0,0 +1,27 @@
# IPFS Cluster - Roadmap
## Q1 2017
This quarter is going to be focused on bringing ipfs-cluster to life as a usable product in the IPFS ecosystem. That means:
* It shouldn't hard to crash
* It shouldn't lose track of content
* It should play well with go-ipfs
* It should support a replication-factor
* It should be very well tested
* It should be very easy to setup and manage
* It should have stable APIs
On these lines, there are several endeavours which stand out for themselves and are officially part of the general IPFS Roadmaps:
* Dynamically add and remove cluster members in an easy fashion (https://github.com/ipfs/pm/issues/353)
This involves easily adding a member (or removing) from a running cluster. `ipfs-cluster-service member add <maddress>` should work and should update the peer set of all components of all members, along with their configurations.
* Replication-factor-based pinning strategy (https://github.com/ipfs/pm/issues/353)
This involves being able to pin an item in, say, 2 nodes only. Cluster should re-pin whenever an item is found to be underpinned, which means that monitoring of pinsets must exist and be automated.
* Tests (https://github.com/ipfs/pm/issues/360)
In the context of the Interplanetary Test Lab, there should be tests end to end tests in which cluster is tested, benchmarked along with IPFS.

14
captain.log.md Normal file
View File

@ -0,0 +1,14 @@
# IPFS Cluster - Captain's log
## 20170123 | @hsanjuan
I have just merged the initial cluster version into master. There are many rough edges to address, and significant changes to namings/APIs will happen during the next few days and weeks.
The rest of the quarter will be focused on 4 main issues:
* Simplify the process of adding and removing members of a cluster
* Implement a replication-factor-based pinning strategy
* Generate real end to end tests
* Make ipfs-cluster stable
These endaevours will be reflected on the [ROADMAP](ROADMAP.md) file.