Skip to main content

Uniconnect Enterprise Current Deployment Topology (Docker)

This page documents the current production deployment architecture generated and managed by the installer (uc-enterprise-installer).

Scope:

  • Single production host (VM or bare metal)
  • Docker Compose based runtime
  • Internal container-to-container networking
  • Installer-managed update and monitoring service (uniconnect-manager)

1. Topology Overview​

2. Runtime Services​

ServiceContainer NamePurposeKey Dependencies
Webuniconnect-webNginx reverse proxy and static UI deliveryapi, cube, manager (via proxy routes)
APIuniconnect-apiCore backend APIs and business logicuniconnect-db, uniconnect-redis
Manageruniconnect-managerUpdate orchestration, monitoring, resource guardDocker socket, all runtime containers
Cubeuniconnect-cubeAnalytics and reporting APIuniconnect-db, uniconnect-cubestore
CubeStoreuniconnect-cubestoreCube analytical storeInternal only
Redisuniconnect-redisCache, queueing, runtime stateInternal only
PostgreSQLuniconnect-dbPrimary relational datastoreInternal and host port exposure

3. Network and Port Model​

External entry points are through the web container ports configured by installer-provided custom port values:

  • Web console HTTP (web_console_port)
  • Web console HTTPS (web_console_https_port)
  • Report/API gateway port (report_port)

Internal service ports:

  • API: 3000
  • Manager: 3079
  • Cube: 4000
  • CubeStore: 3030
  • Redis: 6379
  • PostgreSQL: 5432 (also host mapped)

Notes:

  • Containers communicate over uniconnect_internal network.
  • The network is created as an external Docker network.
  • Nginx forwards and terminates traffic based on generated host config.

4. Persistence and Host Paths​

Persistent data and logs are written under /var/lib/uniconnect/Instance1 and /etc/uniconnect/Instance1.

Primary mounts used by runtime services:

  • Nginx logs and config:
    • /var/lib/uniconnect/Instance1/Logs/UniconnectNginx
    • /etc/uniconnect/Instance1/nginx/nginx.conf
    • /etc/uniconnect/Instance1/nginx/env.js
    • /etc/uniconnect/Instance1/nginx/ssl
  • API:
    • /var/lib/uniconnect/Instance1/Logs/UniconnectApi
    • /var/lib/uniconnect/Instance1/Data
    • /etc/uniconnect
    • /var/lib/uniconnect
    • /var/run/docker.sock
  • Manager:
    • /etc/uniconnect
    • /var/lib/uniconnect
    • /var/run/docker.sock
  • Cube logs:
    • /var/lib/uniconnect/Instance1/Logs/UniconnectCube
  • Redis data and logs:
    • /var/lib/uniconnect/Instance1/Redis
    • /var/lib/uniconnect/Instance1/Logs/UniconnectRedis
  • PostgreSQL data and logs:
    • /var/lib/uniconnect/Instance1/Postgresql/main
    • /var/lib/uniconnect/Instance1/Logs/UniconnectPostgresql

5. Startup and Health Flow​

Installer deployment behavior:

  1. Build a temporary compose file (uniconnect.yml) from release metadata.
  2. Pull images in defined order with retry logic.
  3. Start containers service-by-service.
  4. Wait for each service to become healthy before proceeding.

Health checks:

  • Web: HTTPS localhost check on configured HTTPS port
  • API: http://localhost:3000/api/health/check
  • Manager: http://localhost:3079/api/health
  • Cube: http://localhost:4000
  • Redis: redis-cli ping (with password)
  • PostgreSQL: pg_isready -U uniconnect -d uc_enterprise

6. Manager (Updater) Responsibilities​

uniconnect-manager is part of runtime, not a build-time-only utility.

Core responsibilities:

  • Controlled image-based service upgrades
  • Runtime service status tracking
  • Monitoring endpoints and websocket streams
  • Resource Guard policy execution (observe/enforce modes)

The web proxy can expose manager endpoints (for example /manager/stats) for authenticated operational visibility.

7. Required Developer Knowledge​

Developers working on deployment-sensitive features should align with these rules:

  1. Container names are contract-critical:
    • uniconnect-web, uniconnect-api, uniconnect-manager, uniconnect-cube, uniconnect-cubestore, uniconnect-redis, uniconnect-db
  2. Do not assume localhost in app code for inter-service calls; use Docker DNS service/container names.
  3. Preserve health endpoints and startup behavior when changing server boot logic.
  4. Avoid breaking mount path contracts under /etc/uniconnect/Instance1 and /var/lib/uniconnect/Instance1.
  5. Any change to env keys must remain compatible with system.env generation and updater expectations.
  6. Changes impacting ports or route prefixes must be reflected in installer nginx template generation.

8. Source of Truth in Code​

Installer/runtime behavior is defined by:

  • uc-enterprise-installer/backend/services/dockerConfigService.js
  • uc-enterprise-installer/backend/services/dockerService.js
  • uc-enterprise-installer/backend/services/nginxService.js

Updater/manager behavior is defined by:

  • uc-enterprise-updater/cmd/server/main.go
  • uc-enterprise-updater/internal/config/managed_services.go

If there is any conflict between legacy documentation and runtime behavior, the above files are authoritative.