Directories
¶
| Path | Synopsis |
|---|---|
|
Package appliance contains data on various models/revisions of appliance.
|
Package appliance contains data on various models/revisions of appliance. |
|
altIdent
Package altIdent allows reading, writing a file containing the platform's identity, for use as a fallback if the dmi data doesn't clearly identify the platform.
|
Package altIdent allows reading, writing a file containing the platform's identity, for use as a fallback if the dmi data doesn't clearly identify the platform. |
|
Common (and subpackages) contains interfaces that make it easier to avoid import cycles, swap out functionality for testing, etc.
|
Common (and subpackages) contains interfaces that make it easier to avoid import cycles, swap out functionality for testing, etc. |
|
fr
Interface for a mechanism storing data for use by factory restore
|
Interface for a mechanism storing data for use by factory restore |
|
rkeep
Some sort of external mechanism recording details about units imaged.
|
Some sort of external mechanism recording details about units imaged. |
|
rlog
Interfaces related to setting up or mocking remote logging.
|
Interfaces related to setting up or mocking remote logging. |
|
strs
Abstraction for strings that implementors will likely wish to change.
|
Abstraction for strings that implementors will likely wish to change. |
|
corer
|
|
|
backtrace
Package backtrace creates backtraces from coredumps.
|
Package backtrace creates backtraces from coredumps. |
|
opts
Package opts parses flags and stores config used elsewhere in corer.
|
Package opts parses flags and stores config used elsewhere in corer. |
|
stream
Package stream contains chainable functions acting on sizeable data streams such as cores.
|
Package stream contains chainable functions acting on sizeable data streams such as cores. |
|
testhelper
Package testhelper does setup for tests requiring a core dump.
|
Package testhelper does setup for tests requiring a core dump. |
|
Package disktag encodes and decodes disktags.
|
Package disktag encodes and decodes disktags. |
|
Package erase handles data erase of data on units, for use when a customer's data is sufficiently sensitive and they need to ship a unit without data.
|
Package erase handles data erase of data on units, for use when a customer's data is sufficiently sensitive and they need to ship a unit without data. |
|
raid
Package raid handles reading, storing, and re-writing raid metadata as necessary during the erase process.
|
Package raid handles reading, storing, and re-writing raid metadata as necessary during the erase process. |
|
Package fileutil contains various utility functions useful for dealing with files and dirs.
|
Package fileutil contains various utility functions useful for dealing with files and dirs. |
|
Package guid handles uuid's encoded in the mixed-endianness format used by microsoft and uefi.
|
Package guid handles uuid's encoded in the mixed-endianness format used by microsoft and uefi. |
|
Sub-packages of hw deal with specific hardware or other low-level interfaces.
|
Sub-packages of hw deal with specific hardware or other low-level interfaces. |
|
beep
Package beep activates PC Speaker on hardware supporting it.
|
Package beep activates PC Speaker on hardware supporting it. |
|
block
Package block contains functions dealing with linux block devices and the underlying hardware.
|
Package block contains functions dealing with linux block devices and the underlying hardware. |
|
block/md
Package md does various things with mdadm.
|
Package md does various things with mdadm. |
|
block/partitioning
Package partitioning allows creation of MBR and GPT partition tables and partitions, DESTROYING ANY EXISTING DATA.
|
Package partitioning allows creation of MBR and GPT partition tables and partitions, DESTROYING ANY EXISTING DATA. |
|
cfa
Package cfa implements communication with Crystalfontz LCDs such as CFA-631 and CFA-635, without use of CGO.
|
Package cfa implements communication with Crystalfontz LCDs such as CFA-631 and CFA-635, without use of CGO. |
|
cfa/demo
Demo app to exercise a compatible Crystalfontz LCD.
|
Demo app to exercise a compatible Crystalfontz LCD. |
|
cfa/serial
Package serial configures a serial port for use with Crystalfontz LCDs.
|
Package serial configures a serial port for use with Crystalfontz LCDs. |
|
console
Package console allows for some trivial manipulations of linux virtual terminals, such as switching which one is in the foreground, displaying messages, then switching back.
|
Package console allows for some trivial manipulations of linux virtual terminals, such as switching which one is in the foreground, displaying messages, then switching back. |
|
console/contest
Test app for console package; normal unit test won't work as the vt commands require root privs.
|
Test app for console package; normal unit test won't work as the vt commands require root privs. |
|
cpu
Package cpu allows determining topological arrangement of CPU cores, generally for use in setting RSS IRQs.
|
Package cpu allows determining topological arrangement of CPU cores, generally for use in setting RSS IRQs. |
|
dmi
Package dmi reads DMI (aka SMBIOS) data via dmidecode.
|
Package dmi reads DMI (aka SMBIOS) data via dmidecode. |
|
ioctl
Package ioctl uses IOCTL's to find block device size, adjust network interface state, etc.
|
Package ioctl uses IOCTL's to find block device size, adjust network interface state, etc. |
|
ipmi
Package ipmi interacts with the platform BMC.
|
Package ipmi interacts with the platform BMC. |
|
ipmi/uid
Package uid allows control of the IPMI UID light (AKA Chassis ID light).
|
Package uid allows control of the IPMI UID light (AKA Chassis ID light). |
|
kmsg
Package kmsg facilitates processes writing to the kernel ring buffer.
|
Package kmsg facilitates processes writing to the kernel ring buffer. |
|
nic
Package nic allows enabling/disabling NICs, configuring XPS, RFS, and RSS, etc.
|
Package nic allows enabling/disabling NICs, configuring XPS, RFS, and RSS, etc. |
|
power
Package power handles poweroff- and reboot-related functionality, including running pre-reboot (Preboot) functions registered with the housekeeping pkg.
|
Package power handles poweroff- and reboot-related functionality, including running pre-reboot (Preboot) functions registered with the housekeeping pkg. |
|
udev
Package udev allows starting udev and finding udevd if running.
|
Package udev allows starting udev and finding udevd if running. |
|
uefi
Package uefi manipulates UEFI boot entries and other variables.
|
Package uefi manipulates UEFI boot entries and other variables. |
|
Package id returns UID, GID for given user from given filesystem (not necessarily mounted at /)
|
Package id returns UID, GID for given user from given filesystem (not necessarily mounted at /) |
|
Package init implements early userspace logic in go, replacing the functionality of initramfs's /init.
|
Package init implements early userspace logic in go, replacing the functionality of initramfs's /init. |
|
consts
Package consts contains init-related consts so they can be shared outside of pkg init.
|
Package consts contains init-related consts so they can be shared outside of pkg init. |
|
housekeeping
Package housekeeping works with lists of tasks to be performed in the future.
|
Package housekeeping works with lists of tasks to be performed in the future. |
|
progress
Provides feedback on the LCD that the boot is progressing.
|
Provides feedback on the LCD that the boot is progressing. |
|
Package log is a flexible logging mechanism allowing multiple log sinks, outputting to one or more of: the console, a file, an LCD, a networked log ingester, etc.
|
Package log is a flexible logging mechanism allowing multiple log sinks, outputting to one or more of: the console, a file, an LCD, a networked log ingester, etc. |
|
lcd
Package lcd is a StackableLog that logs events to cfa.DefaultLcd, as long as those events have the EndUserFlag set.
|
Package lcd is a StackableLog that logs events to cfa.DefaultLcd, as long as those events have the EndUserFlag set. |
|
testlog
Package testlog hijacks the output of github.com/purecloudlabs/gprovision/pkg/log, and can hijack log.Cmd().
|
Package testlog hijacks the output of github.com/purecloudlabs/gprovision/pkg/log, and can hijack log.Cmd(). |
|
Package mfg is used to validate the hardware of freshly-assembled units and to image them.
|
Package mfg is used to validate the hardware of freshly-assembled units and to image them. |
|
configStep
Package configStep implements manufacturing steps that can be specified in manufData.json.
|
Package configStep implements manufacturing steps that can be specified in manufData.json. |
|
mfgflags
Package mfgflags handles flags used to alter mfg behavior for testing.
|
Package mfgflags handles flags used to alter mfg behavior for testing. |
|
qa
Package QA implements quality checks for the mfg process.
|
Package QA implements quality checks for the mfg process. |
|
Package net implements some network-related functions for recovery.
|
Package net implements some network-related functions for recovery. |
|
xfer
Package xfer handles robust file transfers, primarily for use in mfg process.
|
Package xfer handles robust file transfers, primarily for use in mfg process. |
|
Package netexport reads network config data from windows.
|
Package netexport reads network config data from windows. |
|
Sub-packages of oss contain replacements for proprietary functionality that could not be open sourced.
|
Sub-packages of oss contain replacements for proprietary functionality that could not be open sourced. |
|
frd
Minimal, OSS impl of a mechanism storing data for use by factory restore.
|
Minimal, OSS impl of a mechanism storing data for use by factory restore. |
|
pblog
Package pblog is the client for a logger using gRPC.
|
Package pblog is the client for a logger using gRPC. |
|
stash
Package stash - oss impl of stash
|
Package stash - oss impl of stash |
|
Package recovery, known alternately as factory restore, is used to overwrite the main drive of a unit with a fresh image.
|
Package recovery, known alternately as factory restore, is used to overwrite the main drive of a unit with a fresh image. |
|
archive
Package archive sorts, verifies, and extracts .upd (xz-compressed tar) files.
|
Package archive sorts, verifies, and extracts .upd (xz-compressed tar) files. |
|
disk
Package disk handles logical disks, filesystems, and boot entries for the purposes of factory restore.
|
Package disk handles logical disks, filesystems, and boot entries for the purposes of factory restore. |
|
emode
Package emode checks any emergency-mode files to determine whether they are updates, json data, or unknown.
|
Package emode checks any emergency-mode files to determine whether they are updates, json data, or unknown. |
|
history
Package history logs image success/failure to disk.
|
Package history logs image success/failure to disk. |
|
systemd
|
|
|
networkd
Package networkd can be used to write config files for systemd-networkd.
|
Package networkd can be used to write config files for systemd-networkd. |
|
status
Package status can be used to query service status, stop/start services, etc.
|
Package status can be used to query service status, stop/start services, etc. |
Click to show internal directories.
Click to hide internal directories.