Skip to main content
Version: 029-rc3

Pantavisor Configuration

note

This reference page presents the newly unified configuration key syntax. To get to the deprecated but still supported previous format, you will have to go here.

Summary

note

The key syntax is the same for all configuration levels.

note

All keys are case insensitive.

note

Syntax and behavior of keys tagged with (experimental) might change and break backwards compatibility.

This table contains the currently supported list of configuration keys, sorted alphabetically.

KeyValueDefaultDescription
PH_CREDS_HOSTIP or hostnameapi.pantahub.comset Pantacor Hub address
PH_CREDS_IDstringemptyset Pantacor Hub device ID
PH_CREDS_PORTport443set port for communication with Pantacor Hub
PH_CREDS_PROXY_HOSTIP or hostnameemptyset Pantacor Hub proxy address
PH_CREDS_PROXY_NOPROXYCONNECT0 or 10disable proxy communication with Pantacor Hub
PH_CREDS_PROXY_PORTport3218set port for proxy communication with Pantacor Hub
PH_CREDS_PRNstringemptyset Pantacor Hub device PRN
PH_CREDS_SECRETstringemptyset Pantacor Hub credentials secret
PH_CREDS_TYPEbuiltinbuiltinset Pantacor Hub credentials type
PH_FACTORY_AUTOTOKtokenemptyset factory auto token for communication with Pantacor Hub
PH_LIBEVENT_HTTP_RETRIESnumber of retries1set HTTP request number of retries for communication with Pantacor Hub
PH_LIBEVENT_HTTP_TIMEOUTtime (in seconds)60set HTTP request timeout for communication with Pantacor Hub
PH_METADATA_DEVMETA_INTERVALtime (in seconds)10set push interval for device metadata to Pantacor Hub
PH_METADATA_USRMETA_INTERVALtime (in seconds)5set refresh interval for user metadata from Pantacor Hub
PH_ONLINE_REQUEST_THRESHOLDnumber of failures0number of failed requests to Pantacor Hub allowed to still consider device online
PH_UPDATER_INTERVALtime (in seconds)60set time between Pantacor Hub update requests
PH_UPDATER_NETWORK_TIMEOUTtime (in seconds)120set time before rollback if device cannot communicate with Pantacor Hub
PH_UPDATER_TRANSFER_MAX_COUNTnumber of transfers5set maximum number of object transfers to and from Pantacor Hub during updates
PV_BOOTLOADER_FITCONFIGstringemptyset FIT configuration name
PV_BOOTLOADER_MTD_ENVstringemptyset MTD name for bootloader env
PV_BOOTLOADER_MTD_ONLY0 or 10enable MTD for bootloader env
PV_BOOTLOADER_TYPEuboot, uboot-ab, uboot-pvk, rpiab or grububootset bootloader type
PV_BOOTLOADER_UBOOTAB_A_NAMEstringfitAname of the partition to use as "A" in uboot-ab mode
PV_BOOTLOADER_UBOOTAB_B_NAMEstringfitBname of the partition to use as "B" in uboot-ab mode
PV_BOOTLOADER_UBOOTAB_ENV_BAK_NAMEstringemptyname of the partition where the uboot environment is backed up
PV_BOOTLOADER_UBOOTAB_ENV_NAMEstringemptyname of the partition where the uboot environment is stored
PV_BOOTLOADER_UBOOTAB_ENV_OFFSEToffset in bytes0environment offset from the beginning of the partition
PV_BOOTLOADER_UBOOTAB_ENV_SIZEsize in bytes0size of the uboot environment
PV_CACHE_DEVMETADIRpath/storage/cache/devmetaset persistent device metadata dir
PV_CACHE_USRMETADIRpath/storage/cache/metaset persistent user metadata dir
PV_CONTROL_REMOTE0 or 11allow remote control from Pantacor Hub
PV_CONTROL_REMOTE_ALWAYS0 or 10keep communication with Pantacor Hub even when a local revision is running
PV_DEBUG_SHELL0 or 11enable local debug shell
PV_DEBUG_SHELL_AUTOLOGIN0 or 10enable autologin for debug shell
PV_DEBUG_SHELL_TIMEOUTtime (in seconds)60time that Pantavisor waits before rebooting if debug shell console is opened
PV_DEBUG_SSH0 or 11enable SSH debug access
PV_DEBUG_SSH_AUTHORIZED_KEYSstringemptyset authorized keys for SSH debug access
PV_DISK_EXPORTSDIRpath/exportsset exports directory
PV_DISK_VOLDIRpath/volumesset volumes directory
PV_DISK_WRITABLEDIRpath/writableset writable directory
PV_DROPBEAR_CACHE_DIRpath/storage/cache/dropbearset debug ssh server cache directory
PV_LIBEVENT_DEBUG_MODE0 or 10enable event loop debug logs
PV_LIBTHTTP_CERTSDIRpath/certsset certificates directory for libthttp
PV_LIBTHTTP_LOG_LEVEL0 to 53set libthttp log verbosity level
PV_LOG_BUF_NITEMSinteger128set in-memory logs buffer size
PV_LOG_CAPTURE0 or 11capture logs from containers
PV_LOG_CAPTURE_DMESG0 or 11capture dmesg logs
PV_LOG_DIRpath/storage/logs/set logs directory
PV_LOG_DIR_MAXSIZEinteger with optional suffix B(default),K,KB,M,MB,G,GB,T,TB,%; 0 for auto 10% (100% if tmpfs)16777216max size of log directory
PV_LOG_FILETREE_TIMESTAMP_FORMATformat stringemptytimestamp format for filetree logs
PV_LOG_HYSTERESIS_FACTORpositive integer4controls the gap between high and low watermarks for log directory cleanup
PV_LOG_LEVEL0 to 50set Pantavisor log level (0: FATAL to 5: ALL)
PV_LOG_LOGGERS0 or 11enable loggers for containers
PV_LOG_PUSH0 or 11push logs to Pantacor Hub
PV_LOG_ROTATE_FACTORinteger5determines per-file rotation threshold for log directory cleanup
PV_LOG_SERVER_OUTPUTSstringfiletreeset log server outputs (comma separated)
PV_LOG_AUTO_DEVLOG0 or 11globally enable or disable the /dev/log bind-mount into containers; can be overridden per-container with dev-log in run.json
PV_LOG_SINGLEFILE_TIMESTAMP_FORMATformat stringemptytimestamp format for single-file logs
PV_LOG_STDOUT_TIMESTAMP_FORMATformat stringemptytimestamp format for stdout logs
PV_LXC_LOG_LEVEL0 to 52set LXC log level
PV_NET_BRADDRESS4IP address10.0.3.1set bridge IPv4 address
PV_NET_BRDEVinterface namelxcbr0set bridge device name
PV_NET_BRMASK4IP mask255.255.255.0set bridge IPv4 mask
PV_OEM_NAMEstringemptyset OEM name for configuration overrides
PV_POLICYstringemptyset policy name for configuration
PV_REMOUNT_POLICYstringemptyset remount policy name for filesystem remounting
PV_REVISION_RETRIESinteger10number of retries for revision transitions
PV_SECUREBOOT_CHECKSUM0 or 11enable artifact checksum validation
PV_SECUREBOOT_HANDLERS0 or 11enable handlers verification
PV_SECUREBOOT_MODEdisabled, audit, lenient or strictlenientset secureboot mode
PV_SECUREBOOT_OEM_TRUSTSTOREpath/etc/pantavisor/certs/oemset path to OEM truststore
PV_SECUREBOOT_TRUSTSTOREpath/etc/pantavisor/certsset path to Pantavisor truststore
PV_STORAGE_DEVICEstringemptyset storage device name
PV_STORAGE_FSTYPEstringemptyset storage filesystem type
PV_STORAGE_GC_KEEP_FACTORY0 or 10keep factory revision during GC
PV_STORAGE_GC_RESERVEDpercentage5reserved storage percentage for GC
PV_STORAGE_GC_THRESHOLDpercentage0storage GC threshold percentage
PV_STORAGE_GC_THRESHOLD_DEFERTIMEtime (in seconds)600defer time for GC threshold
PV_STORAGE_LOGTEMPSIZEsize stringemptyset size for temporary log storage
PV_STORAGE_MNTPOINTpathemptyset storage mount point
PV_STORAGE_MNTTYPEstringemptyset storage mount type
PV_STORAGE_FIRMWARE_VOL0 or 10use bsp volume pv--firmware as alternate kernel firmware load path (written to /sys/module/firmware_class/parameters/path); requires the volume to be declared in device.json
PV_STORAGE_PHCONFIG_VOL0 or 10use volume for Pantahub configuration
PV_STORAGE_WAITtime (in seconds)5time to wait for storage device
PV_SYSCTL_*stringset any kernel sysctl at runtime; key maps to /proc/sys/ (e.g. PV_SYSCTL_KERNEL_CORE_PATTERN/proc/sys/kernel/core_pattern)
PV_SYSCTL_KERNEL_CORE_PATTERNstring|/lib/pv/pvcrash --skipset kernel core dump pattern
PV_SYSTEM_APPARMOR_PROFILESstringemptyAppArmor profiles to load
PV_SYSTEM_CONFDIRpath/configsset directory for system configurations
PV_SYSTEM_DRIVERS_LOAD_EARLY_AUTO0 or 10enable early auto-loading of drivers
PV_SYSTEM_ETCDIRpath/etcset system etc directory
PV_SYSTEM_ETCPANTAVISORDIRpath/etc/pantavisorset Pantavisor etc directory
PV_SYSTEM_INIT_MODEembedded, standalone or appengineembeddedset system init mode
PV_SYSTEM_LIBDIRpath/libset system library directory
PV_SYSTEM_MEDIADIRpath/mediaset system media directory
PV_SYSTEM_MOUNT_SECURITYFS0 or 10mount securityfs
PV_SYSTEM_RUNDIRpath/run/pantavisor/pvset system run directory
PV_SYSTEM_USRDIRpath/usrset system usr directory
PV_UPDATER_COMMIT_DELAYtime (in seconds)25delay before committing an update
PV_UPDATER_GOALS_TIMEOUTtime (in seconds)120timeout for reaching update goals
PV_UPDATER_USE_TMP_OBJECTS0 or 10use temporary objects during updates
PV_VOLMOUNT_DM_EXTRA_ARGSstringemptyextra arguments for DM volume mounting
PV_WDT_MODEdisabled, shutdown, startup or alwaysshutdownset watchdog mode
PV_WDT_TIMEOUTtime (in seconds)15set watchdog timeout
PV_XCONNECT_DBUS_SYSTEMBUS_ENABLED0 or 11enable the pantavisor-hosted D-Bus system bus (also requires the xconnect-dbus-systembus build feature)

