> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siderolabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

> StoragePool defines a directory storage pool on a configured filesystem volume.
Defines a named storage pool backed by a UserVolumeConfig, ExistingVolumeConfig,
or ExternalVolumeConfig. The backing volume must be writable and filesystem-backed.
Only one pool may reference a backing volume. The pool directory is named after
the pool beneath the volume mount target. Removing the configuration stops and
undefines the pool, but never deletes its files or backing volume.
Requires the libvirtd system extension. Changing the backing volume changes
the pool target; it does not migrate existing disk images.


# StoragePool

```yaml theme={null}
apiVersion: v1alpha1
kind: StoragePool
name: vm-images # Pool name: 1-63 ASCII letters, digits, hyphens or underscores, starting with a letter or digit.
# Reference to the writable filesystem volume backing this pool.
volume:
    name: vm-data # Name of the UserVolumeConfig, ExistingVolumeConfig, or ExternalVolumeConfig document.
```

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`name`</td>
      <td>string</td>
      <td>Pool name: 1-63 ASCII letters, digits, hyphens or underscores, starting with a letter or digit.</td>

      <td />
    </tr>

    <tr>
      <td>`volume`</td>
      <td><a href="#volume">StoragePoolVolume</a></td>
      <td>Reference to the writable filesystem volume backing this pool.</td>

      <td />
    </tr>
  </tbody>
</table>

## volume

StoragePoolVolume references a backing volume by its document name.

<table>
  <thead>
    <tr>
      <th>Field</th>
      <th>Type</th>
      <th>Description</th>
      <th>Value(s)</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>`name`</td>
      <td>string</td>
      <td>Name of the UserVolumeConfig, ExistingVolumeConfig, or ExternalVolumeConfig document.<br />This is the literal document name, not the runtime volume ID.<br />For example, a UserVolumeConfig named `u-images` is referenced as `u-images`.</td>

      <td />
    </tr>
  </tbody>
</table>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.