realm

module
v0.2.8-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 23, 2026 License: AGPL-3.0

README

Realm - Lightweight orchestration service

Realm is a lightweight, embeddable, and extensible open-source orchestration service.

It's lightweight because it ships as a single executable: one binary runs as an agent on each node in the cluster and also serves as the command-line client.

It's extensible through a driver system, which lets you add support for custom workloads or node types.

It's embeddable via a C API, so other programs can drive a cluster directly.

Quick Installation

Linux / macOS:

curl -fsSL https://realm.bitomia.com/install.sh | sudo sh

Windows (PowerShell):

irm https://realm.bitomia.com/install.ps1 | sudo 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

Documentation can be found at the Realm documentation site.

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

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).

Directories

Path Synopsis
api
cpu
db
dns
id
cmd
log
realm command
dto
logging
Package logging wires third-party loggers into the agent's slog handler so that every log line the agent emits shares one destination and format.
Package logging wires third-party loggers into the agent's slog handler so that every log line the agent emits shares one destination and format.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL