Skip to content

Platform Framework

Status: Implemented

Overview

The Platform Framework provides the shared foundation used by every Nivron application. Instead of duplicating common functionality across services, reusable capabilities are centralized in a single framework.

The current implementation lives under platform/framework/nivron_framework and is already consumed by the Control Plane.

Design Goals

The framework was designed to:

  • Centralize shared platform capabilities.
  • Keep applications lightweight.
  • Promote consistency across services.
  • Simplify future platform expansion.
  • Reduce duplicated code.

Current Structure

Package Responsibility
config/ Shared platform configuration.
database/ Database connectivity and sessions.
security/ Internal security components.
identifiers/ UUID v7 generation utilities.
audit/ Shared audit foundation.
observability/ Observability foundation.
identity/ Shared identity components.

Framework Architecture

flowchart TD

Application --> Configuration
Application --> Security
Application --> Database
Application --> Identifiers

Database --> PostgreSQL
Security --> APIKey
Identifiers --> UUIDv7

Shared Services

The framework currently provides the following shared capabilities:

Capability Status
Configuration Implemented
Database Connection Implemented
Database Session Implemented
API Key Validation Implemented
UUID v7 Generation Implemented
Audit Foundation Implemented
Observability Foundation Implemented

Architectural Principles

Applications should consume framework services rather than implementing common functionality locally. This approach preserves consistency, simplifies maintenance and enables platform-wide improvements from a single codebase.

  • Control Plane
  • Database Architecture
  • Identity Foundation

Next Step

Continue with Database Architecture to understand how platform data is organized and persisted.