Skip to content

Commit 86cc8e2

Browse files
brunopgalvaodawnkelly09eshabennhussein11
authored
Add node infrastructure guides and restructure section (#1246)
* Add system parachain RPC guide and enhance documentation - Add comprehensive guide for running system parachain RPC nodes - Covers People Chain, Bridge Hub, and Coretime Chain - Provides both Docker and systemd deployment options - Includes snapshot setup, monitoring, and security best practices - Add conclusion sections to RPC and collator guides - polkadot-hub-rpc.md: summarize benefits and next steps - system-parachain-rpc.md: highlight adaptability across system parachains - collator.md: emphasize operator role and responsibilities - Restructure documentation from nodes-and-validators to node-infrastructure * Update system parachain RPC guide to latest versions Update polkadot-omni-node from stable2506-4 to v1.20.2 and Rust from 1.86 to 1.91.1 in the system parachain RPC documentation. This ensures users are working with the latest stable releases. Changes: - Docker image: parity/polkadot-omni-node:v1.20.2 - Cargo package: [email protected] - Rust toolchain: 1.91.1 All versions have been tested and verified to work correctly. * Update software versions and dependencies - Update Rust toolchain to 1.91.1 (from 1.86) - Update polkadot-omni-node to v0.11.0 for collator (from v0.5.0) - Update Docker image to v1.20.2 for RPC nodes (from stable2506-4) - Update chain-spec-builder to v14.0.0 (from v10.0.0) - Update AI-generated page files to reflect latest changes - Clean up old nodes-and-validators AI page files * Update content * initial look at collator.md * tweak admo * wip - collator page * finish collator pre-tech review pass * clean up formatting for RPC node page * formatting edits * Update guides * Use polkadot-parachain binary instead of polkadot-omni-node * Update llms * Download polkadot-parachain binary from GitHub releases instead of Docker * Use MkDocs admonition syntax for notes and warnings * Fix GitHub release tag to polkadot-stable2509-2 * Restructure parachain-rpc.md to use tabbed content layout * Add Docker commands to collator.md monitoring and maintenance sections * Update content * wip rpc page cleanup * Update content * Update node configs: optimize pruning, disable external ports - Remove 9944/9615 from external firewall ports (localhost only) - Add pruning flags for para and relay chains (--blocks-pruning=256, --state-pruning=256) - Use --database=paritydb and --sync=fast for collators - Disable relay chain RPC with --rpc-port=0 - Add --pool-limit=0 for relay chain on collators - Replace archive-canonical with pruned relay chain config - Add chown root:root for binary ownership * Update AI index pages for node infrastructure docs * Update snapshot URLs and storage requirements for node docs - Switch from rocksdb to paritydb snapshots where available - Update relay chain pruned snapshot size from ~200 GB to ~822 GB - Fix non-existent pruned snapshot URLs (Asset Hub, People Chain) - Clarify storage requirements: archive nodes (~1.2 TB) vs pruned nodes (200+ GB) - Update system parachain snapshot sizes with accurate values * Simplify snapshot sections to single archive instructions Remove duplicate tabs for archive/pruned snapshots since the same archive snapshots are used for both node types. * Add Docker setup option for collator deployment Restructure Run the Collator section to provide both Docker and systemd setup options in tabs, consistent with other node documentation. * LLMS files * cleanup docs * add bruno's changes to my changes * add bruno's changes to my changes * fix link * update parachain rpc page * update polkadot hub rpc page * fix full node terminal elements * update collator page * resolve TODOs * fix capitalization * fix: images * update content --------- Co-authored-by: DAWN KELLY <[email protected]> Co-authored-by: Erin Shaben <[email protected]> Co-authored-by: nhussein11 <[email protected]>
1 parent 4bcb1a6 commit 86cc8e2

File tree

85 files changed

+3633
-244
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+3633
-244
lines changed

.ai/pages/node-infrastructure-run-a-collator.md

Lines changed: 666 additions & 0 deletions
Large diffs are not rendered by default.

.ai/pages/node-infrastructure-run-a-node-parachain-rpc.md

Lines changed: 488 additions & 0 deletions
Large diffs are not rendered by default.

.ai/pages/node-infrastructure-run-a-node-polkadot-hub-rpc.md

Lines changed: 458 additions & 0 deletions
Large diffs are not rendered by default.

.ai/pages/nodes-and-validators-run-a-node-bootnode.md renamed to .ai/pages/node-infrastructure-run-a-node-relay-chain-bootnode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Set Up a Bootnode
33
description: Learn how to configure and run a bootnode for Polkadot, including P2P, WS, and secure WSS connections with network key management and proxies.
44
categories: Infrastructure
5-
url: https://docs.polkadot.com/nodes-and-validators/run-a-node/bootnode/
5+
url: https://docs.polkadot.com/node-infrastructure/run-a-node/relay-chain/bootnode/
66
---
77

88
# Set Up a Bootnode

.ai/pages/nodes-and-validators-run-a-node-full-node.md renamed to .ai/pages/node-infrastructure-run-a-node-relay-chain-full-node.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Set Up a Node
33
description: Learn how to install, configure, and run Polkadot nodes, including setting up different node types and connecting to the network.
44
categories: Infrastructure
5-
url: https://docs.polkadot.com/nodes-and-validators/run-a-node/full-node/
5+
url: https://docs.polkadot.com/node-infrastructure/run-a-node/relay-chain/full-node/
66
---
77

88
# Set Up a Node
@@ -27,7 +27,7 @@ Before getting started, ensure the following prerequisites are met:
2727
- [Install the necessary dependencies for the Polkadot SDK](/parachains/install-polkadot-sdk/){target=\_blank}.
2828

2929
!!! warning
30-
This setup is not recommended for validators. If you plan to run a validator, refer to the [Running a Validator](/nodes-and-validators/run-a-validator/onboarding-and-offboarding/set-up-validator/){target=\_blank} guide for proper instructions.
30+
This setup is not recommended for validators. If you plan to run a validator, refer to the [Running a Validator](/node-infrastructure/run-a-validator/onboarding-and-offboarding/set-up-validator/){target=\_blank} guide for proper instructions.
3131

3232
### Install and Build the Polkadot Binary
3333

@@ -58,10 +58,9 @@ This section will walk you through installing and building the Polkadot binary f
5858
You should see output similar to the following:
5959

6060
<div id="termynal" data-termynal>
61-
<span data-ty="input"
62-
><span class="file-path"></span>rustup show <br />
63-
rustup +nightly show</span
64-
>
61+
<span data-ty="input"><span class="file-path"></span>rustup show</span>
62+
<span data-ty>rustup +nightly show</span>
63+
<span data-ty></span>
6564
<span data-ty>active toolchain</span>
6665
<span data-ty>----------------</span>
6766
<span data-ty></span>
@@ -143,10 +142,8 @@ This section will walk you through installing and building the Polkadot binary f
143142
You should see output similar to the following:
144143

145144
<div id="termynal" data-termynal>
146-
<span data-ty="input"
147-
><span class="file-path"></span>rustup show <br />
148-
rustup +nightly show</span
149-
>
145+
<span data-ty="input"><span class="file-path"></span>rustup show</span>
146+
<span data-ty></span>
150147
<span data-ty>active toolchain</span>
151148
<span data-ty>----------------</span>
152149
<span data-ty></span>

.ai/pages/nodes-and-validators-run-a-node-secure-wss.md renamed to .ai/pages/node-infrastructure-run-a-node-relay-chain-secure-wss.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Set Up Secure WebSocket
33
description: Instructions on enabling SSL for your node and setting up a secure WebSocket proxy server using nginx for remote connections.
44
categories: Infrastructure
5-
url: https://docs.polkadot.com/nodes-and-validators/run-a-node/secure-wss/
5+
url: https://docs.polkadot.com/node-infrastructure/run-a-node/relay-chain/secure-wss/
66
---
77

88
# Set Up Secure WebSocket
@@ -122,4 +122,4 @@ Apache2 can run in various modes, including `prefork`, `worker`, and `event`. In
122122
wss://example.com:443
123123
```
124124
125-
![A sync-in-progress chain connected to Polkadot.js UI](/images/nodes-and-validators/run-a-node/secure-wss/secure-wss-01.webp)
125+
![A sync-in-progress chain connected to Polkadot.js UI](/images/node-infrastructure/run-a-node/secure-wss/secure-wss-01.webp)

.ai/pages/nodes-and-validators-run-a-validator-onboarding-and-offboarding-key-management.md renamed to .ai/pages/node-infrastructure-run-a-validator-onboarding-and-offboarding-key-management.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: Validator Key Management
33
description: Learn how to generate and manage validator keys, including session keys for consensus participation and node keys for maintaining a stable network identity.
44
categories: Infrastructure
5-
url: https://docs.polkadot.com/nodes-and-validators/run-a-validator/onboarding-and-offboarding/key-management/
5+
url: https://docs.polkadot.com/node-infrastructure/run-a-validator/onboarding-and-offboarding/key-management/
66
---
77

88
# Key Management
99

1010
## Introduction
1111

12-
After setting up your node environment as shown in the [Setup](/nodes-and-validators/run-a-validator/onboarding-and-offboarding/set-up-validator/){target=\_blank} section, you'll need to configure multiple keys for your validator to operate properly. This includes setting up session keys, which are essential for participating in the consensus process, and configuring a node key that maintains a stable network identity. This guide walks you through the key management process, showing you how to generate, store, and register these keys.
12+
After setting up your node environment as shown in the [Setup](/node-infrastructure/run-a-validator/onboarding-and-offboarding/set-up-validator/){target=\_blank} section, you'll need to configure multiple keys for your validator to operate properly. This includes setting up session keys, which are essential for participating in the consensus process, and configuring a node key that maintains a stable network identity. This guide walks you through the key management process, showing you how to generate, store, and register these keys.
1313

1414
## Set Session Keys
1515

@@ -30,7 +30,7 @@ There are multiple ways to create the session keys. It can be done by interactin
3030
3. Click the **Submit RPC Call** button.
3131
4. Copy the hex-encoded public key from the response.
3232

33-
![](/images/nodes-and-validators/run-a-validator/onboarding-and-offboarding/key-management/key-management-01.webp)
33+
![](/images/node-infrastructure/run-a-validator/onboarding-and-offboarding/key-management/key-management-01.webp)
3434

3535
=== "Curl"
3636

@@ -89,7 +89,7 @@ Now that you have generated your session keys, you must submit them to the chain
8989
2. Select **Set Session Key** on the bonding account you generated earlier.
9090
3. Paste the hex-encoded session key string you generated (from either the UI or CLI) into the input field and submit the transaction.
9191

92-
![](/images/nodes-and-validators/run-a-validator/onboarding-and-offboarding/key-management/key-management-02.webp)
92+
![](/images/node-infrastructure/run-a-validator/onboarding-and-offboarding/key-management/key-management-02.webp)
9393

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

.ai/pages/nodes-and-validators-run-a-validator-onboarding-and-offboarding-set-up-validator.md renamed to .ai/pages/node-infrastructure-run-a-validator-onboarding-and-offboarding-set-up-validator.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Set Up a Validator
33
description: Set up a Polkadot validator node to secure the network and earn staking rewards. Follow this step-by-step guide to install, configure, and manage your node.
44
categories: Infrastructure
5-
url: https://docs.polkadot.com/nodes-and-validators/run-a-validator/onboarding-and-offboarding/set-up-validator/
5+
url: https://docs.polkadot.com/node-infrastructure/run-a-validator/onboarding-and-offboarding/set-up-validator/
66
---
77

88
# Set Up a Validator
@@ -17,10 +17,10 @@ Running a validator requires a commitment to maintaining a stable, secure infras
1717

1818
To get the most from this guide, ensure you've done the following before going forward:
1919

20-
- Read [Validator Requirements](/nodes-and-validators/run-a-validator/requirements/){target=\_blank} and understand the recommended minimum skill level and hardware needs.
21-
- Read [General Management](/nodes-and-validators/run-a-validator/operational-tasks/general-management/){target=\_blank}, [Upgrade Your Node](/nodes-and-validators/run-a-validator/operational-tasks/upgrade-your-node/){target=\_blank}, and [Pause Validating](/nodes-and-validators/run-a-validator/operational-tasks/pause-validating/){target=\_blank} and understand the tasks required to keep your validator operational.
22-
- Read [Rewards Payout](/nodes-and-validators/run-a-validator/staking-mechanics/rewards/){target=\_blank} and understand how validator rewards are determined and paid out.
23-
- Read [Offenses and Slashes](/nodes-and-validators/run-a-validator/staking-mechanics/offenses-and-slashes/){target=\_blank} and understand how validator performance and security can affect tokens staked by you or your nominators.
20+
- Read [Validator Requirements](/node-infrastructure/run-a-validator/requirements/){target=\_blank} and understand the recommended minimum skill level and hardware needs.
21+
- Read [General Management](/node-infrastructure/run-a-validator/operational-tasks/general-management/){target=\_blank}, [Upgrade Your Node](/node-infrastructure/run-a-validator/operational-tasks/upgrade-your-node/){target=\_blank}, and [Pause Validating](/node-infrastructure/run-a-validator/operational-tasks/pause-validating/){target=\_blank} and understand the tasks required to keep your validator operational.
22+
- Read [Rewards Payout](/node-infrastructure/run-a-validator/staking-mechanics/rewards/){target=\_blank} and understand how validator rewards are determined and paid out.
23+
- Read [Offenses and Slashes](/node-infrastructure/run-a-validator/staking-mechanics/offenses-and-slashes/){target=\_blank} and understand how validator performance and security can affect tokens staked by you or your nominators.
2424

2525
## Initial Setup
2626

.ai/pages/nodes-and-validators-run-a-validator-onboarding-and-offboarding-start-validating.md renamed to .ai/pages/node-infrastructure-run-a-validator-onboarding-and-offboarding-start-validating.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
title: Start Validating
33
description: Learn how to start validating on Polkadot by choosing a network, syncing your node, bonding DOT tokens, and activating your validator.
44
categories: Infrastructure
5-
url: https://docs.polkadot.com/nodes-and-validators/run-a-validator/onboarding-and-offboarding/start-validating/
5+
url: https://docs.polkadot.com/node-infrastructure/run-a-validator/onboarding-and-offboarding/start-validating/
66
---
77

88
# Start Validating
99

1010
## Introduction
1111

12-
After configuring your node keys as shown in the [Key Management](/nodes-and-validators/run-a-validator/onboarding-and-offboarding/key-management/){target=\_blank} section and ensuring your system is set up, you're ready to begin the validator setup process. This guide will walk you through choosing a network, synchronizing your node with the blockchain, bonding your DOT tokens, and starting your validator.
12+
After configuring your node keys as shown in the [Key Management](/node-infrastructure/run-a-validator/onboarding-and-offboarding/key-management/){target=\_blank} section and ensuring your system is set up, you're ready to begin the validator setup process. This guide will walk you through choosing a network, synchronizing your node with the blockchain, bonding your DOT tokens, and starting your validator.
1313

1414
## Choose a Network
1515

@@ -99,7 +99,7 @@ If you see terminal output similar to the preceding, and you are unable to synch
9999

100100
## Bond DOT
101101

102-
Once your validator node is synced, the next step is bonding DOT. A bonded account, or stash, holds your staked tokens (DOT) that back your validator node. Bonding your DOT means locking it for a period, during which it cannot be transferred or spent but is used to secure your validator's role in the network. Visit the [Minimum Bond Requirement](/nodes-and-validators/run-a-validator/requirements/#minimum-bond-requirement) section for details on how much DOT is required.
102+
Once your validator node is synced, the next step is bonding DOT. A bonded account, or stash, holds your staked tokens (DOT) that back your validator node. Bonding your DOT means locking it for a period, during which it cannot be transferred or spent but is used to secure your validator's role in the network. Visit the [Minimum Bond Requirement](/node-infrastructure/run-a-validator/requirements/#minimum-bond-requirement) section for details on how much DOT is required.
103103

104104
The following sections will guide you through bonding DOT for your validator.
105105

@@ -131,29 +131,29 @@ Follow these steps to use Polkadot.js Apps to activate your validator:
131131

132132
1. In Polkadot.js Apps, navigate to **Network** and select **Staking**:
133133

134-
![](/images/nodes-and-validators/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-01.webp)
134+
![](/images/node-infrastructure/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-01.webp)
135135

136136
2. Open the **Accounts** tab and click on **+ Validator**:
137137

138-
![](/images/nodes-and-validators/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-02.webp)
138+
![](/images/node-infrastructure/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-02.webp)
139139

140140
3. Set a bond amount in the **value bonded** field and then click **next**:
141141

142-
![](/images/nodes-and-validators/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-03.webp)
142+
![](/images/node-infrastructure/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-03.webp)
143143

144144
4. Paste the hex output from `author_rotateKeys`, set the commission, allow or block new nominations, then click **Bond & Validate** to link your validator with its session keys.
145145

146-
![](/images/nodes-and-validators/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-04.webp)
146+
![](/images/node-infrastructure/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-04.webp)
147147

148148
You can also set the **commission** and **blocked** nominations option via `staking.validate` extrinsic. By default, the blocked option is set to FALSE (i.e., the validator accepts nominations).
149149

150-
![](/images/nodes-and-validators/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-05.webp)
150+
![](/images/node-infrastructure/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-05.webp)
151151

152152
### Monitor Validation Status and Slots
153153

154154
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:
155155

156-
![staking queue](/images/nodes-and-validators/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-06.webp)
156+
![staking queue](/images/node-infrastructure/run-a-validator/onboarding-and-offboarding/start-validating/start-validating-06.webp)
157157

158158
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.
159159
@@ -165,7 +165,7 @@ This following sections will walk you through creating and managing a systemd se
165165
166166
Ensure the following requirements are met before proceeding with the systemd setup:
167167
168-
- Confirm your system meets the [requirements](/nodes-and-validators/run-a-validator/requirements/){target=\_blank} for running a validator.
168+
- Confirm your system meets the [requirements](/node-infrastructure/run-a-validator/requirements/){target=\_blank} for running a validator.
169169
- Ensure you meet the [minimum bond requirements](https://wiki.polkadot.com/general/chain-state-values/#minimum-validator-bond){target=\_blank} for validating.
170170
- Verify the Polkadot binary is [installed](#install-the-polkadot-binaries).
171171

.ai/pages/nodes-and-validators-run-a-validator-onboarding-and-offboarding-stop-validating.md renamed to .ai/pages/node-infrastructure-run-a-validator-onboarding-and-offboarding-stop-validating.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Stop Validating
33
description: Learn to safely stop validating on Polkadot, including chilling, unbonding tokens, and purging validator keys.
44
categories: Infrastructure
5-
url: https://docs.polkadot.com/nodes-and-validators/run-a-validator/onboarding-and-offboarding/stop-validating/
5+
url: https://docs.polkadot.com/node-infrastructure/run-a-validator/onboarding-and-offboarding/stop-validating/
66
---
77

88
# Stop Validating
@@ -25,7 +25,7 @@ The following are steps to ensure a smooth stop to validation:
2525

2626
When stepping back from validating, the first step is to chill your validator status. This action stops your validator from being considered for the next era without fully unbonding your tokens, which can be useful for temporary pauses like maintenance or planned downtime.
2727

28-
Use the `staking.chill` extrinsic to initiate this. For more guidance on chilling your node, refer to the [Pause Validating](/nodes-and-validators/run-a-validator/operational-tasks/pause-validating/){target=\_blank} guide. You may also claim any pending staking rewards at this point.
28+
Use the `staking.chill` extrinsic to initiate this. For more guidance on chilling your node, refer to the [Pause Validating](/node-infrastructure/run-a-validator/operational-tasks/pause-validating/){target=\_blank} guide. You may also claim any pending staking rewards at this point.
2929

3030
## Purge Validator Session Keys
3131

0 commit comments

Comments
 (0)