Firecracker-land

This repository contains a GoLang project that leverages Firecracker to create and manage virtual machines (VMs). Follow the instructions below to set up and run the project. (This is prototype of firecracker demo testing golang codes)

Prerequisites

Before running this project, ensure that you have the following dependencies installed:

• Go: Installation Guide
• Task: Installation Guide
• Firecracker & Jailer binary: Installation Guide

Getting Started

1. Clone the repository:

   git clone https://github.com/iradukunda1/firecracker-land.git
   cd firecracker-land
   

2. To pull a customized kernel image into the current location of the project, use the kernel task:

   task pull-kernel
   

3. Build the binary using the build task:

   task build

this will generate an executable binary file in the project's root directory.

4. Run below command to generate init process and initrd

task gen-init && task gen-initrd

5. Run the project using the run task:

   task run

6. Run this command to setting up and run project:

   task all

The application will start running on localhost:8080.

Available Endpoints

The following endpoints are available for interacting with the application:

• /api/create: This endpoint is used to create a new VM. It expects the location or name of you docker container image as input and name.
• /api/delete: This endpoint is used to delete a VM. It requires the VM ID to be provided as the request body.

1. Create a VM using /api/machines:

   
   curl -X POST -H "Content-Type: application/json" -d '{"image": "Docker container name","name":"my-hello-vm"}' http://localhost:8080/api/machines
   
   

   Replace /path/to/rootfs.img with the actual path to the rootfs image you want to use.

2. Delete a VM using /api/machines/{vm_id}:

   curl -X DELETE -H "Content-Type: application/json" http://localhost:8080/api/machines/{vm_id}

3. List a VMS using /api/machines/list:

   curl -X GET -H "Content-Type: application/json" http://localhost:8080/api/machines/list

4. Find a VM using /api/machines/{vm_id}:

   curl -X GET -H "Content-Type: application/json" http://localhost:8080/api/machines/{vm_id}

Please note that you need to have the server running (task run) before executing these curl commands. Make sure to replace localhost:8080 with the appropriate host and port if you are running the server on a different location.

Feel free to modify the request bodies or endpoints as needed for your testing purposes.