docs: update documentation

Author: Muhammad Yuga Nugraha

docs/configuration.md

@@ -17,22 +17,25 @@ The `MicroVMConfig` class is a dataclass that defines default configuration valu
 | `data_path` | str | "/var/lib/firecracker" | Base directory for storing Firecracker data |
 | `binary_path` | str | "/usr/local/bin/firecracker" | Path to the Firecracker binary |
 | `kernel_file` | str | "{data_path}/vmlinux-5.10.225" | Path to the Linux kernel file |
+| `initrd_file` | str | None | Path to the initrd file (optional) |
+| `init_file` | str | "/sbin/init" | Path to the init file |
 | `base_rootfs` | str | "{data_path}/rootfs.img" | Path to the base root filesystem image |
+| `overlayfs` | bool | False | Whether to use overlay filesystem |
+| `overlayfs_file` | str | None | Path to the overlay filesystem file |
 | `ip_addr` | str | "172.16.0.2" | Default IP address for microVMs |
 | `bridge` | bool | False | Whether to use bridge networking by default |
 | `bridge_name` | str | "docker0" | Default bridge interface name |
 | `mmds_enabled` | bool | False | Whether MMDS (Microvm Metadata Service) is enabled by default |
 | `mmds_ip` | str | "169.254.169.254" | Default IP address for MMDS |
-| `vcpu_count` | int | 1 | Default number of virtual CPUs |
-| `mem_size_mib` | int | 512 | Default memory size in MiB |
+| `vcpu` | int | 1 | Default number of virtual CPUs |
+| `memory` | str | 512 | Default memory size in MiB (can be specified as a number or with units like '1G') |
 | `hostname` | str | "fc-vm" | Default hostname for microVMs |
 | `verbose` | bool | False | Whether verbose logging is enabled by default |
 | `level` | str | "INFO" | Default logging level |
 | `ssh_user` | str | "root" | Default SSH user for connecting to microVMs |
 | `expose_ports` | bool | False | Whether to expose ports by default |
 | `host_port` | int | None | Default host port for port forwarding |
 | `dest_port` | int | None | Default destination port for port forwarding |
-| `nat_enabled` | bool | False | Whether to enable NAT by default |
 | `user_data` | str | None | Cloud-init user data |
 
 ## Using Custom Configuration
@@ -45,7 +48,7 @@ from firecracker import MicroVM
 # Create a microVM with custom configuration
 vm = MicroVM(
     vcpu=2,
-    mem_size_mib=1024,
+    memory=1024,
     ip_addr="192.168.100.2",
     bridge=True,
     bridge_name="br0"
@@ -63,7 +66,7 @@ from firecracker import MicroVM
 
 vm = MicroVM(
     vcpu=1,
-    mem_size_mib=256
+    memory=256
 )
 
 vm.create()
@@ -76,7 +79,7 @@ from firecracker import MicroVM
 
 vm = MicroVM(
     vcpu=4,
-    mem_size_mib=4096
+    memory=4096
 )
 
 vm.create()
@@ -168,15 +171,5 @@ For optimal performance, ensure your host system meets these requirements:
 
 - Linux kernel 4.14 or later
 - KVM enabled
-- At least 2GB of RAM
+- At least 4GB of RAM
 - At least 2 CPU cores
-
-## Best Practices
-
-1. **Resource Allocation**: Allocate only the resources your application needs. Firecracker is designed for lightweight workloads.
-
-2. **Data Persistence**: The rootfs is not persistent by default. For data persistence, consider mounting volumes or using network storage.
-
-3. **Security**: Use minimal permissions and restrict network access to enhance security.
-
-4. **Monitoring**: Implement monitoring to track resource usage and performance of your microVMs. 

docs/examples.md

@@ -25,7 +25,7 @@ from firecracker import MicroVM
 # Create a microVM with custom resources
 vm = MicroVM(
     vcpu=2,
-    mem_size_mib=1024,
+    memory=1024,
     ip_addr="192.168.100.2"
 )
 vm.create()
@@ -197,7 +197,7 @@ from firecracker import MicroVM
 # Create a microVM with appropriate resources
 vm = MicroVM(
     vcpu=2,
-    mem_size_mib=1024,
+    memory=1024,
     ip_addr="192.168.100.2"
 )
 vm.create()
@@ -225,7 +225,7 @@ from firecracker import MicroVM
 vm = MicroVM(
     name="database",
     vcpu=4,
-    mem_size_mib=4096,
+    memory=4096,
     ip_addr="192.168.100.3"
 )
 vm.create()
@@ -250,7 +250,7 @@ from firecracker import MicroVM
 vm = MicroVM(
     name="dev-env",
     vcpu=2,
-    mem_size_mib=2048,
+    memory=2048,
     ip_addr="192.168.100.4"
 )
 vm.create()