ContentLibraryConfig

ContentLibraryConfig is a content library configuration document. ContentLibraryConfig declares a content library: a store for virtual machine images kept on a volume.

The library is the root of the backing volume, so a library backed by the user volume vm-images keeps its images directly in /var/mnt/vm-images. A volume backs exactly one library: two libraries pointed at the same volume are rejected.

Contents are managed over the API with talosctl hv content-library, never by editing the machine configuration. Status is reported via ContentLibraryStatus.

apiVersion: v1alpha1
kind: ContentLibraryConfig
name: my-vm-images-1 # Name of the content library.
# Volume backing the content library.
backing:
    volume: vm-images # Name of the volume storing the library's contents.

Field	Type	Description	Value(s)
name	string	Name of the content library. Must be between 1 and 63 characters long, and can only contain ASCII letters, digits and hyphens. It is the ID used to address the library over the API.
backing	ContentLibraryBacking	Volume backing the content library.

backing

ContentLibraryBacking describes the storage backing a content library.

Field	Type	Description	Value(s)
volume	string	Name of the volume storing the library’s contents. The name of a UserVolumeConfig, ExistingVolumeConfig or ExternalVolumeConfig document, as that document declares it, not the u-/e-/x- prefixed ID Talos derives from the kind and the name. Volume names are unique across those kinds, so the name resolves to one volume. The volume is declared separately and is not provisioned by this document; the library becomes ready only once the volume is mounted. Uploads write into the library, so a volume declared read-only cannot back one.