README
¶
//osbase
osbase is our SDK for building an operating system. It contains low-level building blocks for making a "mini OS" such as ktest, the cloud agent or Monogon OS itself.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bootparam implements encoding and decoding of Linux kernel command lines as documented in https://docs.kernel.org/admin-guide/kernel-parameters.html
|
Package bootparam implements encoding and decoding of Linux kernel command lines as documented in https://docs.kernel.org/admin-guide/kernel-parameters.html |
|
ref
Package ref provides the reference implementation for kernel command line parsing as present in the Linux kernel.
|
Package ref provides the reference implementation for kernel command line parsing as present in the Linux kernel. |
|
Package bringup implements a simple wrapper which configures all default mounts, logging and the corresponding forwarder ttyS0.
|
Package bringup implements a simple wrapper which configures all default mounts, logging and the corresponding forwarder ttyS0. |
|
test
command
|
|
|
build
|
|
|
fwprune
command
fwprune is a buildsystem utility that filters linux-firmware repository contents to include only files required by the built-in kernel modules, that are specified in modules.builtin.modinfo.
|
fwprune is a buildsystem utility that filters linux-firmware repository contents to include only files required by the built-in kernel modules, that are specified in modules.builtin.modinfo. |
|
genproductinfo
command
genproductinfo generates a product info JSON file from arguments and stamping.
|
genproductinfo generates a product info JSON file from arguments and stamping. |
|
kconfig-patcher
command
|
|
|
mkcpio
command
|
|
|
mkerofs
command
mkerofs takes a specification in the form of a prototext file (see fsspec next to this) and assembles an EROFS filesystem according to it.
|
mkerofs takes a specification in the form of a prototext file (see fsspec next to this) and assembles an EROFS filesystem according to it. |
|
mkoci
command
|
|
|
mkoci/index
command
|
|
|
mkpayload
command
mkpayload is an objcopy wrapper that builds EFI unified kernel images.
|
mkpayload is an objcopy wrapper that builds EFI unified kernel images. |
|
mkucode
command
This assembles standalone microcode files into the format expected by the Linux microcode loader.
|
This assembles standalone microcode files into the format expected by the Linux microcode loader. |
|
mkverity
command
This package implements a command line tool that creates dm-verity hash images at a selected path, given an existing data image.
|
This package implements a command line tool that creates dm-verity hash images at a selected path, given an existing data image. |
|
package devicemapper is a thin wrapper for the devicemapper ioctl API.
|
package devicemapper is a thin wrapper for the devicemapper ioctl API. |
|
Package efivarfs provides functions to read and manipulate UEFI runtime variables.
|
Package efivarfs provides functions to read and manipulate UEFI runtime variables. |
|
Package event defines and implements Event Values, a mechanism in which multiple consumers can watch a value for updates in a reliable way.
|
Package event defines and implements Event Values, a mechanism in which multiple consumers can watch a value for updates in a reliable way. |
|
Package fat32 implements a writer for the FAT32 filesystem.
|
Package fat32 implements a writer for the FAT32 filesystem. |
|
Package fsquota provides a simplified interface to interact with Linux's filesystem qouta API.
|
Package fsquota provides a simplified interface to interact with Linux's filesystem qouta API. |
|
quotactl
Package quotactl implements a low-level wrapper around the modern portion of Linux's quotactl() syscall.
|
Package quotactl implements a low-level wrapper around the modern portion of Linux's quotactl() syscall. |
|
Package gpt implements reading and writing GUID Partition Tables as specified in the UEFI Specification.
|
Package gpt implements reading and writing GUID Partition Tables as specified in the UEFI Specification. |
|
Package kexec allows executing subsequent kernels from Linux userspace.
|
Package kexec allows executing subsequent kernels from Linux userspace. |
|
Package logbuffer implements a fixed-size in-memory ring buffer for line-separated logs.
|
Package logbuffer implements a fixed-size in-memory ring buffer for line-separated logs. |
|
Package logtree implements a tree-shaped logger for debug events.
|
Package logtree implements a tree-shaped logger for debug events. |
|
unraw
Package unraw implements a facility to convert raw logs from external sources into leveled logs.
|
Package unraw implements a facility to convert raw logs from external sources into leveled logs. |
|
Package loop implements an interface to configure Linux loop devices.
|
Package loop implements an interface to configure Linux loop devices. |
|
Package msguid provides functions to convert UUIDs/GUIDs to and from Microsoft's idiosyncratic "mixed-endian" format.
|
Package msguid provides functions to convert UUIDs/GUIDs to and from Microsoft's idiosyncratic "mixed-endian" format. |
|
net
|
|
|
dhcp4c
Package dhcp4c implements a DHCPv4 Client as specified in RFC2131 (with some notable deviations).
|
Package dhcp4c implements a DHCPv4 Client as specified in RFC2131 (with some notable deviations). |
|
dhcp4c/callback
Package callback contains minimal callbacks for configuring the kernel with options received over DHCP.
|
Package callback contains minimal callbacks for configuring the kernel with options received over DHCP. |
|
dhcp4c/transport
Package transport contains Linux-based transports for the DHCP broadcast and unicast specifications.
|
Package transport contains Linux-based transports for the DHCP broadcast and unicast specifications. |
|
dns
Package dns provides a DNS server for resolving services against.
|
Package dns provides a DNS server for resolving services against. |
|
dns/forward
Package forward implements a forwarding proxy.
|
Package forward implements a forwarding proxy. |
|
dns/forward/cache
Package cache implements a cache.
|
Package cache implements a cache. |
|
dns/forward/proxy
Package proxy implements a forwarding proxy.
|
Package proxy implements a forwarding proxy. |
|
dns/forward/up
Package up is used to run a function for some duration.
|
Package up is used to run a function for some duration. |
|
dns/kubernetes
Package kubernetes provides the kubernetes backend.
|
Package kubernetes provides the kubernetes backend. |
|
dns/kubernetes/object
Package object holds functions that convert the objects from the k8s API in to a more memory efficient structures.
|
Package object holds functions that convert the objects from the k8s API in to a more memory efficient structures. |
|
dump/cli
command
|
|
|
sshtakeover
Package sshtakeover provides an ssh.Client wrapper which provides utilities for taking over a machine over ssh, by uploading an executable and other payloads, and then executing the executable.
|
Package sshtakeover provides an ssh.Client wrapper which provides utilities for taking over a machine over ssh, by uploading an executable and other payloads, and then executing the executable. |
|
Package nvme provides methods and data structures for issuing commands to device speaking the NVMe protocol.
|
Package nvme provides methods and data structures for issuing commands to device speaking the NVMe protocol. |
|
Package oci contains tools for handling OCI images.
|
Package oci contains tools for handling OCI images. |
|
osimage
Package osimage allows reading OS images represented as OCI artifacts, and contains the types for the OS image config.
|
Package osimage allows reading OS images represented as OCI artifacts, and contains the types for the OS image config. |
|
registry
Package registry contains a client and server implementation of the OCI Distribution spec.
|
Package registry contains a client and server implementation of the OCI Distribution spec. |
|
package pki implements an x509 PKI (Public Key Infrastructure) system backed on etcd.
|
package pki implements an x509 PKI (Public Key Infrastructure) system backed on etcd. |
|
The pstore package provides functions for interfacing with the Linux kernel's pstore (persistent storage) system.
|
The pstore package provides functions for interfacing with the Linux kernel's pstore (persistent storage) system. |
|
INCITS 502 Revision 19 / SPC-5 R19
|
INCITS 502 Revision 19 / SPC-5 R19 |
|
Package smbios implements parsing of SMBIOS data structures.
|
Package smbios implements parsing of SMBIOS data structures. |
|
Package structfs defines a data structure for a file system, similar to the fs package but based on structs instead of interfaces.
|
Package structfs defines a data structure for a file system, similar to the fs package but based on structs instead of interfaces. |
|
Implementation included in this file was written with the aim of easing integration with the interface exposed at /sys/class/block.
|
Implementation included in this file was written with the aim of easing integration with the interface exposed at /sys/class/block. |
|
test
|
|
|
cmd
Package cmd contains helpers that abstract away the chore of starting new processes, tracking their lifetime, inspecting their output, etc.
|
Package cmd contains helpers that abstract away the chore of starting new processes, tracking their lifetime, inspecting their output, etc. |
|
ktest
command
ktest is a test launcher for running tests inside a custom kernel and passes the results back out.
|
ktest is a test launcher for running tests inside a custom kernel and passes the results back out. |
|
ktest/init
command
ktestinit is an init designed to run inside a lightweight VM for running tests in there.
|
ktestinit is an init designed to run inside a lightweight VM for running tests in there. |
|
qemu
Package qemu implements test harnesses for running qemu VMs from tests.
|
Package qemu implements test harnesses for running qemu VMs from tests. |
|
socksproxy
Package socksproxy implements a limited subset of the SOCKS 5 (RFC1928) protocol in the form of a pluggable Proxy object.
|
Package socksproxy implements a limited subset of the SOCKS 5 (RFC1928) protocol in the form of a pluggable Proxy object. |
|
eventlog
Taken and pruned from go-attestation under Apache 2.0
|
Taken and pruned from go-attestation under Apache 2.0 |
|
eventlog/internal
Taken from go-attestation under Apache 2.0
|
Taken from go-attestation under Apache 2.0 |
|
This package implements the minimum of functionality needed to generate and map dm-verity images.
|
This package implements the minimum of functionality needed to generate and map dm-verity images. |
|
Package watchdog provides access to hardware watchdogs.
|
Package watchdog provides access to hardware watchdogs. |
Click to show internal directories.
Click to hide internal directories.