From edc4be1cbbaaa2b8d85b255eafbac65ea229514f Mon Sep 17 00:00:00 2001 From: Kirill Kononovich <41591254+kirkonru@users.noreply.github.com> Date: Mon, 22 Jan 2024 18:15:47 +0300 Subject: [PATCH] Translate/review FAQ.md Signed-off-by: Kirill Kononovich <41591254+kirkonru@users.noreply.github.com> --- docs/FAQ.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 4b6a2984..6c382652 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -6,7 +6,7 @@ description: "Deckhouse Kubernetes Platform. The sds-node-configurator module. C {{< 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 >}} ## Why does creating `BlockDevice` and `LVMVolumeGroup` resources in a cluster fail? @@ -19,25 +19,25 @@ The functionality of the module with other kernels or distributions is possible ## I have deleted the `LVMVolumeGroup` resource, but the `Volume Group` is still there. What do I do? -Deleting a `LVMVolumeGroup` resource does not delete the `Volume Group` it references. To delete it, add a special `storage.deckhouse.io/sds-delete-vg: ""` annotation to trigger the deletion process. The controller will then automatically delete the `LVM Volume Group` from the node and its associated resource. +Deleting an `LVMVolumeGroup` resource does not delete the `Volume Group` it references. To delete it, add a special `storage.deckhouse.io/sds-delete-vg: ""` annotation to trigger the deletion process. The controller will then automatically delete the `LVM Volume Group` from the node as well as its associated resource. -> Note that simply deleting the `LVMVolumeGroup` resource will result in the creation of a new resource with a generated name based on the existing `LVM Volume Group` on the node. +> Note that merely deleting the `LVMVolumeGroup` resource will result in a new resource with a generated name being created based on the existing `LVM Volume Group` on the node. ## I have attached the delete annotation, but the `LVMVolumeGroup` resource is still there as well as the `Volume Group` on the node. Why? -The usual case is that the corresponding `LVM Volume Group` on the node has `Logical Volumes`. The controller does not delete `Logical Volumes` because these `volumes` may contain important data and the user must purge them manually. +Typically, the `LVM Volume Group` on the node has the corresponding `Logical Volumes`. The controller does not delete `Logical Volumes` because these `volumes` may contain important data. Thus, the user must purge them manually. Once the `Logical Volume` has been deleted, the controller will proceed to delete the `Volume Group` and its corresponding resource. ## I'm trying to create a `Volume Group` using the `LVMVolumeGroup` resource, but I'm not getting anywhere. Why? -Most likely, your resource fails controller validation, although it has passed the Kubernetes validation successfully. -The exact cause of the failure can be found in the `status.message` field of the resource itself, -or you can refer to the controller's logs. +Most likely, your resource fails controller validation even if it has passed the Kubernetes validation successfully. +The exact cause of the failure can be found in the `status.message` field of the resource itself. +You can also refer to the controller's logs. -The problem usually stems from incorrectly defined `BlockDevice` resources. Please make sure that these resources meet the following requirements: +The problem usually stems from incorrectly defined `BlockDevice` resources. Please make sure these resources meet the following requirements: - The `Consumable` field is set to `true`. -- For a `Volume Group` of type `Local`, the specified `BlockDevice` belong to the same node. +- For a `Volume Group` of the `Local` type, the specified `BlockDevice` belong to the same node. - The current names of the `BlockDevice` resources are specified. The full list of expected values can be found in the [CR reference](./cr.html) of the `LVMVolumeGroup` resource. @@ -47,7 +47,7 @@ The full list of expected values can be found in the [CR reference](./cr.html) o The `LVMVolumeGroup` resource will persist as long as the corresponding `Volume Group` exists. As long as at least one device exists, the `Volume Group` will be there, albeit in an unhealthy state. Note that these issues will be reflected in the resource's `status`. -When the unplugged device is reactivated, the `LVM Volume Group` will recover while the linked `LVMVolumeGroup` resource be brought to its current state as well. +Once the unplugged device is plugged back in and reactivated, the `LVM Volume Group` will regain its functionality while the corresponding `LVMVolumeGroup` resource will also be updated to reflect the current state. ## How to transfer control of an existing `LVM Volume Group` on the node to the controller? @@ -69,6 +69,6 @@ The controller will then stop tracking the selected `Volume Group` and delete th ## I haven't added the `storage.deckhouse.io/enabled=true` LVM tag to the `Volume Group`, but it is there. How is this possible? -This is possible if you have created the `LVM Volume Group` using the `LVMVolumeGroup` resource, in which case the controller will automatically add this LVM tag to the created `LVM Volume Group`. Alternatively, this applies if the `Volume Group` or its `Thin-pool` already had the `linstor` module LVM tag `linstor-*`. +This can happen if you created the `LVM Volume Group` using the `LVMVolumeGroup` resource, in which case the controller will automatically add this LVM tag to the created `LVM Volume Group`. This is also possible if the `Volume Group` or its `Thin-pool` already had the `linstor-*` LVM tag of the `linstor` module. -When you switch from the `linstor` module to the `sds-node-configurator` and `sds-drbd` modules, the `linstor-*` LVM tags are automatically replaced with the `storage.deckhouse.io/enabled=true` LVM tag in the `Volume Group`. This way, the `sds-node-configurator` gets control of these `Volume Groups`. +When you switch from the `linstor` module to the `sds-node-configurator` and `sds-drbd` modules, the `linstor-*` LVM tags are automatically replaced with the `storage.deckhouse.io/enabled=true` LVM tag in the `Volume Group`. This way, the `sds-node-configurator` gains control over these `Volume Groups`.