Skip to content

Commit

Permalink
Merge pull request #997 from ethereum-optimism/runbook_links
Browse files Browse the repository at this point in the history
Add links to OP Mainnet runbook
  • Loading branch information
sbvegan authored Oct 28, 2024
2 parents 682b360 + 276b018 commit ea5c9ce
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
15 changes: 8 additions & 7 deletions pages/builders/chain-operators/management/best-practices.mdx
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
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

0 comments on commit ea5c9ce

Please sign in to comment.