firework-gitops-example

Example GitOps repository for Firework, focused on building Firecracker-ready rootfs images from Docker images and publishing them to S3.

Related Repositories

• firework - orchestrator runtime (firework-agent, enricher, scheduler)
• firework-deployment-example - Terraform + Packer deployment on AWS

Configuration Docs

Service/config semantics are documented in the main firework repository:

• Configuration reference: https://github.com/artemnikitin/firework/tree/main/docs/configs
• Architecture details: https://github.com/artemnikitin/firework/tree/main/docs/architecture

This repository intentionally keeps only high-level pipeline guidance.

End-to-End Flow

flowchart LR
  GH[Git push to this repo] --> GHA[GitHub Actions build-images]
  GH --> WEBHOOK[Webhook to enricher]

  GHA --> IMG[S3 images bucket<br/>*-rootfs.ext4]
  WEBHOOK --> ENRICHER[enricher Lambda]
  ENRICHER --> CFG[S3 configs bucket<br/>nodes/*.yaml]

  IMG --> AGENT[firework-agent nodes]
  CFG --> AGENT
  AGENT --> VM[Firecracker microVMs reconciled]

Loading

CI Image Pipeline

The build-images workflow does the following on relevant pushes:

1. Resolves fc-init (release asset, go install, or bundled fallback build).
2. Iterates over tenants/*/*.yaml.
3. Reads source_image and optional rootfs_size_mb from each tenant file.
4. Builds <tenant>-<service>-rootfs.ext4 via scripts/docker-to-rootfs.sh.
5. Applies config overlays with precedence:
   • configs/<tenant>-<service>/ (tenant-specific)
   • then configs/<service>/ (shared)
6. Uploads resulting *-rootfs.ext4 artifacts to S3.