Skip to main content

ONEX Infrastructure - Service integration and database infrastructure tools

Project description

ONEX Infrastructure

License: MIT Python 3.12+ Code style: ruff Type checked: mypy Pre-commit Framework: Infrastructure

Production infrastructure services for the ONEX execution layer. Handlers, adapters, and runtime services for PostgreSQL, Kafka, Consul, Vault, and Redis.

What is This?

This repository provides the infrastructure layer for ONEX-based systems. While omnibase_core defines the execution protocol and node archetypes, this package provides:

  • Handlers for external services (database, HTTP, messaging)
  • Adapters wrapping infrastructure clients
  • Event bus abstractions for Kafka/Redpanda
  • Runtime services deployable via Docker

Built on omnibase-core ^0.8.0 and omnibase-spi ^0.5.0.

Install Model

omnibase_infra serves two distinct purposes depending on how you use it:

As a library / runtime (pip install)

pip install omnibase-infra
# or
uv add omnibase-infra

This gives you the Python library and bundled runtime CLIs (onex-runtime, omni-infra, onex-status, etc.). No clone required for library use or running the runtime.

For operational bootstrapping (clone required)

The operational scripts in scripts/ are not bundled in the pip package. A local clone is required to run them:

git clone https://github.com/OmniNode-ai/omnibase_infra.git
cd omnibase_infra
uv sync

Scripts that require a clone:

  • scripts/seed-infisical.py — Populate Infisical from contract YAMLs
  • scripts/bootstrap-infisical.sh — Full first-time Infisical bootstrap
  • scripts/provision-infisical.py — Create machine identities

See CLAUDE.md — Install Model for the full decision matrix.

Quick Start

# Clone the repository
git clone https://github.com/OmniNode-ai/omnibase_infra.git
cd omnibase_infra

# Start infrastructure services with Docker
cd docker
cp .env.example .env
# Edit .env - set POSTGRES_PASSWORD (required for Docker fallback)
# Set OMNIBASE_INFRA_DB_URL (required for CLI/scripts; recommended for Docker)

docker compose -f docker-compose.infra.yml up -d

# Verify services are running
docker compose -f docker-compose.infra.yml ps

Docker Services

Self-contained infrastructure via docker-compose.infra.yml:

Service Profile Port Description
PostgreSQL default 5436 Persistence (always starts)
Redpanda default 29092 Event bus (always starts)
Valkey default 16379 Caching (always starts)
Consul consul 28500 Service discovery (optional)
Infisical secrets 8880 Secrets management (optional)
Runtime runtime 8085 ONEX runtime services (optional)

Profiles:

# Infrastructure only (default)
docker compose -f docker-compose.infra.yml up -d

# With service discovery
docker compose -f docker-compose.infra.yml --profile consul up -d

# With secrets management
docker compose -f docker-compose.infra.yml --profile secrets up -d

# Everything
docker compose -f docker-compose.infra.yml --profile full up -d

Configure via .env file - see docker/README.md for details.

Documentation

I want to... Go to...
Get started quickly Quick Start Guide
Understand the architecture Architecture Overview
Deploy with Docker Docker Guide
See a complete example Registration Walkthrough
Write a contract Contract Reference
Find implementation patterns Pattern Documentation
Read coding standards CLAUDE.md

Full documentation: docs/index.md

Repository Structure

src/omnibase_infra/
├── handlers/          # Request/message handlers
├── event_bus/         # Kafka/Redpanda abstractions
├── clients/           # Service clients
├── models/            # Pydantic models
├── nodes/             # ONEX nodes (Effect, Compute, Reducer, Orchestrator)
├── errors/            # Error hierarchy
├── mixins/            # Reusable behaviors
└── enums/             # Centralized enums

Development

# Install dependencies
uv sync

# Run tests
uv run pytest

# Type checking
uv run mypy src/omnibase_infra/

# Format code
uv run ruff format .
uv run ruff check --fix .

Pre-commit Hooks Setup

Run once after cloning:

uv run pre-commit install
uv run pre-commit install --hook-type pre-push

Contributing

See CONTRIBUTING.md for commit conventions and PR guidelines.

License

MIT License - see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omnibase_infra-0.16.0.tar.gz (6.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

omnibase_infra-0.16.0-py3-none-any.whl (3.6 MB view details)

Uploaded Python 3

File details

Details for the file omnibase_infra-0.16.0.tar.gz.

File metadata

  • Download URL: omnibase_infra-0.16.0.tar.gz
  • Upload date:
  • Size: 6.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for omnibase_infra-0.16.0.tar.gz
Algorithm Hash digest
SHA256 66e5493a9a7de316b583d9c50b17bc16c7a732de0ba253629cd8795073c2750e
MD5 baca8d1258d6cf4fc2b5112da36fadba
BLAKE2b-256 368a7189928a783a1851086ecd7aeaa727cd1a6ea6bca4fb702a791bae6dc684

See more details on using hashes here.

File details

Details for the file omnibase_infra-0.16.0-py3-none-any.whl.

File metadata

  • Download URL: omnibase_infra-0.16.0-py3-none-any.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for omnibase_infra-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ebd1c3ab870fc8b48b61573791db70095220e493fa1158492e7901afd109846
MD5 0b41d6943dbb696832bc8a12fa6b010f
BLAKE2b-256 788ccb7beea293b051a9f3cd1bb284e843e5a2640935c47121ed655572236caf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page