Go to file
Hector Sanjuan 7c636061bd
Improve pin/unpin method signatures (#843)
* Improve pin/unpin method signatures:

These changes the following Cluster Go API methods:

* -> Cluster.Pin(ctx, cid, options) (pin, error)
* -> Cluster.Unpin(ctx, cid) (pin, error)
* -> Cluster.PinPath(ctx, path, opts) (pin,error)

Pin and Unpin now return the pinned object.

The signature of the methods now matches that of the API Client, is clearer as
to what options the user can set and is aligned with PinPath, UnpinPath, which
returned pin methods.

The REST API now returns the Pinned/Unpinned object rather than 204-Accepted.

This was necessary for a cleaner pin/update approach, which I'm working on in
another branch.

Most of the changes here are updating tests to the new signatures

* Adapt load-balancing client to new Pin/Unpin signatures

* cluster.go: Fix typo

Co-Authored-By: Kishan Sagathiya <kishansagathiya@gmail.com>

* cluster.go: Fix typo

Co-Authored-By: Kishan Sagathiya <kishansagathiya@gmail.com>
2019-07-22 15:39:11 +02:00
.github/ISSUE_TEMPLATE fix label in bug report 2019-04-29 18:01:12 +02:00
adder Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
allocator Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00
api Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
cmd Do not load API components removed from the config (#836) 2019-07-18 17:33:14 +02:00
config Do not load API components removed from the config (#836) 2019-07-18 17:33:14 +02:00
consensus Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00
datastore Update dependencies 2019-07-05 18:12:57 +01:00
docker Docker: Run with daemon --upgrade by default. 2018-04-27 07:57:08 +02:00
informer JSON Config object key should match JSON tags 2019-07-15 17:47:35 +05:30
ipfsconn/ipfshttp Merge pull request #738 from ipfs/issue_497 2019-07-04 13:53:20 +01:00
monitor Simplify failed peer detection 2019-06-27 16:55:51 +01:00
observations Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00
pintracker Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00
pstoremgr Merge pull request #820 from ipfs/fix/small-fixes-crdts 2019-06-27 17:52:03 +01:00
rpcutil Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00
sharness Disable some sharness tests adding with cid-version=1 2019-05-17 13:58:26 +02:00
state Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00
test Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
version Release 0.11.0-rc5 2019-06-27 17:58:26 +01: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 Remove gx 2019-07-04 13:58:17 +01:00
.travis.yml Fix #765 Remove gx 2019-07-04 13:57:48 +01:00
add_test.go Fix: fix flaky add test 2019-07-09 02:37:47 +02:00
allocate.go Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00
CHANGELOG.md Changelog for 0.10.1 2019-04-10 11:44:52 +02:00
cluster_config_test.go Feat: regularly trigger "recover" automatically 2019-07-08 16:55:05 +02:00
cluster_config.go Feat: regularly trigger "recover" automatically 2019-07-08 16:55:05 +02:00
cluster_test.go Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
cluster.go Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
clusterhost.go Feat: introduce a ConnectionManager for the libp2p host 2019-05-23 00:34:47 +02:00
config_test.go crdt: Allow to configure CRDT in "TrustAll" mode 2019-06-10 13:35:25 +02:00
connect_graph.go Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02: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 Set CLUSTER_SECRET from shell 2018-10-24 21:20:53 +02:00
Dockerfile Remove docker_install 2019-07-04 13:58:38 +01:00
Dockerfile-bundle Docker: Run with daemon --upgrade by default. 2018-04-27 07:57:08 +02:00
Dockerfile-test Tests: add failfast, bump to go1.12, adjust codecov 2019-05-17 13:54:13 +02:00
go.mod Update dependencies 2019-07-05 18:12:57 +01:00
go.sum Update dependencies 2019-07-05 18:12:57 +01:00
ipfscluster_test.go Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
ipfscluster.go Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02: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 Fix #787: reBoostrap reguarly 2019-06-09 15:12:19 +02:00
Makefile Remove gx 2019-07-04 13:58:37 +01:00
peer_manager_test.go Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02: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 Improve pin/unpin method signatures (#843) 2019-07-22 15:39:11 +02:00
rpc_policy.go RPC Auth: make policygen.go generate a full rpc_policy.go 2019-05-13 23:22:08 +02:00
util.go Update deps along with go-libp2p-core refactor 2019-06-14 13:10:45 +02:00

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.