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.

Sign up for GitHub

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

add notes regarding exporting/importing market data with lotus-shed #972

Merged
merged 8 commits into from
Jul 27, 2021
Merged

add notes regarding exporting/importing market data with lotus-shed #972

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4cf960e
add notes regarding exporting/importing market data with lotus-shed
nonsense Jul 26, 2021
e5a5753
add section on how to interact with different processes
nonsense Jul 27, 2021
d07337f
better docs on the config.toml creation for the markets service
nonsense Jul 27, 2021
0edce7a
fixup
nonsense Jul 27, 2021
4dbc4c7
fixup
nonsense Jul 27, 2021
786cd05
explicitly say to run init command on markets host
nonsense Jul 27, 2021
03ff700
add a note about updating the multiaddr of the miner
nonsense Jul 27, 2021
bbae1d5
group sections into one bigger section
nonsense Jul 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 58 additions & 19 deletions docs/mine/lotus/split-markets-miners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,34 +66,38 @@ export LOTUS_BACKUP_BASE_PATH=~/lotus-backup-location
lotus-miner run
```

## Creating a backup
## Splitting the `lotus-miner` monolith

### 1. Creating a backup

```shell
export LOTUS_BACKUP_BASE_PATH=~/lotus-backup-location
lotus-miner backup ~/lotus-backup-location/backupfile
```

## Copy config.toml for the markets service
### 2. Create `config.toml` for the markets service

You need to generate a `config.toml` for the markets node, and have them ready for the next step. For more information see [configuration usage page](https://docs.filecoin.io/get-started/lotus/configuration-and-advanced-usage/) and the [custom storage layout page](https://docs.filecoin.io/mine/lotus/custom-storage-layout/).
You need to create a `config.toml` for the markets node, and have it ready for the next step. For more information see [configuration usage page](https://docs.filecoin.io/get-started/lotus/configuration-and-advanced-usage/) and the [custom storage layout page](https://docs.filecoin.io/mine/lotus/custom-storage-layout/).

If you intend to run the `mining/sealing/proving` node on the same machine as the `markets` node, make sure that their listeners do not clash:
In the example commands below, we have placed the `config.toml` in the `~/.lotusmarket` directory, which is not the repository directory for the `markets` instance. The repository directory which we use is `~/markets-repo-location`. We are using the following `config.toml`:

```toml
[API]
ListenAddress = "/ip4/127.0.0.1/tcp/8787/http"
RemoteListenAddress = "127.0.0.1:8787"
```

By default the `lotus-miner` API server listens to port 2345, so in the example configuration above, we change the configuration for the `markets` node to listen to `127.0.0.1:8787`.
[Libp2p]
ListenAddresses = ["/ip4/0.0.0.0/tcp/24001", "/ip6/::/tcp/24001"]
AnnounceAddresses = ["/ip4/12.34.56.78/tcp/24001"]
```

In the example commands below, we have placed the `config.toml` in the `~/.lotusmarket` directory.
If you intend to run the `mining/sealing/proving` node on the same machine as the `markets` node, make sure that their listeners do not clash. By default the `lotus-miner` API server listens to port 2345, so in the example configuration above, we change the configuration for the `markets` node to listen to `127.0.0.1:8787`.

Make sure you adjust the `[Libp2p]` section on the `markets` node accordingly - it needs to be publicly accessible, so that clients can make storage and retrieval deals with your system.

The `[Libp2p]` section on the `mining/sealing/proving` node can be removed because this node will no longer be running a Libp2p node.

## Initialising a markets service repository
### 3. Initialising a `markets` service repository

1. Create authentication tokens for the `markets` node

