Reference

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

General information

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

• Requirements
• Architectures
• Guest OS compatibility
• Container environment
• Man pages

Releases

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

• Release notes
• Releases and snap

Images

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

• Remote image servers
• Image format

Configuration options

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

• Configuration option index
• Server configuration
• Instance configuration
• Preseed YAML file fields
• Project configuration
• Storage drivers
• Networks
• Placement group configuration
• Clusters
• Replicator configuration
• Permissions

Production setup

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

• Production server settings
• Provided metrics

API and integrations

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

• REST API
• LXD CSI driver reference

Internal implementation details

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

• Internals