Clean up TdS/validator docs (#9638)

This commit is contained in:
Michael Vines
2020-04-21 16:59:09 -07:00
committed by GitHub
parent 45ff1f2379
commit 5b8d963ee2
22 changed files with 172 additions and 450 deletions

View File

@@ -1,32 +1,5 @@
# Running a Validator
This document describes how to participate in the Solana testnet as a validator
node.
This section describes how run a Solana validator node.
Please note some of the information and instructions described here may change
in future releases, and documentation will be updated for mainnet participation.
## Overview
Solana currently maintains several testnets, each featuring a validator that can
serve as the entrypoint to the cluster for your validator.
Current testnet entrypoints:
* Developer testnet, devnet.solana.com
Solana may launch special testnets for validator participation; we will provide
you with a specific entrypoint URL to use.
Prior to mainnet, the testnets may be running different versions of solana
software, which may feature breaking changes. For information on choosing a
testnet and finding software version info, jump to [Choosing a Testnet](validator-testnet.md).
The testnets are configured to reset the ledger daily, or sooner, should the
hourly automated cluster sanity test fail.
There is a network explorer that shows the status of solana testnets available
at [http://explorer.solana.com/](https://explorer.solana.com/).
Also we'd love it if you choose to register your validator node with us at
[https://forms.gle/LfFscZqJELbuUP139](https://forms.gle/LfFscZqJELbuUP139).
There are several clusters available to connect to, see [choosing a Cluster](../cli/choose-a-cluster.md) for an overview of each.

View File

@@ -86,7 +86,7 @@ To monitor your validator during its warmup period:
* `solana validators` displays the current active stake of all validators, including yours
* `solana stake-history ` shows the history of stake warming up and cooling down over recent epochs
* Look for log messages on your validator indicating your next leader slot: `[2019-09-27T20:16:00.319721164Z INFO solana_core::replay_stage] <VALIDATOR_IDENTITY_PUBKEY> voted and reset PoH at tick height ####. My next leader slot is ####`
* Once your stake is warmed up, you will see a stake balance listed for your validator on the [Solana Network Explorer](http://explorer.solana.com/validators)
* Once your stake is warmed up, you will see a stake balance listed for your validator by running `solana validators`
## Monitor Your Staked Validator

View File

@@ -9,10 +9,10 @@ set the `--url` argument for cli commands. For example:
solana config set --url http://devnet.solana.com
```
\(You can always override the set configuration by explicitly passing the
`--url` argument with a command, eg: `solana --url http://tds.solana.com balance`\)
While this section demonstrates how to connect to the Devnet cluster, the steps
are similar for the other [Solana Clusters](../clusters.md).
## Confirm The Testnet Is Reachable
## Confirm The Cluster Is Reachable
Before attaching a validator node, sanity check that the cluster is accessible
to your machine by fetching the transaction count:
@@ -21,9 +21,6 @@ to your machine by fetching the transaction count:
solana transaction-count
```
Inspect the network explorer at
[https://explorer.solana.com/](https://explorer.solana.com/) for activity.
View the [metrics dashboard](https://metrics.solana.com:3000/d/monitor/cluster-telemetry) for more
detail on cluster activity.
@@ -111,7 +108,7 @@ network. **It is crucial to back-up this information.**
If you dont back up this information, you WILL NOT BE ABLE TO RECOVER YOUR
VALIDATOR if you lose access to it. If this happens, YOU WILL LOSE YOUR
ALLOCATION OF LAMPORTS TOO.
ALLOCATION OF SOL TOO.
To back-up your validator identify keypair, **back-up your
"validator-keypair.json” file or your seed phrase to a secure location.**
@@ -138,8 +135,10 @@ Wallet Config Updated: /home/solana/.config/solana/wallet/config.yml
Airdrop yourself some SOL to get started:
```bash
solana airdrop 1000
solana airdrop 10
```
Note that airdrops are only available on Devnet. Testnet SOL can be obtained by
participating in the [Tour de SOL](../tour-de-sol) program.
To view your current balance:
@@ -187,12 +186,16 @@ account state divergence.
## Connect Your Validator
Connect to a testnet cluster by running:
Connect to the cluster by running:
```bash
solana-validator --identity ~/validator-keypair.json --vote-account ~/vote-account-keypair.json \
--ledger ~/validator-ledger --rpc-port 8899 --entrypoint devnet.solana.com:8001 \
--limit-ledger-size
solana-validator \
--identity ~/validator-keypair.json \
--vote-account ~/vote-account-keypair.json \
--ledger ~/validator-ledger \
--rpc-port 8899 \
--entrypoint devnet.solana.com:8001 \
--limit-ledger-size
```
To force validator logging to the console add a `--log -` argument, otherwise
@@ -219,9 +222,9 @@ If your validator is connected, its public key and IP address will appear in the
By default the validator will dynamically select available network ports in the
8000-10000 range, and may be overridden with `--dynamic-port-range`. For
example, `solana-validator --dynamic-port-range 11000-11010 ...` will restrict
the validator to ports 11000-11011.
the validator to ports 11000-11010.
### Limiting ledger size to conserve disk space
The `--limit-ledger-size` arg will instruct the validator to only retain the
The `--limit-ledger-size` argument will instruct the validator to only retain the
last couple hours of ledger. To retain the full ledger, simply remove that arg.