George Lambert
1b199ca4d4
Zapier is one ingress. Direct web, customer API, and S2S leaf nodes are their own services. Every hop to an internal subject must pass verae.access.authz.check (default deny by plane).
4.7 KiB
Documentation index
Bring the system online: https://zapier.georgelambert.org/packages/verae-ops/GETTING-STARTED.pdf
Live catalog (PDF by default): https://zapier.georgelambert.org/ — Markdown indexes
Operator console (loopback): http://127.0.0.1:3850/ · CONSOLE.pdf
1. High-level (non-technical)
| Document | What it is |
|---|---|
| README.md | Overview (start here) |
| 01-system.md | What runs where, in plain language |
| 02-modules-and-repos.md | Short names of every independent repo |
| zapier-docs-master | One-line SUMMARY + NATS per module |
| zapier-user-docs | Signup → register → lookup |
| verae-ops | Docker / Proxmox / VM / metal install |
2. Architecture
| Document | URL |
|---|---|
| NATS cluster | 03-nats-cluster.md |
| Uptime | 04-uptime.md |
| Network failures | 05-network-failures.md |
| Address routing | 06-address-routing.md |
| External resources | 07-external-resources.md |
| Diagrams | 08-diagrams.md |
| Catalog home | https://zapier.georgelambert.org/ (PDF) · Markdown indexes |
| Composition | https://zapier.georgelambert.org/docs/02-architecture/composition.pdf |
| NATS gateway | https://zapier.georgelambert.org/docs/02-architecture/nats-gateway.pdf |
| NATS subjects | https://zapier.georgelambert.org/docs/02-architecture/nats-subjects.pdf |
| Archive / bloom | https://zapier.georgelambert.org/docs/02-architecture/archive-nats.pdf |
| Module NATS map | https://zapier.georgelambert.org/docs/02-architecture/modules-and-nats.pdf |
| Tree nodes | https://zapier.georgelambert.org/docs/02-architecture/tree-nodes.pdf |
| Fleet | https://zapier.georgelambert.org/docs/02-architecture/fleet.pdf |
3. Remaining documentation
| Document | URL |
|---|---|
| Expansion template | 09-expansion-template.md |
| Operator console | https://zapier.georgelambert.org/packages/verae-fleet/docs/CONSOLE.pdf |
| User guide | https://zapier.georgelambert.org/user-docs/README.pdf |
| Tree-node lookup (users) | https://zapier.georgelambert.org/packages/zapier-user-docs/09-lookup-tree-nodes.pdf |
| Zapier developer setup | https://zapier.georgelambert.org/docs/04-activate/SETUP-ZAPIER-DEVELOPER.pdf |
| docs-master | https://zapier.georgelambert.org/docs-master/README.pdf |
| Sphinx HTML | https://zapier.georgelambert.org/sphinx/ |
| Sphinx LaTeX PDF | https://zapier.georgelambert.org/sphinx/verae-zapier-modules.pdf |
| Install (verae-ops) | https://zapier.georgelambert.org/packages/verae-ops/README.pdf |
Independent git repositories
Prefix: https://git.georgelambert.org/marchon/
overview · verae-nats-process · verae-ops · master-zapier-plan-draft · zappier-edge · verae-access-authz · verae-access-web · verae-access-api · verae-access-leaf · verae-access-zapier · verae-middleware · verae-zapier-app · verae-activate · verae-request-splitter · verae-archive-worm · verae-archive-aggregator · verae-tree-node · verae-fleet · verae-zapier-simulator · zapier-user-docs · zapier-docs-master
Per-module contracts
In zapier-docs-master: modules/<package>/SUMMARY.md and NATS.md for every runtime package.
Operator surfaces (not public NATS)
| Surface | URL |
|---|---|
| Operator console (Fleet · Trace · Docs) | http://127.0.0.1:3850/ |
| Standalone simulator | http://127.0.0.1:3847/ |
A–Z subject index
| Term | See |
|---|---|
| aggregator | verae-archive-aggregator; archive.query / reply |
| bloom miss | silence; 05-network-failures |
| batch / Merkle | verae-tree-node; user-docs 08–09 |
| cluster | 03-nats-cluster |
| fleet / keepFloor | verae-fleet; 04-uptime |
| hash lookup | verae-zapier-app searches; 07-external-resources |
| jobs.events / jobs.watch | nats-subjects.html; middleware |
| includeTree | tree lookup; archive.query kinds=tree |
| routing | 06-address-routing; verae-nats-process |
| splitter | verae-request-splitter |
| 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.