Damien/fabric-orchestrator
1
0
Fork 0
Code Issues 16 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: format markdown tables and update CLI command syntax

Browse Source 
- 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
This commit is contained in:
darnodo
2026-01-07 12:51:14 +01:00
parent 97cdc161da
commit 2445750f23
2 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -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: Progress is tracked via issues. See [all issues](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues) or filter by phase:
| Phase | Description | Issues | | 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 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 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 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 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) 📌 **Project Board**: [View Kanban](https://gitea.arnodo.fr/Damien/fabric-orchestrator/projects)
@@ -115,16 +115,16 @@ fabric-orchestrator/
## 🛠️ Technology Stack ## 🛠️ Technology Stack
| Component | Technology | Purpose | | Component | Technology | Purpose |
|-----------|------------|---------| | --------------- | -------------------------- | ------------------------------------ |
| Source of Truth | NetBox | Intent definition via ConfigContexts | | Source of Truth | NetBox | Intent definition via ConfigContexts |
| Transport | gNMI | Configuration and telemetry | | Transport | gNMI | Configuration and telemetry |
| Data Models | YANG (OpenConfig + Arista) | Structured configuration | | Data Models | YANG (OpenConfig + Arista) | Structured configuration |
| Orchestrator | Python (asyncio) | Reconciliation engine | | Orchestrator | Python (asyncio) | Reconciliation engine |
| CLI | Click + Rich | User interface | | CLI | Click + Rich | User interface |
| API | FastAPI | Webhook receiver | | API | FastAPI | Webhook receiver |
| Event Bus | Redis | Async event handling | | Event Bus | Redis | Async event handling |
| Lab | ContainerLab + cEOS | Development environment | | Lab | ContainerLab + cEOS | Development environment |
## 🔗 Related Projects ## 🔗 Related Projects

4
docs/cli-user-guide.md
View File

@@ -431,7 +431,7 @@ Display a reference table of commonly used YANG paths for Arista EOS.
### Usage ### Usage
```bash ```bash
fabric-orch discover paths uv run fabric-orch discover paths
``` ```
This command doesn't require a target connection - it displays a static reference. 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 │ │ Interfaces │ /interfaces/interface[name=Ethernet1]/state/counters │ Interface counters │
│ Loopbacks │ /interfaces/interface[name=Loopback0] │ Loopback interface │ │ Loopbacks │ /interfaces/interface[name=Loopback0] │ Loopback interface │
│ VLANs │ /network-instances/network-instance[name=default]/vlans/vlan │ All VLANs │ │ 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/vlan-to-vnis │ VLAN-to-VNI mappings │
│ VXLAN │ /interfaces/interface[name=Vxlan1]/arista-vxlan/config │ VXLAN config │ │ VXLAN │ /interfaces/interface[name=Vxlan1]/arista-vxlan/config │ VXLAN config │
│ MLAG │ /arista/eos/mlag/config │ MLAG config (config only) │ │ MLAG │ /arista/eos/mlag/config │ MLAG config (config only) │