Cml Cloud Manager - Neuroglia WebApplication

An opinionated Neuroglia FastAPI template showcasing multi-subapp architecture (API + UI), CQRS, RBAC, OAuth2/OIDC, and pluggable infrastructure:

• 🎨 SubApp Pattern: Clean separation between API and UI concerns
• 🔐 OAuth2/OIDC Authentication: Keycloak integration with Backend-for-Frontend pattern
• 🔴 Redis Session Store: Distributed sessions for horizontal scaling in Kubernetes
• 🛡️ RBAC: Role-based access control at the application layer
• 📋 CQRS Pattern: Command Query Responsibility Segregation
• 🎯 Clean Architecture: Domain-driven design with clear boundaries
• ⏰ Background Task Scheduling: APScheduler integration with Redis/MongoDB persistence
• 📊 Worker Monitoring: Automated health and metrics collection for CML Workers
• 🔄 Real-Time Updates (SSE): Live worker status, metrics & labs pushed to UI

🏗️ Architecture

This application follows the Simple UI sample pattern from Neuroglia, implementing:

• API SubApp (/api): RESTful JSON endpoints with JWT authentication
• UI SubApp (/): Bootstrap 5 SPA with Parcel bundler
• Domain Layer: Task entities with repository pattern
• Application Layer: CQRS commands/queries with RBAC handlers
• Integration Layer: In-memory and MongoDB (motor) repositories (ready for PostgreSQL/Redis/...)

Project Structure

cml-cloud-manager/
├── src/
│   ├── main.py                      # FastAPI app factory entry point
│   ├── api/                         # API sub-app (mounted at /api)
│   │   ├── controllers/             # Route controllers
│   │   ├── dependencies.py          # Shared dependency helpers (auth, user)
│   │   └── services/                # API-specific service utilities (e.g. OpenAPI config)
│   ├── application/                 # Application layer (CQRS, mapping, settings)
│   │   ├── settings.py
│   │   ├── commands/                # Write operations
│   │   ├── queries/                 # Read operations
│   │   ├── events/                  # Domain/application events (placeholder)
│   │   ├── mapping/                 # Object mapping profiles
│   │   └── services/                # Cross-cutting services (logger, background jobs)
│   │       ├── background_scheduler.py       # Background task scheduling with APScheduler
│   │       ├── worker_metrics_collection_job.py  # Metrics collection background job
│   │       ├── worker_monitoring_scheduler.py    # Worker monitoring orchestrator
│   │       └── worker_notification_handler.py    # Metrics event observer
│   ├── domain/                      # Pure domain model
│   │   ├── entities/                # Aggregate/entity classes (CMLWorker, etc.)
│   │   └── repositories/            # Repository interfaces (ports)
│   ├── infrastructure/              # Technical adapters implementing ports
│   │   └── session_store.py         # Session store implementations (in-memory/redis)
│   ├── integration/                 # Concrete adapters / in-memory repos
│   │   └── models/
│   │   └── repositories/
│   │   └── services/                # AWS integration services
│   │       └── aws_ec2_api_client.py         # AWS EC2 and CloudWatch client
│   ├── observability/               # Metrics, tracing, logging integration points
│   │   └── metrics.py
│   ├── ui/                          # Frontend build + controller sub-app
│   │   ├── controllers/             # UI route(s)
│   │   ├── src/                     # Parcel source (scripts, styles)
│   │   ├── package.json             # Frontend dependencies
├── tests/                           # Pytest suites (unit/integration)
│   └── test_rename_integrity.py     # Ensures no leftover starter branding post-rename
├── scripts/
│   └── rename_project.py            # Automated project rebranding utility
├── docs/                            # MkDocs documentation source
├── deployment/                      # Deployment & Keycloak realm config assets
├── notes/                           # Design / architecture scratchpad docs
├── static/                          # Published frontend bundle (built UI assets)
├── Makefile                         # Developer automation commands
├── docker-compose.yml               # Local service orchestration
├── Dockerfile                       # Application container build
├── pyproject.toml                   # Python dependencies & tool config (Poetry)
└── README.md                        # This file

🚀 Quick Start

Prerequisites

• Python 3.11+
• Poetry
• Node.js 20+ (for UI build)
• Docker & Docker Compose

Local Development

1. Install Dependencies:

   make install
   make install-ui

2. Build UI:

   make build-ui

3. Run Application:

   make run

   Access at http://localhost:8000

Production Deployment

1. Configure Environment: Copy the example environment file and update secrets:

   cp deployment/docker-compose/.env.prod.example deployment/docker-compose/.env.prod
   nano deployment/docker-compose/.env.prod

