<a id="reference"></a>

# Reference

The reference material in this section provides technical descriptions of LXD.

<a id="reference-general"></a>

## General information

These guides include compatibility information for operating systems running in instances, and man pages for the `lxc` CLI.

* [Requirements](https://canonical.com/lxd/docs/latest/requirements/index.html.md)
* [Architectures](https://canonical.com/lxd/docs/latest/architectures/index.html.md)
* [Guest OS compatibility](https://canonical.com/lxd/docs/latest/guest-os-compatibility/index.html.md)
* [Container environment](https://canonical.com/lxd/docs/latest/container-environment/index.html.md)
* [Man pages](https://canonical.com/lxd/docs/latest/reference/manpages/index.html.md)

## Releases

Release notes, deprecation notices, and details about the LXD release cadence and its snap.

* [Release notes](https://canonical.com/lxd/docs/latest/reference/release-notes/index.html.md)
* [Deprecation notices](https://canonical.com/lxd/docs/latest/reference/deprecation_notices/index.html.md)
* [Releases and snap](https://canonical.com/lxd/docs/latest/reference/releases-snap/index.html.md)

## Images

Reference information for remote image servers and the LXD image format.

* [Built-in image registries](https://canonical.com/lxd/docs/latest/reference/remote_image_servers/index.html.md)
* [Image format](https://canonical.com/lxd/docs/latest/reference/image_format/index.html.md)

<a id="reference-config"></a>

## Configuration options

LXD is highly configurable, with options available for major entities as well as permissions for access control.

* [Configuration option index](https://canonical.com/lxd/docs/latest/config-options/index.html.md)
* [Server configuration](https://canonical.com/lxd/docs/latest/server/index.html.md)
* [Instance configuration](https://canonical.com/lxd/docs/latest/explanation/instance_config/index.html.md)
* [Preseed YAML file fields](https://canonical.com/lxd/docs/latest/reference/preseed_yaml_fields/index.html.md)
* [Project configuration](https://canonical.com/lxd/docs/latest/reference/projects/index.html.md)
* [Storage drivers](https://canonical.com/lxd/docs/latest/reference/storage_drivers/index.html.md)
* [Networks](https://canonical.com/lxd/docs/latest/reference/networks/index.html.md)
* [Image registries](https://canonical.com/lxd/docs/latest/reference/image_registries/index.html.md)
* [Placement group configuration](https://canonical.com/lxd/docs/latest/reference/placement_groups/index.html.md)
* [Clusters](https://canonical.com/lxd/docs/latest/reference/clusters/index.html.md)
* [Replicator configuration](https://canonical.com/lxd/docs/latest/reference/replicator_config/index.html.md)
* [Permissions](https://canonical.com/lxd/docs/latest/reference/permissions/index.html.md)

<a id="reference-production"></a>

## Production setup

The LXD server can be optimized for production workloads and can monitor server metrics.

* [Production server settings](https://canonical.com/lxd/docs/latest/reference/server_settings/index.html.md)
* [Provided metrics](https://canonical.com/lxd/docs/latest/reference/provided_metrics/index.html.md)

<a id="reference-api"></a>

## API and integrations

LXD exposes a REST API for managing all resources. The LXD CSI driver integrates LXD storage backends with Kubernetes.

* [REST API](https://canonical.com/lxd/docs/latest/restapi_landing/index.html.md)
* [LXD CSI driver reference](https://canonical.com/lxd/docs/latest/reference/driver_csi/index.html.md)

<a id="reference-internal"></a>

## Internal implementation details

These guides are primarily of interest to advanced users, contributors, and developers.

* [Internals](https://canonical.com/lxd/docs/latest/internals/index.html.md)
