Files
proxmox/docs/12-quick-reference/QUICK_REFERENCE_CARDS.md

165 lines
7.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Quick Reference Cards
**Last Updated:** 2026-02-12
**Document Version:** 1.1
**Status:** Active Documentation
---
## 1. Network Quick Reference
| Item | Value |
|------|-------|
| Management VLAN | 11 (192.168.11.0/24) |
| Gateway | 192.168.11.1 |
| Proxmox hosts | ml110 192.168.11.10, r630-01 .11, r630-02 .12 |
| NPMplus (VMID 10233) | 192.168.11.166, 192.168.11.167 (only .167 in UDM Pro) |
| UDM Pro (edge) | 76.53.10.34 |
| Public ingress | 76.53.10.36:80/443 → 192.168.11.167:80/443 |
| Besu Validator VLAN | 110 (10.110.0.0/24) |
| Besu Sentry VLAN | 111 (10.111.0.0/24) |
| Besu RPC VLAN | 112 (10.112.0.0/24) |
| CCIP Commit VLAN | 132 (10.132.0.0/24) |
| CCIP Execute VLAN | 133 (10.133.0.0/24) |
| CCIP RMN VLAN | 134 (10.134.0.0/24) |
**See:** [NETWORK_ARCHITECTURE.md](../02-architecture/NETWORK_ARCHITECTURE.md), [NETWORK_CONFIGURATION_MASTER.md](../11-references/NETWORK_CONFIGURATION_MASTER.md).
---
## 2. VMID Ranges Quick Reference
| Range | Purpose |
|-------|---------|
| 100130 | Infrastructure, monitoring |
| 10001499 | Besu validators |
| 15001999 | Besu sentries |
| 2101, 2201, 23012308 | RPC nodes |
| 24002505 | RPC / NGINX public (25062508 destroyed 2026-02-08) |
| 5000 | Explorer (Blockscout) |
| 78107811 | MIM4U |
| 10233 | NPMplus LXC |
**See:** [VMID_ALLOCATION_FINAL.md](../02-architecture/VMID_ALLOCATION_FINAL.md).
---
## 2.1 CCIP Relay Service (Chain 138 → Mainnet)
| Item | Value |
|------|-------|
| **Host** | r630-01 (192.168.11.11) |
| **Path** | `/opt/smom-dbis-138/services/relay` |
| **Chain 138 Public RPC** | `RPC_URL_138_PUBLIC` — VMID 2201 (192.168.11.221:8545) |
| **Logs** | `ssh root@192.168.11.11 "tail -f /opt/smom-dbis-138/services/relay/relay-service.log"` |
**See:** [07-ccip/CCIP_RELAY_DEPLOYMENT.md](../07-ccip/CCIP_RELAY_DEPLOYMENT.md).
---
## 2.2 Chain 138 contract check & deploy
| Item | Value |
|------|-------|
| **On-chain check** | `./scripts/verify/check-contracts-on-chain-138.sh` (uses `RPC_URL_138`, 36 addresses) |
| **Deploy (Forge)** | Always use `--with-gas-price 1000000000` on Chain 138 |
| **Addresses** | [CONTRACT_ADDRESSES_REFERENCE](../11-references/CONTRACT_ADDRESSES_REFERENCE.md), [ADDRESS_MATRIX_AND_STATUS](../11-references/ADDRESS_MATRIX_AND_STATUS.md) |
---
## 2.3 Token mapping (138↔Mainnet)
| Item | Value |
|------|-------|
| **Source of truth** | [config/token-mapping.json](../../config/token-mapping.json) |
| **Relay-supported** | WETH9 only (Mainnet CCIPRelayBridge); LINK mapped for future use |
| **When adding tokens** | Update token-mapping.json; optionally [CHAIN138_TOKEN_ADDRESSES](../11-references/CHAIN138_TOKEN_ADDRESSES.md) |
**See:** [07-ccip/TOKEN_MAPPING_AND_MAINNET_ADDRESSES.md](../07-ccip/TOKEN_MAPPING_AND_MAINNET_ADDRESSES.md), [07-ccip/CCIP_BRIDGE_MAINNET_CONNECTION.md](../07-ccip/CCIP_BRIDGE_MAINNET_CONNECTION.md).
---
## 3. Common Proxmox Commands
| Task | Command |
|------|---------|
| List VMs/containers | `pct list` or `qm list` |
| Status | `pct status <vmid>` or `qm status <vmid>` |
| Start/stop | `pct start <vmid>`, `pct stop <vmid>` |
| Console | `pct console <vmid>` |
| Config | `pct config <vmid>` |
| Cluster status | `pvecm status` |
| Storage | `pvesm status` |
| Logs (container) | `journalctl -u pve-container@<vmid>` |
**Example with expected output:**
```bash
pvecm status
```
Expected: Cluster name, quorum status, node list (e.g. `r630-01`, `r630-02`).
```bash
pct list
```
Expected: Table with columns VMID, status, name, type (e.g. `running`, `ubuntu-22`).
**See:** [OPERATIONAL_RUNBOOKS.md](../03-deployment/OPERATIONAL_RUNBOOKS.md), [QUICK_REFERENCE.md](QUICK_REFERENCE.md).
---
## 3.1 Documentation Index (ALL_IMPROVEMENTS 6874)
| # | Item | Link |
|---|------|------|
| 68 | Quick reference cards | This document; [QUICK_REFERENCE.md](QUICK_REFERENCE.md), [TROUBLESHOOTING_QUICK_REFERENCE.md](TROUBLESHOOTING_QUICK_REFERENCE.md) |
| 69 | Decision trees | [CONFIGURATION_DECISION_TREE.md](../10-best-practices/CONFIGURATION_DECISION_TREE.md) |
| 70 | Configuration templates | [ER605](../04-configuration/ER605_ROUTER_CONFIGURATION.md), [RPC_ENDPOINTS_MASTER](../04-configuration/RPC_ENDPOINTS_MASTER.md), [.env.example](../04-configuration/) in services |
| 71 | Examples and use cases | [OPERATIONAL_RUNBOOKS.md](../03-deployment/OPERATIONAL_RUNBOOKS.md), [TROUBLESHOOTING_FAQ.md](../09-troubleshooting/TROUBLESHOOTING_FAQ.md) |
| 72 | Glossary and terminology | [GLOSSARY.md](../11-references/GLOSSARY.md) |
| 73 | Visual elements | [NETWORK_ARCHITECTURE.md](../02-architecture/NETWORK_ARCHITECTURE.md), [MASTER_INDEX.md](../MASTER_INDEX.md) |
| 74 | Organization (TOC, cross-links) | [MASTER_INDEX.md](../MASTER_INDEX.md), [docs/README.md](../README.md) |
---
## 4. Troubleshooting Quick Reference
| Symptom | First checks |
|---------|----------------|
| Container won't start | `pct status <vmid>`, `pct config <vmid>`, `journalctl -u pve-container@<vmid>` |
| Service down | `systemctl status <service>`, logs |
| Network / no connectivity | `ping`, `curl`, DNS, firewall |
| Consensus / QBFT | [QBFT_TROUBLESHOOTING.md](../09-troubleshooting/QBFT_TROUBLESHOOTING.md) |
| RPC not responding | Check VMID 24002505, NGINX, Cloudflare tunnel |
| Cloudflare tunnel | [CLOUDFLARE_ROUTING_MASTER.md](../05-network/CLOUDFLARE_ROUTING_MASTER.md) |
**See:** [TROUBLESHOOTING_FAQ.md](../09-troubleshooting/TROUBLESHOOTING_FAQ.md).
---
## 5. Verification & E2E
| Task | Command / Location |
|------|--------------------|
| Full verification (deps + E2E) | `bash scripts/verify/run-full-verification.sh` |
| E2E routing only | `bash scripts/verify/verify-end-to-end-routing.sh --profile=public` |
| E2E with Option B (RPC via tunnel) | `ACCEPT_ANY_DNS=1 bash scripts/verify/verify-end-to-end-routing.sh --profile=public` |
| Dependencies check | `bash scripts/verify/check-dependencies.sh` |
| NPMplus RPC fix (from LAN) | `bash scripts/nginx-proxy-manager/update-npmplus-proxy-hosts-api.sh` |
| NPMplus backup | `bash scripts/verify/backup-npmplus.sh` |
| Config & decision trees | [CONFIGURATION_DECISION_TREE.md](../10-best-practices/CONFIGURATION_DECISION_TREE.md) (canonical); [04-configuration version](../04-configuration/CONFIGURATION_DECISION_TREE.md) (mermaid diagram) |
| Config templates / examples | [04-configuration/README.md](../04-configuration/README.md), [INGRESS_SOURCE_OF_TRUTH.json](../04-configuration/INGRESS_SOURCE_OF_TRUTH.json) |
**CoinGecko / Snap / Explorer (W1-22W1-24):** CoinGecko listing: [smom-dbis-138/services/token-aggregation/docs/COINGECKO_SUBMISSION.md](../../smom-dbis-138/services/token-aggregation/docs/COINGECKO_SUBMISSION.md). Chain 138 Snap (market data, swap, bridge): `metamask-integration/chain138-snap/`. Explorer (dark mode, network selector, sync): `explorer-monorepo/`.
**See:** [E2E_CLOUDFLARE_DOMAINS_RUNBOOK.md](../05-network/E2E_CLOUDFLARE_DOMAINS_RUNBOOK.md), [FULL_PARALLEL_EXECUTION_ORDER.md](../00-meta/FULL_PARALLEL_EXECUTION_ORDER.md).
---
## Related Documentation
- [MASTER_INDEX.md](../MASTER_INDEX.md) - Complete documentation index
- [VALIDATED_SET_QUICK_REFERENCE.md](VALIDATED_SET_QUICK_REFERENCE.md) - Validated set reference
- [QUICK_REFERENCE.md](QUICK_REFERENCE.md) - ProxmoxVE scripts quick reference