Merge pull request #979 from filecoin-project/@jimmylee/docs-copy-updates
documentation: copy revisions
This commit is contained in:
Jim
GitHub
commit
ce310dddd9
@ -1,11 +1,11 @@
|
||||
# API Troubleshooting
|
||||
|
||||
## params
|
||||
## Types: params
|
||||
|
||||
`params` must be an array. If there are no `params` you should still pass an
|
||||
empty array.
|
||||
|
||||
## TipSet
|
||||
## Types: TipSet
|
||||
|
||||
For methods such as `Filecoin.StateMinerPower`, where the method accepts the
|
||||
argument of the type `TipSet`, you can pass `null` to use the current chain
|
||||
@ -18,7 +18,7 @@ curl -X POST \
|
||||
'http://127.0.0.1:1234/rpc/v0'
|
||||
```
|
||||
|
||||
## Sending a CID
|
||||
## Types: Sending a CID
|
||||
|
||||
If you do not serialize the CID as a
|
||||
[JSON IPLD link](https://did-ipid.github.io/ipid-did-method/#txref), you will
|
||||
|
||||
105
documentation/en/mining-lotus-seal-worker.md
Normal file
105
documentation/en/mining-lotus-seal-worker.md
Normal file
@ -0,0 +1,105 @@
|
||||
# Lotus Seal Worker
|
||||
|
||||
The **Lotus Seal Worker** is an extra process that can offload heavy processing
|
||||
tasks from your **Lotus Storage Miner**. It can be run on the same machine as
|
||||
your `lotus-storage-miner`, or on another machine communicating over a fast
|
||||
network.
|
||||
|
||||
## Get Started
|
||||
|
||||
Make sure that the `lotus-seal-worker` is installed by running:
|
||||
|
||||
```sh
|
||||
make lotus-seal-worker
|
||||
```
|
||||
|
||||
## Running Alongside Storage Miner
|
||||
|
||||
You may wish to run the **Lotus Seal Worker** on the same computer as the
|
||||
**Lotus Storage Miner**. This allows you to easily set the process priority of
|
||||
the sealing tasks to be lower than the priority of your more important storage
|
||||
miner process.
|
||||
|
||||
To do this, simply run `lotus-seal-worker run`, and the seal worker will
|
||||
automatically pick up the correct authentication tokens from the
|
||||
`LOTUS_STORAGE_PATH` miner repository.
|
||||
|
||||
To check that the **Lotus Seal Worker** is properly connected to your storage
|
||||
miner, run `lotus-storage-miner info` and check that the remote worker count has
|
||||
increased.
|
||||
|
||||
```sh
|
||||
why@computer ~/lotus> lotus-storage-miner info
|
||||
Miner: t0103
|
||||
Sector Size: 16.0 MiB
|
||||
Power: 0 B / 16.0 MiB (0%)
|
||||
Worker use:
|
||||
Local: 0 / 2 (+1 reserved)
|
||||
**Remote: 0 / 1**
|
||||
PoSt Submissions: Not Proving
|
||||
Sectors: map[Committing:0 Proving:0 Total:0]
|
||||
```
|
||||
|
||||
## Running Over the Network
|
||||
|
||||
Warning: This setup is a little more complex than running it locally.
|
||||
|
||||
To use an entirely separate computer for sealing tasks, you will want to run the
|
||||
`lotus-seal-worker` on a separate machine, connected to your **Lotus Storage
|
||||
Miner** via the local area network.
|
||||
|
||||
First, you will need to ensure your `lotus-storage-miner`'s API is accessible
|
||||
over the network.
|
||||
|
||||
To do this, open up `~/.lotusstorage/config.toml` (Or if you manually set
|
||||
`LOTUS_STORAGE_PATH`, look under that directory) and look for the API field.
|
||||
|
||||
Default config:
|
||||
|
||||
```toml
|
||||
[API]
|
||||
ListenAddress = "/ip4/127.0.0.1/tcp/2345/http"
|
||||
```
|
||||
|
||||
To make your node accessible over the local area network, you will need to
|
||||
determine your machines IP on the LAN, and change the `127.0.0.1` in the file to
|
||||
that address.
|
||||
|
||||
A more permissive and less secure option is to change it to `0.0.0.0`. This will
|
||||
allow anyone who can connect to your computer on that port to access the
|
||||
[API](https://docs.lotu.sh/en+api). They will still need an auth token.
|
||||
|
||||
Next, you will need to
|
||||
[create an authentication token](https://docs.lotu.sh/en+api-scripting-support#generate-a-jwt-46).
|
||||
All Lotus APIs require authentication tokens to ensure your processes are as
|
||||
secure against attackers attempting to make unauthenticated requests to them.
|
||||
|
||||
### Connect the Lotus Seal Worker
|
||||
|
||||
On the machine that will run `lotus-seal-worker`, set the `STORAGE_API_INFO`
|
||||
environment variable to `TOKEN:STORAGE_NODE_MULTIADDR`. Where `TOKEN` is the
|
||||
token we created above, and `STORAGE_NODE_MULTIADDR` is the `multiaddr` of the
|
||||
**Lotus Storage Miner** API that was set in `config.toml`.
|
||||
|
||||
Once this is set, run:
|
||||
|
||||
```sh
|
||||
lotus-seal-worker run
|
||||
```
|
||||
|
||||
To check that the **Lotus Seal Worker** is connected to your **Lotus Storage
|
||||
Miner**, run `lotus-storage-miner info` and check that the remote worker count
|
||||
has increased.
|
||||
|
||||
```sh
|
||||
why@computer ~/lotus> lotus-storage-miner info
|
||||
Miner: t05749
|
||||
Sector Size: 1 GiB
|
||||
Power: 0 B / 136 TiB (0.0000%)
|
||||
Committed: 1 GiB
|
||||
Proving: 1 GiB
|
||||
Worker use:
|
||||
Local: 0 / 1 (+1 reserved)
|
||||
**Remote: 0 / 1**
|
||||
Sectors: map[Proving:1 Total:1]
|
||||
```
|
||||
@ -1,6 +1,6 @@
|
||||
# Mining Troubleshooting
|
||||
|
||||
## Changing the Filecoin Proof Parameters directory
|
||||
## Config: Filecoin Proof Parameters directory
|
||||
|
||||
If you want to put the **Filecoin Proof Parameters** in a different directory,
|
||||
use the following environment variable:
|
||||
@ -9,7 +9,7 @@ use the following environment variable:
|
||||
FIL_PROOFS_PARAMETER_CACHE
|
||||
```
|
||||
|
||||
## Bellman Lockfile
|
||||
## Error: Can't acquire bellman.lock
|
||||
|
||||
The **Bellman** lockfile is created to lock a GPU for a process. This bug can
|
||||
occur when this file isn't properly cleaned up:
|
||||
@ -21,7 +21,7 @@ mining block failed: computing election proof: github.com/filecoin-project/lotus
|
||||
This bug occurs when the storage miner can't acquire the `bellman.lock`. To fix
|
||||
it you need to stop the `lotus-storage-miner` and remove `/tmp/bellman.lock`.
|
||||
|
||||
## Your miner is not ready
|
||||
## Error: Failed to get api endpoint
|
||||
|
||||
```sh
|
||||
lotus-storage-miner info
|
||||
@ -31,7 +31,7 @@ lotus-storage-miner info
|
||||
If you see this, that means your **Lotus Storage Miner** isn't ready yet. You
|
||||
need to finish [syncing the chain](https://docs.lotu.sh/en+join-testnet).
|
||||
|
||||
## Your computer is too slow
|
||||
## Error: Your computer may not be fast enough
|
||||
|
||||
```sh
|
||||
CAUTION: block production took longer than the block delay. Your computer may not be fast enough to keep up
|
||||
@ -40,7 +40,7 @@ CAUTION: block production took longer than the block delay. Your computer may no
|
||||
If you see this, that means your computer is too slow and your blocks are not
|
||||
included in the chain, and you will not receive any rewards.
|
||||
|
||||
## Running out of storage
|
||||
## Error: No space left on device
|
||||
|
||||
```sh
|
||||
lotus-storage-miner pledge-sector
|
||||
@ -52,7 +52,7 @@ which by default is the root partition (This is common for Linux setups).
|
||||
Usually your root partition does not get the largest partition of storage so you
|
||||
will need to change the environment variable to something else.
|
||||
|
||||
## GPU not being used
|
||||
## Error: GPU unused
|
||||
|
||||
If you suspect that your GPU is not being used, first make sure it is properly
|
||||
configured as described in the [testing configuration page](hardware-mining.md).
|
||||
|
||||
@ -1,109 +0,0 @@
|
||||
# Lotus Seal Worker
|
||||
|
||||
The `lotus-seal-worker` is an extra process that can offload heavy processing
|
||||
tasks from your `lotus-storage-miner`. It can be run on the same machine as your
|
||||
`lotus-storage-miner`, or on a different machine communicating over a fast
|
||||
network.
|
||||
|
||||
## Get Started
|
||||
|
||||
Make sure that the `lotus-seal-worker` is installed by running:
|
||||
|
||||
```sh
|
||||
make lotus-seal-worker
|
||||
```
|
||||
|
||||
## Running Alongside Storage Miner
|
||||
|
||||
You may wish to run the lotus seal worker on the same computer as the storage
|
||||
miner. This allows you to easily set the process priority of the sealing tasks
|
||||
to be lower than the priority of your more important storage miner process.
|
||||
|
||||
To do this, simply run `lotus-seal-worker run`, and the seal worker will
|
||||
automatically pick up the correct authentication tokens from the
|
||||
`LOTUS_STORAGE_PATH` miner repository.
|
||||
|
||||
To check that the seal worker is properly connected to your storage miner, run
|
||||
`lotus-storage-miner info` and check that the remote worker count has increased.
|
||||
|
||||
```sh
|
||||
why@computer ~/lotus> lotus-storage-miner info
|
||||
Miner: t0103
|
||||
Sector Size: 16.0 MiB
|
||||
Power: 0 B / 16.0 MiB (0%)
|
||||
Worker use:
|
||||
Local: 0 / 2 (+1 reserved)
|
||||
**Remote: 0 / 1**
|
||||
PoSt Submissions: Not Proving
|
||||
Sectors: map[Committing:0 Proving:0 Total:0]
|
||||
```
|
||||
|
||||
## Running Over the Network
|
||||
|
||||
To use an entirely separate computer for sealing tasks, you will want to run the
|
||||
`lotus-seal-worker` on a separate machine, connected to your storage miner via
|
||||
the local area network.
|
||||
|
||||
This setup is a little more complex than running it locally.
|
||||
|
||||
First, you will need to ensure your `lotus-storage-miner`'s API is accessible
|
||||
over the network.
|
||||
|
||||
To do this, open up `~/.lotusstorage/config.toml` (Or if you manually set
|
||||
`LOTUS_STORAGE_PATH`, look under that directory) and look for the API field.
|
||||
|
||||
By default it should look something like:
|
||||
|
||||
```toml
|
||||
[API]
|
||||
ListenAddress = "/ip4/127.0.0.1/tcp/2345/http"
|
||||
```
|
||||
|
||||
To make your node accessible over the local area network, you will need to
|
||||
determine your machines IP on the LAN, and change the `127.0.0.1` in the file to
|
||||
that address. A less secure, but more permissive option is to change it to
|
||||
`0.0.0.0`. This will allow anyone who can connect to your computer on that port
|
||||
to access the API (though they will still need an auth token, as we will discuss
|
||||
next).
|
||||
|
||||
Next, you will need to get an authentication token for the seal worker. All
|
||||
lotus APIs require authentication tokens to ensure your processes are as secure
|
||||
against attackers attempting to make unauthenticated requests to them. To create
|
||||
a token, run `lotus-storage-miner auth create-token --perm admin`. This will
|
||||
create a token with `admin` permissions. Note: This is an admin token, it can
|
||||
access any of the api endpoints of your node, take care not to leak it. See the
|
||||
[scripting support doc](api-scripting-support.md) for more details.
|
||||
|
||||
This token will look something like this:
|
||||
|
||||
```sh
|
||||
why@computer ~> lotus-storage-miner auth create-token --perm admin
|
||||
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJBbGxvdyI6WyJyZWFkIiwid3JpdGUiLCJzaWduIiwiYWRtaW4iXX0.KWWdh1jOVP_5YMAp8x5wNomFGgKS75ucOtj1ah5iP7k
|
||||
```
|
||||
|
||||
Now that you have allowed the storage miner to be connected to, and have created
|
||||
an auth token, its time to connect up the seal worker.
|
||||
|
||||
On the machine that you will be running the `lotus-seal-worker` on, you will
|
||||
need to set the `STORAGE_API_INFO` environment variable to
|
||||
`TOKEN:STORAGE_NODE_MULTIADDR`. Where `TOKEN` is the token we created above, and
|
||||
`STORAGE_NODE_MULTIADDR` is the multiaddr of the storage miners api that we set
|
||||
in the config file.
|
||||
|
||||
Once this is set, you should be able to just run `lotus-seal-worker run`.
|
||||
|
||||
To check that the seal worker is properly connected to your storage miner, run
|
||||
`lotus-storage-miner info` and check that the remote worker count has increased.
|
||||
|
||||
```sh
|
||||
why@computer ~/lotus> lotus-storage-miner info
|
||||
Miner: t05749
|
||||
Sector Size: 1 GiB
|
||||
Power: 0 B / 136 TiB (0.0000%)
|
||||
Committed: 1 GiB
|
||||
Proving: 1 GiB
|
||||
Worker use:
|
||||
Local: 0 / 1 (+1 reserved)
|
||||
**Remote: 0 / 1**
|
||||
Sectors: map[Proving:1 Total:1]
|
||||
```
|
||||
@ -1,5 +1,7 @@
|
||||
# Setup Troubleshooting
|
||||
|
||||
## Config: Clearing data
|
||||
|
||||
Here is a command that will delete your chain data, stored wallets, stored data
|
||||
and any miners you have set up:
|
||||
|
||||
@ -11,7 +13,7 @@ This command usually resolves any issues with running `lotus` but it is not
|
||||
always required for updates. We will share information about when resetting your
|
||||
chain data and miners is required for an update in the future.
|
||||
|
||||
## Lotus daemon problems
|
||||
## Error: Failed to connect bootstrap peer
|
||||
|
||||
```sh
|
||||
WARN peermgr peermgr/peermgr.go:131 failed to connect to bootstrap peer: failed to dial : all dials failed
|
||||
@ -34,7 +36,7 @@ ERROR hello hello/hello.go:81 other peer has different genesis!
|
||||
|
||||
- You already have another lotus deamon running.
|
||||
|
||||
## Failed messages
|
||||
## Warning: get message get failed
|
||||
|
||||
Some errors will occur that do not prevent Lotus from working:
|
||||
|
||||
|
||||
@ -1,20 +1,25 @@
|
||||
# Storage Troubleshooting
|
||||
|
||||
## Error: Routing: not found
|
||||
|
||||
```sh
|
||||
WARN main lotus/main.go:72 routing: not found
|
||||
```
|
||||
|
||||
- This miner is offline.
|
||||
|
||||
## Error: Failed to start deal
|
||||
|
||||
```sh
|
||||
WARN main lotus/main.go:72 failed to start deal: computing commP failed: generating CommP: Piece must be at least 127 bytes
|
||||
```
|
||||
|
||||
- There is a minimum file size of 127 bytes.
|
||||
|
||||
## Troubleshooting Sealing
|
||||
## Error: 0kb file response during retrieval
|
||||
|
||||
Miners can check sealing progress with this command:
|
||||
In order to retrieve a file, it must be sealed. Miners can check sealing
|
||||
progress with this command:
|
||||
|
||||
```sh
|
||||
lotus-storage-miner sectors list
|
||||
|
||||
Loading…
Reference in New Issue
Block a user