> ## Documentation Index
> Fetch the complete documentation index at: https://siderolabs-fe86397c-1-11-reference.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> VolumeConfig is a system volume configuration document.
Note: at the moment, only `EPHEMERAL` and `IMAGE-CACHE` system volumes are supported.


# VolumeConfig

```yaml
apiVersion: v1alpha1
kind: VolumeConfig
name: EPHEMERAL # Name of the volume.
# The provisioning describes how the volume is provisioned.
provisioning:
    # The disk selector expression.
    diskSelector:
        match: disk.transport == "nvme" # The Common Expression Language (CEL) expression to match the disk.
    maxSize: 50GiB # The maximum size of the volume, if not specified the volume can grow to the size of the

    # # The minimum size of the volume.
    # minSize: 2.5GiB
```

| Field          | Type                                                      | Description                                               | Value(s) |
| -------------- | --------------------------------------------------------- | --------------------------------------------------------- | -------- |
| `name`         | string                                                    | Name of the volume.                                       |          |
| `provisioning` | <a href="#VolumeConfig.provisioning">ProvisioningSpec</a> | The provisioning describes how the volume is provisioned. |          |

## provisioning

ProvisioningSpec describes how the volume is provisioned.

| Field          | Type                                                               | Description                                                                                                                                                                                                                                                                                                                 | Value(s) |
| -------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `diskSelector` | <a href="#VolumeConfig.provisioning.diskSelector">DiskSelector</a> | The disk selector expression.                                                                                                                                                                                                                                                                                               |          |
| `grow`         | bool                                                               | Should the volume grow to the size of the disk (if possible).                                                                                                                                                                                                                                                               |          |
| `minSize`      | ByteSize                                                           | <details><summary>The minimum size of the volume.</summary><br />Size is specified in bytes, but can be expressed in human readable format, e.g. 100MB.</details> <details><summary>Show example(s)</summary>`minSize: 2.5GiB`</details>                                                                                    |          |
| `maxSize`      | ByteSize                                                           | <details><summary>The maximum size of the volume, if not specified the volume can grow to the size of the disk.</summary><br /><br />Size is specified in bytes, but can be expressed in human readable format, e.g. 100MB.</details> <details><summary>Show example(s)</summary>`yaml<br />maxSize: 50GiB<br />`</details> |          |

### diskSelector

DiskSelector selects a disk for the volume.

| Field   | Type       | Description                                                                                                                                                                                                                                                    | Value(s) |
| ------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `match` | Expression | The Common Expression Language (CEL) expression to match the disk. <details><summary>Show example(s)</summary>`match: disk.size > 120u * GB && disk.size < 1u * TB`<br /><br />`match: disk.transport == "sata" && !disk.rotational && !system_disk`</details> |          |
