Open specification of the flui.yaml application manifest — the declarative
format describing how an application is built, deployed, scaled, exposed and
linked to other building blocks on the Flui Cloud
platform.
This repository contains:
- The narrative specification (under
docs/) - JSON Schema definitions (under
schemas/) - Reference TypeScript types and a pure validator library
(under
packages/flui-spec-js/), published to npm as@flui-cloud/spec - Example manifests (under
examples/)
The flui-core reference
implementation consumes this library; the spec itself is intentionally free
of any runtime dependency on it.
apiVersion: flui.cloud/v1beta1 — the spec is published as v1beta1
following Kubernetes-style versioning. Breaking changes are still possible
during the beta phase; promotion to v1 will happen once at least two
independent implementations have used the spec for six months without
breaking changes and no fields remain marked x-flui-experimental.
For backwards compatibility the validator currently also accepts the legacy
apiVersion: flui/v1.
A single flui.yaml file describes one of two kinds:
kind |
Purpose |
|---|---|
Application |
An app built from source (e.g. a Next.js / NestJS repo) |
CatalogApp |
A pre-packaged catalog entry (e.g. PostgreSQL, Wordpress) |
apiVersion: flui.cloud/v1beta1
kind: Application
metadata:
name: my-api
deploy:
port: 3000
env:
NODE_ENV: productionpnpm add @flui-cloud/specimport { parseYaml, validate } from '@flui-cloud/spec';
const manifest = parseYaml(rawYaml);
const result = validate(manifest);
if (!result.valid) {
console.error(result.errors);
}Or validate a flui.yaml from the command line without installing anything:
npx @flui-cloud/spec validate ./flui.yaml