OpenFrame Documentation
Deployment guides, the CLI reference, architecture and admin guides for OpenFrame
Flamingo Raises $4.5M Seed Round · Led by Vertex Ventures, bringing total funding to $6.7M to build the open, AI-native layer for IT and security.
Deployment guides, the CLI reference, architecture and admin guides for OpenFrame
ic# Development
This section is the entry point for developers working on OpenFrame OSS Tenant — the deployable, self-hosted tenant distribution for OpenFrame (flamingo.run/openframe). This repository assembles Spring Boot services (Java), a Rust endpoint agent client, shared configuration, and Kubernetes/Helm manifests into the running MSP platform stack. Most domain logic is consumed from the OpenFrame OSS Library at pinned version 7.0.11; this repository owns the tenant-specific service entry points, runtime configuration, Helm charts, Argo CD application definitions, and the release delivery pipeline.
Use this page to find the right development document instead of digging through the whole repository tree.
If you have not yet installed the project or run it for the first time, start with Introduction, Prerequisites, Quick Start and First Steps before coming back here.
OpenFrame OSS Tenant is a multi-module Maven project (Java 25, Spring Boot 4.1.1 via spring-boot-starter-parent, Spring Cloud 2025.1.3) plus a standalone Rust client crate. The root pom.xml declares the parent POM and wires together nine service modules under openframe/services:
| Service module | Maven artifact | Role |
|---|---|---|
openframe-config |
com.openframe:openframe-config |
Spring Cloud Config Server for shared platform configuration |
openframe-api |
com.openframe:openframe-api |
Main OpenFrame API and GraphQL service |
openframe-client |
com.openframe:openframe-client |
Managed endpoint registration, delivery, telemetry, RMM coordination |
openframe-stream |
com.openframe:openframe-stream |
Kafka event processing, enrichment, log storage, software projection |
openframe-management |
com.openframe:openframe-management |
Platform initialization, reconciliation, catalog sync, scheduled jobs |
openframe-gateway |
com.openframe:openframe-gateway |
Reactive edge router, JWT boundary, API-key enforcement, tool proxy |
openframe-external-api |
com.openframe:openframe-external-api |
API-key-protected REST API for third-party integrations |
openframe-authorization-server |
com.openframe:openframe-authorization-server |
OAuth 2.0 / OpenID Connect authorization server |
openframe-test |
com.openframe:openframe-test |
Shared tenant integration and end-to-end test service artifact |
Each service module is a thin composition layer: it pulls in a corresponding *-service-core artifact from the OpenFrame OSS Library (for example openframe-api depends on com.openframe.oss:openframe-api-service-core, openframe-authorization-server depends on com.openframe.oss:openframe-authorization-service-core), adds spring-cloud-starter-config for centralized configuration, and in several cases openframe-data-redis for caching. The Rust agent in clients/openframe-client (crate openframe_client, Cargo package name openframe-client) is a thin binary over openframe-agent-lib, pulled directly from the OpenFrame OSS Library git repository at tag v0.0.5.
flowchart LR
Lib["OpenFrame OSS Library 7.0.11"] --> Tenant["OpenFrame OSS Tenant"]
Tenant --> ConfigSvc["openframe-config"]
Tenant --> ApiSvc["openframe-api"]
Tenant --> ClientSvc["openframe-client"]
Tenant --> StreamSvc["openframe-stream"]
Tenant --> MgmtSvc["openframe-management"]
Tenant --> GatewaySvc["openframe-gateway"]
Tenant --> ExtApiSvc["openframe-external-api"]
Tenant --> AuthzSvc["openframe-authorization-server"]
Tenant --> TestSvc["openframe-test"]
Tenant --> RustAgent["openframe_client (Rust agent)"]
Per the repository graph, this repository has no recorded downstream consumers inside the organization (coverage is full, so this is confirmed, not just unindexed) — its outputs are delivered as container images and a Helm app-of-apps chart rather than consumed as a library by other repositories. Everything upstream flows from the single openframe-oss-lib dependency pinned at 7.0.11 (Maven) and v0.0.5 (the openframe-agent-lib crate used by the Rust client).
The development documentation is organized into four areas, each covering a distinct concern of contributing to and operating this repository:
openframe-test module and service-level tests are structured.| Document | What it covers |
|---|---|
| Local Development | Running the Spring Boot service modules and the Rust client locally. |
| Environment Configuration | Shared configuration under configs/base, datasource wiring, and gateway routes. |
| Architecture | How the service modules, shared config, and Kubernetes manifests relate. |
| Testing | The openframe-test module and how service-level tests are organized. |
| Contributing Guidelines | How to propose and submit changes to this repository. |
| Security | Authentication, authorization server, and security boundaries. |
Use this guide to jump to the right document based on what you are trying to do.
flowchart TD
Start["I want to..."] --> RunLocally["Run services locally"]
Start --> Configure["Understand configuration"]
Start --> Understand["Understand the architecture"]
Start --> Test["Write or run tests"]
Start --> Contribute["Submit a change"]
Start --> Secure["Understand security boundaries"]
RunLocally --> LocalDev["./setup/local-development.md"]
Configure --> EnvDoc["./setup/environment.md"]
Understand --> ArchDoc["./architecture/README.md"]
Test --> TestDoc["./testing/README.md"]
Contribute --> ContribDoc["./contributing/guidelines.md"]
Secure --> SecDoc["./security/README.md"]
configs/base shared application configuration.openframe-test artifact and per-service tests are structured.If you are working inside a specific service module, these reference documents (generated from the OpenFrame OSS Library's own architecture) describe the core logic each tenant service composes:
| Tenant service | Related architecture reference |
|---|---|
openframe-api |
Openframe API Service Core |
openframe-authorization-server |
Openframe Authorization Service Core |
openframe-client (Java side) |
Openframe Client Core Java |
openframe-client (Rust agent) |
Openframe Client Core |
openframe-config |
Openframe Config Core |
openframe-external-api |
Openframe External API Service Core |
openframe-gateway |
Openframe Gateway Service Core |
openframe-management |
Openframe Management Service Core |
openframe-stream |
Openframe Stream Service Core |
openframe-test |
Openframe Test Service Core |
For the complete artifact, dependency, and delivery-chain picture (container images, Helm charts, Argo CD applications), see Ecosystem and the full Architecture Reference.
Note: The
openframe-clientCLI tooling referenced by the agent ecosystem (openframe-cli) is maintained in a separate, external repository: flamingo-stack/openframe-cli. Its installation guide and documentation live there, not in this repository.
This project does not use GitHub Issues or GitHub Discussions. Questions, bug reports, and feature discussions happen in the OpenMSP Slack community — join via the Slack invite link. For released versions of the tenant distribution, see Releases.
If you'd like a broader product overview before diving into development details, this walkthrough covers current platform functionality end to end: