Firecracker - Revision history

Leo: troubleshooting

2021-12-31T07:10:15Z

troubleshooting

@@ Line 128: / Line 128: @@
 You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.
-== Tasks ==
+==Tasks==
-=== Custom Firecracker Images ===
+===Custom Firecracker Images===
 See: https://github.com/firecracker-microvm/firecracker/blob/master/docs/rootfs-and-kernel-setup.md
 <br />
 ==See Also==

Leo: Added categories and navbox

2021-12-30T00:48:56Z

Added categories and navbox

← Older revision		Revision as of 00:48, 30 December 2021
Line 137:		Line 137:
	*Project website - https://github.com/firecracker-microvm/firecracker		*Project website - https://github.com/firecracker-microvm/firecracker
	*The Firecracker virtual machine monitor - https://lwn.net/Articles/775736/		*The Firecracker virtual machine monitor - https://lwn.net/Articles/775736/
	*
			{{Navbox Linux}}
			[[Category:Linux]]
			[[Category:LinuxUtilities]]

Leo: /* Tasks Custom Firecracker Images */

2021-12-29T07:17:45Z

Tasks Custom Firecracker Images

← Older revision		Revision as of 07:17, 29 December 2021
Line 128:		Line 128:
	You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.		You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.

	=== ~~Tasks~~ Custom Firecracker Images ===		== Tasks ==
			=== Custom Firecracker Images ===
	See: https://github.com/firecracker-microvm/firecracker/blob/master/docs/rootfs-and-kernel-setup.md		See: https://github.com/firecracker-microvm/firecracker/blob/master/docs/rootfs-and-kernel-setup.md
	<br />		<br />

	==See Also==		==See Also==

Leo at 01:38, 15 February 2021

2021-02-15T01:38:38Z

← Older revision		Revision as of 01:38, 15 February 2021
Line 128:		Line 128:
	You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.		You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.

			=== Tasks Custom Firecracker Images ===
			See: https://github.com/firecracker-microvm/firecracker/blob/master/docs/rootfs-and-kernel-setup.md
	<br />		<br />
			==See Also==

	~~== See Also ==~~		*Project website - https://github.com/firecracker-microvm/firecracker
			*The Firecracker virtual machine monitor - https://lwn.net/Articles/775736/
	* Project website - https://github.com/firecracker-microvm/firecracker
	* The Firecracker virtual machine monitor - https://lwn.net/Articles/775736/
	*		*

Leo at 01:34, 15 February 2021

2021-02-15T01:34:49Z

