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 agent 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 agent exposes. It's embeddable because Realm provides a C API to interface with clusters.

Quick Installation

Linux:

curl -fsSL https://raw.githubusercontent.com/bitomia/realm/main/install.sh | sh

Windows (PowerShell):

irm https://raw.githubusercontent.com/bitomia/realm/main/install.ps1 | iex

The install location can be overridden via the REALM_INSTALL_DIR environment variable.

Getting Started

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

Documentation

• Getting Started - Installation and setup for Linux and Windows
• Configuration - Configuration reference (agent, 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: agent, 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
├── agent/                 # Agent 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).