Skip to main content
Version: v0.20.0

API Modules

The Analytics Data Plane is intentionally split into a small execution path and the signaling needed to connect it to a dataspace. Multi-party coordination is outside this process and belongs to the analytics use-case application.

Data plane and dataflows​

DataPlaneModule​

Registers the analytics orchestration and analytics data-access data planes with the control plane and exposes read-only registration/catalog state. It does not implement transfer negotiation or move dataset bytes.

DataflowModule​

Receives control-plane dataflow lifecycle callbacks (prepare, start, complete, suspend, resume, and terminate). An orchestration dataflow allocates the authenticated execution endpoint. A data-access dataflow binds a dataset to a local data source. The module records those bindings and applies their lifecycle to local execution and event channels.

Execution​

AlgorithmInstancesModule​

Stores the local algorithm instance, validates the submission against a started orchestration dataflow, starts or terminates the local job, and exposes the management and execution endpoints. It owns local job status only; it does not coordinate other participants.

OrchestrationModule​

Runs the local Docker or Kubernetes workload and reports job status. It resolves source references from started dataflows and injects the resulting file or URL into the job using the existing algorithm image contract.

DatasourceModule​

Resolves named local, HTTP, and S3 sources at job start using the execution configuration of the LAN-side runner. The source location and upstream credentials remain local to the LAN runner. For HTTP, the job receives an ADP proxy URL and a short-lived token scoped to its algorithm instance and dataset, never the upstream Authorization header. The token is revoked when the job is removed.

Events and split deployment​

EventsModule​

Accepts algorithm and internal events from local jobs, stores event metadata and payloads, and serves cursor-based reads. Provisioned event channels deliver metadata and payloads directly between participant execution endpoints. In split mode the bridge carries only the event and job-control messages needed by the client runner.

Bridge modules​

The server bridge sends execution metadata and start requests to a client. The client bridge sends job status and locally produced events back to the server. The bridge is an internal deployment boundary, not a second transfer protocol.

Auth, config, and audit​

Shared authentication, runtime configuration, logging, and audit modules protect the management surface. The API specification in openapi.yaml is generated from the active controllers.