2016-12-28 15:25:24 +00:00
|
|
|
// Package ipfscluster implements a wrapper for the IPFS deamon which
|
|
|
|
// allows to orchestrate pinning operations among several IPFS nodes.
|
2016-12-02 18:33:39 +00:00
|
|
|
//
|
2016-12-28 15:25:24 +00:00
|
|
|
// IPFS Cluster uses a go-libp2p-raft to keep a shared state between
|
2017-01-26 18:59:31 +00:00
|
|
|
// the different cluster peers. It also uses LibP2P to enable
|
2016-12-28 15:25:24 +00:00
|
|
|
// communication between its different components, which perform different
|
|
|
|
// tasks like managing the underlying IPFS daemons, or providing APIs for
|
|
|
|
// external control.
|
2016-12-02 18:33:39 +00:00
|
|
|
package ipfscluster
|
|
|
|
|
|
|
|
import (
|
2017-01-25 11:14:39 +00:00
|
|
|
rpc "github.com/hsanjuan/go-libp2p-gorpc"
|
2016-12-16 11:40:28 +00:00
|
|
|
cid "github.com/ipfs/go-cid"
|
|
|
|
peer "github.com/libp2p/go-libp2p-peer"
|
2016-12-23 18:35:37 +00:00
|
|
|
protocol "github.com/libp2p/go-libp2p-protocol"
|
2017-02-08 17:04:08 +00:00
|
|
|
|
|
|
|
"github.com/ipfs/ipfs-cluster/api"
|
2016-12-02 18:33:39 +00:00
|
|
|
)
|
|
|
|
|
2017-01-26 18:59:31 +00:00
|
|
|
// RPCProtocol is used to send libp2p messages between cluster peers
|
2017-01-24 15:19:23 +00:00
|
|
|
var RPCProtocol = protocol.ID("/ipfscluster/" + Version + "/rpc")
|
2016-12-23 18:35:37 +00:00
|
|
|
|
2016-12-29 17:38:09 +00:00
|
|
|
// Component represents a piece of ipfscluster. Cluster components
|
2016-12-08 16:24:38 +00:00
|
|
|
// usually run their own goroutines (a http server for example). They
|
2016-12-23 18:35:37 +00:00
|
|
|
// communicate with the main Cluster component and other components
|
|
|
|
// (both local and remote), using an instance of rpc.Client.
|
2016-12-29 17:38:09 +00:00
|
|
|
type Component interface {
|
2016-12-23 18:35:37 +00:00
|
|
|
SetClient(*rpc.Client)
|
2016-12-02 18:33:39 +00:00
|
|
|
Shutdown() error
|
|
|
|
}
|
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
// API is a component which offers an API for Cluster. This is
|
2016-12-02 18:33:39 +00:00
|
|
|
// a base component.
|
2016-12-15 18:08:46 +00:00
|
|
|
type API interface {
|
2016-12-29 17:38:09 +00:00
|
|
|
Component
|
2016-12-02 18:33:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// IPFSConnector is a component which allows cluster to interact with
|
2016-12-08 16:24:38 +00:00
|
|
|
// an IPFS daemon. This is a base component.
|
2016-12-02 18:33:39 +00:00
|
|
|
type IPFSConnector interface {
|
2016-12-29 17:38:09 +00:00
|
|
|
Component
|
2017-02-08 17:04:08 +00:00
|
|
|
ID() (api.IPFSID, error)
|
2016-12-02 18:33:39 +00:00
|
|
|
Pin(*cid.Cid) error
|
|
|
|
Unpin(*cid.Cid) error
|
2017-02-08 17:04:08 +00:00
|
|
|
PinLsCid(*cid.Cid) (api.IPFSPinStatus, error)
|
|
|
|
PinLs() (map[string]api.IPFSPinStatus, error)
|
2016-12-02 18:33:39 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Peered represents a component which needs to be aware of the peers
|
2016-12-08 16:24:38 +00:00
|
|
|
// in the Cluster and of any changes to the peer set.
|
2016-12-02 18:33:39 +00:00
|
|
|
type Peered interface {
|
|
|
|
AddPeer(p peer.ID)
|
|
|
|
RmPeer(p peer.ID)
|
2017-01-30 12:12:25 +00:00
|
|
|
//SetPeers(peers []peer.ID)
|
2016-12-02 18:33:39 +00:00
|
|
|
}
|
|
|
|
|
2016-12-15 18:08:46 +00:00
|
|
|
// State represents the shared state of the cluster and it
|
|
|
|
// is used by the Consensus component to keep track of
|
2016-12-06 21:29:59 +00:00
|
|
|
// objects which objects are pinned. This component should be thread safe.
|
2016-12-15 18:08:46 +00:00
|
|
|
type State interface {
|
|
|
|
// AddPin adds a pin to the State
|
2016-12-06 21:29:59 +00:00
|
|
|
AddPin(*cid.Cid) error
|
2016-12-15 18:08:46 +00:00
|
|
|
// RmPin removes a pin from the State
|
2016-12-06 21:29:59 +00:00
|
|
|
RmPin(*cid.Cid) error
|
2016-12-09 19:54:46 +00:00
|
|
|
// ListPins lists all the pins in the state
|
|
|
|
ListPins() []*cid.Cid
|
2016-12-20 18:51:13 +00:00
|
|
|
// HasPin returns true if the state is holding a Cid
|
|
|
|
HasPin(*cid.Cid) bool
|
2017-02-02 22:52:06 +00:00
|
|
|
// AddPeer adds a peer to the shared state
|
2016-12-06 21:29:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// PinTracker represents a component which tracks the status of
|
|
|
|
// the pins in this cluster and ensures they are in sync with the
|
|
|
|
// IPFS daemon. This component should be thread safe.
|
|
|
|
type PinTracker interface {
|
2016-12-29 17:38:09 +00:00
|
|
|
Component
|
2016-12-19 17:35:24 +00:00
|
|
|
// Track tells the tracker that a Cid is now under its supervision
|
|
|
|
// The tracker may decide to perform an IPFS pin.
|
|
|
|
Track(*cid.Cid) error
|
|
|
|
// Untrack tells the tracker that a Cid is to be forgotten. The tracker
|
|
|
|
// may perform an IPFS unpin operation.
|
|
|
|
Untrack(*cid.Cid) error
|
2017-01-25 18:38:23 +00:00
|
|
|
// StatusAll returns the list of pins with their local status.
|
2017-02-08 17:04:08 +00:00
|
|
|
StatusAll() []api.PinInfo
|
2017-01-25 18:38:23 +00:00
|
|
|
// Status returns the local status of a given Cid.
|
2017-02-08 17:04:08 +00:00
|
|
|
Status(*cid.Cid) api.PinInfo
|
2017-01-25 18:38:23 +00:00
|
|
|
// SyncAll makes sure that all tracked Cids reflect the real IPFS status.
|
2017-01-25 17:07:19 +00:00
|
|
|
// It returns the list of pins which were updated by the call.
|
2017-02-08 17:04:08 +00:00
|
|
|
SyncAll() ([]api.PinInfo, error)
|
2017-01-25 18:38:23 +00:00
|
|
|
// Sync makes sure that the Cid status reflect the real IPFS status.
|
|
|
|
// It returns the local status of the Cid.
|
2017-02-08 17:04:08 +00:00
|
|
|
Sync(*cid.Cid) (api.PinInfo, error)
|
2016-12-20 18:51:13 +00:00
|
|
|
// Recover retriggers a Pin/Unpin operation in Cids with error status.
|
2017-02-08 17:04:08 +00:00
|
|
|
Recover(*cid.Cid) (api.PinInfo, error)
|
2017-01-30 12:12:25 +00:00
|
|
|
}
|