bea1903ac9
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
Co-authored-by: Cursor <cursoragent@cursor.com>
107 lines
8.5 KiB
Markdown
107 lines
8.5 KiB
Markdown
# Runbooks Master Index
|
||
|
||
**Purpose:** Single index of all operational and deployment runbooks across the repository.
|
||
**Last updated:** 2026-02-20
|
||
|
||
---
|
||
|
||
## Deployment & Contracts
|
||
|
||
| Runbook | Location | Purpose |
|
||
|---------|----------|---------|
|
||
| **Operational Runbooks (master)** | [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md) | Master index: Besu, CCIP, Blockscout, maintenance, emergency |
|
||
| **Contract Deployment** | [03-deployment/CONTRACT_DEPLOYMENT_RUNBOOK.md](03-deployment/CONTRACT_DEPLOYMENT_RUNBOOK.md) | Deploy and verify contracts (Forge, Blockscout) |
|
||
| **Deploy Confirm & Full E2E** | [00-meta/DEPLOY_CONFIRM_AND_FULL_E2E_RUNBOOK.md](00-meta/DEPLOY_CONFIRM_AND_FULL_E2E_RUNBOOK.md) | On-chain check, verification, E2E routing, explorer E2E |
|
||
| **cUSDT/cUSDC Multi-Chain + Liquidity** | [smom-dbis-138/docs/deployment/CUSDT_CUSDC_MULTICHAIN_LIQUIDITY_RUNBOOK.md](../smom-dbis-138/docs/deployment/CUSDT_CUSDC_MULTICHAIN_LIQUIDITY_RUNBOOK.md) | Deploy cUSDT/cUSDC to other chains; Dodo PMM, Uniswap, Balancer, Curve |
|
||
| **All Mainnets Deployment** | [smom-dbis-138/docs/deployment/ALL_MAINNETS_DEPLOYMENT_RUNBOOK.md](../smom-dbis-138/docs/deployment/ALL_MAINNETS_DEPLOYMENT_RUNBOOK.md) | CCIP, Trustless, Oracle, PMM across chains (anchored to 138) |
|
||
| **Operator Next Steps** | [smom-dbis-138/docs/deployment/OPERATOR_NEXT_STEPS_RUNBOOK.md](../smom-dbis-138/docs/deployment/OPERATOR_NEXT_STEPS_RUNBOOK.md) | G1–G4: PMM L2s, Trustless L2s, LP funding, CCIPLogger |
|
||
| **Liquidity Pool Controls** | [03-deployment/LIQUIDITY_POOL_CONTROLS_RUNBOOK.md](03-deployment/LIQUIDITY_POOL_CONTROLS_RUNBOOK.md) | Trustless LP, DODO PMM, PoolManager, LiquidityManager |
|
||
| **Optional Future Deployments** | [03-deployment/OPTIONAL_FUTURE_DEPLOYMENTS_RUNBOOK.md](03-deployment/OPTIONAL_FUTURE_DEPLOYMENTS_RUNBOOK.md) | Trustless, DeployAll, vault, reserve, DODO, eMoney |
|
||
| **DApp LXC Deployment** | [03-deployment/DAPP_LXC_DEPLOYMENT.md](03-deployment/DAPP_LXC_DEPLOYMENT.md) | Deploy frontend-dapp to LXC (VMID 5800) |
|
||
| **Phoenix Deployment** | [03-deployment/PHOENIX_DEPLOYMENT_RUNBOOK.md](03-deployment/PHOENIX_DEPLOYMENT_RUNBOOK.md) | Phoenix system deployment |
|
||
| **Proxmox VM Creation** | [03-deployment/PROXMOX_VM_CREATION_RUNBOOK.md](03-deployment/PROXMOX_VM_CREATION_RUNBOOK.md) | Create VMs/containers on Proxmox |
|
||
| **Snapshot** | [03-deployment/SNAPSHOT_RUNBOOK.md](03-deployment/SNAPSHOT_RUNBOOK.md) | Container snapshots |
|
||
| **Multichain Deployment** | [smom-dbis-138/docs/deployment/MULTICHAIN_DEPLOYMENT_RUNBOOK.md](../smom-dbis-138/docs/deployment/MULTICHAIN_DEPLOYMENT_RUNBOOK.md) | Multi-chain deployment (smom-dbis-138) |
|
||
|
||
---
|
||
|
||
## CCIP & Bridge
|
||
|
||
| Runbook | Location | Purpose |
|
||
|---------|----------|---------|
|
||
| **CCIP Relay Deployment** | [07-ccip/CCIP_RELAY_DEPLOYMENT.md](07-ccip/CCIP_RELAY_DEPLOYMENT.md) | Relay service deploy, config, logs |
|
||
| **Relay Bridge Add LINK Support** | [07-ccip/RELAY_BRIDGE_ADD_LINK_SUPPORT_RUNBOOK.md](07-ccip/RELAY_BRIDGE_ADD_LINK_SUPPORT_RUNBOOK.md) | Add LINK support to relay bridge |
|
||
| **Config Ready Chains Completion** | [07-ccip/CONFIG_READY_CHAINS_COMPLETION_RUNBOOK.md](07-ccip/CONFIG_READY_CHAINS_COMPLETION_RUNBOOK.md) | Complete config for CCIP-ready chains |
|
||
| **Bridge Operations** | [runbooks/BRIDGE_OPERATIONS_RUNBOOK.md](runbooks/BRIDGE_OPERATIONS_RUNBOOK.md) | Bridge operations |
|
||
| **Tezos CCIP Runbooks Index** | [07-ccip/TEZOS_CCIP_RUNBOOKS_INDEX.md](07-ccip/TEZOS_CCIP_RUNBOOKS_INDEX.md) | Tezos/CCIP runbooks |
|
||
|
||
---
|
||
|
||
## Monitoring & Troubleshooting
|
||
|
||
| Runbook | Location | Purpose |
|
||
|---------|----------|---------|
|
||
| **Block Production Fix** | [08-monitoring/BLOCK_PRODUCTION_FIX_RUNBOOK.md](08-monitoring/BLOCK_PRODUCTION_FIX_RUNBOOK.md) | Restore block production (permissioning, tx-pool) |
|
||
| **RPC and Validator Testing** | [08-monitoring/RPC_AND_VALIDATOR_TESTING_RUNBOOK.md](08-monitoring/RPC_AND_VALIDATOR_TESTING_RUNBOOK.md) | RPC and validator testing |
|
||
| **Blockscout Fix** | [03-deployment/BLOCKSCOUT_FIX_RUNBOOK.md](03-deployment/BLOCKSCOUT_FIX_RUNBOOK.md) | Blockscout 502, DB, migration |
|
||
| **Stuck TX Root Cause** | [08-monitoring/STUCK_TX_ROOT_CAUSE_AND_GUARDRAILS.md](08-monitoring/STUCK_TX_ROOT_CAUSE_AND_GUARDRAILS.md) | Stuck transaction diagnosis |
|
||
|
||
---
|
||
|
||
## Configuration & Infrastructure
|
||
|
||
| Runbook | Location | Purpose |
|
||
|---------|----------|---------|
|
||
| **VMID 5000 Storage and Logs** | [04-configuration/VMID5000_STORAGE_AND_LOGS_RUNBOOK.md](04-configuration/VMID5000_STORAGE_AND_LOGS_RUNBOOK.md) | Blockscout storage and logs |
|
||
| **Logrotate Audit** | [04-configuration/LOGROTATE_AUDIT_RUNBOOK.md](04-configuration/LOGROTATE_AUDIT_RUNBOOK.md) | Logrotate configuration audit |
|
||
| **Ingress Verification** | [04-configuration/INGRESS_VERIFICATION_RUNBOOK.md](04-configuration/INGRESS_VERIFICATION_RUNBOOK.md) | Ingress and proxy verification |
|
||
| **CMC/CoinGecko Submission** | [04-configuration/coingecko/CMC_COINGECKO_SUBMISSION_RUNBOOK.md](04-configuration/coingecko/CMC_COINGECKO_SUBMISSION_RUNBOOK.md) | Submit tokens to CMC/CoinGecko |
|
||
| **E2E Cloudflare Domains** | [05-network/E2E_CLOUDFLARE_DOMAINS_RUNBOOK.md](05-network/E2E_CLOUDFLARE_DOMAINS_RUNBOOK.md) | Edge and domain verification |
|
||
| **Option B RPC via Tunnel** | [05-network/OPTION_B_RPC_VIA_TUNNEL_RUNBOOK.md](05-network/OPTION_B_RPC_VIA_TUNNEL_RUNBOOK.md) | RPC via Cloudflare Tunnel |
|
||
| **Edge Port Verification** | [05-network/EDGE_PORT_VERIFICATION_RUNBOOK.md](05-network/EDGE_PORT_VERIFICATION_RUNBOOK.md) | Edge port checks |
|
||
| **Cloudflare Tunnel 502 Fix** | [04-configuration/cloudflare/CLOUDFLARE_TUNNEL_502_FIX_RUNBOOK.md](04-configuration/cloudflare/CLOUDFLARE_TUNNEL_502_FIX_RUNBOOK.md) | Tunnel 502 troubleshooting |
|
||
| **DBIS Frontend Nginx** | [04-configuration/DBIS_FRONTEND_10130_NGINX_RUNBOOK.md](04-configuration/DBIS_FRONTEND_10130_NGINX_RUNBOOK.md) | DBIS frontend Nginx |
|
||
| **SSH DApp NPMplus** | [03-deployment/SSH_DAPP_NPMPLUS_RUNBOOK.md](03-deployment/SSH_DAPP_NPMPLUS_RUNBOOK.md) | SSH and DApp/NPMplus access |
|
||
|
||
---
|
||
|
||
## Besu & Chain 138
|
||
|
||
| Runbook | Location | Purpose |
|
||
|---------|----------|---------|
|
||
| **Besu Allowlist** | [06-besu/BESU_ALLOWLIST_RUNBOOK.md](06-besu/BESU_ALLOWLIST_RUNBOOK.md) | Allowlist management |
|
||
| **Install Besu 1504/2301** | [06-besu/INSTALL_BESU_1504_2301_RUNBOOK.md](06-besu/INSTALL_BESU_1504_2301_RUNBOOK.md) | Besu version install |
|
||
| **Bridge Operations (Besu)** | [06-besu/BRIDGE_OPERATIONS_RUNBOOK.md](06-besu/BRIDGE_OPERATIONS_RUNBOOK.md) | Bridge operations in Besu context |
|
||
|
||
---
|
||
|
||
## GRU M1 & Compliance
|
||
|
||
| Runbook | Location | Purpose |
|
||
|---------|----------|---------|
|
||
| **GRU M1 Listing Dry-Run** | [runbooks/GRU_M1_LISTING_DRY_RUN_RUNBOOK.md](runbooks/GRU_M1_LISTING_DRY_RUN_RUNBOOK.md) | cUSDC/cUSDT listing dry-run, CMC/CG submission |
|
||
| **Incident Response** | [runbooks/INCIDENT_RESPONSE_RUNBOOK.md](runbooks/INCIDENT_RESPONSE_RUNBOOK.md) | General incident response |
|
||
| **Ledger Allocation Posting** | [04-configuration/mifos-omnl-central-bank/LEDGER_ALLOCATION_POSTING_RUNBOOK.md](04-configuration/mifos-omnl-central-bank/LEDGER_ALLOCATION_POSTING_RUNBOOK.md) | Ledger allocation (Mifos/OMNL) |
|
||
|
||
---
|
||
|
||
## Subproject Runbooks
|
||
|
||
| Runbook | Location | Purpose |
|
||
|---------|----------|---------|
|
||
| **smom-dbis-138 Runbooks Index** | [smom-dbis-138/docs/runbooks/RUNBOOKS_INDEX.md](../smom-dbis-138/docs/runbooks/RUNBOOKS_INDEX.md) | Chain 138 / smom runbooks index |
|
||
| **Chain 138 Snap** | [metamask-integration/chain138-snap/docs/RUNBOOK.md](../metamask-integration/chain138-snap/docs/RUNBOOK.md) | MetaMask Snap runbook |
|
||
| **Explorer** | [explorer-monorepo/RUNBOOK.md](../explorer-monorepo/RUNBOOK.md) | Blockscout/explorer operations |
|
||
| **CCIP Operations (explorer)** | [explorer-monorepo/docs/CCIP_OPERATIONS_RUNBOOK.md](../explorer-monorepo/docs/CCIP_OPERATIONS_RUNBOOK.md) | CCIP operations in explorer context |
|
||
|
||
---
|
||
|
||
## Quick Links
|
||
|
||
- **Tasks not yet run + remaining deployments + recommendations:** [00-meta/TASKS_RUNBOOKS_REMAINING_AND_RECOMMENDATIONS.md](00-meta/TASKS_RUNBOOKS_REMAINING_AND_RECOMMENDATIONS.md)
|
||
- **Start here (operations):** [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md)
|
||
- **Deploy & verify:** [00-meta/DEPLOY_CONFIRM_AND_FULL_E2E_RUNBOOK.md](00-meta/DEPLOY_CONFIRM_AND_FULL_E2E_RUNBOOK.md)
|
||
- **cUSDT/cUSDC multichain + liquidity:** [smom-dbis-138/docs/deployment/CUSDT_CUSDC_MULTICHAIN_LIQUIDITY_RUNBOOK.md](../smom-dbis-138/docs/deployment/CUSDT_CUSDC_MULTICHAIN_LIQUIDITY_RUNBOOK.md)
|
||
- **Troubleshooting:** [09-troubleshooting/README.md](09-troubleshooting/README.md) | [TROUBLESHOOTING_FAQ.md](09-troubleshooting/TROUBLESHOOTING_FAQ.md)
|
||
- **Master doc index:** [MASTER_INDEX.md](MASTER_INDEX.md)
|