Update README.md tables to be more compact
Add .ruff_cache to .gitignore
This commit is contained in:
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,2 +1,3 @@
|
||||
__pycache__
|
||||
.envrc
|
||||
.ruff_cache
|
||||
|
||||
12
README.md
12
README.md
@@ -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:
|
||||
|
||||
| Feature | NetBox | InfraHub |
|
||||
| ------------------- | ----------------------- | -------------------------------------------- |
|
||||
| ------------------- | --------------------- | ------------------------------------ |
|
||||
| **Schema** | Fixed DCIM/IPAM model | Fully customizable YAML schema |
|
||||
| **Git Integration** | External sync needed | Native - branches = data branches |
|
||||
| **Versioning** | Changelog only | True Git-like versioning with merges |
|
||||
@@ -42,7 +42,7 @@ We chose [InfraHub](https://github.com/opsmill/infrahub) over NetBox as Source o
|
||||
## 🎛 Why Prefect?
|
||||
|
||||
| Feature | Benefit |
|
||||
| -------------------------------- | ------------------------------------------------------------------------- |
|
||||
| -------------------------------- | ---------------------------------------------------------------------- |
|
||||
| **Python-native workflows** | Use `@flow` and `@task` decorators — no YAML, just Python |
|
||||
| **Free secrets management** | Native `Secret` blocks for credentials (free in OSS) |
|
||||
| **Built-in UI** | Dashboard, logs, metrics, execution history via `prefect server start` |
|
||||
@@ -68,7 +68,7 @@ Reference lab topology: [arista-evpn-vxlan-clab](https://gitea.arnodo.fr/Damien/
|
||||
Progress is tracked via issues. See [all issues](https://gitea.arnodo.fr/Damien/fabric-orchestrator/issues) or filter by phase:
|
||||
|
||||
| Phase | Description | Status |
|
||||
| ----------- | ---------------------------------------------------------------------------- | -------------- |
|
||||
| ----------- | ------------------------------------------------------------------------- | -------------- |
|
||||
| **Phase 1** | YANG Path Discovery - Map EOS 4.35.0F YANG models, validate gNMI | ✅ Complete |
|
||||
| **Phase 2** | InfraHub Client & Core Reconciler - SDK client, diff engine, YANG mappers | 🔄 In Progress |
|
||||
| **Phase 3** | Full Fabric Coverage - BGP, MLAG, VRFs mappers | 📋 Planned |
|
||||
@@ -116,7 +116,7 @@ fabric-orchestrator/
|
||||
## 🛠️ Technology Stack
|
||||
|
||||
| Component | Technology | Purpose |
|
||||
| --------------- | ------------------------------- | ------------------------------------------ |
|
||||
| --------------- | -------------------------- | ------------------------------------ |
|
||||
| Source of Truth | **InfraHub** | Intent definition via custom schema |
|
||||
| Orchestrator | **Prefect** | Python-native workflow orchestration |
|
||||
| Transport | gNMI | Configuration and telemetry |
|
||||
@@ -136,21 +136,25 @@ fabric-orchestrator/
|
||||
## 📚 References
|
||||
|
||||
### InfraHub
|
||||
|
||||
- [InfraHub Documentation](https://docs.infrahub.app)
|
||||
- [InfraHub Schema Guide](https://docs.infrahub.app/guides/create-schema)
|
||||
- [InfraHub Python SDK](https://github.com/opsmill/infrahub-sdk-python)
|
||||
|
||||
### Prefect
|
||||
|
||||
- [Prefect Documentation](https://docs.prefect.io)
|
||||
- [Prefect Flows](https://docs.prefect.io/latest/develop/write-flows/)
|
||||
- [Prefect Tasks](https://docs.prefect.io/latest/develop/write-tasks/)
|
||||
|
||||
### YANG / gNMI
|
||||
|
||||
- [Arista gNMI Documentation](https://aristanetworks.github.io/openmgmt/configuration/gnmi/)
|
||||
- [OpenConfig Models](https://github.com/openconfig/public)
|
||||
- [pygnmi Library](https://github.com/akarneliuk/pygnmi)
|
||||
|
||||
### EVPN-VXLAN
|
||||
|
||||
- [Arista BGP EVPN Configuration Example](https://overlaid.net/2019/01/27/arista-bgp-evpn-configuration-example/)
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
Reference in New Issue
Block a user