Firecracker API module.
npm install firecrackerode-ptyNode.js client for Amazon's Firecracker MicroVM platform.
npm install firecrackerode
* Check Fireracker API documentation for more details.
To use firecrackerode first you need to instantiate it:
`` js`
var Firecracker = require('firecrackerode');
var firecracker = new Firecracker({socketPath: '/tmp/firecracker.socket'});
` js`
//https://s3.amazonaws.com/spec.ccfc.min/img/hello/kernel/hello-vmlinux.bin
firecracker.bootSource({
'kernel_image_path': process.cwd() + '/images/hello-vmlinux.bin',
'boot_args': 'console=ttyS0 reboot=k panic=1 pci=off'
}).then(function(data) {
//https://s3.amazonaws.com/spec.ccfc.min/img/hello/fsfiles/hello-rootfs.ext4
var drive = firecracker.drive('rootfs');
return drive.updatePreboot({
'path_on_host': process.cwd() + '/images/hello-rootfs.ext4',
'is_root_device': true,
'is_read_only': false
});
}).then(function(data) {
return firecracker.action('InstanceStart');
}).then(function(data){
console.log('MicroVM booted!');
}).catch(function(err) {
console.log(err);
});
` js
//Downloading an image
firecracker.downloadImage('https://s3.amazonaws.com/spec.ccfc.min/img/hello/kernel/hello-vmlinux.bin', os.tmpdir() + '/hello-vmlinux.bin').then(function () {
console.log('Kernel image downloaded!');
}).catch(function(err) {
console.log(err);
});
//Spawn Firecracker process
firecracker.spawn().then(function () {
console.log('Firecracker spawned!');
}).catch(function(err) {
console.log(err);
});
//Kill Firecracker process
firecracker.kill()
`
* You need a KVM host.
* Tests are implemented using mocha and chai. Run them with npm test`.
Check the examples folder for more specific use cases examples.
Pedro Dias - @pedromdias
Licensed under the Apache license, version 2.0 (the "license"); You may not use this file except in compliance with the license. You may obtain a copy of the license at:
http://www.apache.org/licenses/LICENSE-2.0.html
Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.