unik

README

A platform for automating unikernel & MicroVM compilation and deployment

UniK (pronounced you-neek) is a tool for compiling application sources into unikernels (lightweight bootable disk images) and MicroVM rather than binaries.

UniK runs and manages instances of compiled images across a variety of cloud providers as well as locally.

UniK utilizes a simple docker-like command line interface, making building unikernels and MicroVM as easy as building containers.

UniK is built to be easily extensible, allowing (and encouraging) adding support for unikernel/MicroVM compilers and cloud providers. See architecture for a better understanding of UniK's pluggable code design.

To learn more about the motivation behind project UniK, read our blog post, or watch session (Slides). We also encourage you to read this blog about IoT Security.

To stay up-to-date on UniK, follow us at twitter and join us on our slack channel.

---

Changelog:

Due to the frequency with which features and patches are applied to UniK, we have decided to list these changes by date in our unversioned changelog.

---

Documentation

• Installation
  • Install UniK
  • Configuring the daemon
  • Launching the InstanceListener
• Getting Started
  • Pull and run a unikernel without building on Virtualbox with UniK
  • Run your first Go MicroVM on Firecracker with Unik
  • Run your first Go unikernel on Virtualbox with UniK
  • Run your first Node.js unikernel on Virtualbox with UniK
  • Run your first Python3 unikernel on Virtualbox with UniK
  • Run your first Java unikernel on Virtualbox with UniK
  • Run your first C++ unikernel on Virtualbox with UniK
• User Documenation
  • Using the command line interface
  • Compiling Node.js Applications to Unikernels
  • Compiling Go Applications to Unikernels
  • Compiling Java Applications to Unikernels (OSv)
  • Compiling Node.js Applications to Unikernels (OSv)
  • Compiling C/C++ Applications to Unikernels (OSv)
  • Compiling C/C++ Applications to Unikernels
  • Compiling Python3 Applications to Unikernels
• Developer Documentation
  • Adding compiler support
  • Adding provider support

---

Supported unikernel types:

• Firecracker: UniK supports compiling GO code into Firecracker MicroVMs
• rump: UniK supports compiling Python, Node.js and Go code into rumprun unikernels
• OSv: UniK supports compiling Java, Node.js, C and C++ code into OSv unikernels
• IncludeOS: UniK supports compiling C++ code into IncludeOS unikernels
• MirageOS: UniK supports compiling OCaml, code into MirageOS unikernels

We are looking for community help to add support for more unikernel types and languages.

Supported providers:

• Firecracker
• Virtualbox
• AWS
• Google Cloud
• vSphere
• QEMU
• UKVM
• Xen
• OpenStack
• Photon Controller

Roadmap:

• extend unik to build & deploy Kata Containers
• extend unik to build & deploy FreeRTOS
• extend unik to build & deploy LinuxKit
• dynamic volume and application arguments configuration at instance runtime (rather than at compile time)
• expanding test coverage
• better code documentation
• multi-account support per provider (i.e. multiple AWS accounts/regions, etc.)
• migrate from martini to echo

UniK is still experimental! APIs and compatibility are subject to change. We are looking for community support to help identify potential bugs and compatibility issues. Please open a Github issue for any problems you may experience, and join us on our slack channel

---

Thanks

UniK would not be possible without the valuable open-source work of projects in the unikernel community. We would like to extend a special thank-you to Firecracker, rumprun, deferpanic, cloudius systems, mirageos and includeOS.