Try to go more to the point in the readme. Move quickstart guide to docs/
License: MIT Signed-off-by: Hector Sanjuan <hector@protocol.ai>
This commit is contained in:
Hector Sanjuan
Hector Sanjuan
parent
857e38175e
commit
c18b4beea3
154
README.md
154
README.md
|
|
@ -13,39 +13,31 @@
|
|||
|
||||
> Collective pinning and composition for IPFS.
|
||||
|
||||
**WORK IN PROGRESS**
|
||||
**THIS SOFTWARE IS ALPHA**
|
||||
|
||||
**DO NOT USE IN PRODUCTION**
|
||||
`ipfs-cluster` allows to replicate content (by pinning) in multiple IPFS nodes:
|
||||
|
||||
`ipfs-cluster` is a tool which groups a number of IPFS nodes together, allowing to collectively perform operations such as pinning.
|
||||
* Works on top of the IPFS daemon by running one cluster peer per IPFS node (`ipfs-cluster-service`)
|
||||
* A `replication_factor` controls how many times a CID is pinned in the cluster
|
||||
* Provides an HTTP API and a command-line wrapper (`ipfs-cluster-ctl`)
|
||||
* Provides an IPFS daemon API Proxy which intercepts any "pin"/"unpin" requests and does cluster pinning instead
|
||||
* Peers share the state using Raft-based consensus. Uses the LibP2P stack (`go-libp2p-raft`, `go-libp2p-rpc`...)
|
||||
|
||||
In order to do so IPFS Cluster nodes use a libp2p-based consensus algorithm (currently Raft) to agree on a log of operations and build a consistent state across the cluster. The state represents which objects should be pinned by which nodes.
|
||||
|
||||
Additionally, cluster nodes act as a proxy/wrapper to the IPFS API, so they can be used as a regular node, with the difference that `pin add`, `pin rm` and `pin ls` requests are handled by the Cluster.
|
||||
|
||||
IPFS Cluster provides a cluster-node application (`ipfs-cluster-service`), a Go API, a HTTP API and a command-line tool (`ipfs-cluster-ctl`).
|
||||
|
||||
Current functionality only allows pinning in all cluster peers, but more strategies (like setting a replication factor for each pin) will be developed.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Background](#background)
|
||||
- [Maintainers and Roadmap](#maintainers-and-roadmap)
|
||||
- [Install](#install)
|
||||
- [Usage](#usage)
|
||||
- [`ipfs-cluster-service`](#ipfs-cluster-service)
|
||||
- [`ipfs-cluster-ctl`](#ipfs-cluster-ctl)
|
||||
- [Quick start: Building and updating an IPFS Cluster](#quick-start-building-and-updating-an-ipfs-cluster)
|
||||
- [`Go`](#go)
|
||||
- [`Additional docs`](#additional-docs)
|
||||
- [API](#api)
|
||||
- [Architecture](#api)
|
||||
- [Contribute](#contribute)
|
||||
- [License](#license)
|
||||
|
||||
## Background
|
||||
|
||||
Since the start of IPFS it was clear that a tool to coordinate a number of different nodes (and the content they are supposed to store) would add a great value to the IPFS ecosystem. Naïve approaches are possible, but they present some weaknesses, specially at dealing with error handling, recovery and implementation of advanced pinning strategies.
|
||||
|
||||
`ipfs-cluster` aims to address this issues by providing a IPFS node wrapper which coordinates multiple cluster peers via a consensus algorithm. This ensures that the desired state of the system is always agreed upon and can be easily maintained by the cluster peers. Thus, every cluster node knows which content is tracked, can decide whether asking IPFS to pin it and can react to any contingencies like node reboots.
|
||||
|
||||
## Maintainers and Roadmap
|
||||
|
||||
|
|
@ -53,7 +45,7 @@ This project is captained by [@hsanjuan](https://github.com/hsanjuan). See the [
|
|||
|
||||
## Install
|
||||
|
||||
In order to install the `ipfs-cluster-service` the `ipfs-cluster-ctl` tool simply download this repository and run `make` as follows:
|
||||
`ipfs-cluster` is written in Go. In order to install the `ipfs-cluster-service` the `ipfs-cluster-ctl` tool simply download this repository and run `make` as follows:
|
||||
|
||||
```
|
||||
$ go get -u -d github.com/ipfs/ipfs-cluster
|
||||
|
|
@ -61,7 +53,7 @@ $ cd $GOPATH/src/github.com/ipfs/ipfs-cluster
|
|||
$ make install
|
||||
```
|
||||
|
||||
This will install `ipfs-cluster-service` and `ipfs-cluster-ctl` in your `$GOPATH/bin` folder.
|
||||
This will install `ipfs-cluster-service` and `ipfs-cluster-ctl` in your `$GOPATH/bin` folder. See the usage below.
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -71,7 +63,6 @@ This will install `ipfs-cluster-service` and `ipfs-cluster-ctl` in your `$GOPATH
|
|||
|
||||
```
|
||||
$ ipfs-cluster-service -h
|
||||
|
||||
```
|
||||
|
||||
Before running `ipfs-cluster-service` for the first time, initialize a configuration file with:
|
||||
|
|
@ -82,7 +73,7 @@ $ ipfs-cluster-service -init
|
|||
|
||||
The configuration will be placed in `~/.ipfs-cluster/service.json` by default.
|
||||
|
||||
You can add the multiaddresses for the other cluster peers the `bootstrap_multiaddresses` variable. For example, here is a valid configuration for a single-peer cluster:
|
||||
You can add the multiaddresses for the other cluster peers the `bootstrap` variable. For example, here is a valid configuration for a single-peer cluster:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
@ -95,17 +86,17 @@ You can add the multiaddresses for the other cluster peers the `bootstrap_multia
|
|||
"api_listen_multiaddress": "/ip4/127.0.0.1/tcp/9094",
|
||||
"ipfs_proxy_listen_multiaddress": "/ip4/127.0.0.1/tcp/9095",
|
||||
"ipfs_node_multiaddress": "/ip4/127.0.0.1/tcp/5001",
|
||||
"consensus_data_folder": "/home/hector/go/src/github.com/ipfs/ipfs-cluster/ipfs-cluster-service/d1/data",
|
||||
"consensus_data_folder": "/home/user/.ipfs-cluster/data",
|
||||
"state_sync_seconds": 60,
|
||||
"replication_factor": -1
|
||||
}
|
||||
```
|
||||
|
||||
The configuration file should probably be identical among all cluster peers, except for the `id` and `private_key` fields. Once every cluster peer has the configuration in place, you can run `ipfs-cluster-service` to start the cluster.
|
||||
The configuration file should probably be identical among all cluster peers, except for the `id` and `private_key` fields. Once every cluster peer has the configuration in place, you can run `ipfs-cluster-service` to start the cluster. See the [additional docs](#additional-docs) section for detailed documentation on how to build a cluster.
|
||||
|
||||
#### Clusters using `cluster_peers`
|
||||
|
||||
The `cluster_peers` configuration variable holds a list of current cluster members. If you know the members of the cluster in advance, or you want to start a cluster fully in parallel, set `cluster_peers` in all configurations so that every peer knows the rest upon boot. Leave `bootstrap` empty (although it will be ignored anyway)
|
||||
The `cluster_peers` configuration variable holds a list of current cluster members. If you know the members of the cluster in advance, or you want to start a cluster fully in parallel, set `cluster_peers` in all configurations so that every peer knows the rest upon boot. Leave `bootstrap` empty. A cluster peer address looks like: `/ip4/1.2.3.4/tcp/9096/<id>`.
|
||||
|
||||
#### Clusters using `bootstrap`
|
||||
|
||||
|
|
@ -114,7 +105,6 @@ When the `cluster_peers` variable is empty, the multiaddresses `bootstrap` can b
|
|||
Bootstrap is a convenient method, but more prone to errors than `cluster_peers`. It can be used as well with `ipfs-cluster-service --bootstrap <multiaddress>`. Note that bootstrapping nodes with an old state (or diverging state) from the one running in the cluster may lead to problems with
|
||||
the consensus, so usually you would want to bootstrap blank nodes.
|
||||
|
||||
|
||||
#### Debugging
|
||||
|
||||
`ipfs-cluster-service` offers two debugging options:
|
||||
|
|
@ -147,118 +137,20 @@ $ ipfs-cluster-ctl recover Qma4Lid2T1F68E3Xa3CpE6vVJDLwxXLD8RfiB9g1Tmqp58 # at
|
|||
|
||||
`ipfs-cluster-ctl` provides a `--debug` flag which allows to inspect request paths and raw response bodies.
|
||||
|
||||
### Quick start: Building and updating an IPFS Cluster
|
||||
|
||||
#### Step 0: Run your first cluster node
|
||||
|
||||
This step creates a single-node IPFS Cluster.
|
||||
|
||||
First initialize the configuration:
|
||||
|
||||
```
|
||||
node0 $ ipfs-cluster-service init
|
||||
ipfs-cluster-service configuration written to /home/user/.ipfs-cluster/service.json
|
||||
```
|
||||
|
||||
Then run cluster:
|
||||
|
||||
```
|
||||
node0> ipfs-cluster-service
|
||||
13:33:34.044 INFO cluster: IPFS Cluster v0.0.1 listening on: cluster.go:59
|
||||
13:33:34.044 INFO cluster: /ip4/127.0.0.1/tcp/9096/ipfs/QmQHKLBXfS7hf8o2acj7FGADoJDLat3UazucbHrgxqisim cluster.go:61
|
||||
13:33:34.044 INFO cluster: /ip4/192.168.1.103/tcp/9096/ipfs/QmQHKLBXfS7hf8o2acj7FGADoJDLat3UazucbHrgxqisim cluster.go:61
|
||||
13:33:34.044 INFO cluster: starting Consensus and waiting for a leader... consensus.go:163
|
||||
13:33:34.047 INFO cluster: PinTracker ready map_pin_tracker.go:71
|
||||
13:33:34.047 INFO cluster: waiting for leader raft.go:118
|
||||
13:33:34.047 INFO cluster: REST API: /ip4/127.0.0.1/tcp/9094 rest_api.go:309
|
||||
13:33:34.047 INFO cluster: IPFS Proxy: /ip4/127.0.0.1/tcp/9095 -> /ip4/127.0.0.1/tcp/5001 ipfs_http_connector.go:168
|
||||
13:33:35.420 INFO cluster: Raft Leader elected: QmQHKLBXfS7hf8o2acj7FGADoJDLat3UazucbHrgxqisim raft.go:145
|
||||
13:33:35.921 INFO cluster: Consensus state is up to date consensus.go:214
|
||||
13:33:35.921 INFO cluster: IPFS Cluster is ready cluster.go:191
|
||||
13:33:35.921 INFO cluster: Cluster Peers (not including ourselves): cluster.go:192
|
||||
13:33:35.921 INFO cluster: - No other peers cluster.go:195
|
||||
```
|
||||
|
||||
#### Step 1: Add new members to the cluster
|
||||
|
||||
Initialize and run cluster in a different node(s):
|
||||
|
||||
```
|
||||
node1> ipfs-cluster-service init
|
||||
ipfs-cluster-service configuration written to /home/user/.ipfs-cluster/service.json
|
||||
node1> ipfs-cluster-service
|
||||
13:36:19.313 INFO cluster: IPFS Cluster v0.0.1 listening on: cluster.go:59
|
||||
13:36:19.313 INFO cluster: /ip4/127.0.0.1/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85 cluster.go:61
|
||||
13:36:19.313 INFO cluster: /ip4/192.168.1.103/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85 cluster.go:61
|
||||
13:36:19.313 INFO cluster: starting Consensus and waiting for a leader... consensus.go:163
|
||||
13:36:19.316 INFO cluster: REST API: /ip4/127.0.0.1/tcp/7094 rest_api.go:309
|
||||
13:36:19.316 INFO cluster: IPFS Proxy: /ip4/127.0.0.1/tcp/7095 -> /ip4/127.0.0.1/tcp/5001 ipfs_http_connector.go:168
|
||||
13:36:19.316 INFO cluster: waiting for leader raft.go:118
|
||||
13:36:19.316 INFO cluster: PinTracker ready map_pin_tracker.go:71
|
||||
13:36:20.834 INFO cluster: Raft Leader elected: QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85 raft.go:145
|
||||
13:36:21.334 INFO cluster: Consensus state is up to date consensus.go:214
|
||||
13:36:21.334 INFO cluster: IPFS Cluster is ready cluster.go:191
|
||||
13:36:21.334 INFO cluster: Cluster Peers (not including ourselves): cluster.go:192
|
||||
13:36:21.334 INFO cluster: - No other peers cluster.go:195
|
||||
```
|
||||
|
||||
Add them to the original cluster with `ipfs-cluster-ctl peers add <multiaddr>`. The command will return the ID information of the newly added member:
|
||||
|
||||
```
|
||||
node0> ipfs-cluster-ctl peers add /ip4/192.168.1.103/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85
|
||||
{
|
||||
"id": "QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85",
|
||||
"public_key": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDtjpvI+XKVGT5toXTimtWceONYsf/1bbRMxLt/fCSYJoSeJqj0HUtttCD3dcBv1M2rElIMXDhyLUpkET+AN6otr9lQnbgi0ZaKrtzphR0w6g/0EQZZaxI2scxF4NcwkwUfe5ceEmPFwax1+C00nd2BF+YEEp+VHNyWgXhCxncOGO74p0YdXBrvXkyfTiy/567L3PPX9F9x+HiutBL39CWhx9INmtvdPB2HwshodF6QbfeljdAYCekgIrCQC8mXOVeePmlWgTwoge9yQbuViZwPiKwwo1AplANXFmSv8gagfjKL7Kc0YOqcHwxBsoUskbJjfheDZJzl19iDs9EvUGk5AgMBAAE=",
|
||||
"addresses": [
|
||||
"/ip4/127.0.0.1/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85",
|
||||
"/ip4/192.168.1.103/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85"
|
||||
],
|
||||
"cluster_peers": [
|
||||
"/ip4/192.168.123.103/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85"
|
||||
],
|
||||
"version": "0.0.1",
|
||||
"commit": "83baa5c859b9b17b2deec4f782d1210590025c80",
|
||||
"rpc_protocol_version": "/ipfscluster/0.0.1/rpc",
|
||||
"ipfs": {
|
||||
"id": "QmXZrtE5jQwXNqCJMfHUTQkvhQ4ZAnqMnmzFMJfLewur2n",
|
||||
"addresses": [
|
||||
"/ip4/127.0.0.1/tcp/4001/ipfs/QmXZrtE5jQwXNqCJMfHUTQkvhQ4ZAnqMnmzFMJfLewur2n",
|
||||
"/ip4/192.168.1.103/tcp/4001/ipfs/QmXZrtE5jQwXNqCJMfHUTQkvhQ4ZAnqMnmzFMJfLewur2n"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
You can repeat the process with any other nodes.
|
||||
|
||||
#### Step 3: Remove no longer needed nodes
|
||||
|
||||
You can use `ipfs-cluster-ctl peers rm <multiaddr>` to remove and disconnect any nodes from your cluster. The nodes will be automatically
|
||||
shutdown. They can be restarted manually and re-added to the Cluster any time:
|
||||
|
||||
```
|
||||
node0> ipfs-cluster-ctl peers rm QmbGFbZVTF3UAEPK9pBVdwHGdDAYkHYufQwSh4k1i8bbbb
|
||||
Request succeeded
|
||||
```
|
||||
|
||||
The `node1` is then disconnected and shuts down:
|
||||
|
||||
```
|
||||
13:42:50.828 WARNI cluster: this peer has been removed from the Cluster and will shutdown itself in 5 seconds peer_manager.go:48
|
||||
13:42:51.828 INFO cluster: stopping Consensus component consensus.go:257
|
||||
13:42:55.836 INFO cluster: shutting down IPFS Cluster cluster.go:235
|
||||
13:42:55.836 INFO cluster: Saving configuration config.go:283
|
||||
13:42:55.837 INFO cluster: stopping Cluster API rest_api.go:327
|
||||
13:42:55.837 INFO cluster: stopping IPFS Proxy ipfs_http_connector.go:332
|
||||
13:42:55.837 INFO cluster: stopping MapPinTracker map_pin_tracker.go:87
|
||||
```
|
||||
|
||||
### Go
|
||||
|
||||
IPFS Cluster nodes can be launched directly from Go. The `Cluster` object provides methods to interact with the cluster and perform actions.
|
||||
|
||||
Documentation and examples on how to use IPFS Cluster from Go can be found in [godoc.org/github.com/ipfs/ipfs-cluster](https://godoc.org/github.com/ipfs/ipfs-cluster).
|
||||
|
||||
### Additional docs
|
||||
|
||||
You can find more information and detailed guides:
|
||||
|
||||
* [Building and updating an IPFS Cluster](docs/HOWTO_build_and_update_a_cluster.md)
|
||||
|
||||
Note: please contribute to improve and add more documentation!
|
||||
|
||||
## API
|
||||
|
||||
TODO: Swagger
|
||||
|
|
|
|||
105
docs/HOWTO_build_and_update_a_cluster.md
Normal file
105
docs/HOWTO_build_and_update_a_cluster.md
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
# Building and updating an IPFS Cluster
|
||||
|
||||
### Step 0: Run your first cluster node
|
||||
|
||||
This step creates a single-node IPFS Cluster.
|
||||
|
||||
First initialize the configuration:
|
||||
|
||||
```
|
||||
node0 $ ipfs-cluster-service init
|
||||
ipfs-cluster-service configuration written to /home/user/.ipfs-cluster/service.json
|
||||
```
|
||||
|
||||
Then run cluster:
|
||||
|
||||
```
|
||||
node0> ipfs-cluster-service
|
||||
13:33:34.044 INFO cluster: IPFS Cluster v0.0.1 listening on: cluster.go:59
|
||||
13:33:34.044 INFO cluster: /ip4/127.0.0.1/tcp/9096/ipfs/QmQHKLBXfS7hf8o2acj7FGADoJDLat3UazucbHrgxqisim cluster.go:61
|
||||
13:33:34.044 INFO cluster: /ip4/192.168.1.103/tcp/9096/ipfs/QmQHKLBXfS7hf8o2acj7FGADoJDLat3UazucbHrgxqisim cluster.go:61
|
||||
13:33:34.044 INFO cluster: starting Consensus and waiting for a leader... consensus.go:163
|
||||
13:33:34.047 INFO cluster: PinTracker ready map_pin_tracker.go:71
|
||||
13:33:34.047 INFO cluster: waiting for leader raft.go:118
|
||||
13:33:34.047 INFO cluster: REST API: /ip4/127.0.0.1/tcp/9094 rest_api.go:309
|
||||
13:33:34.047 INFO cluster: IPFS Proxy: /ip4/127.0.0.1/tcp/9095 -> /ip4/127.0.0.1/tcp/5001 ipfs_http_connector.go:168
|
||||
13:33:35.420 INFO cluster: Raft Leader elected: QmQHKLBXfS7hf8o2acj7FGADoJDLat3UazucbHrgxqisim raft.go:145
|
||||
13:33:35.921 INFO cluster: Consensus state is up to date consensus.go:214
|
||||
13:33:35.921 INFO cluster: IPFS Cluster is ready cluster.go:191
|
||||
13:33:35.921 INFO cluster: Cluster Peers (not including ourselves): cluster.go:192
|
||||
13:33:35.921 INFO cluster: - No other peers cluster.go:195
|
||||
```
|
||||
|
||||
### Step 1: Add new members to the cluster
|
||||
|
||||
Initialize and run cluster in a different node(s):
|
||||
|
||||
```
|
||||
node1> ipfs-cluster-service init
|
||||
ipfs-cluster-service configuration written to /home/user/.ipfs-cluster/service.json
|
||||
node1> ipfs-cluster-service
|
||||
13:36:19.313 INFO cluster: IPFS Cluster v0.0.1 listening on: cluster.go:59
|
||||
13:36:19.313 INFO cluster: /ip4/127.0.0.1/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85 cluster.go:61
|
||||
13:36:19.313 INFO cluster: /ip4/192.168.1.103/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85 cluster.go:61
|
||||
13:36:19.313 INFO cluster: starting Consensus and waiting for a leader... consensus.go:163
|
||||
13:36:19.316 INFO cluster: REST API: /ip4/127.0.0.1/tcp/7094 rest_api.go:309
|
||||
13:36:19.316 INFO cluster: IPFS Proxy: /ip4/127.0.0.1/tcp/7095 -> /ip4/127.0.0.1/tcp/5001 ipfs_http_connector.go:168
|
||||
13:36:19.316 INFO cluster: waiting for leader raft.go:118
|
||||
13:36:19.316 INFO cluster: PinTracker ready map_pin_tracker.go:71
|
||||
13:36:20.834 INFO cluster: Raft Leader elected: QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85 raft.go:145
|
||||
13:36:21.334 INFO cluster: Consensus state is up to date consensus.go:214
|
||||
13:36:21.334 INFO cluster: IPFS Cluster is ready cluster.go:191
|
||||
13:36:21.334 INFO cluster: Cluster Peers (not including ourselves): cluster.go:192
|
||||
13:36:21.334 INFO cluster: - No other peers cluster.go:195
|
||||
```
|
||||
|
||||
Add them to the original cluster with `ipfs-cluster-ctl peers add <multiaddr>`. The command will return the ID information of the newly added member:
|
||||
|
||||
```
|
||||
node0> ipfs-cluster-ctl peers add /ip4/192.168.1.103/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85
|
||||
{
|
||||
"id": "QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85",
|
||||
"public_key": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDtjpvI+XKVGT5toXTimtWceONYsf/1bbRMxLt/fCSYJoSeJqj0HUtttCD3dcBv1M2rElIMXDhyLUpkET+AN6otr9lQnbgi0ZaKrtzphR0w6g/0EQZZaxI2scxF4NcwkwUfe5ceEmPFwax1+C00nd2BF+YEEp+VHNyWgXhCxncOGO74p0YdXBrvXkyfTiy/567L3PPX9F9x+HiutBL39CWhx9INmtvdPB2HwshodF6QbfeljdAYCekgIrCQC8mXOVeePmlWgTwoge9yQbuViZwPiKwwo1AplANXFmSv8gagfjKL7Kc0YOqcHwxBsoUskbJjfheDZJzl19iDs9EvUGk5AgMBAAE=",
|
||||
"addresses": [
|
||||
"/ip4/127.0.0.1/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85",
|
||||
"/ip4/192.168.1.103/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85"
|
||||
],
|
||||
"cluster_peers": [
|
||||
"/ip4/192.168.123.103/tcp/7096/ipfs/QmU7JJftGsP1zM8H37XwvfA7dwdepsB7xVnJA6sKpozc85"
|
||||
],
|
||||
"version": "0.0.1",
|
||||
"commit": "83baa5c859b9b17b2deec4f782d1210590025c80",
|
||||
"rpc_protocol_version": "/ipfscluster/0.0.1/rpc",
|
||||
"ipfs": {
|
||||
"id": "QmXZrtE5jQwXNqCJMfHUTQkvhQ4ZAnqMnmzFMJfLewur2n",
|
||||
"addresses": [
|
||||
"/ip4/127.0.0.1/tcp/4001/ipfs/QmXZrtE5jQwXNqCJMfHUTQkvhQ4ZAnqMnmzFMJfLewur2n",
|
||||
"/ip4/192.168.1.103/tcp/4001/ipfs/QmXZrtE5jQwXNqCJMfHUTQkvhQ4ZAnqMnmzFMJfLewur2n"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
You can repeat the process with any other nodes.
|
||||
|
||||
### Step 2: Remove no longer needed nodes
|
||||
|
||||
You can use `ipfs-cluster-ctl peers rm <multiaddr>` to remove and disconnect any nodes from your cluster. The nodes will be automatically
|
||||
shutdown. They can be restarted manually and re-added to the Cluster any time:
|
||||
|
||||
```
|
||||
node0> ipfs-cluster-ctl peers rm QmbGFbZVTF3UAEPK9pBVdwHGdDAYkHYufQwSh4k1i8bbbb
|
||||
Request succeeded
|
||||
```
|
||||
|
||||
The `node1` is then disconnected and shuts down:
|
||||
|
||||
```
|
||||
13:42:50.828 WARNI cluster: this peer has been removed from the Cluster and will shutdown itself in 5 seconds peer_manager.go:48
|
||||
13:42:51.828 INFO cluster: stopping Consensus component consensus.go:257
|
||||
13:42:55.836 INFO cluster: shutting down IPFS Cluster cluster.go:235
|
||||
13:42:55.836 INFO cluster: Saving configuration config.go:283
|
||||
13:42:55.837 INFO cluster: stopping Cluster API rest_api.go:327
|
||||
13:42:55.837 INFO cluster: stopping IPFS Proxy ipfs_http_connector.go:332
|
||||
13:42:55.837 INFO cluster: stopping MapPinTracker map_pin_tracker.go:87
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user