Skip to content

Add links to OP Mainnet runbook #997

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

Merged
merged 5 commits into from
Oct 28, 2024
Merged

Add links to OP Mainnet runbook #997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ab32e3b
Add placeholder links to OP Mainnet runbooks
alfonso-op Oct 16, 2024
bb84159
Update runbook URLs to actual public ones
alfonso-op Oct 22, 2024
ec5ccaa
centralizing the runbook link
sbvegan Oct 28, 2024
0d81f69
Merge branch 'main' into runbook_links
sbvegan Oct 28, 2024
276b018
fixing linter
sbvegan Oct 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
15 changes: 8 additions & 7 deletions pages/builders/chain-operators/management/best-practices.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ import { Callout } from 'nextra/components'
The following information has some best practices around running the OP Stack's
off-chain components.

## Best practices

### Correct release versions
## Correct release versions

Chain and node operators should always run the latest production releases of
the OP Stack's off chain components. Our latest releases, notes, and changelogs
Expand All @@ -35,7 +33,7 @@ and `op-geth` releases can be found [here](https://github.com/ethereum-optimism/
version. Since we cannot left-pad with zeroes, the geth major version is not
padded.

### Keep deployment artifacts
## Keep deployment artifacts

After deploying your contracts on Ethereum, you should keep a record of all the
deployment artifacts:
Expand All @@ -49,20 +47,20 @@ created in [packages/contracts-bedrock/deployments](https://github.com/ethereum-
deployment
* The genesis file that you generated after the contract deployment

### Incremental upgrade rollouts
## Incremental upgrade rollouts

When upgrading your nodes, take a staggered approach. This means deploying the
upgrade gradually across your infrastructure and ensuring things work as
expected before making changes to every node.

### Isolate your sequencer
## Isolate your sequencer

You can isolate your sequencer node, by not connecting it directly to the
internet. Instead, you could handle your ingress traffic behind a proxy. Have
the proxy forward traffic to replicas and have them gossip the transactions
internally.

### Improve reliability of peer-to-peer transactions
## Improve reliability of peer-to-peer transactions

These flags can improve the reliability of peer-to-peer transactions from internal replica nodes and the sequencer node.

Expand All @@ -84,6 +82,9 @@ GETH_TXPOOL_NOLOCALS: "true"

For additional information about these flags, check out our [Execution Layer Configuration Options](/builders/node-operators/configuration/execution-config) doc.

## Write your own runbooks

Create custom runbooks to prepare for operating an OP Stack chain. For a deeper understanding of daily operations and best practices, explore the public [OP Mainnet Runbooks](https://oplabs.notion.site/OP-Mainnet-Runbooks-120f153ee1628045b230d5cd3df79f63) to see how these practices could be applied to your own chain.

## Assumptions

Expand Down
3 changes: 2 additions & 1 deletion words.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,6 @@ REMOTEDB
remotedb
replayability
replayor
reproven
REQUIREDBLOCKS
requiredblocks
rollouts
Expand All @@ -320,6 +319,8 @@ rpcs
RPGF
Rpgf
rpgf
Runbooks
runbooks
RWAs
safedb
Schnorr
Expand Down
Loading