Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre release hive alpha v0.1.2 #1

Merged
merged 2 commits into from Jan 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions Dockerfile
Expand Up @@ -4,7 +4,7 @@ MAINTAINER Hector Sanjuan <hector@protocol.ai>
# This dockerfile builds and runs ipfs-cluster-service.

ENV GOPATH /go
ENV SRC_PATH $GOPATH/src/github.com/ipfs/ipfs-cluster
ENV SRC_PATH $GOPATH/src/github.com/elastos/Elastos.NET.Hive.Cluster

COPY . $SRC_PATH
WORKDIR $SRC_PATH
Expand All @@ -30,7 +30,7 @@ MAINTAINER Hector Sanjuan <hector@protocol.ai>
# built binaries on the go-ipfs-container.

ENV GOPATH /go
ENV SRC_PATH /go/src/github.com/ipfs/ipfs-cluster
ENV SRC_PATH /go/src/github.com/elastos/Elastos.NET.Hive.Cluster
ENV IPFS_CLUSTER_PATH /data/ipfs-cluster

EXPOSE 9094
Expand Down
4 changes: 2 additions & 2 deletions Dockerfile-bundle
Expand Up @@ -6,7 +6,7 @@ MAINTAINER Hector Sanjuan <hector@protocol.ai>

# This builder just builds the cluster binaries
ENV GOPATH /go
ENV SRC_PATH $GOPATH/src/github.com/ipfs/ipfs-cluster
ENV SRC_PATH $GOPATH/src/github.com/elastos/Elastos.NET.Hive.Cluster

COPY . $SRC_PATH
WORKDIR $SRC_PATH
Expand All @@ -20,7 +20,7 @@ MAINTAINER Hector Sanjuan <hector@protocol.ai>
# built binaries on the go-ipfs-container.

ENV GOPATH /go
ENV SRC_PATH /go/src/github.com/ipfs/ipfs-cluster
ENV SRC_PATH /go/src/github.com/elastos/Elastos.NET.Hive.Cluster
ENV IPFS_CLUSTER_PATH /data/ipfs-cluster

EXPOSE 9094
Expand Down
4 changes: 2 additions & 2 deletions Dockerfile-test
Expand Up @@ -4,7 +4,7 @@ MAINTAINER Hector Sanjuan <hector@protocol.ai>
# This build state just builds the cluster binaries

ENV GOPATH /go
ENV SRC_PATH $GOPATH/src/github.com/ipfs/ipfs-cluster
ENV SRC_PATH $GOPATH/src/github.com/elastos/Elastos.NET.Hive.Cluster

COPY . $SRC_PATH
WORKDIR $SRC_PATH
Expand All @@ -23,7 +23,7 @@ MAINTAINER Hector Sanjuan <hector@protocol.ai>
# built binaries on the go-ipfs-container.

ENV GOPATH /go
ENV SRC_PATH /go/src/github.com/ipfs/ipfs-cluster
ENV SRC_PATH /go/src/github.com/elastos/Elastos.NET.Hive.Cluster
ENV IPFS_CLUSTER_PATH /data/ipfs-cluster

EXPOSE 9094
Expand Down
73 changes: 73 additions & 0 deletions README.ipfs-cluster.md
@@ -0,0 +1,73 @@
# IPFS Cluster


