Add operator console (Fleet, Trace, Docs) with screenshots
Some checks are pending
offline / test (push) Waiting to run
Some checks are pending
offline / test (push) Waiting to run
Unify loopback ops, hop testing, and reading order. Overview lists high-level docs first, then architecture, then the rest. Credits: Scott Lindsey, George Lambert, NATS.IO, Grok-Code by Grok.com.
This commit is contained in:
parent
a32c91475c
commit
cf4ef9e3af
17 changed files with 457 additions and 143 deletions
|
|
@ -15,7 +15,7 @@ Each runtime piece is its **own git repo** on Forgejo (`git.georgelambert.org`,
|
|||
| **verae-archive-worm** | `packages/verae-archive-worm` | Bloom WORM node |
|
||||
| **verae-archive-aggregator** | `packages/verae-archive-aggregator` | Merge archive replies |
|
||||
| **verae-tree-node** | `packages/verae-tree-node` | Merkle leaf proofs (bulk summaries) |
|
||||
| **verae-fleet** | `packages/verae-fleet` | Catalog, min copies, pause/restart, SSH hosts |
|
||||
| **verae-fleet** | `packages/verae-fleet` | Catalog, min copies, pause/restart, SSH hosts, operator console |
|
||||
| **verae-zapier-simulator** | `packages/verae-zapier-simulator` | Trace console before `zapier-platform push` |
|
||||
| **zapier-user-docs** | `packages/zapier-user-docs` | Customer signup → register → lookup |
|
||||
| **zapier-docs-master** | `packages/docs-master` | Per-module `SUMMARY.md` + `NATS.md` |
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ Uptime is **NATS durability + fleet replica floors + more than one machine**, no
|
|||
| archive-aggregator, job-poller, webhook-deliver | 1 | yes |
|
||||
| zappier-edge, middleware-http | 1 | yes |
|
||||
|
||||
If a tree node is paused, crashes, or fails `/health`, fleet **starts another copy** until three are available. Monitor: http://127.0.0.1:3850/ (green / yellow / red rows).
|
||||
If a tree node is paused, crashes, or fails `/health`, fleet **starts another copy** until three are available. Operator console: http://127.0.0.1:3850/ (Fleet tab — green / yellow / red; Trace tab for hop tests; Docs tab for reading order).
|
||||
|
||||
## Restart and pause
|
||||
|
||||
|
|
|
|||
|
|
@ -1,26 +1,29 @@
|
|||
# Documentation index
|
||||
|
||||
Pointers into the rest of the documentation. Live HTML catalog: https://zapier.georgelambert.org/
|
||||
Read **high-level first**, then **architecture**, then the rest. Live catalog: https://zapier.georgelambert.org/
|
||||
|
||||
## This overview
|
||||
Operator console (loopback): http://127.0.0.1:3850/
|
||||
|
||||
| Topic | File |
|
||||
|-------|------|
|
||||
| TOC / intro | [README.md](README.md) |
|
||||
| System | [01-system.md](01-system.md) |
|
||||
| Modules and repos | [02-modules-and-repos.md](02-modules-and-repos.md) |
|
||||
| NATS 3-server cluster | [03-nats-cluster.md](03-nats-cluster.md) |
|
||||
| Uptime | [04-uptime.md](04-uptime.md) |
|
||||
| Local network failures | [05-network-failures.md](05-network-failures.md) |
|
||||
| Address routing | [06-address-routing.md](06-address-routing.md) |
|
||||
| External search / storage | [07-external-resources.md](07-external-resources.md) |
|
||||
| Diagrams | [08-diagrams.md](08-diagrams.md) |
|
||||
| Expansion template | [09-expansion-template.md](09-expansion-template.md) |
|
||||
## 1. High-level (non-technical)
|
||||
|
||||
## Catalog (HTML)
|
||||
| Document | What it is |
|
||||
|----------|------------|
|
||||
| [README.md](README.md) | Overview (start here) |
|
||||
| [01-system.md](01-system.md) | What runs where, in plain language |
|
||||
| [02-modules-and-repos.md](02-modules-and-repos.md) | Short names of every independent repo |
|
||||
| [zapier-docs-master](https://git.georgelambert.org/marchon/zapier-docs-master) | One-line SUMMARY + NATS per module |
|
||||
| [zapier-user-docs](https://git.georgelambert.org/marchon/zapier-user-docs) | Signup → register → lookup |
|
||||
|
||||
## 2. Architecture
|
||||
|
||||
| Document | URL |
|
||||
|----------|-----|
|
||||
| NATS cluster | [03-nats-cluster.md](03-nats-cluster.md) |
|
||||
| Uptime | [04-uptime.md](04-uptime.md) |
|
||||
| Network failures | [05-network-failures.md](05-network-failures.md) |
|
||||
| Address routing | [06-address-routing.md](06-address-routing.md) |
|
||||
| External resources | [07-external-resources.md](07-external-resources.md) |
|
||||
| Diagrams | [08-diagrams.md](08-diagrams.md) |
|
||||
| Catalog home | https://zapier.georgelambert.org/ |
|
||||
| Composition | https://zapier.georgelambert.org/docs/02-architecture/composition.html |
|
||||
| NATS gateway | https://zapier.georgelambert.org/docs/02-architecture/nats-gateway.html |
|
||||
|
|
@ -29,6 +32,13 @@ Pointers into the rest of the documentation. Live HTML catalog: https://zapier.g
|
|||
| Module NATS map | https://zapier.georgelambert.org/docs/02-architecture/modules-and-nats.html |
|
||||
| Tree nodes | https://zapier.georgelambert.org/docs/02-architecture/tree-nodes.html |
|
||||
| Fleet | https://zapier.georgelambert.org/docs/02-architecture/fleet.html |
|
||||
|
||||
## 3. Remaining documentation
|
||||
|
||||
| Document | URL |
|
||||
|----------|-----|
|
||||
| Expansion template | [09-expansion-template.md](09-expansion-template.md) |
|
||||
| Operator console | https://git.georgelambert.org/marchon/verae-fleet/src/branch/main/docs/CONSOLE.md |
|
||||
| User guide | https://zapier.georgelambert.org/user-docs/README.md |
|
||||
| Tree-node lookup (users) | https://zapier.georgelambert.org/packages/zapier-user-docs/09-lookup-tree-nodes.html |
|
||||
| Zapier developer setup | https://zapier.georgelambert.org/docs/04-activate/SETUP-ZAPIER-DEVELOPER.html |
|
||||
|
|
@ -48,8 +58,8 @@ In **zapier-docs-master**: `modules/<package>/SUMMARY.md` and `NATS.md` for ever
|
|||
|
||||
| Surface | URL |
|
||||
|---------|-----|
|
||||
| Fleet monitor | http://127.0.0.1:3850/ |
|
||||
| Zapier simulator | http://127.0.0.1:3847/ |
|
||||
| Operator console (Fleet · Trace · Docs) | http://127.0.0.1:3850/ |
|
||||
| Standalone simulator | http://127.0.0.1:3847/ |
|
||||
|
||||
## A–Z subject index
|
||||
|
||||
|
|
@ -68,3 +78,8 @@ In **zapier-docs-master**: `modules/<package>/SUMMARY.md` and `NATS.md` for ever
|
|||
| SSH hosts | verae-fleet machines.json |
|
||||
| Zapier never NATS | 01-system |
|
||||
| zappier-edge | metering, portal |
|
||||
| operator console | http://127.0.0.1:3850/ ; verae-fleet docs/CONSOLE.md |
|
||||
|
||||
---
|
||||
|
||||
Design: **Scott Lindsey**, **George Lambert**, **NATS.IO**, and **Grok-Code** by [Grok.com](https://grok.com).
|
||||
|
|
|
|||
|
|
@ -46,3 +46,59 @@ Zapier → HTTPS `zappier-edge` → HTTPS `verae-middleware` → **NATS cluster*
|
|||
| [zapier-docs-master](https://git.georgelambert.org/marchon/zapier-docs-master) | Per-module SUMMARY + NATS |
|
||||
|
||||
Clone any of them: `git clone ssh://git@git.georgelambert.org:2223/marchon/<name>.git` (SSH port **2223**).
|
||||
|
||||
## Operator console (loopback)
|
||||
|
||||
Fleet, message **Trace**, and **Docs** share one shell at http://127.0.0.1:3850/ (`verae-fleet`). Not public. See [verae-fleet CONSOLE.md](https://git.georgelambert.org/marchon/verae-fleet/src/branch/main/docs/CONSOLE.md).
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
## Where to read next
|
||||
|
||||
Start at the top. Architecture is second. Everything else is reference.
|
||||
|
||||
### 1. High-level (non-technical)
|
||||
|
||||
| Document | What it is |
|
||||
|----------|------------|
|
||||
| **This overview** | Whole system in one place |
|
||||
| [Modules and repositories](02-modules-and-repos.md) | Short names of every independent repo |
|
||||
| [zapier-docs-master](https://git.georgelambert.org/marchon/zapier-docs-master) | One-line SUMMARY + NATS per module |
|
||||
| [zapier-user-docs](https://git.georgelambert.org/marchon/zapier-user-docs) | Signup → register a hash → lookup |
|
||||
|
||||
### 2. Architecture
|
||||
|
||||
| Document | What it is |
|
||||
|----------|------------|
|
||||
| [NATS 3-server cluster](03-nats-cluster.md) | Who may connect; private URLs |
|
||||
| [Uptime](04-uptime.md) | Replica floors, restart, SSH hosts |
|
||||
| [Local network failures](05-network-failures.md) | Reconnect, bloom silence, failover |
|
||||
| [Address routing](06-address-routing.md) | Unplanned functions as new subjects |
|
||||
| [External resources](07-external-resources.md) | Chain, WORM, tree-node search |
|
||||
| [Diagrams](08-diagrams.md) | SVG + mermaid |
|
||||
| [Fleet](https://zapier.georgelambert.org/docs/02-architecture/fleet.html) | Operator replica control |
|
||||
| [Module NATS map](https://zapier.georgelambert.org/docs/02-architecture/modules-and-nats.html) | Address table |
|
||||
| [Archive / bloom](https://zapier.georgelambert.org/docs/02-architecture/archive-nats.html) | Multipart and multi-receipt |
|
||||
| [Tree nodes](https://zapier.georgelambert.org/docs/02-architecture/tree-nodes.html) | Bulk Merkle leaves |
|
||||
| [Composition](https://zapier.georgelambert.org/docs/02-architecture/composition.html) | zappier + middleware HTTPS |
|
||||
|
||||
### 3. Remaining documentation
|
||||
|
||||
| Document | What it is |
|
||||
|----------|------------|
|
||||
| [Documentation index](INDEX.md) | A–Z and catalog URLs |
|
||||
| [Expansion template](09-expansion-template.md) / [verae-nats-process](https://git.georgelambert.org/marchon/verae-nats-process) | Copy this to add an address |
|
||||
| [Operator console](https://git.georgelambert.org/marchon/verae-fleet/src/branch/main/docs/CONSOLE.md) | Screenshots of Fleet / Trace / Docs |
|
||||
| [Simulator](https://git.georgelambert.org/marchon/verae-zapier-simulator) | Standalone trace (also inside the console) |
|
||||
| [Zapier developer setup](https://zapier.georgelambert.org/docs/04-activate/SETUP-ZAPIER-DEVELOPER.html) | CLI / login / push |
|
||||
| Live catalog | https://zapier.georgelambert.org/ |
|
||||
|
||||
---
|
||||
|
||||
## Credits
|
||||
|
||||
Design: **Scott Lindsey**, **George Lambert**, **NATS.IO**, and **Grok-Code** by [Grok.com](https://grok.com).
|
||||
|
|
|
|||
BIN
packages/overview/screenshots/console-docs.png
Normal file
BIN
packages/overview/screenshots/console-docs.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 142 KiB |
BIN
packages/overview/screenshots/console-fleet.png
Normal file
BIN
packages/overview/screenshots/console-fleet.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 211 KiB |
BIN
packages/overview/screenshots/console-trace.png
Normal file
BIN
packages/overview/screenshots/console-trace.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 254 KiB |
Loading…
Add table
Add a link
Reference in a new issue