Documentation
¶
Index ¶
Constants ¶
View Source
const ( // Common Ignite prefix IGNITE_PREFIX = "ignite-" // Ignite data base directory DATA_DIR = "/var/lib/firecracker" // Permissions for the data directory and its subdirectories DATA_DIR_PERM = 0755 // Filename for metadata files METADATA = "metadata.json" // DHCP infinite lease time DHCP_INFINITE_LEASE = "4294967295s" // TAP adapter prefix in the parent container TAP_PREFIX = "vm_" // Bridge device prefix in the parent container BRIDGE_PREFIX = "br_" // Timeout in seconds to wait for VM shutdown before SIGKILL STOP_TIMEOUT = 20 // Additional timeout in seconds for docker to wait for ignite to save and quit IGNITE_TIMEOUT = 10 // In-container path for the firecracker socket SOCKET_PATH = "/tmp/firecracker.sock" // In-container path for the firecracker log FIFO LOG_FIFO = "/tmp/firecracker_log.fifo" // In-container path for the firecracker metrics FIFO METRICS_FIFO = "/tmp/firecracker_metrics.fifo" // Log level for the firecracker VM VM_LOG_LEVEL = "Error" )
View Source
const ( // Some commonly used multipliers for data sizes MB = 1048576 GB = 1073741824 )
View Source
const ( // Path to directory containing a subdirectory for each image IMAGE_DIR = DATA_DIR + "/image" // Filename for the image file containing the image filesystem IMAGE_FS = "image.ext4" )
View Source
const ( // Path to directory containing a subdirectory for each kernel KERNEL_DIR = DATA_DIR + "/kernel" // Kernel filename KERNEL_FILE = "vmlinux" // Filename for the tar containing the kernel filesystem KERNEL_TAR = "kernel.tar" // The kernel image to be used as the default DEFAULT_KERNEL_IMAGE = "weaveworks/ignite-kernel:4.19.47" )
View Source
const ( // Default maximum size for the pool (if using a physical device, it's size will be used instead) POOL_DATA_SIZE_BYTES = 100 * GB // 100 GB // Default allocation size for the pool, should be between // 128 (64KB) and 2097152 (1GB). 128 is recommended if // snapshotting a lot (like we do with layers). POOL_ALLOCATION_SIZE_SECTORS = 128 // Additional space for volumes to accommodate the ext4 partition POOL_VOLUME_EXTRA_SIZE = 100 * MB // Base directory for snapshotter data SNAPSHOTTER_DIR = DATA_DIR + "/snapshotter" // Paths to the default data and metadata backing files SNAPSHOTTER_METADATA_PATH = SNAPSHOTTER_DIR + "/metadata.dm" SNAPSHOTTER_DATA_PATH = SNAPSHOTTER_DIR + "/data.dm" )
View Source
const ( // Path to directory containing a subdirectory for each VM VM_DIR = DATA_DIR + "/vm" // Default values for VM options VM_DEFAULT_CPUS = 1 VM_DEFAULT_MEMORY = 512 * MB VM_DEFAULT_SIZE = 4 * GB VM_DEFAULT_KERNEL_ARGS = "console=ttyS0 reboot=k panic=1 pci=off ip=dhcp" // SSH key template for VMs VM_SSH_KEY_TEMPLATE = "id_%s" // TODO: remove this when the old dm code is removed OVERLAY_FILE = "overlay.dm" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.