Pantavisor Configuration¶
Note
The configuration syntax is common for all levels, but not all levels support the same keys. Our reference contains the list of keys and the allowed levels for each one.
There are several ways to set Pantavisor configuration, depending on when it can be modified in the Pantavisor life cycle. Bear in mind that not all configuration parameters will be available for all levels. Furthermore, each level will overwrite whatever is configured in the previous ones, following this order:
pantavisor.config¶
Configuration file for Pantavisor. It can only be changed at build time.
pantahub.config¶
Build time configuration file for Pantavisor built-in Pantacor Hub client.
Policies¶
Policies are added at build time from the vendor skel directory, but loaded during boot up time.
To select a policy among the installed ones, we need to set its name to the PV_POLICY key either from pantavisor.config or environment variables.
OEM¶
For setups where we want to modify the configuration based on device updates, we offer the possibility to attach a configuration file to a revision.
Its location inside the revision will be defined by the configuration values of the keys PV_OEM_NAME and PV_POLICY from pantavisor.config, environment variables or policies levels.
cmdline¶
Warning
This method is DEPRECATED but still supported for backwards compatibility reasons. It is recommended to use env variables instead.
Right after loading the configuration files, Pantavisor reads /proc/cmdline in search for key=value pairs that use the prefix ph_ or pv_. This can be done from the bootloader console.
Environment Variables¶
Linux environment variables can be used to configure Pantavisor. To do that, the rules to set env variables have to be followed:
- Use
key=valueformat - Do not use
. - If
characted is needed, you can escape them by using"between the config item. For example:"PV_SYSCTL_KERNEL_CORE_PATTERN=|/lib/pv/pvcrash --skip".
These variables need to be set during boot time, and setting them after that will have no effect on Pantavisor. This can be achieved from the bootloader console.
User Metadata¶
Note
If the user metadata volume is assigned to a permanent volume, as it is by default, these changes will persist over device reboots.
User metadata can be used to override any of the previously presented configuration mechanisms.
There is a number of ways of setting user metadata, depending on the device management method choice. Go to our how-to use Pantavisor guide for more information.
Commands¶
Note
It is important to notice that these changes will not persist after a device reboot in any case.
The Pantavisor control socket, or consequently the PVControl tool, offers another way to change a very limited subset of configuration values. Specifically, using the command endpoint.