Release 0.7.0

config.example.yml

@@ -6,21 +6,30 @@ experiments:
 
 log_level: INFO
 
-# EOS orchestrator's internal web API server configuration
+# Orchestrator web API configuration
 web_api:
   host: localhost
   port: 8070
 
-# EOS database (MongoDB) configuration
+# PostgreSQL database configuration
 db:
   host: localhost
-  port: 27017
+  port: 5432
   username: ""
   password: ""
 
-# EOS file database (MinIO) configuration
+# MinIO file configuration
 file_db:
   host: localhost
   port: 9004
   username: ""
   password: ""
+
+# The minimum processing rate of the orchestrator.
+# The lower the rate, the less CPU usage while idle but increases the latency
+# of the first task to process.
+orchestrator_min_hz: 0.5
+
+# The maximum processing rate of the orchestrator.
+# The higher the rate, the faster work is processed at the cost of increased CPU usage.
+orchestrator_max_hz: 10

docker/.env.example

@@ -1,8 +1,8 @@
 COMPOSE_PROJECT_NAME=eos
 
-# MongoDB admin credentials
-EOS_MONGODB_ROOT_USER=
-EOS_MONGODB_ROOT_PASSWORD=
+# PostgreSQL admin credentials
+EOS_POSTGRES_USER=
+EOS_POSTGRES_PASSWORD=
 
 # MinIO admin credentials
 EOS_MINIO_ROOT_USER=

docker/docker-compose.yml

@@ -1,25 +1,20 @@
 services:
-  eos-mongodb:
-    build:
-      context: .
-      dockerfile: mongodb/Dockerfile
-      args:
-        - MONGO_INITDB_ROOT_USERNAME=${EOS_MONGODB_ROOT_USER}
-        - MONGO_INITDB_ROOT_PASSWORD=${EOS_MONGODB_ROOT_PASSWORD}
-    image: eos-mongodb/latest
-    container_name: eos-mongodb
-    hostname: eos-mongodb
+  eos-postgresql:
+    image: postgres:17.2
+    container_name: eos-postgresql
+    hostname: eos-postgresql
     restart: unless-stopped
+    shm_size: 256mb
     environment:
-      MONGO_INITDB_ROOT_USERNAME: ${EOS_MONGODB_ROOT_USER}
-      MONGO_INITDB_ROOT_PASSWORD: ${EOS_MONGODB_ROOT_PASSWORD}
+      POSTGRES_DB: postgres
+      POSTGRES_USER: ${EOS_POSTGRES_USER}
+      POSTGRES_PASSWORD: ${EOS_POSTGRES_PASSWORD}
     ports:
-      - "27017:27017"
+      - "5432:5432"
     networks:
       - eos_network
     volumes:
-      - mongodb_data:/data/db
-    command: ["-f", "/etc/mongod.conf"]
+      - postgresql_data:/var/lib/postgresql/data
 
   eos-minio:
     image: minio/minio:RELEASE.2024-10-02T17-50-41Z
@@ -44,7 +39,7 @@ networks:
     driver: bridge
 
 volumes:
-  mongodb_data:
+  postgresql_data:
     driver: local
   minio_data:
     driver: local

docs/conf.py

@@ -10,7 +10,7 @@
 project = "eos"
 copyright = "2024, UNC Robotics"
 author = "Angelos Angelopoulos"
-release = "0.6.0"
+release = "0.7.0"
 
 extensions = [
     "sphinx.ext.autodoc",

docs/user-guide/configuration.rst

@@ -1,7 +1,8 @@
 Configuration
 =============
 
-After installation, you need to configure external services such as MongoDB and MinIO as well as EOS itself.
+EOS uses PostgreSQL for data storage, and MinIO for file storage. EOS must be configured to connect to these external
+services.
 
 1. Configure External Services
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -14,7 +15,7 @@ Copy the example environment file:
 
     cp docker/.env.example docker/.env
 
-Edit `docker/.env` and provide values for all fields.
+Edit the environment file `docker/.env` and provide values for all fields.
 
 2. Configure EOS
 ^^^^^^^^^^^^^^^^
@@ -26,7 +27,7 @@ Copy the example configuration file:
 
     cp config.example.yml config.yml
 
-Edit `config.yml`. Ensure that credentials are provided for the MongoDB and MinIO services.
+Edit `config.yml`. Ensure that credentials are provided for PostgreSQL and MinIO.
 
 By default, EOS loads the "multiplication_lab" laboratory and the "optimize_multiplication" experiment from an example
 EOS package. Feel free to change this.

docs/user-guide/installation.rst

@@ -11,7 +11,7 @@ We recommend a central computer that is easily accessible.
     We strongly recommend that the laboratory has its own isolated network for security and performance reasons.
     See :doc:`infrastructure setup <infrastructure_setup>` for more information.
 
-EOS also requires a MongoDB database and a MinIO object storage server.
+EOS also requires a PostgreSQL database and a MinIO object storage server.
 We provide a Docker Compose file that can set up all of these services for you.
 
 1. Install PDM

docs/user-guide/running.rst

@@ -13,14 +13,8 @@ Running
 
     source env/bin/activate
 
-3. Start the EOS Orchestrator
+3. Start EOS
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: shell
 
     eos orchestrator
-
-4. Start the EOS REST API
-^^^^^^^^^^^^^^^^^^^^^^^^^
-.. code-block:: shell
-
-    eos api