2. Start Stack:

   make prod-up

3. Access Services:

   • UI: http://localhost/
   • Keycloak: http://localhost/auth/
   • Grafana: http://localhost/grafana/

See Deployment Documentation for details.

• Docker & Docker Compose (optional)

Quick Setup (Recommended)

Use the Makefile for easy setup and management:

make setup    # Install backend & frontend dependencies
make run      # Start FastAPI locally
make up       # Start full Docker stack (Mongo, Keycloak, Redis, OTEL)
make help     # List all available Makefile targets

Manual Local Development

1. Install Python dependencies:

   poetry install

2. Install frontend dependencies and build UI:

   make install-ui
   make build-ui

3. Run the application:

   make run

4. Access the application:

   • Application: http://localhost:8000/
   • API Documentation: http://localhost:8000/api/docs

Frontend Development Mode

For hot-reload during UI development:

# Terminal 1: Watch and rebuild frontend assets
make dev-ui

# Terminal 2: Start backend with hot-reload
make run

Docker Development

Run the complete stack with Docker Compose using the Makefile (recommended):

# Copy environment variables (first time only)
cp .env.example .env

# Build and start services
make up

# View logs
make logs

# Stop services
make down

# Rebuild from scratch
make rebuild

Or use docker-compose directly:

# Start all services
docker-compose up

# Or run in background
docker-compose up -d

This will start:

