Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 2.87 KB

architecture.md

File metadata and controls

23 lines (15 loc) · 2.87 KB

Architecture

In Figure 3 the high-level architecture of the platform is shown, with the most important components and communication between components. The central component is the orchestrator, which is responsible for the deployment of services and initializing connections between instances of services. The orchestrator exposes an API that is used by the web-based user interface. This approach allows third-party developers to incorporate the orchestrator by using the API. Services are stored in a central registry. The services are stored as Docker images, with additional metadata attached to the images describing the interfaces that service is able to receive connections on. The description of interfaces occurs via either Protocol Buffers (protobuf) or XML Schema Definition (XSD), this way the compatibility of interfaces is ensured when two interfaces have compatible definitions.

Nodes in the environment are hosts that are capable of running the Docker images as containers. The nodes are attached to a Virtual Private Network (VPN) in order to have a secured private network in which processes are able to communicate with each other, as well as processes being able to receive directions from the orchestrator.

"High-level overview"

A quick overview of the components in dEF-Pi are as follows:

Component Description
Orchestrator Orchestrates the runtime environment of processes and connections. Exposes an API to control the current environment.
Services Implementations of a service that is able to be deployed by the orchestrator as process. Contained in an image with additional metadata describing the properties and interfaces of that service.
Interfaces Description of the messages a service is able to send and receive in a standardised way with Protocol Buffers (protobuf) or XML Schema Definitions (XSD).
Registry Registry containing services with their metadata, also allowing different versions of the same service to be deployable.
Processes Instantiated services in the runtime environment, managed by the orchestrator.
Connections Link between compatible interfaces of two processes.
Nodes Nodes in the cluster on which processes can be deployed. Are either limited to one user (private) or are available for all users (public) to deploy instances of services on.
Web-based user interface User interface communicating with the orchestrator API to manage the runtime environment for users.