Skip to content
Apelora
Product Services Training Pricing Documentation GitHub Request a demo
    Documentation home
    Get started
    • Before you start
    • Try it on your workstation
    • Design your first application
    • Deploy it
    • Manage it
    • When something goes wrong
    Install and configure
    • Servers and network
    • Install Incus
    • Install Apelora
    • Sign in
    • Identity providers
    • Terminal access
    • Settings reference
    Operate
    • Runbooks: start here
    • Add a server to the cluster
    • Maintenance on a server
    • A server fails
    • Remove a server from the cluster for good
    • The cluster loses quorum
    • Reading quorum, and a rolling Incus upgrade
    • A replica fails its health check
    • An application's volumes: kept, missing or to be deleted
    • A storage problem: a pool filling up, a pool that is down, or backups that stop
    • Network incidents (OVN)
    • The control plane or the worker is down
    • Reading the Health page
    • Alerts
    • Troubleshooting with logs and the audit trail
    • Rotate Apelora's Incus certificates
    • The deploy identity cannot see its project
    • Revoke access
    • A security incident: a stolen credential, a misused account or a session you did not expect
    • Tenancy: environments' Incus projects and quotas
    • Back up and restore Apelora's own database
    • Update Apelora without internet access
    API
    • Overview
    • System
    • Inventory
    • Deployment
    • Applications
    • Cluster
    • Administration
    • Audit
    • Identity and access
    • Sessions
    • Alerts
    Reference
    • Module catalog
    • Module ports
    Concepts
    • Platform architecture
    • Component model
    • Connections and scale
    • One design at every size
    • Storage
    • Access, roles and security
    • Identity and authorization
    • Monitoring
    • Without internet access

    Project and engineering

    Project status and roadmap
    • What works today
    • Testing without hardware
    • The global fabric
    • Runtime providers
    • Roadmap to a full cloud
    Design notes
    • Deploying an application from the Studio
    • Applications view: create an application, open its canvas
    • Application-level readiness
    • Health and capacity
    • Alerts
    • Moving modules and surviving failures
    • Restarting a virtual machine
    • Enrolling a server
    • Installing a server with MAAS
    • Sign-in methods: local accounts and a directory
    • Tenancy isolation and quotas
    • Capacity: a global fabric
    • Studio architecture
    • Studio interface
    Decisions
    • 0001 · Incus-first runtime and control-plane boundaries
    • 0002 · Bare-metal provisioning through MAAS
    • 0003 · Two Incus identities; members join with single-use tokens
    • 0004 · Service discovery: stable addresses, delivered as environment; DNS optional later
    • 0005 · Access model: roles bound to scopes, applications owned by projects
    • 0006 · The parts of an application are called modules
    • 0007 · Sign-in methods: identity providers, local accounts and a directory
    • 0008 · Sectors: linking Incus clusters into one fabric
    • 0009 · A global fabric: regions, sites and sectors, with a control plane per region
    • 0010 · Installations without internet access (air-gapped and disconnected)
    • 0011 · One design at every size: same mechanisms from three servers to the global fabric
    • 0012 · Environments own restricted Incus projects that Apelora prepares; quotas are Apelora's, mirrored as Incus limits
    • 0013 · Fencing before a module restarts on another server
    • 0014 · Fencing by switching a server off through its BMC
    • 0015 · Application lifecycle verbs: Shut down, Stop, and Migrate
    Contribute
    • Disposable Incus test cluster
    • Continuous integration
    • Implementation phases
    • Fabric Console: what is missing, and the build plan
    • Lessons learned
    • Mutation testing
    • Staying in sync with upstream Incus
    • MCP and tooling: what runs where
    Documentation

    Reference

    The module catalog and the ports modules connect through.

    • Module catalogAll 83 modules: their ports, settings and which ones deploy.
    • Module portsHow ports are arranged on every module, so diagrams read the same way.
    Apelora

    Design applications, control infrastructure. Open source, on your own Linux servers.

    Product

    • Product
    • Use cases
    • Compare
    • Services
    • Training
    • Pricing

    Resources

    • Documentation
    • Source code
    • What works today
    • Report a problem

    Talk to us

    • Request a demo
    • Ask about support
    • Contact

    Legal

    • Licence: AGPL-3.0
    • Privacy policy
    • Terms of use
    • Refunds and cancellation
    • Cookie policy
    • Names and logos

    Apelora is an independent open-source project. Incus is a project of the Linux Containers community. Product names and logos in screenshots belong to their owners and appear only to show the modules the catalog offers; they imply no endorsement.