Documentation
Everything you need to run Ryuki — the governed control plane for multi-site infrastructure.
Getting Started
Prerequisites, database setup, first build and run.
First Test Acceptance
Normative dry-run and live vSphere test gates, evidence, and cleanup.
Architecture
The stack, component diagram, key decisions and network policy.
Platform Security Boundary
Provider-neutral identity, authorization, machine trust, secrets, audit, and production acceptance.
Configuration
Environment variables, providers and platform configuration.
Entra App Registration
OIDC / OAuth2 app registration and role setup for Entra ID.
Site Management
UN/LOCODE locations, activation and the admin API.
RBAC & Scoping
Roles, route access classes, site/environment scopes and their enforcement semantics.
Agents & Live Execution
Enrolling execution agents and the signed approval chain that gates a live apply.
Multi-Step Orchestration
Dependency-ordered step plans, disabled human per-step live approval, and system-owned compensation groundwork.
Notifications
In-app notifications, read receipts, the portal bell, and what emits them.
Using the API
Authentication, conventions, and a complete request lifecycle with curl.
API Reference
Route-by-area control-plane reference, plus a bounded machine-readable OpenAPI subset.