Skip to content
MirageOS is a library operating system that constructs unikernels
OCaml Other
Latest commit 66f5fd9 @djs55 djs55 Merge pull request #485 from simonjbeaumont/xe-upload-fixup
xe: Start VM using UUID, not name-label
Failed to load latest commit information.
lib xe: Start VM using UUID, not name-label
lib_runtime Expose the type equality between Functoria_info and Mirage_info
lib_test Improve the implementation of the generic stack (and fix an example).
scripts Remove `nat-script.sh` from the scripts directory, to be available
types s/xmit/transmit/g
.gitignore Add documentation things to gitignore.
.merlin Enable the warnings.
.opam-config-exec update Dockerfile to work with current mirage-dev
.travis-ci.sh Use mirage-skeletong for CI.
.travis.yml Add a temporary pin to mirage-skeleton.
CHANGES.md Remove `nat-script.sh` from the scripts directory, to be available
Dockerfile Dockerfile: reduce verbosity and remove entrypoint
Makefile Add release runes
README.md minor typos in readme; remove ref to `run` phase
_oasis Better support for runtime info and fix rename to deps
_tags Updates to latest functoria API updates
build Further build fixes to remove V2 references
configure Update autogen files
mirage-types.opam Clean-up opam's dependencies of mirage and mirage-types
mirage.opam Partial revert of previous commit for conflcits.
myocamlbuild.ml Move runtime to lib_runtime/
setup.ml Update autogen files

README.md

Mirage

Mirage is a programming framework for constructing secure, high-performance network applications across a variety of cloud computing and mobile platforms. Code can be developed on a normal OS such as Linux or MacOS X, and then compiled into a fully-standalone, specialised unikernel that runs under the Xen hypervisor. Since Xen powers most public cloud computing infrastructure such as Amazon EC2, this lets your servers run more cheaply, securely and finer control than with a full software stack.

The most up-to-date documentation can be found at the homepage. The site is self-hosted and a useful example. Simpler skeleton applications are also available online.

Build Status docs

This repository

This repository includes:

  • a command-line tool to create and deploy applications with Mirage; and
  • in types/, a library of type signatures that compliant applications use.

There are several diverse backends in Mirage that require rather specialised build steps (from JavaScript to Xen unikernels), and this complexity is wrapped up in the tool.

To work with Mirage, you'll need the following prerequisites installed:

  • a working OCaml compiler (4.01.0 or higher).
  • the OPAM source package manager (1.2.0 or higher).
  • an x86_64 or armel Linux host to compile Xen kernels, or FreeBSD, OpenBSD or MacOS X for the userlevel version.

There are two stages to using mirage:

  • a configure phase where OPAM package dependencies are satisfied.
  • a build phase where the compiler and any support scripts are run.

Configuration files

mirage currently uses a configuration file to build a Mirage unikernel. While we're documenting it all, please see the lib_test directory in this repository for the regression examples. The latest instructions are also to be found at http://openmirage.org/docs

Configuring Mirage Applications

Provided that one and only one file of name <foo>.conf (where <foo> can be any string) is present in the current working directory, the command:

mirage configure

will configure your project. It will generate a Makefile and main.ml with the appropriate boilerplate for your chosen platform.

To configure for the Unix-direct target (using tap interfaces), do:

mirage configure --unix

To build for the Xen target, do:

mirage configure --xen

Building Mirage Applications

To compile your application, use:

make

Running Mirage Applications

Every mirage backend will have a different way to be deployed. On Unix, the unikernel will run as a Unix process, using a virtual interface (tap) if needed:

./mir-<project-name>

On Xen, the unikernel will run as a virtual machine. For instance, using the xl command-line tool:

xl create <project-name>.xl

Configuration files for xe and libvirt are also generated by the tool (see the files <project-name>_libvirt.xml and <project-name>.xe in the build directory).

Compiling to Xen and deploying to the cloud

In order to deploy a Mirage unikernel to Amazon EC2, you need to install the AWS tools on your machine, build a unikernel with the --xen option and then use the ec2.sh script (in directory script) in order to register your kernel with AWS. Then you can start your kernel with the web interface to AWS or any other means AWS provides to start EC2 instances.

Something went wrong with that request. Please try again.