Go Firecracker SDK
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Initial commit Nov 15, 2018
client add metadata support and generated files Nov 30, 2018
cmd/firectl remove unnecessary flags from cli Dec 8, 2018
fctesting adding support for file based logging Dec 3, 2018
testdata Adding more verbose error messages and testdata folder Nov 29, 2018
.gitignore Adding more verbose error messages and testdata folder Nov 29, 2018
CODE_OF_CONDUCT.md Initial commit Nov 15, 2018
CONTRIBUTING.md *: update package name to firecracker-go-sdk Nov 16, 2018
COPYRIGHT_HEADER Initial (code) commit Nov 15, 2018
HACKING.md add metadata support and generated files Nov 30, 2018
LICENSE Initial commit Nov 15, 2018
Makefile add metadata support and generated files Nov 30, 2018
NOTICE Initial commit Nov 15, 2018
README.md Move most of the firectl docs to a dedicated README Nov 30, 2018
command_builder.go Merge remote-tracking branch 'origin/pr/36' Dec 10, 2018
command_builder_test.go adding support for file based logging Dec 3, 2018
doc.go godoc: add new and enhance existing documentation Dec 10, 2018
example_test.go remove unnecessary flags from cli Dec 8, 2018
firecracker.go godoc: add new and enhance existing documentation Dec 10, 2018
go.mod remove unnecessary flags from cli Dec 8, 2018
go.sum remove unnecessary flags from cli Dec 8, 2018
machine.go Merge remote-tracking branch 'origin/pr/36' Dec 10, 2018
machine_test.go remove unnecessary flags from cli Dec 8, 2018
opts.go godoc: add new and enhance existing documentation Dec 10, 2018
swagger.go swagger: disable validation Dec 5, 2018

README.md

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.