/firecracker-go-sdk

Go Firecracker SDK

Primary LanguageGoApache License 2.0Apache-2.0

A basic Go interface to the Firecracker API

This package is a Go library to interact with the Firecracker API. There is also a command-line application that can be used to control Firecracker microVMs called firectl.

There are some Firecracker features that are not yet supported by the SDK. These are tracked as GitHub issues with the firecracker-feature label . Contributions to address missing features are welcomed.

Developing

Please see HACKING

Building

This library requires Go 1.11 and Go modules to build. A Makefile is provided for convenience, but is not required. When using the Makefile, you can pass additional flags to the Go compiler via the EXTRAGOARGS make variable.

Tools

There's a firectl tool that provides a simple command-line interface to launching a firecracker VM.

Network configuration

Firecracker, by design, only supports Linux tap devices. The SDK provides facilities to attach a tap device to the Firecracker VM, but the client is responsible for further configuration.

License

This library is licensed under the Apache 2.0 License.