Skip to content

Commit 28c601c

Browse files
dawnkelly09eshaben
andauthored
updates admonitions for all pages in Infra section (#326)
* updates admonitions for all pages in Infra section * applies review feedback re: terminal element and images * Apply suggestions from code review Co-authored-by: Erin Shaben <[email protected]> --------- Co-authored-by: Erin Shaben <[email protected]>
1 parent 0076e63 commit 28c601c

File tree

14 files changed

+43
-43
lines changed

14 files changed

+43
-43
lines changed
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<div id="termynal" data-termynal>
2+
<span data-ty="input"><span class="file-path"></span>polkadot</span>
3+
<span data-ty>2021-06-17 03:07:07 Idle (0 peers), best: #0 (0x3fd7...5baf), finalized #0 (0x3fd7...5baf), ⬇ 2.9kiB/s ⬆ 3.7kiB/s</span>
4+
<span data-ty>2021-06-17 03:07:12 Idle (0 peers), best: #0 (0x3fd7...5baf), finalized #0 (0x3fd7...5baf), ⬇ 1.7kiB/s ⬆ 2.0kiB/s</span>
5+
<span data-ty>2021-06-17 03:07:17 Idle (0 peers), best: #0 (0x3fd7...5baf), finalized #0 (0x3fd7...5baf), ⬇ 0.9kiB/s ⬆ 1.2kiB/s</span>
6+
<span data-ty>2021-06-17 03:07:19 Libp2p => Random Kademlia query has yielded empty results</span>
7+
<span data-ty>2021-06-17 03:08:00 Idle (0 peers), best: #0 (0x3fd7...5baf), finalized #0 (0x3fd7...5baf), ⬇ 1.6kiB/s ⬆ 1.9kiB/s</span>
8+
<span data-ty>2021-06-17 03:08:05 Idle (0 peers), best: #0 (0x3fd7...5baf), finalized #0 (0x3fd7...5baf), ⬇ 0.6kiB/s ⬆ 0.9kiB/s</span>
9+
<span data-ty>...</span>
10+
</div>
11+
12+
-8.26 KB
Loading
7.3 KB
Loading
-32.1 KB
Loading
20.5 KB
Loading
65.4 KB
Loading

infrastructure/running-a-node/setup-bootnode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ Bootnodes must be accessible through three key channels to connect with other no
3030
--listen-addr /ip4/0.0.0.0/tcp/INSERT_PORT
3131

3232
```
33-
!!! note
34-
This is not enabled by default on non-validator nodes like archive RPC nodes.
33+
34+
This is not enabled by default on non-validator nodes like archive RPC nodes.
3535

3636
- **P2P/WS** - a WebSocket (WS) connection, also configured via `--listen-addr`
3737
- **P2P/WSS** - a secure WebSocket (WSS) connection using SSL, often required for light clients. An SSL proxy is needed, as the node itself cannot handle certificates

infrastructure/running-a-node/setup-full-node.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ This section will walk you through installing and building the Polkadot binary f
9191
- O /var/lib/polkadot-data/polkadot
9292
```
9393

94-
!!!info
94+
!!!tip
9595
The nature of pre-built binaries means that they may not work on your particular architecture or Linux distribution. If you see an error like `cannot execute binary file: Exec format error` it likely means the binary is incompatible with your system. You will either need to compile the binary or use [Docker](#use-docker).
9696

9797
Ensure that you properly configure the permissions to make the Polkadot release binary executable:
@@ -204,8 +204,7 @@ Now that you've installed and built the Polkadot binary, the next step is to con
204204

205205
Also, note that you can use the same binary for Polkadot as you would for Kusama or any other relay chain. You'll need to use the `--chain` flag to differentiate between chains.
206206

207-
!!!note
208-
Not sure which type of node to run? Explore an [overview of the different node types](/infrastructure/running-a-node/#types-of-nodes){target=\_blank}.
207+
If you aren't sure which type of node to run, see the [Types of Full Nodes](/infrastructure/running-a-node/#types-of-nodes){target=\_blank} section.
209208

210209
The base commands for running a Polkadot node are as follows:
211210

infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -124,13 +124,14 @@ You can also download the binaries by using the following direct links:
124124
gpg --verify polkadot-execute-worker.asc
125125
```
126126

127-
!!!warning
128-
Signature verification cryptographically ensures the downloaded binaries are authentic and have not been tampered with by using GPG signing keys. Polkadot releases use two different signing keys:
129127

130-
- ParityReleases ([email protected]) with key [`90BD75EBBB8E95CB3DA6078F94A4029AB4B35DAE`](https://keyserver.ubuntu.com/pks/lookup?search=9D4B2B6EB8F97156D19669A9FF0812D491B96798&fingerprint=on&op=index){target=\_blank} for current and new releases
131-
- Parity Security Team ([email protected]) with key [`9D4B2B6EB8F97156D19669A9FF0812D491B96798`](https://keyserver.ubuntu.com/pks/lookup?search=90BD75EBBB8E95CB3DA6078F94A4029AB4B35DAE&fingerprint=on&op=index){target=\_blank} for old releases
128+
Signature verification cryptographically ensures the downloaded binaries are authentic and have not been tampered with by using GPG signing keys. Polkadot releases use two different signing keys:
129+
130+
- ParityReleases ([email protected]) with key [`90BD75EBBB8E95CB3DA6078F94A4029AB4B35DAE`](https://keyserver.ubuntu.com/pks/lookup?search=9D4B2B6EB8F97156D19669A9FF0812D491B96798&fingerprint=on&op=index){target=\_blank} for current and new releases
131+
- Parity Security Team ([email protected]) with key [`9D4B2B6EB8F97156D19669A9FF0812D491B96798`](https://keyserver.ubuntu.com/pks/lookup?search=90BD75EBBB8E95CB3DA6078F94A4029AB4B35DAE&fingerprint=on&op=index){target=\_blank} for old releases
132132

133-
When verifying a signature, a "Good signature" message indicates successful verification, while any other output signals a potential security risk.
133+
!!!warning
134+
When verifying a signature, a "Good signature" message indicates successful verification, while any other output signals a potential security risk.
134135

135136
### Install with Package Managers
136137

@@ -254,13 +255,11 @@ After successfully installing and verifying the Polkadot binaries, the next step
254255

255256
Warp sync ensures that your node quickly updates to the latest finalized state. The historical blocks are downloaded in the background as the node continues to operate.
256257

257-
??? info "Adjustments for TestNets"
258+
If you're planning to run a validator on a TestNet, you can specify the chain using the `--chain` flag. For example, the following will run a validator on Kusama:
258259
259-
If you're planning to run a validator on a TetNet, you can specify the chain using the `--chain` flag. For example, the following will run a validator on Kusama:
260-
261-
```sh
262-
polkadot --chain=kusama
263-
```
260+
```sh
261+
polkadot --chain=kusama
262+
```
264263
265264
2. **Monitor sync progress** - once the sync starts, you will see a stream of logs providing information about the node's status and progress. Here's an example of what the output might look like:
266265
@@ -279,10 +278,9 @@ If you'd like to speed up the process further, you can use a database snapshot.
279278
!!!warning
280279
Although snapshots are convenient, syncing from scratch is recommended for security purposes. If snapshots become corrupted and most nodes rely on them, the network could inadvertently run on a non-canonical chain.
281280
282-
??? info "Why am I unable to synchronize the chain with 0 peers?"
283-
Make sure you have libp2p port `30333` activated. It will take some time to discover other peers over the network.
281+
--8<-- 'code/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-a-validator/terminal-output-03.html'
284282
285-
![Terminal logs showing 0 peers](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-01.webp)
283+
If you see terminal output similar to the preceding, and you are unable to synchronize the chain due to having zero peers, make sure you have libp2p port `30333` activated. It will take some time to discover other peers over the network.
286284
287285
## Bond DOT
288286
@@ -341,7 +339,7 @@ Now that you have generated your session keys, you must submit them to the chain
341339
2. Select **Set Session Key** on the bonding account you generated earlier
342340
3. Paste the hex-encoded session key string you generated (from either the UI or CLI) into the input field and submit the transaction
343341

344-
![](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-02.webp)
342+
![](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-01.webp)
345343

346344
Once the transaction is signed and submitted, your session keys will be registered on-chain.
347345

@@ -404,27 +402,27 @@ To confirm that your validator is live and synchronized with the Polkadot networ
404402

405403
In the following example, a node named `techedtest` is successfully located and synchronized, ensuring it's prepared to participate in the network:
406404
407-
![Polkadot telemetry dashboard](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-03.webp)
405+
![Polkadot telemetry dashboard](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-02.webp)
408406
409407
### Activate using Polkadot.js Apps
410408
411409
Follow these steps to use Polkadot.js Apps to activate your validator:
412410
413411
1. Go to the **Validator** tab in the Polkadot.js Apps UI and locate the section where you input the keys generated from `rotateKeys`. Paste the output from `author_rotateKeys`, which is a hex-encoded key that links your validator with its session keys:
414412
415-
![](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-04.webp)
413+
![](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-03.webp)
416414
417415
2. Set a reward commission percentage if desired. You can set a percentage of the rewards to pay to your validator and the remainder pays to your nominators. A 100% commission rate indicates the validator intends to keep all rewards and is seen as a signal the validator is not seeking nominators
418416
3. Toggle the **allows new nominations** option if your validator is open to more nominations from DOT holders
419417
4. Once everything is configured, select **Bond & Validate** to activate your validator status
420418
421-
![](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-05.webp)
419+
![](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-04.webp)
422420
423421
### Monitor Validation Status and Slots
424422
425423
On the [**Staking**](https://polkadot.js.org/apps/#/staking){target=\_blank} tab in Polkadot.js Apps, you can see your validator's status, the number of available validator slots, and the nodes that have signaled their intent to validate. Your node may initially appear in the waiting queue, especially if the validator slots are full. The following is an example view of the **Staking** tab:
426424

427-
![staking queue](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-06.webp)
425+
![staking queue](/images/infrastructure/running-a-validator/onboarding-and-offboarding/set-up-validator/set-up-a-validator-05.webp)
428426

429427
The validator set refreshes each era. If there's an available slot in the next era, your node may be selected to move from the waiting queue to the active validator set, allowing it to start validating blocks. If your validator is not selected, it remains in the waiting queue. Increasing your stake or gaining more nominators may improve your chance of being selected in future eras.
430428
@@ -454,7 +452,7 @@ In this unit file, you will write the commands that you want to run on server bo
454452
--8<-- 'https://raw.githubusercontent.com/paritytech/polkadot-sdk/refs/heads/master/polkadot/scripts/packaging/polkadot.service'
455453
```
456454
457-
!!! warning "Restart Delay Recommendation"
455+
!!! warning "Restart delay and equivocation risk"
458456
It is recommended that a node's restart be delayed with `RestartSec` in the case of a crash. It's possible that when a node crashes, consensus votes in GRANDPA aren't persisted to disk. In this case, there is potential to equivocate when immediately restarting. Delaying the restart will allow the network to progress past potentially conflicting votes.
459457

460458
### Run the Service

0 commit comments

Comments
 (0)