Neops product documentation
Neops is a transactional network automation platform. Operators describe network changes as workflows — ordered sequences of versioned function blocks — which the workflow engine orchestrates by acquiring entity locks from the CMS, distributing jobs to workers through the blackboard job queue, and applying changes atomically with explicit failure semantics (FAILED_SAFE vs FAILED_UNSAFE). Function blocks are written in Python with the worker SDK and tested against real topologies via the Remote Lab, while the web client exposes workflows to operators and the Secure Gateway lets external consumers reach a filtered subset of the API.
Documentation Overview
-
Getting Started
Recommended entry points for operators, workflow authors, and function-block developers.
-
Concepts
The cross-cutting ideas — transactional model, function blocks, blackboard, remote lab — that explain how the pieces fit together.
-
User Guide
Use the web client to browse entity data, trigger workflows, and watch executions live.
-
Workflows
Author, schedule, and operate workflows with the workflow engine: definitions, lifecycle, retries, and rollbacks.
-
Function Blocks
Build reusable Python execution units with the worker SDK — anatomy, device connections, testing, deployment.
-
Remote Lab
Run pytest suites against shared Netlab topologies via a FIFO session queue.
-
Installation & Deployment
Per-component deployment guides for the engine, workers, remote lab, and secure gateway.
-
Modules
Optional add-on services such as the Secure Gateway.