> ## 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.

> LVMLogicalVolumeConfig is an LVM logical volume config document.
Defines a logical volume provisioned inside a volume group.


# LVMLogicalVolumeConfig

```yaml theme={null}
apiVersion: v1alpha1
kind: LVMLogicalVolumeConfig
name: lv-data # Logical volume name.
type: linear # Logical volume layout.
# Describes how the logical volume is provisioned.
provisioning:
    volumeGroup: vg-pool # Name of the volume group that backs the logical volume.
    maxSize: 50GiB # The maximum size of the volume.
```

<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>Logical volume name.<br /><br />Must be 1-63 chars: ASCII letters, digits, hyphens, underscores.</td>

      <td />
    </tr>

    <tr>
      <td>`type`</td>
      <td>LVMLogicalVolumeType</td>
      <td>Logical volume layout.</td>
      <td>`linear`<br />`raid0`<br />`raid1`<br />`raid10`<br /></td>
    </tr>

    <tr>
      <td>`mirrors`</td>
      <td>uint32</td>
      <td>Number of mirror copies for `raid1` / `raid10` layouts.<br /><br />Defaults to 1 (a two-way mirror) when unset. Not valid for `linear`<br />or `raid0`.</td>

      <td />
    </tr>

    <tr>
      <td>`stripes`</td>
      <td>uint32</td>
      <td>Number of stripes for `raid0` / `raid10` layouts.<br /><br />Defaults to all available physical volumes when unset. Must be at<br />least 2. Not valid for `linear` or `raid1`.</td>

      <td />
    </tr>

    <tr>
      <td>`provisioning`</td>
      <td><a href="#provisioning">LVMLogicalVolumeProvisioningSpec</a></td>
      <td>Describes how the logical volume is provisioned.</td>

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

## provisioning

LVMLogicalVolumeProvisioningSpec describes how an LV is provisioned.

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

  <tbody>
    <tr>
      <td>`volumeGroup`</td>
      <td>string</td>
      <td>Name of the volume group that backs the logical volume.</td>

      <td />
    </tr>

    <tr>
      <td>`minSize`</td>
      <td>ByteSize</td>
      <td>The minimum size of the volume.<br /><br />Size is specified in bytes, but can be expressed in human readable format, e.g. 100MB.</td>

      <td />
    </tr>

    <tr>
      <td>`maxSize`</td>
      <td>Size</td>
      <td>The maximum size of the volume.<br /><br />Size is specified in bytes or in percents of the volume group.<br />It can be expressed in human readable format, e.g. 100MB or 80%.</td>

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