Expand All @@ -102,9 +106,11 @@ export APISEALER=`./lotus-miner auth api-info --perm=admin`
export APISECTORINDEX=`./lotus-miner auth api-info --perm=admin`
```

2. Initialise the `market` node. This performs a one-time setup of the markets node. Part of that setup includes updating the `Peer ID` and the `Multiaddr` in the miner actor by submitting a message on chain. This is necessary so that storage and retrieval clients know that this miner's **deal-making** endpoint is now publicly dialable/reachable on a new address (the new `market` node).
2. Initialise the `market` node. This performs a one-time setup of the markets node. Part of that setup includes updating the `peer id` in the miner actor by submitting a message on chain. This is necessary so that storage and retrieval clients know that this miner's **deal-making** endpoint is now publicly dialable/reachable on a new address (the new `market` node).

Note that `lotus-miner` interacts with one repository or another depending on the `LOTUS_MINER_PATH` environment variable!

Note that `lotus-miner` interacts with one repository or another depending on the `LOTUS_MINER_PATH` environment variable!
This command should be run on the `markets` miner instance host, as it is creating the `markets` miner instance repository, among other actions.

```shell
export LOTUS_MINER_PATH=~/markets-repo-location
Expand All @@ -116,13 +122,19 @@ export LOTUS_MINER_PATH=~/markets-repo-location
~/lotus-backup-location/backupfile
```

## Move the DAG store directory to the markets node repository
3. Optionally update your miner's `multiaddr` on-chain - in case your `markets` instance is publicly exposed at a different location compared to your exiting monolith miner, you also need to update your `multiaddr` on-chain and advertise the correct one to clients:

```shell
./lotus-miner actor set-addrs <NEW_MULTIADDR>
```

### 4. Move the DAG store directory to the markets node repository

```shell
mv ~/.lotusminer/dagStore ~/markets-repo-location/
```

## Start the `mining/sealing/proving` miner process without the markets subsystem
### 5. Start the `mining/sealing/proving` miner process without the markets subsystem

1. Update your `config.toml` and set `EnableMarkets` option to `false`.

Expand All @@ -132,15 +144,34 @@ mv ~/.lotusminer/dagStore ~/markets-repo-location/
./lotus-miner run
```

## Start the `markets` miner process with the markets subsystem
### 6. Start the `markets` miner process with the markets subsystem

```shell
LOTUS_MINER_PATH=~/markets-repo-location ./lotus-miner run
```

## Rollback to `lotus-miner` monolith process
## Interacting with the different miner instances with CLI over JSON RPC

> In case you run more than one miner instance on the same machine, make sure that you have `MINER_API_INFO` environment variable `unset`. If you have it set, you will always be interacting with only one miner process, because it has precedence over `LOTUS_MINER_PATH`.

Now that you have both a `markets` miner process and a `mining/sealing/proving` miner process running, you can confirm that you can interact with each respective process with the following:

1. Get the peer identity of the `markets` miner process
```shell
LOTUS_MINER_PATH=~/markets-repo-location ./lotus-miner net id
```

> Warning: after rollback, your miner won't be able to serve any storage deals that were made to it while the system was running in multi-process architecture (i.e. with a split `markets` service)
2. Get a list of storage deals from the `markets` miner process
```shell
LOTUS_MINER_PATH=~/markets-repo-location ./lotus-miner storage-deals list
```

3. Get a list of sectors from the `mining/sealing/proving` miner process
```shell
LOTUS_MINER_PATH=~/.lotusminer ./lotus-miner sectors list
```

## Rollback to `lotus-miner` monolith process

If you want to revert the changes listed above and go back to running `lotus-miner` as a single process, run the following:

Expand All @@ -155,25 +186,33 @@ If you want to revert the changes listed above and go back to running `lotus-min
EnableMarkets = true
```

1. Move back the DAG store directory to the monolith miner node repository
3. Move back the DAG store directory to the monolith miner node repository

```shell
mv ~/markets-repo-location/dagStore ~/.lotusminer/
```

1. Restart the `mining/sealing/proving` node (with the default LOTUS_MINER_PATH, which should point to your `mining/sealing/proving` node repo). Note that `lotus-miner` interacts with a given repository depending on the `LOTUS_MINER_PATH` environment variable!
4. Backup and restore the metadata related to storage deals from the `markets` instance back to the monolith miner instance. Given that storage deals metadata would have changed on the `markets` instance in case you accepted storage deals while running multi-services architecture, we have to copy it back to the monolith miner instance.

```shell
./lotus-shed market export-datastore --repo ~/markets-repo-location --backup-dir /tmp/deals-backup

./lotus-shed market import-datastore --repo ~/.lotusminer --backup-path /tmp/deals-backup/markets.datastore.backup
```

5. Restart the `mining/sealing/proving` node (with the default LOTUS_MINER_PATH, which should point to your `mining/sealing/proving` node repo). Note that `lotus-miner` interacts with a given repository depending on the `LOTUS_MINER_PATH` environment variable!

```shell
./lotus-miner run
```

1. Fetch the node identity. This is necessary as you have to update your miner's peer identity on-chain, as it was changed to the identity of the markets node during the initialising of the markets service repository.
6. Fetch the node identity. This is necessary as you have to update your miner's peer identity on-chain, as it was changed to the identity of the markets node during the initialising of the markets service repository.

```shell
./lotus-miner net id
```

1. Update the miner's peer id on-chain with the result from the previous step.
7. Update the miner's peer id on-chain with the result from the previous step.

```shell
./lotus-miner actor set-peer-id 12D3XXXXX
Expand Down