From ab32e3b1d5fad3b1dae4df5474ae57a3a79f4324 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alfonso=20Mu=C3=B1oz=20de=20Laborde?= Date: Wed, 16 Oct 2024 23:22:55 +0400 Subject: [PATCH 1/4] Add placeholder links to OP Mainnet runbooks --- pages/builders/chain-operators/self-hosted.mdx | 2 ++ pages/builders/node-operators/rollup-node.mdx | 2 ++ 2 files changed, 4 insertions(+) diff --git a/pages/builders/chain-operators/self-hosted.mdx b/pages/builders/chain-operators/self-hosted.mdx index 200eb7f4b..9342a2fb6 100644 --- a/pages/builders/chain-operators/self-hosted.mdx +++ b/pages/builders/chain-operators/self-hosted.mdx @@ -105,6 +105,8 @@ They'll help you get a head start deploying your first OP Stack chain. You can also [suggest a new tutorial](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=tutorial%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_tutorial.yaml\&title=%5BTUTORIAL%5D+Add+PR+title) if you have something specific in mind. We'd love to grow this list! +Lastly, for deeper insight into the day-to-day operations of OP Mainnet to see how these operational practices could apply to your chain, see the public [OP Mainnet Runbooks](https://www.notion.so/oplabs/Optimism-Runbooks-WIP-120f153ee1628045b230d5cd3df79f63?pvs=4). + ## Next Steps * After deploying your chain, check the [Rollup Operations](./management/operations) guide for common operations you'll need to run with your rollup. diff --git a/pages/builders/node-operators/rollup-node.mdx b/pages/builders/node-operators/rollup-node.mdx index dcffe980d..46acaef0a 100644 --- a/pages/builders/node-operators/rollup-node.mdx +++ b/pages/builders/node-operators/rollup-node.mdx @@ -121,6 +121,8 @@ It is important to regularly monitor your node, and you can optionally configure | [Running an OP Mainnet Node from Source](tutorials/mainnet) | Learn how to run an OP Mainnet node from source code. | 🟡 Medium | | [Running an OP Sepolia Node from Source](tutorials/testnet) | Learn how to run an OP Sepolia node from source code. | 🟡 Medium | +For deeper insight into the day-to-day operations of OP Mainnet to see how these practices could apply to your own node operations, see the public [OP Mainnet Runbooks](https://www.notion.so/oplabs/Optimism-Runbooks-WIP-120f153ee1628045b230d5cd3df79f63?pvs=4). + ## Next Steps * If you've already got your node up and running, check out the [Node Metrics and Monitoring Guide](/builders/node-operators/management/metrics) to learn how to keep tabs on your node and make sure it keeps running smoothly. From bb8415912380a932c52a1d7e36582e37c85ce006 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alfonso=20Mu=C3=B1oz=20de=20Laborde?= Date: Tue, 22 Oct 2024 16:43:15 +0400 Subject: [PATCH 2/4] Update runbook URLs to actual public ones --- pages/builders/chain-operators/self-hosted.mdx | 2 +- pages/builders/node-operators/rollup-node.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/builders/chain-operators/self-hosted.mdx b/pages/builders/chain-operators/self-hosted.mdx index 9342a2fb6..3a5edd689 100644 --- a/pages/builders/chain-operators/self-hosted.mdx +++ b/pages/builders/chain-operators/self-hosted.mdx @@ -105,7 +105,7 @@ They'll help you get a head start deploying your first OP Stack chain. You can also [suggest a new tutorial](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=tutorial%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_tutorial.yaml\&title=%5BTUTORIAL%5D+Add+PR+title) if you have something specific in mind. We'd love to grow this list! -Lastly, for deeper insight into the day-to-day operations of OP Mainnet to see how these operational practices could apply to your chain, see the public [OP Mainnet Runbooks](https://www.notion.so/oplabs/Optimism-Runbooks-WIP-120f153ee1628045b230d5cd3df79f63?pvs=4). +Lastly, for deeper insight into the day-to-day operations of OP Mainnet to see how these operational practices could apply to your chain, see the public [OP Mainnet Runbooks](https://oplabs.notion.site/OP-Mainnet-Runbooks-120f153ee1628045b230d5cd3df79f63). ## Next Steps diff --git a/pages/builders/node-operators/rollup-node.mdx b/pages/builders/node-operators/rollup-node.mdx index 46acaef0a..ac84bdc47 100644 --- a/pages/builders/node-operators/rollup-node.mdx +++ b/pages/builders/node-operators/rollup-node.mdx @@ -121,7 +121,7 @@ It is important to regularly monitor your node, and you can optionally configure | [Running an OP Mainnet Node from Source](tutorials/mainnet) | Learn how to run an OP Mainnet node from source code. | 🟡 Medium | | [Running an OP Sepolia Node from Source](tutorials/testnet) | Learn how to run an OP Sepolia node from source code. | 🟡 Medium | -For deeper insight into the day-to-day operations of OP Mainnet to see how these practices could apply to your own node operations, see the public [OP Mainnet Runbooks](https://www.notion.so/oplabs/Optimism-Runbooks-WIP-120f153ee1628045b230d5cd3df79f63?pvs=4). +For deeper insight into the day-to-day operations of OP Mainnet to see how these practices could apply to your own node operations, see the public [OP Mainnet Runbooks](https://oplabs.notion.site/OP-Mainnet-Runbooks-120f153ee1628045b230d5cd3df79f63). ## Next Steps From ec5ccaaa76ec7835be06c6b4889483b948bdea84 Mon Sep 17 00:00:00 2001 From: soyboy <85043086+sbvegan@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:24:08 -0600 Subject: [PATCH 3/4] centralizing the runbook link --- .../chain-operators/management/best-practices.mdx | 15 ++++++++------- pages/builders/chain-operators/self-hosted.mdx | 2 -- pages/builders/node-operators/rollup-node.mdx | 2 -- 3 files changed, 8 insertions(+), 11 deletions(-) diff --git a/pages/builders/chain-operators/management/best-practices.mdx b/pages/builders/chain-operators/management/best-practices.mdx index 33184b384..31cf1c631 100644 --- a/pages/builders/chain-operators/management/best-practices.mdx +++ b/pages/builders/chain-operators/management/best-practices.mdx @@ -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 @@ -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: @@ -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. @@ -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 diff --git a/pages/builders/chain-operators/self-hosted.mdx b/pages/builders/chain-operators/self-hosted.mdx index 3a5edd689..200eb7f4b 100644 --- a/pages/builders/chain-operators/self-hosted.mdx +++ b/pages/builders/chain-operators/self-hosted.mdx @@ -105,8 +105,6 @@ They'll help you get a head start deploying your first OP Stack chain. You can also [suggest a new tutorial](https://github.com/ethereum-optimism/docs/issues/new?assignees=\&labels=tutorial%2Cdocumentation%2Ccommunity-request\&projects=\&template=suggest_tutorial.yaml\&title=%5BTUTORIAL%5D+Add+PR+title) if you have something specific in mind. We'd love to grow this list! -Lastly, for deeper insight into the day-to-day operations of OP Mainnet to see how these operational practices could apply to your chain, see the public [OP Mainnet Runbooks](https://oplabs.notion.site/OP-Mainnet-Runbooks-120f153ee1628045b230d5cd3df79f63). - ## Next Steps * After deploying your chain, check the [Rollup Operations](./management/operations) guide for common operations you'll need to run with your rollup. diff --git a/pages/builders/node-operators/rollup-node.mdx b/pages/builders/node-operators/rollup-node.mdx index ac84bdc47..dcffe980d 100644 --- a/pages/builders/node-operators/rollup-node.mdx +++ b/pages/builders/node-operators/rollup-node.mdx @@ -121,8 +121,6 @@ It is important to regularly monitor your node, and you can optionally configure | [Running an OP Mainnet Node from Source](tutorials/mainnet) | Learn how to run an OP Mainnet node from source code. | 🟡 Medium | | [Running an OP Sepolia Node from Source](tutorials/testnet) | Learn how to run an OP Sepolia node from source code. | 🟡 Medium | -For deeper insight into the day-to-day operations of OP Mainnet to see how these practices could apply to your own node operations, see the public [OP Mainnet Runbooks](https://oplabs.notion.site/OP-Mainnet-Runbooks-120f153ee1628045b230d5cd3df79f63). - ## Next Steps * If you've already got your node up and running, check out the [Node Metrics and Monitoring Guide](/builders/node-operators/management/metrics) to learn how to keep tabs on your node and make sure it keeps running smoothly. From 276b018e4a2e6b85b8741c607517e415a1b422a6 Mon Sep 17 00:00:00 2001 From: soyboy <85043086+sbvegan@users.noreply.github.com> Date: Mon, 28 Oct 2024 16:27:35 -0600 Subject: [PATCH 4/4] fixing linter --- words.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/words.txt b/words.txt index 79b22b4bd..be73f2ed6 100644 --- a/words.txt +++ b/words.txt @@ -306,7 +306,6 @@ REMOTEDB remotedb replayability replayor -reproven REQUIREDBLOCKS requiredblocks rollouts @@ -320,6 +319,8 @@ rpcs RPGF Rpgf rpgf +Runbooks +runbooks RWAs safedb Schnorr