README.md

Flintlock - Create and manage the lifecycle of MicroVMs, backed by containerd.

What is regnite?

Flintlock is a service for creating and managing the lifecycle of microVMs on a host machine. Initially we will be supporting Firecracker.

The primary use case for flintlock is to create microVMs on a bare-metal host where the microVMs will be used as nodes in a virtualized Kubernetes cluster. It is an essential part of Liquid Metal and will ultimately be driven by Cluster API Provider Microvm (coming soon).

Features

Using API requests (via gRPC or HTTP):

• Create, update, delete microVMs using Firecracker
• Manage the lifecycle of microVMs (i.e. start, stop, pause)
• Make metadata available to microVMs to support cloud-init, ignition etc
• Use OCI images for the volumes, kernel & initrd
• (coming soon) Use CNI to configure the network for the microVMs

Documentation

See our getting started with flintlock guide.

Contributing

Contributions are welcome. Please read the CONTRIBUTING.md and our Code Of Conduct.

Other interesting resources include:

• The issue tracker
• The list of milestones
• Architectural Decision Records (ADR)
• Getting started with flintlock

Getting Help

If you have any questions about, feedback for or problems with flintlock:

• File an issue.

Your feedback is always welcome!

License

MPL-2.0 License