How to configure instances#
You can configure instances by setting Instance options or by adding and configuring Devices.
See the following sections for instructions.
To store and reuse different instance configurations, use profiles.
Configure instance options#
You can specify instance options when you create an instance.
To update instance options after the instance is created, use the
lxc config set command.
Specify the instance name and the key and value of the instance option:
lxc config set <instance_name> <option_key>=<option_value> <option_key>=<option_value> ...
See Instance options for a list of available options and information about which options are available for which instance type.
For example, to change the memory limit for your container, enter the following command:
lxc config set my-container limits.memory=128MiB
Some of the instance options are updated immediately while the instance is running. Others are updated only when the instance is restarted.
See the “Live update” column in the Instance options tables for information about which options are applied immediately while the instance is running.
To add and configure an instance device for your instance, use the
lxc config device add command.
Generally, devices can be added or removed for a container while it is running.
VMs support hotplugging for some device types, but not all.
Specify the instance name, a device name, the device type and maybe device options (depending on the device type):
lxc config device add <instance_name> <device_name> <device_type> <device_option_key>=<device_option_value> <device_option_key>=<device_option_value> ...
See Devices for a list of available device types and their options.
Every device entry is identified by a name unique to the instance.
Devices from profiles are applied to the instance in the order in which the profiles are assigned to the instance. Devices defined directly in the instance configuration are applied last. At each stage, if a device with the same name already exists from an earlier stage, the whole device entry is overridden by the latest definition.
Device names are limited to a maximum of 64 characters.
For example, to add the storage at
/share/c1 on the host system to your instance at path
/opt, enter the following command:
lxc config device add my-container disk-storage-device disk source=/share/c1 path=/opt
To configure instance device options for a device that you have added earlier, use the
lxc config device set command:
lxc config device set <instance_name> <device_name> <device_option_key>=<device_option_value> <device_option_key>=<device_option_value> ...
You can also specify device options by using the
--device flag when creating an instance.
This is useful if you want to override device options for a device that is provided through a profile.
To remove a device, use the
lxc config device remove command.
lxc config device --help for a full list of available commands.
Display instance configuration#
To display the current configuration of your instance, including writable instance properties, instance options, devices and device options, enter the following command:
lxc config show <instance_name> --expanded
Edit the full instance configuration#
To edit the full instance configuration, including writable instance properties, instance options, devices and device options, enter the following command:
lxc config edit <instance_name>
For convenience, the
lxc config edit command displays the full configuration including read-only instance properties.
However, you cannot edit those properties.
Any changes are ignored.