docs: reformat README tables for better raw readability
Update Markdown tables including InfraHub comparison, Prefect benefits, and project progress phases to use consistent column padding. This improves the visual alignment and readability when viewing the raw source file.
This commit is contained in:
3
.infrahub.yml
Normal file
3
.infrahub.yml
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
schemas:
|
||||||
|
- schemas
|
||||||
@@ -25,7 +25,7 @@ Think `terraform plan` and `terraform apply`, but for your network fabric — po
|
|||||||
We chose [InfraHub](https://github.com/opsmill/infrahub) over NetBox as Source of Truth for several reasons:
|
We chose [InfraHub](https://github.com/opsmill/infrahub) over NetBox as Source of Truth for several reasons:
|
||||||
|
|
||||||
| Feature | NetBox | InfraHub |
|
| Feature | NetBox | InfraHub |
|
||||||
|---------|--------|----------|
|
| ------------------- | --------------------- | ------------------------------------ |
|
||||||
| **Schema** | Fixed DCIM/IPAM model | Fully customizable YAML schema |
|
| **Schema** | Fixed DCIM/IPAM model | Fully customizable YAML schema |
|
||||||
| **Git Integration** | External sync needed | Native - branches = data branches |
|
| **Git Integration** | External sync needed | Native - branches = data branches |
|
||||||
| **Versioning** | Changelog only | True Git-like versioning with merges |
|
| **Versioning** | Changelog only | True Git-like versioning with merges |
|
||||||
@@ -99,7 +99,7 @@ git push
|
|||||||
## 🎛 Why Prefect?
|
## 🎛 Why Prefect?
|
||||||
|
|
||||||
| Feature | Benefit |
|
| Feature | Benefit |
|
||||||
|---------|---------|
|
| -------------------------------- | ---------------------------------------------------------------------- |
|
||||||
| **Python-native workflows** | Use `@flow` and `@task` decorators — no YAML, just Python |
|
| **Python-native workflows** | Use `@flow` and `@task` decorators — no YAML, just Python |
|
||||||
| **Free secrets management** | Native `Secret` blocks for credentials (free in OSS) |
|
| **Free secrets management** | Native `Secret` blocks for credentials (free in OSS) |
|
||||||
| **Built-in UI** | Dashboard, logs, metrics, execution history via `prefect server start` |
|
| **Built-in UI** | Dashboard, logs, metrics, execution history via `prefect server start` |
|
||||||
@@ -125,7 +125,7 @@ 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 | Status |
|
| Phase | Description | Status |
|
||||||
|-------|-------------|--------|
|
| ----------- | -------------------------------------------------------------------- | ------------- |
|
||||||
| **Phase 1** | YANG Path Discovery - Map EOS 4.35.0F YANG models, validate gNMI | ✅ Complete |
|
| **Phase 1** | YANG Path Discovery - Map EOS 4.35.0F YANG models, validate gNMI | ✅ Complete |
|
||||||
| **Phase 2** | InfraHub Setup & Core Reconciler - Schema, diff engine, YANG mappers | 🔄 In Progress |
|
| **Phase 2** | InfraHub Setup & Core Reconciler - Schema, diff engine, YANG mappers | 🔄 In Progress |
|
||||||
| **Phase 3** | Full Fabric Coverage - BGP, MLAG, VRFs mappers | 📋 Planned |
|
| **Phase 3** | Full Fabric Coverage - BGP, MLAG, VRFs mappers | 📋 Planned |
|
||||||
@@ -198,7 +198,7 @@ fabric-orchestrator/
|
|||||||
## 🛠️ Technology Stack
|
## 🛠️ Technology Stack
|
||||||
|
|
||||||
| Component | Technology | Purpose |
|
| Component | Technology | Purpose |
|
||||||
|-----------|------------|---------|
|
| --------------- | -------------------------- | ------------------------------------ |
|
||||||
| Source of Truth | **InfraHub** | Intent definition via custom schema |
|
| Source of Truth | **InfraHub** | Intent definition via custom schema |
|
||||||
| Data Storage | **This Git repo** | Schema + data versioned together |
|
| Data Storage | **This Git repo** | Schema + data versioned together |
|
||||||
| Orchestrator | **Prefect** | Python-native workflow orchestration |
|
| Orchestrator | **Prefect** | Python-native workflow orchestration |
|
||||||
|
|||||||
Reference in New Issue
Block a user