Default package
Get desktop application:
View/edit binary Protocol Buffers messages
service DriveMounter
drivemount.proto:7rpc MountDrive (, )
drivemount.proto:8message
drivemount.proto:12string DriveID = 1
string DestinationPath = 2
string FilesytemType = 3
repeated string Options = 4
rpc UnmountDrive (, )
drivemount.proto:9message
drivemount.proto:19string DriveID = 1
service Firecracker
fccontrol.proto:9rpc CreateVM (, )
fccontrol.proto:11Runs new Firecracker VM instance
message
firecracker.proto:8CreateVMRequest specifies creation parameters for a new FC instance
string VMID = 1
VM identifier to assign
optional MachineCfg = 2
Specifies the machine configuration for the VM
string KernelImagePath = 3
Specifies the file path where the kernel image is located
string KernelArgs = 4
Specifies the commandline arguments that should be passed to the kernel
optional RootDrive = 5
Specifies drive containing the rootfs of the VM
repeated DriveMounts = 6
Specifies additional drives whose contents will be mounted inside the VM on boot.
repeated NetworkInterfaces = 7
Specifies the networking configuration for a VM
int32 ContainerCount = 8
The number of dummy drives to reserve in advance before running FC instance.
bool ExitAfterAllTasksDeleted = 9
Whether the VM should exit after all tasks running in it have been deleted.
optional JailerConfig = 10
uint32 TimeoutSeconds = 11
string LogFifoPath = 12
string MetricsFifoPath = 13
optional BalloonDevice = 14
message
firecracker.proto:46string VMID = 1
string SocketPath = 2
string LogFifoPath = 3
string MetricsFifoPath = 4
string CgroupPath = 5
rpc PauseVM (, )
fccontrol.proto:14Pauses a VM
message
firecracker.proto:54string VMID = 1
rpc ResumeVM (, )
fccontrol.proto:17Resumes a VM
message
firecracker.proto:58string VMID = 1
rpc StopVM (, )
fccontrol.proto:20Stops existing Firecracker instance by VM ID
message
firecracker.proto:62string VMID = 1
uint32 TimeoutSeconds = 2
rpc GetVMInfo (, )
fccontrol.proto:23Returns VM info by VM ID
message
firecracker.proto:67string VMID = 1
message
firecracker.proto:71string VMID = 1
string SocketPath = 2
string LogFifoPath = 3
string MetricsFifoPath = 4
string CgroupPath = 5
string VSockPath = 6
rpc SetVMMetadata (, )
fccontrol.proto:26Sets VM's instance metadata
message
firecracker.proto:80string VMID = 1
string Metadata = 2
rpc UpdateVMMetadata (, )
fccontrol.proto:29Update Vm's instance metadata
message
firecracker.proto:85string VMID = 1
string Metadata = 2
rpc GetVMMetadata (, )
fccontrol.proto:32Get Vm's instance metadata
message
firecracker.proto:90string VMID = 1
message
firecracker.proto:94string Metadata = 1
rpc GetBalloonConfig (, )
fccontrol.proto:35Get balloon configuration
message
firecracker.proto:146string VMID = 1
message
firecracker.proto:150optional BalloonConfig = 1
rpc UpdateBalloon (, )
fccontrol.proto:38Update balloon's memory
message
firecracker.proto:141string VMID = 1
int64 AmountMib = 2
rpc GetBalloonStats (, )
fccontrol.proto:41Gets a balloon device statistics
message
firecracker.proto:154string VMID = 1
message
firecracker.proto:158int64 ActualMib = 1
Actual amount of memory (in MiB) the device is holding.
int64 ActualPages = 2
Actual number of pages the device is holding.
int64 AvailableMemory = 3
An estimate of how much memory is available (in bytes) for starting new applications, without pushing the system to swap.
int64 DiskCaches = 4
The amount of memory, in bytes, that can be quickly reclaimed without additional I/O. Typically these pages are used for caching files from disk.
int64 FreeMemory = 5
The amount of memory not being used for any purpose (in bytes).
int64 HugetlbAllocations = 6
The number of successful hugetlb page allocations in the guest.
int64 HugetlbFailures = 7
The number of failed hugetlb page allocations in the guest.
int64 MajorFaults = 8
The number of major page faults that have occurred.
int64 MinorFaults = 9
The number of minor page faults that have occurred.
int64 SwapIn = 10
The amount of memory that has been swapped in (in bytes).
int64 SwapOut = 11
The amount of memory that has been swapped out to disk (in bytes).
int64 TargetMib = 12
Target amount of memory (in MiB) the device aims to hold.
int64 TargetPages = 13
Target number of pages the device aims to hold.
int64 TotalMemory = 14
The total amount of memory available (in bytes).
rpc UpdateBalloonStats (, )
fccontrol.proto:44Updates a balloon device statistics polling interval.
message
firecracker.proto:203string VMID = 1
int64 StatsPollingIntervals = 2
service IOProxy
ioproxy.proto:7rpc State (, )
ioproxy.proto:8message
ioproxy.proto:12string ID = 1
string ExecID = 2
message
ioproxy.proto:17bool IsOpen = 1
rpc Attach (, )
ioproxy.proto:9message
ioproxy.proto:21string ID = 1
string ExecID = 2
uint32 StdinPort = 3
uint32 StdoutPort = 4
uint32 StderrPort = 5
message
types.proto:32Message to specify CNI configuration that will be used to generate a network interface for a Firecracker VM
Used in:
string NetworkName = 1
NetworkName is the name of a CNI network (as found in CNI configuration files) that will be used to generate the network interface.
string InterfaceName = 2
InterfaceName corresponds to the CNI_IFNAME parameter that will be provided to CNI plugins during invocation.
repeated string BinPath = 3
BinPath is a list of directories that will be searched when looking for CNI plugin binaries. Defaults to just "/opt/cni/bin"
string ConfDir = 4
ConfDir is the directory in which CNI configuration will be sought. If not specified, will default to "/etc/cni/conf.d".
string CacheDir = 5
CacheDir is the directory in which CNI results will be temporarily cached by the runtime. If not specified, it will default to "/var/lib/cni"
repeated Args = 6
Args corresponds to the CNI_ARGS parameter that will be provided to CNI plugins on invocation.
message
types.proto:55Used in:
string Key = 1
string Value = 2
DriveExposePolicy is used to configure the method to expose drive files. "COPY" is copying the files to the jail, which is the default behavior. "BIND" is bind-mounting the files on the jail, assuming a caller pre-configures the permissions of the files appropriately.
Used in:
COPY = 0
BIND = 1
message
types.proto:7Message to store bundle/config.json bytes
bytes JsonSpec = 1
optional RuncOptions = 2
uint32 StdinPort = 3
uint32 StdoutPort = 4
uint32 StderrPort = 5
message
types.proto:178Used in: ,
int64 AmountMib = 1
Target balloon size in MiB.
bool DeflateOnOom = 2
Whether the balloon should deflate when the guest has memory pressure.
int64 StatsPollingIntervals = 3
Interval in seconds between refreshing statistics.
message
types.proto:132Used in:
string HostPath = 1
(Required) HostPath is the path on the host to the filesystem image or device that will be mounted inside the VM.
string VMPath = 2
(Required) VMPath is the path inside the VM guest at which the filesystem image or device will be mounted.
string FilesystemType = 3
(Required) FilesystemType is the filesystem type (i.e. ext4, xfs, etc.), as used when mounting the filesystem image inside the VM. The VM guest kernel is expected to have support for this filesystem.
repeated string Options = 4
(Optional) Options are fstab-style options that the mount will be performed within the VM (i.e. ["rw", "noatime"]). Defaults to none if not specified.
optional RateLimiter = 5
(Optional) RateLimiter configuration that will be applied to the backing-drive for the VM's rootfs
bool IsWritable = 6
(Optional) If set to true, IsWritable results in the backing file for the drive being opened as read-write by the Firecracker VMM on the host, allowing writes to the image from within the guest. Defaults to false, in which case the block device in the VM will be read-only.
string CacheType = 7
(Optional) CacheType specifies the caching strategy for the block device. The supported caching strategies are: "Unsafe"(default) and "Writeback".
message
types.proto:97Message to set the machine config for a Firecracker VM
Used in:
string CPUTemplate = 1
Specifies the cpu template. Example: "T2" or "C3"
bool HtEnabled = 2
Specifies if hyper-threading should be enabled
uint32 MemSizeMib = 3
Specifies the memory size of VM This lets us create a Firecracker VM of up to 4096 TiB, which for a microVM should be large enough
uint32 VcpuCount = 4
Specifies the number of vCPUs for the VM
message
types.proto:16Message to specify network config for a Firecracker VM
Used in:
bool AllowMMDS = 1
Specifies if metadata service should be available on this network interface
optional InRateLimiter = 2
Specifies a rate limiter for incoming bytes
optional OutRateLimiter = 3
Specifies a rate limiter for outgoing bytes
optional CNIConfig = 4
CNIConfiguration specifies CNI configuration that will be used to generate a network interface for a Firecracker VM.
optional StaticConfig = 5
StaticNetworkConfiguration specifies static configuration parameters for a Firecracker VM's network interface
message
types.proto:166Message to specify an IO rate limiter with bytes/s and ops/s limits
Used in: , ,
optional Bandwidth = 1
Specifies a token bucket with bytes as tokens
optional Ops = 2
Specifies a token bucket with operations as tokens
message
types.proto:108Message to specify the block device config for a Firecracker VM
Used in:
string HostPath = 1
(Required) HostPath is the path on the host to the filesystem image or device that will supply the rootfs of the VM.
string Partuuid = 2
(Optional) If the HostPath points to a drive or image with multiple partitions, Partuuid specifies which partition will be used to boot the VM
bool IsWritable = 3
(Optional) If set to true, IsWritable results in the VM Guest's rootfs being mounted as read-write. Defaults to false, in which case the rootfs is mounted as read-only.
optional RateLimiter = 4
(Optional) RateLimiter configuration that will be applied to the backing-drive for the VM's rootfs
string CacheType = 5
(Optional) CacheType specifies the caching strategy for the block device. The supported caching strategies are: "Unsafe"(default) and "Writeback".
message
types.proto:172Message to specify a token buicket used to rate limit disk and network IO for a Firecracker VM
Used in:
int64 OneTimeBurst = 1
Specifies the initial size of the token bucket
int64 RefillTime = 2
Specifies the amount of millis it takes for the bucket to fill
int64 Capacity = 3
Specifies the number of tokens this bucket can hold
message
types.proto:79Message to specify static IP configuration that will be applied to a Firecracker VM's network interface internally
Used in:
string PrimaryAddr = 1
PrimaryAddr specifies, in CIDR notation, the primary address and subnet that a network interface will be assigned inside the VM.
string GatewayAddr = 3
GatewayAddr specifies the default gateway that a network interface should use inside the VM.
repeated string Nameservers = 4
Nameservers is a list of nameservers that the VM will be configured to use internally. Currently only up to 2 nameservers can be specified (any more in the list will be ignored) and configuration is provided to the VM via /proc/net/pnp.
message
firecracker.proto:107Used in:
string NetNS = 1
string CPUs = 2
List of the physical numbers of the CPUs on which processes in that cpuset are allowed to execute. See List Format below for a description of the format of cpus. The CPUs allowed to a cpuset may be changed by writing a new list to its cpus file. Taken from http://man7.org/linux/man-pages/man7/cpuset.7.html This is formatted as specified in the cpuset man page under "List Format" http://man7.org/linux/man-pages/man7/cpuset.7.html
string Mems = 3
List of memory nodes on which processes in this cpuset are allowed to allocate memory. See List Format below for a description of the format of mems. Taken from http://man7.org/linux/man-pages/man7/cpuset.7.html This is formatted as specified in the cpuset man page under "List Format" http://man7.org/linux/man-pages/man7/cpuset.7.html
uint32 UID = 4
uint32 GID = 5
string CgroupPath = 6
CgroupPath is used to dictate where the cgroup should be located relative to the cgroup directory which is /sys/fs/cgroup/cpu/<CgroupPath>/<vmID> if no value was provided, then /firecracker-containerd will be used as the default value
DriveExposePolicy DriveExposePolicy = 7
DriveExposePolicy is used to configure the method to expose drive files.
message
types.proto:67Message to specify static configuration parameters for a Firecracker VM's network interface
Used in:
string MacAddress = 1
Specifies the mac address for the the device
string HostDevName = 2
Specifies the name of the tap device on the host
optional IPConfig = 3
IPConfig optionally provides static IP configuration that will be configured on the VM's internal networking interface. If not specified, no IP configuration will be applied to the VM's internal nic automatically.
message
events.proto:5string VMID = 1
message
events.proto:9string VMID = 1