• ✅ Cml Cloud Manager App (http://localhost:8020)
• ✅ MongoDB (localhost:8022) and Mongo Express (http://localhost:8023)
• ✅ Keycloak (http://localhost:8021)
• ✅ OpenTelemetry Collector
• ✅ UI Builder (auto-rebuild)
• ✅ Redis (localhost:6379)
• ✅ Event Player (http://localhost:8024)

👥 Test Users

The application includes test users with different roles:

Username	Password	Role	Capability Highlights
admin	test	admin	Full lifecycle (create/import/start/stop/terminate), monitoring control
manager	test	manager	Start/stop, tag updates, view metrics & labs
user	test	user	Read-only workers, metrics, labs

See deployment/keycloak/cml-cloud-manager-realm-export.json

🔐 Authentication & RBAC

🔄 Real-Time & Background Jobs

Feature	Component	Interval / Trigger
SSE Stream	/api/events/stream	Persistent (heartbeat 30s)
Labs Refresh	LabsRefreshJob	Every 30 min + startup run
Metrics Collection	WorkerMetricsCollectionJob	Configurable (worker_metrics_poll_interval)
Status Updates	UpdateCMLWorkerStatusCommand	Manual & scheduled reconciliation
Telemetry Events	Domain handlers	On state change

SSE-First Worker Metadata

Worker list, details, and telemetry now derive exclusively from Server-Sent Events:

• worker.snapshot events provide full authoritative metadata + derived CPU / memory / storage utilization.
• REST list & per-row enrichment calls were removed from the UI code; loadWorkers() is deprecated.
• Manual refresh actions will transition to asynchronous scheduling that emits request/skip events and relies on subsequent metrics updates.
• Simplicity goal: a single state flow (Aggregate → Domain Events → Snapshot Broadcast → UI render).

If snapshots fail to arrive within a short window, a passive "Awaiting worker snapshot events" message is shown instead of performing fallback REST polling.

UI auto-refreshes worker list, details modal, and Labs tab. A badge shows connection status: connected / reconnecting / disconnected / error.

👤 Extending Real-Time Events

Add a new event:

1. Emit a domain event or directly broadcast.
2. In handler: await get_sse_relay().broadcast_event("my.event", { id: ... })
3. In UI: sseClient.on('my.event', data => {/* update UI */})

Keep payloads lean; prefer IDs and fetch details only when needed.

JWT Authentication

• Stateless: No server-side sessions required
• Token Storage: localStorage (not cookies)
• Expiration: 24 hours (configurable)
• Claims: username, user_id, roles, department

Role-Based Access Control

Authorization happens in the application layer (handlers), not controllers:

• Admin: Can view and manage all tasks, can delete tasks
• Manager: Can view tasks in their department
• User: Can only view their assigned tasks

Example RBAC logic in GetTasksQueryHandler:

if "admin" in user_roles:
    tasks = await self.task_repository.get_all_async()
elif "manager" in user_roles:
    tasks = await self.task_repository.get_by_department_async(department)
else:
    tasks = await self.task_repository.get_by_assignee_async(user_id)

🛠️ Configuration

Environment Variables

Create a .env file (or use .env.example):

# Application server
APP_HOST=127.0.0.1         # Override only if you must expose the API externally
APP_PORT=8080

# Keycloak OAuth2/OIDC
# External URL - browser/Swagger UI accessible (defaults to http://localhost:8021)
KEYCLOAK_URL=http://localhost:8021
# Internal URL - backend server-to-server communication (optional, defaults to KEYCLOAK_URL if not set)
# In Docker: use internal Docker network URL (http://keycloak:8080)
# In Kubernetes: may be same as KEYCLOAK_URL or intra-cluster URL depending on setup
KEYCLOAK_URL_INTERNAL=http://keycloak:8080
KEYCLOAK_REALM=cml-cloud-manager
KEYCLOAK_CLIENT_ID=portal-web-app

# Redis Session Storage (for production horizontal scaling)
REDIS_ENABLED=false          # Set to true for production
REDIS_URL=redis://redis:6379/0
REDIS_KEY_PREFIX=session:

# Database
MONGODB_PASSWORD=neuroglia123

Redis Session Store

The application supports two session storage backends:

Development (default): InMemorySessionStore

• ⚡ Fast, no external dependencies
• ⚠️ Sessions lost on restart
• ❌ Not suitable for multiple instances

Production: RedisSessionStore

• 🔴 Distributed, shared across pods
• 📈 Enables horizontal scaling in Kubernetes
• 💪 Sessions survive pod restarts
• ⏰ Auto-expiring via Redis TTL

To enable Redis for production:

# In .env file
REDIS_ENABLED=true

See notes/REDIS_SESSION_STORE.md for detailed documentation on:

• Kubernetes deployment strategies
• Redis configuration options
• Testing horizontal scaling
• Security best practices

VS Code Setup

The project includes VS Code settings for:

• ✅ Automatic Poetry venv activation
• ✅ Python formatter (Black)
• ✅ Import organization
• ✅ Pytest integration

📚 Documentation

API Documentation

Once running, visit http://localhost:8020/api/docs for interactive API documentation.

Project Documentation

Comprehensive documentation is available in the docs/ directory and online:

• Online: https://bvandewe.github.io/cml-cloud-manager
• Local: Run make docs-serve and visit http://127.0.0.1:8000

Documentation Topics

• Getting Started - How to install and run the application.
• Architecture - CQRS pattern, dependency injection, design patterns
• Security - Dual auth system (session + JWT), OAuth2/OIDC, RBAC
• Development - Makefile reference, workflow, testing
• AI Agent Guide - Comprehensive guide for AI coding agents (and humans!)
• Deployment - Docker environment, deployment, configuration
• Troubleshooting - Common issues, known bugs, solutions

Documentation Commands

# Install documentation dependencies
make docs-install

# Serve documentation locally with live reload
make docs-serve

# Build documentation site
make docs-build

# Deploy to GitHub Pages (maintainers only)
make docs-deploy

Key Endpoints

Authentication

• POST /api/auth/login - Login and get JWT token

Tasks

• GET /api/tasks - Get tasks (role-filtered)
• POST /api/tasks - Create new task
• PUT /api/tasks/{task_id} - Update task (with authorization)

All task endpoints require Authorization: Bearer {token} header.

�️ Makefile Commands

The project includes a comprehensive Makefile for easy development workflow management:

Docker Commands

• make build - Build Docker image
• make dev - Build and start Docker services with logs
• make rebuild - Rebuild services from scratch (no cache)
• make up - Start services in background
• make down - Stop and remove services
• make restart - Restart all services
• make logs - Show logs from all services
• make clean - Stop services and remove volumes ⚠️

Local Development Commands

• make setup - Complete setup for new developers (install + build)
• make install - Install Python dependencies with Poetry
• make install-ui - Install Node.js dependencies
• make build-ui - Build frontend assets
• make dev-ui - Start UI dev server with hot-reload
• make run - Run application locally with auto-reload
• make run-debug - Run with debug logging

Testing & Quality Commands

• make test - Run tests
• make test-cov - Run tests with coverage report
• make lint - Run linting checks
• make format - Format code with Black

Utility Commands

• make clean - Clean up caches and generated files
• make clean-all - Clean everything including Docker volumes
• make status - Show current environment status
• make info - Display project information and URLs
• make env-check - Check environment requirements
• make help - Display all available commands

Example Workflow:

# New developer setup
make setup

# Start local development
make run

# Or use Docker
make docker-up
make docker-logs

# Stop Docker services
make docker-down

�🔗 Related Documentation

• Neuroglia Python Framework
• Simple UI Sample
• RBAC Guide
• OAuth & JWT Reference

🧪 Testing

# Run tests
poetry run pytest

🪝 Pre-Commit Hooks

Automated formatting, linting, and security checks run before you commit to keep the codebase consistent.

What's Included

• Trailing whitespace / EOF / merge conflict checks
• Black (Python formatting) + isort (imports)
• Flake8 (lint) and optional Ruff/extra rules if enabled
• Prettier for JS/TS/CSS/HTML/JSON/YAML/Markdown
• Markdownlint (auto-fix basic style issues)
• Yamllint (with relaxed config)
• Bandit (Python security scanning)
• Detect-Secrets (prevents committing secrets)

Setup

poetry add --group dev pre-commit
poetry run pre-commit install --install-hooks
poetry run pre-commit run --all-files  # Run on entire repo once

If you later update hooks:

poetry run pre-commit autoupdate

Enforcing Consistency

CI should run:

poetry run pre-commit run --all-files

DCO Reminder

Pre-commit does not enforce DCO; ensure commits include:

Signed-off-by: Your Name <[email protected]>

Use git commit -s to auto-add this line.

🔁 Rebranding / Forking as a New Project

You can turn this repository into a new project quickly without manually hunting for every cml-cloud-manager occurrence.

Option 1: Built-in Rename Script (Recommended)

Run a dry run first:

python scripts/rename_project.py --new-name "Acme Tasks" --dry-run

Apply the changes:

python scripts/rename_project.py --new-name "Acme Tasks"

This will replace variants:

• cml-cloud-manager (slug)
• cml_cloud_manager (snake)
• Cml Cloud Manager (title)
• CmlCloudManager (Pascal)
• CML_CLOUD_MANAGER (UPPER_SNAKE)
• Cml Cloud Manager API

Optional flags:

# Also adjust Keycloak realm/client identifiers (you must reconfigure Keycloak manually afterward)
python scripts/rename_project.py --new-name "Acme Tasks" --update-keycloak

# Limit to certain folders
python scripts/rename_project.py --new-name "Acme Tasks" --include src docs

# Override derived name styles explicitly
python scripts/rename_project.py --new-name "Acme Tasks" \
    --slug acme-tasks --snake acme_tasks --pascal AcmeTasks --upper ACME_TASKS

Post-rename checklist:

1. Rename the repository folder and remote (e.g., git remote set-url origin ...).
2. Adjust Docker image tags / compose service names if needed.
3. Update Keycloak realm + client IDs if --update-keycloak was used.
4. Search for any remaining branding (e.g., README examples, docs URLs).
5. Run tests: poetry run pytest -q.
6. Rebuild UI assets: make build-ui.

Option 2: GitHub Template Repo

Using GitHub's built‑in Template feature lets you create a clean copy of the repository without forking the full commit history. Workflow:

1. Maintainer: In the original repo, go to Settings → General → Enable "Template repository".
2. Consumer: Click "Use this template" (instead of Fork). GitHub scaffolds a brand‑new repo with the current contents (no upstream remote linkage).
3. In your new repo clone, run the rename script (Option 1) to apply your branding and identifiers.
4. Update any secrets / realms (Keycloak) and run tests.

Why combine both? The template feature handles repository creation & initial history isolation; the rename script performs systematic text/style replacements so you don't miss lingering cml-cloud-manager variants. If you skip the script, manual edits are error‑prone (especially mixed case variants and service identifiers).

Option 3: Cookiecutter (Future)

You can evolve this into a Cookiecutter template for parameter prompts. A future cookiecutter.json might include: app_name, slug, docker_image, keycloak_realm, enable_redis, etc.

Verify No Leftover Names

Run the rename integrity test (after the script has been applied and test added):

poetry run pytest -k rename_integrity -q

If it fails, it lists files containing residual references.

Run with coverage

poetry run pytest --cov=. --cov-report=html

📦 Deployment

Production Checklist

• Change JWT_SECRET_KEY to a strong random value
• Set DEBUG=False in settings
• Configure proper database (MongoDB/PostgreSQL)
• Set up Keycloak for production OAuth/OIDC
• Configure CORS for production domains
• Set up proper logging and monitoring
• Use environment-specific .env files

Docker Production Build

docker build -t cml-cloud-manager:latest .
docker run -p 8000:8000 cml-cloud-manager:latest

🤝 Contributing

This project follows the Neuroglia Python Framework patterns. See the development guide for more information.

📄 License

Licensed under the Apache License, Version 2.0. See LICENSE for the full text.

Copyright © 2025 Cml Cloud Manager Contributors.

You may not use this project except in compliance with the License. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.

---

Built with ❤️ using Neuroglia Python Framework