Levels

This table shows the configuration levels that are allowed for each configuration key.

Keypv.confph.confenv,bootargsPolicyOEMUser metaCommand
PH_CREDS_HOST
PH_CREDS_ID
PH_CREDS_PORT
PH_CREDS_PROXY_HOST
PH_CREDS_PROXY_NOPROXYCONNECT
PH_CREDS_PROXY_PORT
PH_CREDS_PRN
PH_CREDS_SECRET
PH_CREDS_TYPE
PH_FACTORY_AUTOTOK
PH_LIBEVENT_HTTP_TIMEOUT
PH_LIBEVENT_HTTP_RETRIES
PH_METADATA_DEVMETA_INTERVAL
PH_METADATA_USRMETA_INTERVAL
PH_ONLINE_REQUEST_THRESHOLD
PH_UPDATER_INTERVAL
PH_UPDATER_NETWORK_TIMEOUT
PH_UPDATER_TRANSFER_MAX_COUNT
PV_BOOTLOADER_FITCONFIG
PV_BOOTLOADER_MTD_ENV
PV_BOOTLOADER_MTD_ONLY
PV_BOOTLOADER_TYPE
PV_BOOTLOADER_UBOOTAB_A_NAME
PV_BOOTLOADER_UBOOTAB_B_NAME
PV_BOOTLOADER_UBOOTAB_ENV_NAME
PV_BOOTLOADER_UBOOTAB_ENV_BAK_NAME
PV_BOOTLOADER_UBOOTAB_ENV_OFFSET
PV_BOOTLOADER_UBOOTAB_ENV_SIZE
PV_CACHE_DEVMETADIR
PV_CACHE_USRMETADIR
PV_CONTROL_REMOTE
PV_CONTROL_REMOTE_ALWAYS
PV_DEBUG_SHELL
PV_DEBUG_SHELL_AUTOLOGIN
PV_DEBUG_SHELL_TIMEOUT
PV_DEBUG_SSH
PV_DEBUG_SSH_AUTHORIZED_KEYS
PV_DISK_EXPORTSDIR
PV_DISK_VOLDIR
PV_DISK_WRITABLEDIR
PV_DROPBEAR_CACHE_DIR
PV_LIBEVENT_DEBUG_MODE
PV_LIBTHTTP_CERTSDIR
PV_LIBTHTTP_LOG_LEVEL
PV_LOG_BUF_NITEMS
PV_LOG_CAPTURE
PV_LOG_CAPTURE_DMESG
PV_LOG_DIR
PV_LOG_DIR_MAXSIZE
PV_LOG_FILETREE_TIMESTAMP_FORMAT
PV_LOG_HYSTERESIS_FACTOR
PV_LOG_LEVEL
PV_LOG_LOGGERS
PV_LOG_PUSH
PV_LOG_ROTATE_FACTOR
PV_LOG_SERVER_OUTPUTS
PV_LOG_AUTO_DEVLOG
PV_LOG_SINGLEFILE_TIMESTAMP_FORMAT
PV_LOG_STDOUT_TIMESTAMP_FORMAT
PV_LXC_LOG_LEVEL
PV_NET_BRADDRESS4
PV_NET_BRDEV
PV_NET_BRMASK4
PV_OEM_NAME
PV_POLICY
PV_REMOUNT_POLICY
PV_REVISION_RETRIES
PV_SECUREBOOT_CHECKSUM
PV_SECUREBOOT_HANDLERS
PV_SECUREBOOT_MODE
PV_SECUREBOOT_OEM_TRUSTSTORE
PV_SECUREBOOT_TRUSTSTORE
PV_STORAGE_DEVICE
PV_STORAGE_FSTYPE
PV_STORAGE_GC_KEEP_FACTORY
PV_STORAGE_GC_RESERVED
PV_STORAGE_GC_THRESHOLD_DEFERTIME
PV_STORAGE_GC_THRESHOLD
PV_STORAGE_LOGTEMPSIZE
PV_STORAGE_MNTPOINT
PV_STORAGE_MNTTYPE
PV_STORAGE_WAIT
PV_SYSCTL_*
PV_SYSCTL_KERNEL_CORE_PATTERN
PV_SYSTEM_APPARMOR_PROFILES
PV_SYSTEM_CONFDIR
PV_SYSTEM_DRIVERS_LOAD_EARLY_AUTO
PV_SYSTEM_ETCDIR
PV_SYSTEM_INIT_MODE
PV_SYSTEM_LIBDIR
PV_SYSTEM_MEDIADIR
PV_SYSTEM_MOUNT_SECURITYFS
PV_SYSTEM_RUNDIR
PV_SYSTEM_USRDIR
PV_UPDATER_COMMIT_DELAY
PV_UPDATER_GOALS_TIMEOUT
PV_UPDATER_USE_TMP_OBJECTS
PV_VOLMOUNT_DM_EXTRA_ARGS
PV_WDT_MODE
PV_WDT_TIMEOUT
PV_XCONNECT_DBUS_SYSTEMBUS_ENABLED