← Older revision		Revision as of 01:34, 15 February 2021
Line 19:		Line 19:
	}}		}}

	== Introduction ==		==Introduction==
	Firecracker comes with two components: Firecracker which is the virtual machine monitor (VMM) itself, and a separate jailer program, which runs Firecracker inside a dedicated namespace and optionally limits what system calls can be used.		Firecracker comes with two components: Firecracker which is the virtual machine monitor (VMM) itself, and a separate jailer program, which runs Firecracker inside a dedicated namespace and optionally limits what system calls can be used. You can make use of Firecracker without the jailer component.

	~~You can make use of~~ Firecracker ~~without~~ the ~~jailer component~~.		The reason for Firecracker's speed is its minimalistic approach. It eliminates extraneous devices and the BIOS by only providing network, block, serial, and a keyboard (for shutdown) device support only.

	Firecracker can be interacted via a HTTP API using the API socket that each instance sets up. The API is optional and can be disabled.		===Running VMs===
			Firecracker can be interacted via a HTTP API using the API socket that each instance sets up. The API is optional and can be disabled using the <code>--no-api</code> flag.

	~~===Running VMs===~~
	====Basic Setup====		====Basic Setup====
	~~With all the software prerequisites set up, you can now start VMs with Firecracker.~~ The Firecracker README has some instructions on how to get your first VM running, which I will summarize below:		The Firecracker README has some instructions on how to get your first VM running, which I will summarize below:

	{{highlight\|lang=terminal\|code=		{{highlight\|lang=terminal\|code=
Line 65:		Line 65:

	====With Networking====		====With Networking====
	~~Networking~~ can ~~be set up using~~ tun/tap ~~interfaces~~ on the host.		Building on the example in the previous section, we can add networking to the guest system via a tun/tap interface on the host.

	On the host:		On the host:
Line 127:		Line 127:
	====How about internet access?====		====How about internet access?====
	You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.		You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.

			<br />

			== See Also ==

			* Project website - https://github.com/firecracker-microvm/firecracker
			* The Firecracker virtual machine monitor - https://lwn.net/Articles/775736/
			*

Leo at 01:26, 15 February 2021

2021-02-15T01:26:34Z

← Older revision		Revision as of 01:26, 15 February 2021
Line 6:		Line 6:
	Build or download the binaries from their Github repo: https://github.com/firecracker-microvm/firecracker		Build or download the binaries from their Github repo: https://github.com/firecracker-microvm/firecracker

	=== Building ===		===Building===
	{{Highlight		{{Highlight
	\| code = # docker run --rm -ti -v `pwd`/firecracker:/firecracker rust:1.49 sh		\| code = # docker run --rm -ti -v `pwd`/firecracker:/firecracker rust:1.49 sh
Line 19:		Line 19:
	}}		}}

	==~~Running VMs~~==		== Introduction ==
	~~You can interface~~ with Firecracker ~~via~~ a ~~HTTP API or with config files. The next few examples will cover usage in both~~.		Firecracker comes with two components: Firecracker which is the virtual machine monitor (VMM) itself, and a separate jailer program, which runs Firecracker inside a dedicated namespace and optionally limits what system calls can be used.

	===Basic Setup===		You can make use of Firecracker without the jailer component.

			Firecracker can be interacted via a HTTP API using the API socket that each instance sets up. The API is optional and can be disabled.

			===Running VMs===
			====Basic Setup====
	With all the software prerequisites set up, you can now start VMs with Firecracker. The Firecracker README has some instructions on how to get your first VM running, which I will summarize below:		With all the software prerequisites set up, you can now start VMs with Firecracker. The Firecracker README has some instructions on how to get your first VM running, which I will summarize below:

Line 59:		Line 64:
	The VM should boot into a functional Linux system in a few seconds. The guest OS serial console is mapped to Firecracker's standard input/output. To stop the VM, I had to kill Firecracker from another terminal.		The VM should boot into a functional Linux system in a few seconds. The guest OS serial console is mapped to Firecracker's standard input/output. To stop the VM, I had to kill Firecracker from another terminal.

	===With Networking===		====With Networking====
	Networking can be set up using tun/tap interfaces on the host.		Networking can be set up using tun/tap interfaces on the host.

Line 120:		Line 125:
	You should be able to ping the gateway <code>172.17.0.1</code>, which will be the <code>tap0</code> device on the host system.		You should be able to ping the gateway <code>172.17.0.1</code>, which will be the <code>tap0</code> device on the host system.

	==== How about internet access? ====		====How about internet access?====
	You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.		You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.

Leo at 01:17, 15 February 2021

2021-02-15T01:17:48Z

← Older revision		Revision as of 01:17, 15 February 2021
Line 1:		Line 1:
	Firecracker is a virtual machine monitor that is capable of quickly starting Linux guest VMs using KVM. It's main selling feature is the speed to start up VMs. It is developed by AWS and is used by AWS in their serverless Lambda and Fargate offerings.		Firecracker is a virtual machine monitor that is capable of quickly starting Linux guest VMs using KVM. It's main selling feature is the speed to start up VMs. It is developed by AWS and is used by AWS in their serverless Lambda and Fargate offerings.

	== Setup ==		==Setup==
	You need to have a Linux host with KVM already installed. The host must have a CPU should have virtualization flags (cat /proc/cpuinfo \| grep -iE 'vmx\|~~???~~'). /dev/kvm ~~should also be accessible~~ by ~~the~~ user ~~running the Firecracker instances~~.		You need to have a Linux host with KVM already installed. The host must have a CPU should have virtualization flags which you can verify by running <code>cat /proc/cpuinfo \| grep -iE 'vmx\|svm'</code>. Intel uses the <code>vmx</code> flag while AMD uses the <code>svm</code> flag. If you intend to run Firecracker as a normal user, ensure that <code>/dev/kvm</code> is readable by that user.

	Build or download the binaries from their Github repo: https://github.com/firecracker-microvm/firecracker		Build or download the binaries from their Github repo: https://github.com/firecracker-microvm/firecracker

	== Running VMs ==		=== Building ===
			{{Highlight
			\| code = # docker run --rm -ti -v `pwd`/firecracker:/firecracker rust:1.49 sh
			## Inside the container, run
			# git clone https://github.com/firecracker-microvm/firecracker.git

			## Build, as per the README
			# cd firecracker/
			# tools/devtool build
			# toolchain="$(uname -m)-unknown-linux-musl"
			\| lang = terminal
			}}

			==Running VMs==
	You can interface with Firecracker via a HTTP API or with config files. The next few examples will cover usage in both.		You can interface with Firecracker via a HTTP API or with config files. The next few examples will cover usage in both.

	=== Basic Setup ===		===Basic Setup===
	With all the software ~~prerequsites~~ set up, you can now start VMs with Firecracker. ~~Outlined in the~~ Firecracker README ~~is a quick guide~~ on ~~getting~~ your first VM ~~started~~:		With all the software prerequisites set up, you can now start VMs with Firecracker. The Firecracker README has some instructions on how to get your first VM running, which I will summarize below:

	{{highlight\|lang=terminal\|code=		{{highlight\|lang=terminal\|code=
Line 46:		Line 59:
	The VM should boot into a functional Linux system in a few seconds. The guest OS serial console is mapped to Firecracker's standard input/output. To stop the VM, I had to kill Firecracker from another terminal.		The VM should boot into a functional Linux system in a few seconds. The guest OS serial console is mapped to Firecracker's standard input/output. To stop the VM, I had to kill Firecracker from another terminal.

	=== With Networking ===		===With Networking===
	Networking can be set up using tun/tap interfaces on the host.		Networking can be set up using tun/tap interfaces on the host.

Line 84:		Line 97:
	"ht_enabled": false		"ht_enabled": false
	}		}
	}		<nowiki>}</nowiki>

	}}		}}
