Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos in op-conductor/README.md documentation #13128

Merged
merged 3 commits into from
Dec 2, 2024
Merged

Fix typos in op-conductor/README.md documentation #13128

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42acc19
Update README.md
sky-coderay Nov 27, 2024
57492b1
Update README.md
sky-coderay Nov 27, 2024
a672b50
Update README.md
sky-coderay Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions op-conductor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# op-conductor

op-conductor is an auxiliary service designed to enhance the reliability and availability of a sequencer in
Expand All @@ -20,7 +21,7 @@ For configuration and runbook, please refer to [RUNBOOK.md](./RUNBOOK.md)
### Architecture

Typically you can setup a 3 nodes sequencer cluster, each one with op-conductor running alongside the sequencer in different regions / AZs.
Below diagram showcaes how conductor interacts with relevant op-stack components.
Below diagram showcases how conductor interacts with relevant op-stack components.

![op-conductor setup](./assets/setup.svg)

Expand Down Expand Up @@ -93,6 +94,6 @@ There are 2 situations we need to consider.

1. Leadership transfer triggered by raft consensus protocol (network partition, etc)
1. In this case, a new leader will be elected regardless of its sync status, it could be behind for a few blocks
2. The solution is to simple, wait until the elected leader catch up to tip (same as the FSM tip)
2. The solution is to simply wait until the elected leader catches up to tip (same as the FSM tip)
2. Leadership transfer triggered by us (Conductor detected unhealthy sequencer)
1. In this case, we have the choice to determine which node to transfer leadership to, we can simply query the latest block from candidates within the network and transfer directly to the one with the most up to date blocks.