From 2445750f237c35969b0dc279ac0233e9d7131be2 Mon Sep 17 00:00:00 2001 From: darnodo Date: Wed, 7 Jan 2026 12:51:14 +0100 Subject: [PATCH] docs: format markdown tables and update CLI command syntax - Align columns in README.md roadmap and technology stack tables - Update CLI example to use 'uv run fabric-orch' command prefix - Improve overall markdown table readability --- README.md | 32 ++++++++++++++++---------------- docs/cli-user-guide.md | 4 ++-- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index dea0b1d..0800b72 100644 --- a/README.md +++ b/README.md @@ -69,12 +69,12 @@ Reference: [arista-evpn-vxlan-clab](https://gitea.arnodo.fr/Damien/arista-evpn-v Progress is tracked via issues. See [all issues](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues) or filter by phase: -| Phase | Description | Issues | -|-------|-------------|--------| -| **Phase 1** | YANG Path Discovery - Map EOS 4.35.0F YANG models, validate gNMI | [phase-1-yang-discovery](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues?type=all&state=all&labels=1) | -| **Phase 2** | Minimal Reconciler - VLANs/VNIs, diff engine, CLI plan/apply | [phase-2-minimal-reconciler](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues?type=all&state=all&labels=2) | -| **Phase 3** | Full Fabric - BGP, MLAG, VRFs, dependency ordering | [phase-3-full-fabric](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues?type=all&state=all&labels=3) | -| **Phase 4** | Event-Driven - gNMI Subscribe, drift detection, webhooks | [phase-4-event-driven](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues?type=all&state=all&labels=4) | +| Phase | Description | Issues | +| ----------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| **Phase 1** | YANG Path Discovery - Map EOS 4.35.0F YANG models, validate gNMI | [phase-1-yang-discovery](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues?type=all&state=all&labels=1) | +| **Phase 2** | Minimal Reconciler - VLANs/VNIs, diff engine, CLI plan/apply | [phase-2-minimal-reconciler](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues?type=all&state=all&labels=2) | +| **Phase 3** | Full Fabric - BGP, MLAG, VRFs, dependency ordering | [phase-3-full-fabric](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues?type=all&state=all&labels=3) | +| **Phase 4** | Event-Driven - gNMI Subscribe, drift detection, webhooks | [phase-4-event-driven](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues?type=all&state=all&labels=4) | 📌 **Project Board**: [View Kanban](https://gitea.arnodo.fr/Damien/fabric-orchestrator/projects) @@ -115,16 +115,16 @@ fabric-orchestrator/ ## 🛠️ Technology Stack -| Component | Technology | Purpose | -|-----------|------------|---------| -| Source of Truth | NetBox | Intent definition via ConfigContexts | -| Transport | gNMI | Configuration and telemetry | -| Data Models | YANG (OpenConfig + Arista) | Structured configuration | -| Orchestrator | Python (asyncio) | Reconciliation engine | -| CLI | Click + Rich | User interface | -| API | FastAPI | Webhook receiver | -| Event Bus | Redis | Async event handling | -| Lab | ContainerLab + cEOS | Development environment | +| Component | Technology | Purpose | +| --------------- | -------------------------- | ------------------------------------ | +| Source of Truth | NetBox | Intent definition via ConfigContexts | +| Transport | gNMI | Configuration and telemetry | +| Data Models | YANG (OpenConfig + Arista) | Structured configuration | +| Orchestrator | Python (asyncio) | Reconciliation engine | +| CLI | Click + Rich | User interface | +| API | FastAPI | Webhook receiver | +| Event Bus | Redis | Async event handling | +| Lab | ContainerLab + cEOS | Development environment | ## 🔗 Related Projects diff --git a/docs/cli-user-guide.md b/docs/cli-user-guide.md index 74d300f..b98242f 100644 --- a/docs/cli-user-guide.md +++ b/docs/cli-user-guide.md @@ -431,7 +431,7 @@ Display a reference table of commonly used YANG paths for Arista EOS. ### Usage ```bash -fabric-orch discover paths +uv run fabric-orch discover paths ``` This command doesn't require a target connection - it displays a static reference. @@ -449,7 +449,7 @@ Common YANG Paths for Arista EOS │ Interfaces │ /interfaces/interface[name=Ethernet1]/state/counters │ Interface counters │ │ Loopbacks │ /interfaces/interface[name=Loopback0] │ Loopback interface │ │ VLANs │ /network-instances/network-instance[name=default]/vlans/vlan │ All VLANs │ -│ BGP │ .../bgp/neighbors/neighbor/state │ All BGP neighbors │ +│ BGP │ .../bgp/neighbors/neighbor/state │ All BGP neighbors │ │ VXLAN │ /interfaces/interface[name=Vxlan1]/arista-vxlan/vlan-to-vnis │ VLAN-to-VNI mappings │ │ VXLAN │ /interfaces/interface[name=Vxlan1]/arista-vxlan/config │ VXLAN config │ │ MLAG │ /arista/eos/mlag/config │ MLAG config (config only) │