Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
Signed-off-by: Aleksandr Zimin <[email protected]>
  • Loading branch information
AleksZimin committed Jan 21, 2024
1 parent 839b4b6 commit 55170d5
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 9 deletions.
14 changes: 9 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,16 @@ The module is guaranteed to work only with stock kernels that are shipped with t
The functionality of the module with other kernels or distributions is possible but not guaranteed.
{{< /alert >}}

The `SDS-Node-Configurator` module allows you to manage `LVM Volume Group` and `LVM Thin-pool` by applying Kubernetes manifests. This module runs together with the `SDS-DRBD` module: `SDS-Node-Configurator` generates the `LVMVolumeGroup` resources that are then used to create the `DRBDStoragePool`.
The module manages `LVM` on cluster nodes through [Kubernetes custom resources](./cr.html), performing the following operations:

The module exctracts information from the [Kubernetes Custom Resources](resource link) and uses it to create, update, and delete `Volume Group` and `Thin-pool` resources based on them.
- Detecting block devices and creating/updating/deleting the corresponding [BlockDevice resources](./cr.html#blockdevice).

The user can define the desired state of the `Volume Group` and `Thin-pool` in the `Spec` field of the `LVMVolumeGroup` resource. The `SDS-Node-Configurator` will then automatically perform all necessary steps to bring the resource to the desired state. The module continuously monitors the created resources to ensure that their current state matches the specified parameters.
> **Attention!** Manual creation and modification of the `BlockDevice` resource is prohibited.
Note that the module also automatically detects the size of `Physical Volumes`. If block device sizes are expanded, the corresponding `Physical Volumes` and the `Volume Group` (VG) will be automatically expanded as well, providing dynamic support for the changes. However, keep in mind that block device **downsizing is not supported**.
- 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`.

Note that [Kubernetes Custom Resources](resource link) are cluster-scoped.
- 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).

> **Attention!** Reduction in the size of block devices 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)
4 changes: 2 additions & 2 deletions docs/README_RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ moduleStatus: experimental

> **Внимание!** Ручное создание и изменение ресурса `BlockDevice` запрещено.
- Обнаружение на узлах `LVM Volume Group` с тегом `storage.deckhouse.io/enabled=true` и `Thin-pool` на них, а также управление соответствующими [ресурсами LVMVolumeGroup](./cr.html#lvmvolumegroup). Модуль автоматически создает ресурс `LVMVolumeGroup`, если его еще не существует для обнаруженной `LVM Volume Group`.
- Обнаружение на узлах `LVM Volume Group` с LVM тегом `storage.deckhouse.io/enabled=true` и `Thin-pool` на них, а также управление соответствующими [ресурсами LVMVolumeGroup](./cr.html#lvmvolumegroup). Модуль автоматически создает ресурс `LVMVolumeGroup`, если его еще не существует для обнаруженной `LVM Volume Group`.

- Сканирование на узлах `LVM Physical Volumes`, которые входят в управляемые `LVM Volume Group`. В случае расширения размеров нижестоящих блочных устройств, соотвующие `LVM Physical Volumes` будут автоматически расширены (произойдёт pvresize).
- Сканирование на узлах `LVM Physical Volumes`, которые входят в управляемые `LVM Volume Group`. В случае расширения размеров нижестоящих блочных устройств, соотвующие `LVM Physical Volumes` будут автоматически расширены (произойдёт `pvresize`).

> **Внимание!** Уменьшение размеров блочного устройства не поддерживается.
Expand Down
4 changes: 2 additions & 2 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The controller supports two types of resources:
* `BlockDevice`;
* `LVMVolumeGroup`.

## [BlockDevice](block device) resources
## `BlockDevice` resources

### Creating a `BlockDevice` resource

Expand Down Expand Up @@ -47,7 +47,7 @@ The following are the cases in which the controller will automatically delete a

> The controller performs the above activities automatically and requires no user intervention.
## [LVMVolumeGroup](lvmVolumeGroup) resources
## `LVMVolumeGroup` resources

The `BlockDevice` resources are required to create and update `LVMVolumeGroup` resources.

Expand Down

0 comments on commit 55170d5

Please sign in to comment.