/flynn

A next generation open source platform as a service (PaaS)

Primary LanguageGoOtherNOASSERTION

Welcome to Flynn

Flynn is a next generation open source Platform as a Service (PaaS).

Unlike most PaaS's, Flynn can run stateful services as well as twelve-factor apps. This includes built-in database appliances (just Postgres to start). Flynn is modular so users can easily modify, upgrade, and replace components.

Flynn components are divided into two layers.

Layer 0 is a low-level resource framework inspired by the Google Omega paper. Layer 0 also includes service discovery.

Layer 1 is a set of higher level components that makes it easy to deploy and maintain applications and databases.

You can learn more about the project at the Flynn website.

Status

Flynn is in active development and currently unsuitable for production use.

Users are encouraged to experiment with Flynn but should assume there are stability, security, and performance weaknesses throughout the project. This warning will be removed when Flynn is ready for production use.

Please report bugs as issues on this repository after searching to see if anyone has already reported the issue.

Getting Started

Managed cluster

We have a web dashboard for launching Flynn clusters on your Amazon Web Services account.

Run your own cluster

If you want to setup and run your own Flynn cluster (either locally, on dedicated hardware or using a cloud provider) take a look at the Installation Guide.

Deploying applications

Check out the Using Flynn guide for instructions on deploying and scaling applications.

Components

Layer 0

discoverd The Flynn service discovery system.

host The Flynn host service, manages containers on each host and provides the scheduling framework.

Layer 1

blobstore A simple, fast HTTP file service.

bootstrap Bootstraps Flynn Layer 1 from a JSON manifest using the Layer 0 API.

cli Command-line Flynn HTTP API client.

controller Provides management and scheduling of applications running on Flynn via an HTTP API.

gitreceived An SSH server made specifically for accepting git pushes.

postgresql Flynn PostgreSQL database appliance.

receiver Flynn's git deployer.

router Flynn's TCP/HTTP router/load balancer.

sdutil Service discovery utility for discoverd.

slugbuilder Turns a tarball into a Heroku-style "slug" using buildpacks.

slugrunner Runs Heroku-like slugs.

taffy Taffy pulls git repos and deploys them to Flynn.

Contributing

We welcome and encourage community contributions to Flynn.

Since the project is still unstable, there are specific priorities for development. Pull requests that do not address these priorities will not be accepted until Flynn is production ready.

Please familiarize yourself with the Contribution Guidelines and Project Roadmap before contributing.

There are many ways to help Flynn besides contributing code:

  • Find bugs and file issues.
  • Improve the documentation and website.

Learn more at flynn.io.

Flynn is a trademark of Prime Directive, Inc.