Skip to content

Commit d8b0218

Browse files
Add suggestions for docs
Co-authored-by: Vishal <[email protected]>
1 parent 9409345 commit d8b0218

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

cmd/bootstrap/transit/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,17 @@ Running `transit push-transit-key` will perform the following actions:
8484
1. Upload the node's public files to the server
8585
- `transit-key.pub.<id>`
8686

87-
## Ansible Playbook
87+
## Root Block Signing Automation
8888

89-
The `root_block_voting.yml` Ansible playbook is used to automate the process of pulling the root block and random beacon key, generating the root block vote, and pushing the vote to the server. Please refer to this as an example of how to use the transit script in an automated environment.
89+
The root block voting is a critical and time-sensitive step of a network upgrade (spork). During this process, Consensus Node operators must download the root block, generate a vote for it using each of their Consensus Nodes, and upload those votes to the server (one vote per node).
90+
91+
To ensure this step is completed reliably and without delays, operators running multiple Consensus Nodes are strongly encouraged to automate the root block voting process. The provided `root_block_voting.yml` Ansible playbook serves as an example for building such automation. It automates:
92+
93+
- Pulling the root block and random beacon key
94+
- Generating the root block vote
95+
- Pushing the vote to the server
96+
97+
Refer to this playbook as a reference for how to use the transit script in an automated environment.
9098

9199
Example usage:
92100

0 commit comments

Comments
 (0)