Ubuntu Core configuration options

Ubuntu Core supports a set of system-wide options that allow you to customise your snap or Ubuntu Core environment. These are listed below.

See Configure Ubuntu Core for further details on how they are viewed and configured.

pi-config

On a Raspberry Pi, the following options set corresponding values in the config.txt system configuration file:

• pi-config.disable-overscan
• pi-config.force-turbo
• pi-config.framebuffer-width
• pi-config.framebuffer-height
• pi-config.framebuffer-depth
• pi-config.framebuffer-ignore_alpha
• pi-config.overscan-left
• pi-config.overscan-right
• pi-config.overscan-top
• pi-config.overscan-bottom
• pi-config.overscan-scale
• pi-config.display-rotate
• pi-config.hdmi-cvt
• pi-config.hdmi-group
• pi-config.hdmi-mode
• pi-config.hdmi-timings
• pi-config.hdmi-drive
• pi-config.avoid-warnings
• pi-config.gpu-mem-256
• pi-config.gpu-mem-512
• pi-config.gpu-mem
• pi-config.sdtv-aspect
• pi-config.config-hdmi-boost
• pi-config.hdmi-force-hotplug
• pi-config.start-x

Further details on the above, see the official Raspberry Pi documentation.

refresh

There are four system-wide options that are used to manage how updates are handed:

• refresh.timer: defines the refresh frequency and schedule
• refresh.hold: delays the next refresh until the defined time and date
• refresh.metered: pauses refresh updates when network connection is metered
• refresh.retain: sets how many revisions of a snap are stored on the system

The following example asks the system to only refresh snaps between 4.00am and 7.00am, and 7.00pm and 10:10pm:

$ sudo snap set system refresh.timer=4:00-7:00,19:00-22:10 

See Controlling updates for further details on how the above options are used.

system journal.persistent

Enables or disables journal persistence. Can be true or false. If persistent journals were previously enabled by this setting, changing the value to false will delete all saved logs.

Example to enable the journal:

$ snap set system journal.persistent=true

Available since snapd 2.45.

system proxy.{http,https,ftp}

These options may be set to change the proxies to be used by the system when communicating with external sites that speak the respective protocols:

snap set system proxy.http="http://<proxy_addr>:<proxy_port>"
sudo snap set system proxy.https="http://<proxy_addr>:<proxy_port>"

Available since snapd 2.28.

system resilience.vitality-hint

This option adjusts the Linux kernel’s out-of-memory (OOM) killer behaviour for specific snap services.

By default, all snap services have the same value for systemd’s OOMScoreAdjust. By passing a list of snaps ordered by decreasing importance to the resilience.vitality-hint system option, the order is respected if snap processes are killed in low memory situations.

The list of snaps need to be as string containing comma separated snap instance names in decreasing order of importance, such as:

snap set system resilience.vitality-hint=snapA,snapB,snapC

In the above example, services inside snapA are the least likely to be killed in out of memory situations, followed by services in snapB, services in snapC, and then the services in all the other snaps not referenced by the vitality-hint option.

Available since snapd 2.46.

system service.console-conf.disable

May be set to true to disable the console-conf system configuration wizard that is launched by default when booting an initialised Ubuntu Core image.

$ snap set system service.console-conf.disable=true

Available since snapd 2.46.

system service.ssh.disable

Can be set to true to disable the SSH service at startup.

$ snap set system service.ssh.disable=true

Available since snapd 2.22.

system snapshots.automatic.retention

Automatic snapshot retention time is configured with the snapshots.automatic.retention system option. The default value is 31 days, and the value needs to be greater than 24 hours:

$ snap set system snapshots.automatic.retention=30h

To disable automatic snapshots, set the retention time to no:

$ snap set system snapshots.automatic.retention=no

Automatic snapshots require snap version 2.39+.

system store-certs

A custom SSL certificate can be added to snapd’s trusted certificates pool for the store communication with the store-certs.<name>=<value> system option.

To add a certificate, enter the following:

$ snap set system store-certs.cert1="$(cat /path/to/mycert)"

A certificate can be removed with unset:

$ snap unset system store-certs.cert1

Available since snapd 2.45.

system swap.size

Sets the swap size for the base system.

Value can be any integer multiple of a megabyte that is either larger than or equal to 1 MB, or 0 for no swap enabled:

$ snap set system swap.size=200M

This option is typically defined in the gadget.yaml file when building an Ubuntu Core image:

defaults:
  system:
    swap:
      size: 200M

Available since snapd 2.52

system system.disable-backlight-service

May be set to true to disable the backlight service:

$ snap set core system.disable-backlight-service=true

Available since snapd 2.46.

system system.kernel.printk.console-loglevel

Override the console log level with a number between 0 and 7.

The configuration will be stored in /etc/sysctl.d/99-snapd.conf and the default value is 4