[![Made by](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
[![Main project](https://img.shields.io/badge/project-ipfs-blue.svg?style=flat-square)](http://github.com/ipfs/ipfs)
[![IRC channel](https://img.shields.io/badge/freenode-%23ipfs--cluster-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs-cluster)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![GoDoc](https://godoc.org/github.com/ipfs/ipfs-cluster?status.svg)](https://godoc.org/github.com/ipfs/ipfs-cluster)
[![Go Report Card](https://goreportcard.com/badge/github.com/ipfs/ipfs-cluster)](https://goreportcard.com/report/github.com/ipfs/ipfs-cluster)
[![Build Status](https://travis-ci.org/ipfs/ipfs-cluster.svg?branch=master)](https://travis-ci.org/ipfs/ipfs-cluster)
[![Coverage Status](https://coveralls.io/repos/github/ipfs/ipfs-cluster/badge.svg?branch=master)](https://coveralls.io/github/ipfs/ipfs-cluster?branch=master)

> Pinset orchestration for IPFS.

<p align="center">
<img src="https://cluster.ipfs.io/cluster/png/IPFS_Cluster_color_no_text.png" alt="logo" width="300" height="300" />
</p>

IPFS Cluster is a stand-alone application and a CLI client that allocates, replicates, and tracks pins across a cluster of IPFS daemons.

It provides:

* A cluster peer application: `ipfs-cluster-service`, to be run along with `go-ipfs`.
* A client CLI application: `ipfs-cluster-ctl`, which allows easily interacting with the peer's HTTP API.

---

### Are you using IPFS Cluster?

Please participate in the [IPFS Cluster user registry](https://docs.google.com/forms/d/e/1FAIpQLSdWF5aXNXrAK_sCyu1eVv2obTaKVO3Ac5dfgl2r5_IWcizGRg/viewform).

---

## Table of Contents

- [Documentation](#documentation)
- [News & Roadmap](#news--roadmap)
- [Install](#install)
- [Usage](#usage)
- [Contribute](#contribute)
- [License](#license)


## Documentation

Please visit https://cluster.ipfs.io/documentation/ to access user documentation, guides and any other resources, including detailed **download** and **usage** instructions.

## News & Roadmap

We regularly post project updates to https://cluster.ipfs.io/news/ .

The most up-to-date *Roadmap* is available at https://cluster.ipfs.io/roadmap/ .

## Install

Instructions for different installation methods (including from source) are available at https://cluster.ipfs.io/documentation/download .

## Usage

Extensive usage information is provided at https://cluster.ipfs.io/documentation/ , including:

* [Docs for `ipfs-cluster-service`](https://cluster.ipfs.io/documentation/ipfs-cluster-service/)
* [Docs for `ipfs-cluster-ctl`](https://cluster.ipfs.io/documentation/ipfs-cluster-ctl/)

## Contribute

PRs accepted. As part of the IPFS project, we have some [contribution guidelines](https://cluster.ipfs.io/developer/contribute).

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

MIT © Protocol Labs, Inc.
80 changes: 35 additions & 45 deletions README.md
@@ -1,73 +1,63 @@
# IPFS Cluster
Elastos Hive Cluster
==========================

## Introduction

[![Made by](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
[![Main project](https://img.shields.io/badge/project-ipfs-blue.svg?style=flat-square)](http://github.com/ipfs/ipfs)
[![IRC channel](https://img.shields.io/badge/freenode-%23ipfs--cluster-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs-cluster)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![GoDoc](https://godoc.org/github.com/ipfs/ipfs-cluster?status.svg)](https://godoc.org/github.com/ipfs/ipfs-cluster)
[![Go Report Card](https://goreportcard.com/badge/github.com/ipfs/ipfs-cluster)](https://goreportcard.com/report/github.com/ipfs/ipfs-cluster)
[![Build Status](https://travis-ci.org/ipfs/ipfs-cluster.svg?branch=master)](https://travis-ci.org/ipfs/ipfs-cluster)
[![Coverage Status](https://coveralls.io/repos/github/ipfs/ipfs-cluster/badge.svg?branch=master)](https://coveralls.io/github/ipfs/ipfs-cluster?branch=master)
Elastos Hive Cluster is a decentralized File Storage Service that based on IPFS cluster. Hive Cluster use IPFS and IPFS-cluster as the base infrastructure to save Elastos data. Hive Cluster is also a stand-alone application as same as IPFS Cluster.

> Pinset orchestration for IPFS.
The typical IPFS peer is a resource hunger program. If you install IPFS daemon to your mobile device, it will take up resources and slow down your device. We are creating Hive project, which uses IPFS cluster as the Elastos App storage backend, and can be used in a low resources consumption scenario.

<p align="center">
<img src="https://cluster.ipfs.io/cluster/png/IPFS_Cluster_color_no_text.png" alt="logo" width="300" height="300" />
</p>
The project distils from the IPFS Cluster, but it will have many differences with the IPFS Cluster.

IPFS Cluster is a stand-alone application and a CLI client that allocates, replicates, and tracks pins across a cluster of IPFS daemons.
Elastos Hive Cluster maintains a big IPFS pinset for sharing. It can serve numerous virtual IPFS peers with only one running a real IPFS peer.

It provides:

* A cluster peer application: `ipfs-cluster-service`, to be run along with `go-ipfs`.
* A client CLI application: `ipfs-cluster-ctl`, which allows easily interacting with the peer's HTTP API.

---

### Are you using IPFS Cluster?

Please participate in the [IPFS Cluster user registry](https://docs.google.com/forms/d/e/1FAIpQLSdWF5aXNXrAK_sCyu1eVv2obTaKVO3Ac5dfgl2r5_IWcizGRg/viewform).

---
Hive Cluster is not only a pinset manager but also a backend for multiple IPFS clients.

## Table of Contents

- [Documentation](#documentation)
- [News & Roadmap](#news--roadmap)
- [Introduction](#introduction)
- [Install](#install)
- [Usage](#usage)
- [Contribute](#contribute)
- [Contribution](#contribution)
- [Acknowledgments](#acknowledgments)
- [License](#license)

## Install

## Documentation

Please visit https://cluster.ipfs.io/documentation/ to access user documentation, guides and any other resources, including detailed **download** and **usage** instructions.
The following requirements apply to the installation from source:

## News & Roadmap
- Go 1.11+
- Git
- IPFS or internet connectivity (to download depedencies).

We regularly post project updates to https://cluster.ipfs.io/news/ .
In order to build and install IPFS Cluster in Unix systems follow the steps:

The most up-to-date *Roadmap* is available at https://cluster.ipfs.io/roadmap/ .
```shell
$ git clone https://github.com/elastos/Elastos.NET.Hive.Cluster.git $GOPATH/src/github.com/elastos/Elastos.NET.Hive.Cluster
$ cd $GOPATH/src/github.com/elastos/Elastos.NET.Hive.Cluster
$ make install
```
After the dependencies have been downloaded, ipfs-cluster-service and ipfs-cluster-ctl will be installed to your $GOPATH/bin (it uses go install).

## Install
If you would rather have them built locally, use make build instead. You can run make clean to remove any generated artifacts and rewrite the import paths to their original form.

Instructions for different installation methods (including from source) are available at https://cluster.ipfs.io/documentation/download .
Note that when the ipfs daemon is running locally on its default ports, the build process will use it to fetch gx, gx-go and all the needed dependencies directly from IPFS.

## Usage

Extensive usage information is provided at https://cluster.ipfs.io/documentation/ , including:

ipfs-cluster-service is a command line program, please refer to the docs from https://cluster.ipfs.io.
* [Docs for `ipfs-cluster-service`](https://cluster.ipfs.io/documentation/ipfs-cluster-service/)
* [Docs for `ipfs-cluster-ctl`](https://cluster.ipfs.io/documentation/ipfs-cluster-ctl/)

## Contribute
Hive Cluster uses HTTP interface to serve numerous clients. About HTTP API, please refer to
* [HTTP API] TODO

PRs accepted. As part of the IPFS project, we have some [contribution guidelines](https://cluster.ipfs.io/developer/contribute).
## Contribution

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
We welcome contributions to the Elastos Hive Project.

## License
## Acknowledgments

A sincere thank you to all teams and projects that we rely on directly or indirectly.

MIT © Protocol Labs, Inc.
## License
This project is licensed under the terms of the [MIT license](https://github.com/elastos/Elastos.Hive.Cluster/blob/master/LICENSE).
4 changes: 2 additions & 2 deletions add_test.go
Expand Up @@ -6,8 +6,8 @@ import (
"mime/multipart"
"testing"

"github.com/ipfs/ipfs-cluster/api"
"github.com/ipfs/ipfs-cluster/test"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/test"
)

func TestAdd(t *testing.T) {
Expand Down
4 changes: 2 additions & 2 deletions adder/adder.go
Expand Up @@ -8,8 +8,8 @@ import (
"mime/multipart"
"strings"

"github.com/ipfs/ipfs-cluster/adder/ipfsadd"
"github.com/ipfs/ipfs-cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/adder/ipfsadd"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"

cid "github.com/ipfs/go-cid"
files "github.com/ipfs/go-ipfs-files"
Expand Down
4 changes: 2 additions & 2 deletions adder/adder_test.go
Expand Up @@ -7,8 +7,8 @@ import (
"testing"
"time"

"github.com/ipfs/ipfs-cluster/api"
"github.com/ipfs/ipfs-cluster/test"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/test"

cid "github.com/ipfs/go-cid"
files "github.com/ipfs/go-ipfs-files"
Expand Down
8 changes: 4 additions & 4 deletions adder/adderutils/adderutils.go
Expand Up @@ -8,10 +8,10 @@ import (
"net/http"
"sync"

"github.com/ipfs/ipfs-cluster/adder"
"github.com/ipfs/ipfs-cluster/adder/local"
"github.com/ipfs/ipfs-cluster/adder/sharding"
"github.com/ipfs/ipfs-cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/adder"
"github.com/elastos/Elastos.NET.Hive.Cluster/adder/local"
"github.com/elastos/Elastos.NET.Hive.Cluster/adder/sharding"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"

cid "github.com/ipfs/go-cid"
logging "github.com/ipfs/go-log"
Expand Down
2 changes: 1 addition & 1 deletion adder/ipfsadd/add.go
Expand Up @@ -8,7 +8,7 @@ import (
"io"
gopath "path"

"github.com/ipfs/ipfs-cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"

cid "github.com/ipfs/go-cid"
chunker "github.com/ipfs/go-ipfs-chunker"
Expand Down
4 changes: 2 additions & 2 deletions adder/local/dag_service.go
Expand Up @@ -6,8 +6,8 @@ import (
"context"
"errors"

adder "github.com/ipfs/ipfs-cluster/adder"
"github.com/ipfs/ipfs-cluster/api"
adder "github.com/elastos/Elastos.NET.Hive.Cluster/adder"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"

cid "github.com/ipfs/go-cid"
ipld "github.com/ipfs/go-ipld-format"
Expand Down
6 changes: 3 additions & 3 deletions adder/local/dag_service_test.go
Expand Up @@ -7,9 +7,9 @@ import (
"sync"
"testing"

adder "github.com/ipfs/ipfs-cluster/adder"
"github.com/ipfs/ipfs-cluster/api"
"github.com/ipfs/ipfs-cluster/test"
adder "github.com/elastos/Elastos.NET.Hive.Cluster/adder"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/test"

rpc "github.com/libp2p/go-libp2p-gorpc"
)
Expand Down
4 changes: 2 additions & 2 deletions adder/sharding/dag.go
Expand Up @@ -20,8 +20,8 @@ import (
"context"
"fmt"

"github.com/ipfs/ipfs-cluster/api"
"github.com/ipfs/ipfs-cluster/rpcutil"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/rpcutil"

blocks "github.com/ipfs/go-block-format"
cid "github.com/ipfs/go-cid"
Expand Down
4 changes: 2 additions & 2 deletions adder/sharding/dag_service.go
Expand Up @@ -10,8 +10,8 @@ import (

"time"

"github.com/ipfs/ipfs-cluster/adder"
"github.com/ipfs/ipfs-cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/adder"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"

humanize "github.com/dustin/go-humanize"
cid "github.com/ipfs/go-cid"
Expand Down
6 changes: 3 additions & 3 deletions adder/sharding/dag_service_test.go
Expand Up @@ -7,9 +7,9 @@ import (
"sync"
"testing"

adder "github.com/ipfs/ipfs-cluster/adder"
"github.com/ipfs/ipfs-cluster/api"
"github.com/ipfs/ipfs-cluster/test"
adder "github.com/elastos/Elastos.NET.Hive.Cluster/adder"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/test"

cid "github.com/ipfs/go-cid"
logging "github.com/ipfs/go-log"
Expand Down
4 changes: 2 additions & 2 deletions adder/sharding/shard.go
Expand Up @@ -4,8 +4,8 @@ import (
"context"
"fmt"

"github.com/ipfs/ipfs-cluster/adder"
"github.com/ipfs/ipfs-cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/adder"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"

humanize "github.com/dustin/go-humanize"
cid "github.com/ipfs/go-cid"
Expand Down
2 changes: 1 addition & 1 deletion adder/sharding/verify.go
Expand Up @@ -4,7 +4,7 @@ import (
"fmt"
"testing"

"github.com/ipfs/ipfs-cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"

cid "github.com/ipfs/go-cid"
)
Expand Down
4 changes: 2 additions & 2 deletions adder/util.go
Expand Up @@ -5,8 +5,8 @@ import (
"errors"
"fmt"

"github.com/ipfs/ipfs-cluster/api"
"github.com/ipfs/ipfs-cluster/rpcutil"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/rpcutil"

cid "github.com/ipfs/go-cid"
ipld "github.com/ipfs/go-ipld-format"
Expand Down
2 changes: 1 addition & 1 deletion allocate.go
Expand Up @@ -7,7 +7,7 @@ import (
cid "github.com/ipfs/go-cid"
peer "github.com/libp2p/go-libp2p-peer"

"github.com/ipfs/ipfs-cluster/api"
"github.com/elastos/Elastos.NET.Hive.Cluster/api"
)

// This file gathers allocation logic used when pinning or re-pinning
Expand Down