Go to file
Hector Sanjuan 4ea830f74e Feat: ipfs-cluster-follow
This adds a new cluster command: ipfs-cluster-follow.

This command allows initializing and running follower peers as configured by a
remote-source configuration. The command can list configured peers
and obtain information for each of them.

Peers are launched with the rest API listening on a local unix socket. The
command can be run to list the items in the cluster pinset using this
endpoint. Alternatively, if no socket is present, the peer will be assumed to
be offline and the pin list will be directly read from the datastore.

Cluster peers launched with this command (and their configurations) are
compatible with ipfs-cluster-ctl and ipfs-cluster-service. We purposely do not
support most configuration options here. Using ipfs-cluster-ctl or launching
the peers using ipfs-cluster-service is always an option when the usecase
deviates from that supported by ipfs-cluster-follow.

Examples:

$ ipfs-cluster-follow -> list configured peers
$ ipfs-cluster-follow --help
$ ipfs-cluster-follow <clusterName> init <url>
$ ipfs-cluster-follow <clusterName> info
$ ipfs-cluster-follow <clusterName> run
$ ipfs-cluster-follow <clusterName> list
2019-12-07 15:38:59 +01:00
.github/ISSUE_TEMPLATE fix label in bug report 2019-04-29 18:01:12 +02:00
adder Golint 2019-10-01 13:59:54 +02:00
allocator Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00
api ipfsproxy: hijack repo/gc and trigger cluster-wide GC 2019-12-06 13:08:57 +01:00
cmd Feat: ipfs-cluster-follow 2019-12-07 15:38:59 +01:00
cmdutils Service/cmdutils: fix small typos (review) 2019-12-02 16:08:47 +01:00
config Feat: ipfs-cluster-follow 2019-12-07 15:38:59 +01:00
consensus Raft logging: update logger to new interface 2019-11-05 12:51:18 +01:00
datastore Tests: multiple fixes to tests reliability (#943) 2019-10-31 21:51:13 +01:00
docker Docker: improve for CRDTs 2019-08-13 19:32:38 +02:00
informer JSON Config object key should match JSON tags 2019-07-15 17:47:35 +05:30
ipfsconn/ipfshttp Feat: Allow and run multiple informer components (#962) 2019-12-05 15:08:43 +01:00
monitor Fix #374: health metrics improvements 2019-10-24 16:37:26 +02:00
observations Feat: ipfs-cluster-follow 2019-12-07 15:38:59 +01:00
pintracker Error queue is full for stateless pintracker 2019-09-11 12:53:51 +07:00
pstoremgr Improve comment about discovery 2019-11-07 20:19:24 +01:00
rpcutil Add ability to run Garbage Collector on all peers 2019-10-22 11:13:19 +05:30
sharness Tests: multiple fixes to tests reliability (#943) 2019-10-31 21:51:13 +01:00
state Fix #481: Pin expiration 2019-11-05 10:40:48 +01:00
test ipfsproxy: hijack repo/gc and trigger cluster-wide GC 2019-12-06 13:08:57 +01:00
version Release 0.11.0 2019-09-13 18:57:25 +02:00
.codeclimate.yml codeclimate 2018-08-07 20:12:05 +02:00
.codecov.yml Tests: add failfast, bump to go1.12, adjust codecov 2019-05-17 13:54:13 +02:00
.dockerignore Issue #259: Address CR comments 2017-12-04 13:59:48 +01:00
.gitignore Feat: ipfs-cluster-follow 2019-12-07 15:38:59 +01:00
.travis.yml Tests: multiple fixes, increase timings 2019-11-08 12:46:11 +01:00
add_test.go Added UserAllocations support for add 2019-08-16 18:13:06 +05:30
allocate.go Feat: Allow and run multiple informer components (#962) 2019-12-05 15:08:43 +01:00
CHANGELOG.md Spelling fix 2019-09-13 20:09:11 -07:00
cluster_config_test.go config: Add PeerAddresses 2019-12-02 15:08:37 +01:00
cluster_config.go config: Add PeerAddresses 2019-12-02 15:08:37 +01:00
cluster_test.go Feat: Allow and run multiple informer components (#962) 2019-12-05 15:08:43 +01:00
cluster.go Feat: Allow and run multiple informer components (#962) 2019-12-05 15:08:43 +01:00
clusterhost.go Fix #949: Cluster peers should advertise their external earlier 2019-11-07 13:05:31 +01:00
config_test.go Tests: multiple fixes, increase timings 2019-11-08 12:46:11 +01:00
connect_graph.go health/graph: Improve graph 2019-11-07 10:47:29 +01:00
CONTRIBUTING.md Docs: Move to website. 2018-04-27 09:05:11 +02:00
COPYRIGHT Dual-license the codebase. 2019-03-01 20:12:19 +00:00
docker-compose.yml Improve docker-compose.yml for testing 2019-09-20 11:08:40 -04:00
Dockerfile Dockerfile formatting 2019-12-06 10:56:17 +01:00
Dockerfile-bundle Dockerfile formatting 2019-12-06 10:56:17 +01:00
Dockerfile-test Dockerfile formatting 2019-12-06 10:56:17 +01:00
go.mod Feat: ipfs-cluster-follow 2019-12-07 15:38:59 +01:00
go.sum Feat: ipfs-cluster-follow 2019-12-07 15:38:59 +01:00
ipfscluster_test.go Feat: Allow and run multiple informer components (#962) 2019-12-05 15:08:43 +01:00
ipfscluster.go Merge branch 'master' into feat/cluster-gc 2019-11-07 18:35:42 +01:00
LICENSE-APACHE Dual-license the codebase. 2019-03-01 20:12:19 +00:00
LICENSE-MIT Dual-license the codebase. 2019-03-01 20:12:19 +00:00
logging.go Merge pull request #915 from ipfs/feat/proxy-logging 2019-09-27 12:07:34 +02:00
Makefile Feat: ipfs-cluster-follow 2019-12-07 15:38:59 +01:00
peer_manager_test.go Tests: multiple fixes, increase timings 2019-11-08 12:46:11 +01:00
pnet_test.go Tests: multiple fixes 2019-05-20 23:45:04 +02:00
README.md docs: fix download link in readme 2019-03-18 09:42:43 +00:00
release.sh Remove gx 2019-07-04 13:58:17 +01:00
rpc_api.go Feat: Allow and run multiple informer components (#962) 2019-12-05 15:08:43 +01:00
rpc_policy.go Feat: Allow and run multiple informer components (#962) 2019-12-05 15:08:43 +01:00
util.go remove unused var 2019-11-08 22:41:14 +05:30

IPFS Cluster

Made by Main project IRC channel standard-readme compliant GoDoc Go Report Card Build Status codecov

Pinset orchestration for IPFS.

logo

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.


Table of Contents

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/download .

Usage

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

Contribute

PRs accepted. As part of the IPFS project, we have some contribution guidelines.

Small note: If editing the README, please conform to the standard-readme specification.

License

This library is dual-licensed under Apache 2.0 and MIT terms.

© 2019. Protocol Labs, Inc.