Reference
Technical reference documentation for OpenFactory.
Quick Links
| Reference | Description |
|---|---|
| Recipe Schema | Complete BuildRecipe JSON schema |
| Assertion Types | All test assertion types |
| API Reference | REST API documentation |
| ServiceNow Integration | Enterprise ITSM integration |
Resources
Build Artifacts
Every completed build produces:
| Artifact | Description |
|---|---|
| ISO image | Bootable installation media |
| Recipe JSON | Build configuration |
| Test results | Verification report |
| Build log | Complete execution log |
File Browser
Explore build contents:
- ISO contents - Mounted ISO structure
- Squashfs - Root filesystem
- Config files - Modified configurations
- Packages - Installed package list
Build Status
| Status | Description |
|---|---|
| pending | Build queued |
| building | Build in progress |
| testing | Running verification |
| completed | Build successful |
| failed | Build or test failed |
Supported Distributions
| Distribution | Codename | Package Format |
|---|---|---|
| Elster OS 12 | - | deb |
| Elster OS 13 | - | deb |
| Debian 12 | Bookworm | deb |
| Debian 13 | Trixie | deb |
| Ubuntu 24.04 | Noble | deb |
| Fedora 40 | - | rpm |
Configuration Paths
Build System
| Path | Purpose |
|---|---|
/config/packages.list.chroot | Package list |
/config/includes.chroot/ | Files to include |
/config/hooks/ | Build hooks |
/config/package-lists/ | Package lists |
Elster OS Specific
| Path | Purpose |
|---|---|
/config.boot | Vyatta configuration |
/etc/vyos/ | Vyatta system config |
Support
- Documentation: You’re here!
- GitHub Issues: Report bugs and feature requests
- Email: support@openfactory.tech