Skip to main content
FieldTypeDescriptionValue(s)
namestringName 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.
backingContentLibraryBackingVolume backing the content library.

backing

ContentLibraryBacking describes the storage backing a content library.
FieldTypeDescriptionValue(s)
volumestringName 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.