Skip to content
flui-cloudPublic

About

Open specification of flui.yaml, the Flui application manifest. JSON Schema and a TypeScript validator. Apache-2.0.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Flui Spec

CI Quality Gate Status Coverage Maintainability License: Apache 2.0

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 flui-core reference implementation consumes this library; the spec itself is intentionally free of any runtime dependency on it.

Status

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.

Two manifest kinds

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: production

Quickstart

pnpm add @flui-cloud/spec
import { 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

License

Apache License 2.0.

About

Open specification of flui.yaml, the Flui application manifest. JSON Schema and a TypeScript validator. Apache-2.0.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages