Skip to content

Commit b309131

Browse files
committed
Minor changes WIP
1 parent 928f275 commit b309131

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

docs/pos/howto/operating/validator-node/ansible.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
This guide provides a step-by-step approach to deploy a Polygon validator node through an Ansible playbook, ensuring an efficient and reliable setup.
22

3-
## System Requirements and Setup Options
3+
## Setup requirements and options
44

55
Before beginning, confirm your system aligns with the [system requirements for validator nodes](/pos/howto/operating/validator-node/#system-requirements-for-nodes). If you prefer running the validator node from binaries instead of Ansible, refer to [the manual installation instructions](/pos/validator/index.md).
66

@@ -17,7 +17,7 @@ Before beginning, confirm your system aligns with the [system requirements for v
1717
- SSH public key of your local machine must be present on the remote machines for Ansible connectivity.
1818
- Access to Bloxroute as a relay network is available. For adding a gateway as a Trusted Peer, contact **@validator-support-team** on [Polygon Discord](https://discord.com/invite/0xPolygon).
1919

20-
## Setting Up the Nodes
20+
## Setting up the nodes
2121

2222
### Preparing the Machines
2323

@@ -62,7 +62,7 @@ Then, edit the `inventory.yml` file to add IP addresses of the sentry and valida
6262
}
6363
```
6464

65-
### Sentry Node Setup
65+
### Sentry node setup
6666

6767
Execute a test run of the sentry node setup:
6868

@@ -82,7 +82,7 @@ Run the sentry node setup with sudo privileges:
8282

8383
To restart the setup due to any issues, use `ansible-playbook -l sentry playbooks/clean.yml`.
8484

85-
### Validator Node Setup
85+
### Validator node setup
8686

8787
After the sentry node setup:
8888

@@ -110,30 +110,30 @@ A success message will indicate completion.
110110

111111
Use `ansible-playbook -l validator playbooks/clean.yml` for a fresh start in case of any issues.
112112

113-
### Configuring Sentry Node
113+
### Configuring sentry node
114114

115115
Configure the Heimdall and Bor services on the sentry node:
116116

117117
1. Edit Heimdall's `config.toml` and Bor's `config.toml` as per the provided guidelines. Key parameters include `moniker`, `seeds`, `pex`, and `private_peer_ids`.
118118
2. Set firewall rules to open ports `26656`, `30303`, and optionally `22` with restricted access.
119119

120-
### Starting Sentry Node
120+
### Starting sentry node
121121

122122
1. Start the Heimdall service and check its logs for successful execution.
123123
2. Once Heimdall is synced, start the Bor service and monitor its logs for successful operation.
124124

125-
### Configuring Validator Node
125+
### Configuring validator node
126126

127127
1. Configure Heimdall and Bor similar to the sentry setup, ensuring correct Ethereum RPC endpoint settings.
128128
2. Generate and place Heimdall's `priv_validator_key.json` and Bor's keystore file in their respective directories.
129129
3. Add `password.txt` file in the Bor directory and include it in Bor's `config.toml`.
130130

131-
### Starting Validator Node
131+
### Starting validator node
132132

133133
1. Start the Heimdall service on the validator node and wait for it to sync.
134134
2. Start the Bor service and monitor its operation through logs.
135135

136-
## Health Check and Staking
136+
## Health check and staking
137137

138138
- After setting up the nodes, request a health check by the community on [Polygon's Discord](https://discord.com/invite/0xPolygon).
139139
- Maintain sufficient ETH balance in the signer address for transaction fees.

docs/pos/howto/operating/validator-node/index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Operating as a validator on the Polygon Network involves playing a pivotal role in validating transactions within the blockchain. This guide provides details on how to run a Validator Node (including Sentry and Validator components) on the Polygon Network, the responsibilities involved, and the technical and operational aspects to consider.
44

5-
## Eligibility and Responsibilities
5+
## Eligibility and responsibilities
66

77
To qualify as a validator on the Polygon Network, participants must:
88

@@ -25,7 +25,7 @@ Key responsibilities include:
2525
- Offer feedback and suggestions to the Polygon team.
2626
- **Rewards**: Earn staking rewards and transaction fees for validating blocks.
2727

28-
## Technical Node Operations
28+
## Technical node operations
2929

3030
These operations are automatically executed by the nodes:
3131

@@ -34,38 +34,38 @@ These operations are automatically executed by the nodes:
3434
- **Checkpoint Submission**: Proposers among validators create, validate, and submit checkpoints to the Ethereum mainnet.
3535
- **State Sync**: Contract state data is synchronized between Ethereum and Polygon, particularly through Bor.
3636

37-
## Operational Guidelines
37+
## Operational guidelines
3838

39-
### Maintaining High Uptime
39+
### Maintaining high uptime
4040

4141
- Validators must sign checkpoint transactions approximately every 34 minutes.
4242
- Failure to sign these transactions affects node performance.
4343
- Node health maintenance and monitoring are crucial for uninterrupted operations.
4444

45-
### Daily Checks and Monitoring
45+
### Daily checks and monitoring
4646

4747
- Regularly check and prune Heimdall and Bor services and processes.
4848
- Utilize Grafana Dashboards or alternative monitoring tools.
4949
- Monitor the Ethereum endpoint used on nodes to stay within request limits.
5050

51-
### ETH Balance Management
51+
### ETH balance management
5252

5353
- Adequate ETH balance is required for checkpoint transaction fees.
5454
- Fluctuations in Ethereum network gas prices must be considered.
5555

56-
## Earning Rewards
56+
## Earning rewards
5757

5858
Validators stake MATIC tokens for network security and receive rewards:
5959

6060
- **Staking Rewards**: Validators are compensated for their contributions to network security.
6161
- **Transaction Fees**: Validators earn a portion of the transaction fees from the blocks they produce.
6262

63-
### Reward Distribution
63+
### Reward distribution
6464

6565
- A portion of Polygon's total token supply is allocated for staking rewards.
6666
- Rewards are designed to gradually shift from staking to transaction fee-based as the network matures.
6767

68-
### Incentives for Validators
68+
### Incentives for validators
6969

7070
- Validators earn rewards from both staking and transaction fees.
7171
- The reward structure is designed to balance the payout between staking and fees over time.
@@ -77,21 +77,21 @@ Validators should:
7777
- Be open to delegations from the community.
7878
- Clearly communicate their commission rates.
7979

80-
## Effective Communication
80+
## Effective communication
8181

8282
- Report issues promptly on platforms like Discord, the Polygon Forum, or GitHub.
8383
- Provide constructive feedback and suggestions.
8484

85-
## System Requirements for Nodes
85+
## System requirements
8686

87-
### Minimum Requirements
87+
### Minimum requirements
8888

8989
- **RAM**: 32 GB
9090
- **CPU**: 8-core
9191
- **Storage**: 2.5 TB SSD
9292
- **AWS Equivalent**: c5.2xlarge for Sentry, c5.4xlarge for Validator node (with unlimited credits).
9393

94-
### Recommended Requirements
94+
### Recommended requirements
9595

9696
- **RAM**: 64 GB
9797
- **CPU**: 16-core

0 commit comments

Comments
 (0)