Concepts

Reference vocabulary for using compose_run.

Organization (Org)

Billing and permissions container. An org owns projects, members and API keys. A user can belong to multiple orgs.

Project

A logical workspace within an org. Groups related stacks (e.g. prod, staging). Identified by a project_id UUID.

Stack

A deployed instance of a docker-compose.yml. Identified by a stack_id UUID. Has its own lifecycle (deployments, logs, metrics).

Deploy (Deployment)

An execution of the deploy pipeline on a stack. Each deploy has a status (pending, running, success, failed).

API key

An authentication token attached to an org. Carries one or more scopes (e.g. deploy) that define its permissions. Used by the public webhooks.

Scope

Granular permission carried by an API key. The deploy scope authorizes triggering redeploys via webhook.

📝 Page to be completed — details and diagrams.