Example to set the log level to 1:

$ snap set system system.kernel.printk.console-loglevel=1
$ cat /etc/sysctl.d/99-snapd.conf 
kernel.printk = 1 4 1 7

Available since snapd 2.46.

system system.network.netplan

On systems that support Netplan, such as Ubuntu Core 20 and 22, snapd can both query and configure the Netplan key and value notation through its get and set system options commands:

$ snap get -d system system.network.netplan
{
        "system.network.netplan": {
                "network": {
                        "ethernets": {
                                "enp0s2": {
                                        "dhcp4": true
                                }
                        },
                        "version": 2
                }
        }
}

Netplan key names and properties reflect a device’s specification, capabilities and configuration. The network.ethernets.enp0s2 device listed above, for example, could be eth0 or another network device name. Equally, a device with wireless capabilities would present key value configuration options beneath system.network.netplan.network.wifi.

For example, the following output is typical of a static network configuration:

{
        "system.network.netplan": {
                "network": {
                        "ethernets": {
                                "enp0s2": {
                                        "addresses": [
                                                "10.0.2.15/24"
                                        ],
                                        "gateway4": "10.0.2.2",
                                        "nameservers": {
                                                "addresses": [
                                                        "8.8.8.8",
                                                        "8.8.4.4"
                                                ],
                                                "search": []
                                        }
                                }
                        },
                        "version": 2
                }
        }
}

The following snap set command could be used to change the gateway4 address in the above configuration:

snap set system system.network.netplan.network.ethernets.enp0s2.gateway4=10.0.2.1

See Netplan reference for details on the key and value pairs used for network configuration.

Available since snapd 2.55.4

system system.power-key-action

Defines the behaviour of the system when the power key is pressed.

May be set to one of:

• ignore
• poweroff
• reboot
• halt
• kexec
• suspend
• hibernate
• hybrid-sleep
• lock

To set the system power button behaviour to hibernate, for example, enter the following:

$ snap set system system.power-key-action=hibernate

Available since snapd 2.23.

system system.timezone

May be used to set a time zone value, as typically found in /usr/share/zoneinfo, such as America/Chicago.

$ snap set system system.timezone="America/Chicago"

To see the current timezone settings, use the snap get -d system:

$ snap get -d system
{
        "experimental": {
                "hotplug": true,
                "layouts": true
        },
        "refresh": {
                "last": "2017-05-25T09:03:58.664837614+01:00",
                "retain": 2
        },
        "seed": {
                "loaded": true
        },
        "system": {
                "timezone": "America/Chicago"
        }
}

Available since snapd 2.46.

system tmp.size

Configures the default size for the /tmp mount point on Ubuntu Core devices:

snap set system tmp.size=<size>

Size can given as either bytes, megabytes or gigabytes: <bytes>, <bytes/2^20>M, or <bytes/2^30>G.

To set the /tmp mount point to a size of 2GB, for example, run the following command:

$ snap set system tmp.size=2G

Use snap get to retrieve the current size:

$ snap get system tmp.size

To set to /tmp to the default size, remove any custom setting:

$ snap unset system tmp.size

By default, /tmp is set to use 50% of physical RAM.

system users.create.automatic

Configures whether the system creates users automatically from a valid system-user assertion (when set to true), or by using create user API calls with the automatic flag (when set to false):

$ snap set system users.create.automatic=false

Default is true.

system watchdog.runtime-timeout

Configures the system’s hardware watchdog runtime timeout.

The watchdog runtime timeout is an interval during which the system manager must contact the hardware watchdog to prevent a device from being automatically rebooted. Usage of this feature requires corresponding hardware support as the watchdog hardware, /dev/watchdog or the kernel option systemd.watchdog-device=, will be programmed to automatically reboot the system when not contacted within the specified timeout interval.

A valid value is a non-negative time duration in seconds, or suffixed with ms, min, h, d, w for milliseconds, minutes, hours, days and weeks respectively.

The following example will set the timeout to 1 minute:

$ snap set system watchdog.runtime-timeout=1m

Available since snapd 2.34.

system watchdog.shutdown-timeout

Configures the system’s hardware watchdog shutdown timeout.

The watchdog shutdown timeout is an interval to permit a clean reboot of the system. If the system fails to reboot within this interval, the watchdog will forcibly restart the system to protect against failed or hanging reboots. Usage of this feature requires hardware support.

Note that the shutdown-timeout applies only to the second phase of a reboot, after all regular services are terminated and the system and service manager process has been replaced by the systemd-shutdown binary.

As with the watchdog runtime timeout, a valid value is a non-negative time duration in seconds, or suffixed with ms, min, h, d, w for milliseconds, minutes, hours, days and weeks respectively.

The following example will set the timeout to 500 seconds:

$ snap set system watchdog.shutdown-timeout=500

Available since snapd 2.34.