realm

Realm - Simple orchestration service

Realm is a extendable, embeddable and simple orchestration service for different type of loads such as native processes or OCI containers.

It's simple because it is just one executable to command the cluster where Realm runs as daemon on each one of the cluster nodes. It's also extendable because it uses a driver systems to extend it with custom loads or node drivers. Managing the cluster can be commanded from command-line interface or using the REST API that each daemon exposes. It's embeddable because Realm provides a C API to interface with clusters.

Getting Started

Realm running as client does not require any external dependencies. For daemon installation on Linux or Windows, see the Getting Started Guide.

Documentation

• Getting Started - Installation and setup for Linux and Windows
• Configuration - Configuration reference (daemon, nodes, loads, etcd, registries, discovery, environment variables)
• Container Driver - Container driver: entrypoint, volumes, networking
• Process Driver - Process driver: commands, signals, lifecycle
• Development Guide - Development environment setup
• Contributing - Contributing guidelines

Configuration

Realm is configured through a YAML file with four top-level sections: daemon, nodes, loads, and discovery. Configuration values can also be set via environment variables with the REALM_ prefix. See the full Configuration Reference for details.

Contributing

Please follow the contributing guidelines to ensure code quality and consistency.

Project Structure

realm/
├── cmd/                   # Command-line interface
├── daemon/                # Daemon implementation
├── drivers/               # Standard drivers
├── internal/              # Private application code
├── config/                # Configuration management
├── dev/                   # Development tools and scripts
└── docs/                  # Documentation

Development Environment

See the Development Guide for setting up your development environment on Debian 12 or Windows 11 Pro.

License

Realm is dual-licensed:

Open Source License: AGPL-3.0

The open-source version of Realm is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

Commercial License

If you cannot comply with AGPL-3.0 requirements, we offer commercial licenses that allow you to:

• Use Realm in proprietary/closed-source applications
• Embed Realm via the C API without open-sourcing your code
• Offer Realm-based services without releasing your source code
• Receive enterprise support and SLA guarantees
• Access professional services and custom development

For commercial licensing options and pricing, contact licensing@bitomia.com.

Copyright (C) 2024-2025 Bitomia Software SLU. All rights reserved.