Line 94:		Line 107:
	}}		}}

	Or alternatively, pass the interface config as a kernel parameter. See: https://mjmwired.net/kernel/Documentation/filesystems/nfs/nfsroot.txt#81. In general, you pass: <code>ip=IP_ADDRESS::GATEWAY:NETMASK:HOSTNAME:DEVICE:AUTOCONFIG</code>, where AUTOCONFIG is off (for static configuration). Change the kernel arguments in the config.json file:		Or alternatively, pass the interface config as a kernel parameter. See: https://mjmwired.net/kernel/Documentation/filesystems/nfs/nfsroot.txt#81. In general, you pass: <code>ip=IP_ADDRESS::GATEWAY:NETMASK:HOSTNAME:DEVICE:AUTOCONFIG</code>, where <code>AUTOCONFIG</code> should be set to <code>off</code> for a static network configuration. Change the kernel arguments in the <code>config.json</code> file:

	{{highlight\|lang=text\|code=		{{highlight\|lang=text\|code=
Line 100:		Line 113:
	"boot-source": {		"boot-source": {
	"kernel_image_path": "hello-vmlinux.bin",		"kernel_image_path": "hello-vmlinux.bin",
	"boot_args": "console=ttyS0 reboot=k panic=1 pci=off ip=172.17.100.1::172.17.~~100~~.1:255.255.0.0::eth0:off"		"boot_args": "console=ttyS0 reboot=k panic=1 pci=off ip=172.17.100.1::172.17.0.1:255.255.0.0::eth0:off"
	},		},
	...		...
	}}		}}

	You should be able to ping the gateway, which will be the tap0 device on the host system.		You should be able to ping the gateway <code>172.17.0.1</code>, which will be the <code>tap0</code> device on the host system.

			==== How about internet access? ====
			You need to make your host route traffic and act as a NAT. You then need to specify the nameservers for the guest system.

Leo: Initial Content

2021-02-15T01:09:43Z

Initial Content

New page

