How orchestron-orchestrator/orchestron works
Project type and purpose
• Orchestron is a command-line platform/library (written in the Acton language) for building reactive, model-driven network orchestration systems.
• It ingests configuration events (northbound APIs) and streaming telemetry, applies layered “transforms” built from static types (derived from YANG models), and emits automation actions or generated artifacts (e.g., device configs, code stubs).
Top-level file structure & architectural hints
• Root:
• Acton.toml, build.act.json, Makefile → build system & CLI packaging
• .github/workflows → CI for tests & compliance
• docs/ → user/developer documentation & assets
• gen_dmc/ → a standalone code-generation plugin (YANG→DMC) with its own build
• src/
• orchestron.act → CLI launcher & entry point
• src/orchestron/ → core modules (device models, transform runners, YANG type loader, TTT transform & generator)
• top-level test_*.act → unit tests for core transform layers
• test/golden/ → expected outputs for integration/golden-file tests
Key README insights
• Emphasis on “transforms” as first-class, layered, declarative blocks
• Reactive event-driven core (subscriptions on telemetry & config changes)
• Use of static types derived from YANG to catch errors at compile time
Main components
• Northbound API (e.g., REST/gRPC config changes)
• Streaming telemetry subscriber
• Parses CLI args, loads configuration
• Dispatches incoming events to transform layers
• Core transform runner (ttt.act, ttt_gen.act)
• Device model loader (device.act, device_meta_config.act)
• YANG-type generator (yang.act)
• Plugin sub-folder gen_dmc (YANG→DMC codegen)
• Generated Acton types from YANG (oyang.act)
• Device configuration commands
• Generated code/artifacts (e.g., DMC stubs)
• Unit tests (test_*.act)
• Golden-file tests (test/golden/)
• GitHub workflows
Relationships & Data flow
• Event Bus → Transform Engine → individual Transform Modules
• Transform Modules read Data Models → emit Outputs
• Plugin (gen_dmc) is loaded by the Transform Engine via a module boundary
• Tests invoke the CLI/Engine with sample inputs and compare against golden outputs
• CI orchestrates build → tests → compliance
Architectural patterns & principles
• Pipeline of pure, layered transforms (functional-style)
• Static typing “left shifted” via code generation from YANG
• Modular plugin architecture (core + gen_dmc)
• Reactive event bus separating sources from processing
Technologies & frameworks
• Acton language & its build system (Acton.toml, build.act.json)
• GitHub Actions for CI & REUSE compliance
• YANG models for type generation
• Makefile as developer convenience