Skip to content

Manifest

The manifest describes an environment: inputs, state backend, runners, and the components Orch applies and destroys.

version: orch/1.0
metadata:
id: my-env
description: Example environment
owner:
name: Platform
email: platform@example.com
state:
backend: local
config:
path: .orch
inputs:
image:
type: string
default: myapp:latest
runners:
local:
type: local
config: {}
components:
setup:
type: script
runner: local
source:
embedded: |
echo "ready=true" >> "$ORCH_OUTPUT_ENV"
outputs:
- name: ready

The manifest format is still alpha. Field names and adapter behavior may change before a stable release.

FieldRequiredDescription
versionYesManifest version. Current examples use orch/1.0.
metadataNoEnvironment metadata. Useful for humans and future remote state backends.
stateNoState backend selection. Defaults to the local backend when omitted.
inputsNoNamed values that can be supplied by flags, params files, or defaults.
runnersYesExecution targets available to components.
componentsYesOrdered component declarations. Orch builds a dependency graph from this list.

Adapter-specific config fields are documented on each adapter page: