arc.yaml reference

arc.yaml sits next to your docker-compose.yml. Compose runs as written, and arc.yaml says what compose cannot: which service answers HTTP, which services hold personal data and how to anonymize it, and how much the arc needs.

Every key is listed here, with its type, whether you must write it, and the errors it can raise. The file can be at most 64 KiB when you deploy.

For completion and checking as you type, put this comment on the first line of arc.yaml. Editors that use the YAML language server, such as VS Code with the Red Hat YAML extension, read it:

# yaml-language-server: $schema=https://docs.omniarc.eu/schema/arc.yaml.json

Key	Type	Required	What it is
arc	string	yes	The name of the arc this file belongs to.
compose	list of strings	no, default compose's own file lookup	The compose files to use, in order.
profiles	list of strings	no, default none	The compose profiles to turn on.
edge	none or map	yes	Which service answers HTTP for the arc, or none if nothing should.
recordsize	string, a power of two from 4KiB to 1MiB	no, default 16KiB with a deployed database, document or forge kind, otherwise 128KiB	The block size the arc's storage uses.
resources	map	no	How much CPU, memory and disk the arc needs.
ready_timeout_secs	integer, 1 to 3600	no, default 300	How many seconds OmniArc waits for the services to become ready.
services	map of service name to entry	yes	One entry for each service in your compose project.