Project configuration

Projects can be configured through a set of key/value configuration options. See Configure a project for instructions on how to set these options.

The key/value configuration is namespaced. The following options are available:

Project features

The project features define which entities are isolated in the project and which are inherited from the default project.

If a feature.* option is set to true, the corresponding entity is isolated in the project.

Note

When you create a project without explicitly configuring a specific option, this option is set to the initial value given in the following table.

However, if you unset one of the feature.* options, it does not go back to the initial value, but to the default value. The default value for all feature.* options is false.

⤋⤊
features.images

Whether to use a separate set of images for the project

features.networks

Whether to use a separate set of networks for the project

features.networks.zones

Whether to use a separate set of network zones for the project

features.profiles

Whether to use a separate set of profiles for the project

features.storage.buckets

Whether to use a separate set of storage buckets for the project

features.storage.volumes

Whether to use a separate set of storage volumes for the project

Project limits

Project limits define a hard upper bound for the resources that can be used by the containers and VMs that belong to a project.

Depending on the limits.* option, the limit applies to the number of entities that are allowed in the project (for example, limits.containers or limits.networks) or to the aggregate value of resource usage for all instances in the project (for example, limits.cpu or limits.processes). In the latter case, the limit usually applies to the Resource limits that are configured for each instance (either directly or via a profile), and not to the resources that are actually in use.

For example, if you set the project’s limits.memory configuration to 50GiB, the sum of the individual values of all limits.memory configuration keys defined on the project’s instances will be kept under 50 GiB.

Similarly, setting the project’s limits.cpu configuration key to 100 means that the sum of individual limits.cpu values will be kept below 100.

When using project limits, the following conditions must be fulfilled:

  • When you set one of the limits.* configurations and there is a corresponding configuration for the instance, all instances in the project must have the corresponding configuration defined (either directly or via a profile). See Resource limits for the instance configuration options.

  • The limits.cpu configuration cannot be used if CPU pinning is enabled. This means that to use limits.cpu on a project, the limits.cpu configuration of each instance in the project must be set to a number of CPUs, not a set or a range of CPUs.

  • The limits.memory configuration must be set to an absolute value, not a percentage.

⤋⤊
limits.containers

Maximum number of containers that can be created in the project

limits.cpu

Maximum number of CPUs to use in the project

limits.disk

Maximum disk space used by the project

limits.disk.pool.POOL_NAME

Maximum disk space used by the project on this pool

limits.instances

Maximum number of instances that can be created in the project

limits.memory

Usage limit for the host’s memory for the project

limits.networks

Maximum number of networks that the project can have

limits.processes

Maximum number of processes within the project

limits.virtual-machines

Maximum number of VMs that can be created in the project

Project restrictions

To prevent the instances of a project from accessing security-sensitive features (such as container nesting or raw LXC configuration), set the restricted configuration option to true. You can then use the various restricted.* options to pick individual features that would normally be blocked by restricted and allow them, so they can be used by the instances of the project.

For example, to restrict a project and block all security-sensitive features, but allow container nesting, enter the following commands:

lxc project set <project_name> restricted=true
lxc project set <project_name> restricted.containers.nesting=allow

Each security-sensitive feature has an associated restricted.* project configuration option. If you want to allow the usage of a feature, change the value of its restricted.* option. Most restricted.* configurations are binary switches that can be set to either block (the default) or allow. However, some options support other values for more fine-grained control.

Note

You must set the restricted configuration to true for any of the restricted.* options to be effective. If restricted is set to false, changing a restricted.* option has no effect.

Setting all restricted.* keys to allow is equivalent to setting restricted itself to false.

⤋⤊
restricted

Whether to block access to security-sensitive features

restricted.backups

Whether to prevent creating instance or volume backups

restricted.cluster.groups

Cluster groups that can be targeted

restricted.cluster.target

Whether to prevent targeting of cluster members

restricted.containers.interception

Whether to prevent using system call interception options

restricted.containers.lowlevel

Whether to prevent using low-level container options

restricted.containers.nesting

Whether to prevent running nested LXD

restricted.containers.privilege

Which settings for privileged containers to prevent

restricted.devices.disk

Which disk devices can be used

restricted.devices.disk.paths

Which source can be used for disk devices

restricted.devices.gpu

Whether to prevent using devices of type gpu

restricted.devices.infiniband

Whether to prevent using devices of type infiniband

restricted.devices.nic

Which network devices can be used

restricted.devices.pci

Whether to prevent using devices of type pci

restricted.devices.proxy

Whether to prevent using devices of type proxy

restricted.devices.unix-block

Whether to prevent using devices of type unix-block

restricted.devices.unix-char

Whether to prevent using devices of type unix-char

restricted.devices.unix-hotplug

Whether to prevent using devices of type unix-hotplug

restricted.devices.usb

Whether to prevent using devices of type usb

restricted.idmap.gid

Which host GID ranges are allowed in raw.idmap

restricted.idmap.uid

Which host UID ranges are allowed in raw.idmap

restricted.networks.access

Which network names are allowed for use in this project

restricted.networks.subnets

Which network subnets are allocated for use in this project

restricted.networks.zones

Which network zones can be used in this project

restricted.snapshots

Whether to prevent creating instance or volume snapshots

restricted.virtual-machines.lowlevel

Whether to prevent using low-level VM options

Project-specific configuration

There are some Server configuration options that you can override for a project. In addition, you can add user metadata for a project.

⤋⤊
backups.compression_algorithm

Compression algorithm to use for backups

images.auto_update_cached

Whether to automatically update cached images in the project

images.auto_update_interval

Interval at which to look for updates to cached images

images.compression_algorithm

Compression algorithm to use for new images in the project

images.default_architecture

Default architecture to use in a mixed-architecture cluster

images.remote_cache_expiry

When an unused cached remote image is flushed in the project

user.*

User-provided free-form key/value pairs