Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# About images

Incus uses an image-based workflow. Each instance is based on an image, which contains a basic operating system (for example, a Linux distribution) and some Incus-related information.

Images are available from remote image stores (see Default image server for an overview), but you can also create your own images, either based on an existing instances or a rootfs image.

You can copy images from remote servers to your local image store, or copy local images to remote servers. You can also use a local image to create a remote instance.

Each image is identified by a fingerprint (SHA256). To make it easier to manage images, Incus allows defining one or more aliases for each image.

## Caching

When you create an instance using a remote image, Incus downloads the image and caches it locally. It is stored in the local image store with the cached flag set. The image is kept locally as a private image until either:

- The image has not been used to create a new instance for the number of days set in `images.remote_cache_expiry`.

- The image’s expiry date (one of the image properties; see Edit image properties for information on how to change it) is reached.

Incus keeps track of the image usage by updating the `last_used_at` image property every time a new instance is spawned from the image.

## Auto-update

Incus can automatically keep images that come from a remote server up to date.

Note

Only images that are requested through an alias can be updated. If you request an image through a fingerprint, you request an exact image version.

Whether auto-update is enabled for an image depends on how the image was downloaded:

- If the image was downloaded and cached when creating an instance, it is automatically updated if `images.auto_update_cached` was set to `true` (the default) at download time.

- If the image was copied from a remote server using the `incus image copy` command, it is automatically updated only if the `--auto-update` flag was specified.

You can change this behavior for an image by editing the `auto_update` property.

On startup and after every `images.auto_update_interval` (by default, every six hours), the Incus daemon checks for more recent versions of all the images in the store that are marked to be auto-updated and have a recorded source server.

When a new version of an image is found, it is downloaded into the image store. Then any aliases pointing to the old image are moved to the new one, and the old image is removed from the store.

To not delay instance creation, Incus does not check if a new version is available when creating an instance from a cached image. This means that the instance might use an older version of an image for the new instance until the image is updated at the next update interval.

## Special image properties

Image properties that begin with the prefix `requirements` (for example, `requirements.XYZ`) are used by Incus to determine the compatibility of the host system and the instance that is created based on the image. If these are incompatible, Incus does not start the instance.

The following requirements are supported:

`requirements.cdrom_agent`

If set to `true`, indicates that the VM requires an `agent:config` disk be added.

Key: | `requirements.cdrom_agent`
Type: | bool

`requirements.cgroup`

If set to `v1`, indicates that the image requires the host to run cgroup v1.

Key: | `requirements.cgroup`
Type: | string

`requirements.nesting`

If set to `true`, indicates that the image cannot work without nesting enabled.

Key: | `requirements.nesting`
Type: | bool

`requirements.privileged`

If set to `false`, indicates that the image cannot work as a privileged container.

Key: | `requirements.privileged`
Type: | bool

`requirements.secureboot`

If set to `false`, indicates that the image cannot boot under secure boot.

Key: | `requirements.secureboot`
Type: | bool