diff --git a/docs/getting-started.md b/docs/getting-started.md index 897073a82..546506a38 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -212,13 +212,16 @@ configuration file has the following fields: `firecracker` located in its working directory. A fully-qualified path to the `firecracker` binary is recommended, as the working directory typically changes every execution when run by containerd. -* `kernel_image_path` (required) - A path where the kernel image file is - located. A fully-qualified path is recommended. +* `kernel_image_path` (optional) - A path where the kernel image file is + located. A fully-qualified path is recommended. If left undefined, the + runtime looks for a file named + `/var/lib/firecracker-containerd/runtime/default-vmlinux.bin`. * `kernel_args` (optional) - Arguments for the kernel command line. If left undefined, the runtime specifies "console=ttyS0 noapic reboot=k panic=1 pci=off nomodules rw". -* `root_drive` (required) - A path where the root drive image file is located. A - fully-qualified path is recommended. +* `root_drive` (optional) - A path where the root drive image file is located. A + fully-qualified path is recommended. If left undefined, the runtime looks for + a file named `/var/lib/firecracker-containerd/runtime/default-rootfs.img`. * `cpu_count` (required) - The number of vCPUs to make available to a microVM. * `cpu_template` (required) - The Firecracker CPU emulation template. Supported values are "C3" and "T2". diff --git a/docs/quickstart.md b/docs/quickstart.md index 1393e942d..2107e2809 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -133,13 +133,12 @@ cd ~ # Configure the aws.firecracker runtime sudo mkdir -p /var/lib/firecracker-containerd/runtime -sudo cp hello-rootfs.ext4 hello-vmlinux.bin /var/lib/firecracker-containerd/runtime +sudo cp hello-rootfs.ext4 /var/lib/firecracker-containerd/runtime/default-rootfs.img +sudo cp hello-vmlinux.bin /var/lib/firecracker-containerd/runtime/default-vmlinux.bin sudo mkdir -p /etc/containerd sudo tee -a /etc/containerd/firecracker-runtime.json <