Firecracker is a virtual machine monitor that is capable of quickly starting Linux guest VMs using KVM. It's main selling feature is the speed to start up VMs. It is developed by AWS and is used by AWS in their serverless Lambda and Fargate offerings.

== Setup ==
You need to have a Linux host with KVM already installed. The host must have a CPU should have virtualization flags (cat /proc/cpuinfo | grep -iE 'vmx|???'). /dev/kvm should also be accessible by the user running the Firecracker instances.

Build or download the binaries from their Github repo: https://github.com/firecracker-microvm/firecracker

== Running VMs ==
You can interface with Firecracker via a HTTP API or with config files. The next few examples will cover usage in both.

=== Basic Setup ===
With all the software prerequsites set up, you can now start VMs with Firecracker. Outlined in the Firecracker README is a quick guide on getting your first VM started:

{{highlight|lang=terminal|code=
# Obtain the kernel and initramfs
$ wget https://s3.amazonaws.com/spec.ccfc.min/img/hello/kernel/hello-vmlinux.bin
$ wget https://s3.amazonaws.com/spec.ccfc.min/img/hello/fsfiles/hello-rootfs.ext4

# Create a config file outlining the VM
$ cat <<EOF > config.json
{
"boot-source": {
"kernel_image_path": "hello-vmlinux.bin",
"boot_args": "console=ttyS0 reboot=k panic=1 pci=off"
},
"drives": [
{
"drive_id": "rootfs",
"path_on_host": "hello-rootfs.ext4",
"is_root_device": true,
"is_read_only": false
}
],
"machine-config": {
"vcpu_count": 2,
"mem_size_mib": 1024,
"ht_enabled": false
}
}
EOF

# Start the VM
$ firecracker --no-api --config-file config.json
}}

The VM should boot into a functional Linux system in a few seconds. The guest OS serial console is mapped to Firecracker's standard input/output. To stop the VM, I had to kill Firecracker from another terminal.

=== With Networking ===
Networking can be set up using tun/tap interfaces on the host.

On the host:
{{highlight|lang=terminal|code=
# ip tuntap add dev tap0 mode tap
# sysctl -w net.ipv4.conf.tap0.proxy_arp=1
# sysctl -w net.ipv6.conf.tap0.disable_ipv6=1
# ip addr add 172.17.0.1/16 dev tap0
# ip link set tap0 up
}}

Configure the VM to have this network interface with the <code>network-interfaces</code> section. The MAC address can be specified with <code>guest_mac</code> but can be left undefined for random MAC address.
{{highlight|lang=text|code=
{
"boot-source": {
"kernel_image_path": "hello-vmlinux.bin",
"boot_args": "console=ttyS0 reboot=k panic=1 pci=off"
},
"drives": [
{
"drive_id": "rootfs",
"path_on_host": "hello-rootfs.ext4",
"is_root_device": true,
"is_read_only": false
}
],
"network-interfaces": [
{
"iface_id": "eth0",
"host_dev_name": "tap0"
}
],
"machine-config": {
"vcpu_count": 2,
"mem_size_mib": 1024,
"ht_enabled": false
}
}

}}

After starting up the VM again, you should see that <code>eth0</code> is up but without an address. You will need to bring the interface up manually:
{{highlight|lang=terminal|code=
# ip addr add 172.17.100.1/16 dev eth0
# ip link set eth0 up
}}

Or alternatively, pass the interface config as a kernel parameter. See: https://mjmwired.net/kernel/Documentation/filesystems/nfs/nfsroot.txt#81. In general, you pass: <code>ip=IP_ADDRESS::GATEWAY:NETMASK:HOSTNAME:DEVICE:AUTOCONFIG</code>, where AUTOCONFIG is off (for static configuration). Change the kernel arguments in the config.json file:

{{highlight|lang=text|code=
...
"boot-source": {
"kernel_image_path": "hello-vmlinux.bin",
"boot_args": "console=ttyS0 reboot=k panic=1 pci=off ip=172.17.100.1::172.17.100.1:255.255.0.0::eth0:off"
},
...
}}

You should be able to ping the gateway, which will be the tap0 device on the host system.