Skip to content

Commit

Permalink
Translate/review README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Kirill Kononovich <[email protected]>
  • Loading branch information
kirkonru authored Jan 22, 2024
1 parent 0a59f17 commit 53d5f49
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ moduleStatus: experimental
{{< alert level="warning" >}}
The module is guaranteed to work only with stock kernels that are shipped with the [supported distributions](https://deckhouse.io/documentation/v1/supported_versions.html#linux).

The functionality of the module with other kernels or distributions is possible but not guaranteed.
The module may work with other kernels or distributions, but its stable operation and availability of all features is not guaranteed.
{{< /alert >}}

The module manages `LVM` on cluster nodes through [Kubernetes custom resources](./cr.html), performing the following operations:
The module manages `LVM` on cluster nodes through [Kubernetes custom resources](./cr.html) by performing the following operations:

- Detecting block devices and creating/updating/deleting the corresponding [BlockDevice resources](./cr.html#blockdevice).
- Discovering block devices and creating/updating/deleting their corresponding [BlockDevice resources](./cr.html#blockdevice).

> **Caution!** Manual creation and modification of the `BlockDevice` resource is prohibited.
- Detecting `LVM Volume Groups` with the `storage.deckhouse.io/enabled=true` LVM tag and `Thin-pools` on them on the nodes, as well as managing the corresponding [LVMVolumeGroup resources](./cr.html#lvmvolumegroup). The module automatically creates an `LVMVolumeGroup` resource if it does not yet exist for the discovered `LVM Volume Group`.
- Discovering `LVM Volume Groups` on the nodes with the `storage.deckhouse.io/enabled=true` LVM tag attached and `Thin-pools` running on them as well as managing the corresponding [LVMVolumeGroup resources](./cr.html#lvmvolumegroup). The module automatically creates an `LVMVolumeGroup` resource if it does not yet exist for a discovered `LVM Volume Group`.

- Scanning `LVM Physical Volumes` on the nodes that are part of managed `LVM Volume Groups`. In case of expansion of underlying block device sizes, the corresponding `LVM Physical Volumes` will be automatically expanded (`pvresize` will occur).
- Scanning `LVM Physical Volumes` on the nodes that are part of managed `LVM Volume Groups`. In case the size of underlying block device expands, the corresponding `LVM Physical Volumes` will be automatically expanded as well (`pvresize` will occur).

> **Caution!** Reduction in the size of block devices is not supported.
> **Caution!** Downsizing a block device is not supported.
- Creating/expanding/deleting `LVM Volume Groups` on the node in accordance with user changes in `LVMVolumeGroup` resources. [Usage examples](./usage.html#lvmvolumegroup-resources)
- Creating/expanding/deleting `LVM Volume Groups` on the node according to the changes the user has made to the `LVMVolumeGroup` resources. [Usage examples](./usage.html#lvmvolumegroup-resources)

0 comments on commit 53d5f49

Please sign in to comment.