docs icon indicating copy to clipboard operation
docs copied to clipboard

[DOCS] production op stack chain operator guide

Open sbvegan opened this issue 1 year ago • 0 comments

Brief Description of the Docs Request

A new guide to help production operators understand the considerations they need to make when preparing, deploying, and maintaining a production deployment.

Description of the Documentation You'd Like

This new guide should include the considerations, tips, tricks, and maybe a check list of the things necessary to operate a production chain. This new page should aim to be evergreen by being general and not being overly prescriptive. It should include information about:

  • [x] Understanding the OP Stack Architecture and how the different components work together. (This is covered in the OP Stack > Protocol Section and will be getting more detail soon)
  • [ ] #381
  • [x] Experience with testnet deployments (This is an existing tutorial)
  • [x] #382
    • General guidance on key management, i.e. HSM + eth_signTransaction (https://github.com/ethereum-optimism/optimism/blob/develop/op-service/signer/client.go)
  • [ ] #383
    • Setup infrastructure for watching and refilling wallets
    • Monitoring i.e. chain-mon, wd-mon, fault-detector, and balance-mon
  • [ ] #384
    • Replica health check for non-sequencing nodes to ensure there is no divergence
    • General node infrastructure
      • p2p seed nodes
      • bootnodes
      • handling ingress
  • [ ] #385
    • How to upgrade each component of the stack: sequencer, batcher, and proposer
  • Tips like watching the op-geth volume sizes and making sure the disk size isn't too full and having a reliable connection to the L1 and a failover setup

Not all of this information needs to be in this single page, but can link out to other pages with more information.

Links to Related Pages

  • https://docs.optimism.io/builders/chain-operators/overview

Additional Context

We want folks to be able to have the resources and guidance they need to self service op stack chains in production.

sbvegan avatar Jan 03 '24 22:01 sbvegan