update readme doc

Signed-off-by: mortelumina98 <ekaterina.matseevska@flant.com>
deckhouse · Dec 3, 2024 · 67ae43b · 67ae43b
1 parent 23e931f
commit 67ae43b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 27 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -6,13 +6,13 @@ moduleStatus: preview
 
 The module manages local block storage based on LVM. It enables the creation of StorageClasses in Kubernetes using [LocalStorageClass](cr.html#localstorageclass) custom resources.
 
-To create a StorageClass, you must first configure `LVMVolumeGroup` on the cluster nodes. The LVM configuration is handled by the [sds-node-configurator](../../sds-node-configurator/stable/) module.
+To create a StorageClass, you must first configure LVMVolumeGroup on the cluster nodes. The LVM configuration is handled by the [sds-node-configurator](../../sds-node-configurator/stable/) module.
 
 ## Module setup steps
 
 To ensure the correct operation of the `sds-local-volume` module, follow these steps:
 
-- Configure `LVMVolumeGroup`.
+- Configure LVMVolumeGroup.
 
   Before creating a StorageClass, you need to create the [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) resource of the `sds-node-configurator` module on the cluster nodes.
 
@@ -77,7 +77,7 @@ Enabling the `sds-local-volume` module:
    kubectl get modules sds-local-volume -w
    ```
 
-1. Make sure that all pods in `d8-sds-local-volume` and `d8-sds-node-configurator` namespaces are `Running` or `Completed` and are running on all nodes where `LVM` resources are intended to be used.
+1. Make sure that all pods in `d8-sds-local-volume` and `d8-sds-node-configurator` namespaces are `Running` or `Completed` and are running on all nodes where LVM resources are intended to be used.
 
    ```shell
    kubectl -n d8-sds-local-volume get pod -owide -w
@@ -98,7 +98,7 @@ kubectl -n d8-sds-local-volume get pod -owide
 
 ### Configuring storage on nodes
 
-You need to create LVM volume groups on the nodes using `LVMVolumeGroup` custom resources. As part of this quickstart guide, we will create a regular Thick storage.
+You need to create LVM volume groups on the nodes using LVMVolumeGroup custom resources. As part of this quickstart guide, we will create a regular storage Thick.
 
 {{< alert level="warning" >}}
 Please ensure that the `sds-local-volume-csi-node` pod is running on the node before creating the `LVMVolumeGroup`. You can do this using the command:
@@ -125,7 +125,7 @@ kubectl -n d8-sds-local-volume get pod -owide
    dev-6c5abbd549100834c6b1668c8f89fb97872ee2b1   worker-2   false        894006140416   /dev/nvme0n1p6
    ```
 
-1. Create an [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) resource for `worker-0`:
+1. Create an [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) resource for worker-0:
 
    ```yaml
    kubectl apply -f - <<EOF
@@ -148,15 +148,15 @@ kubectl -n d8-sds-local-volume get pod -owide
    EOF
    ```
 
-1. Wait for the created `LVMVolumeGroup` resource to become `Ready`:
+1. Wait for the created LVMVolumeGroup resource to become `Ready`:
 
    ```shell
    kubectl get lvg vg-1-on-worker-0 -w
    ```
 
-The resource becoming `Ready` means that an LVM VG named `vg-1` made up of the `/dev/nvme1n1` and `/dev/nvme0n1p6` block devices has been created on the `worker-0` node.
+The resource becoming `Ready` means that an LVM VG named `vg-1` made up of the `/dev/nvme1n1` and `/dev/nvme0n1p6` block devices has been created on the worker-0 node.
 
-1. Create an [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) resource for `worker-1`:
+1. Create an [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) resource for worker-1:
 
    ```yaml
    kubectl apply -f - <<EOF
@@ -179,15 +179,15 @@ The resource becoming `Ready` means that an LVM VG named `vg-1` made up of the `
    EOF
    ```
 
-1. Wait for the created `LVMVolumeGroup` resource to become `Ready`:
+1. Wait for the created LVMVolumeGroup resource to become `Ready`:
 
    ```shell
    kubectl get lvg vg-1-on-worker-1 -w
    ```
 
-The resource becoming `Ready` means that an LVM VG named `vg-1` made up of the `/dev/nvme1n1` and `/dev/nvme0n1p6` block device has been created on the `worker-1` node.
+The resource becoming `Ready` means that an LVM VG named `vg-1` made up of the `/dev/nvme1n1` and `/dev/nvme0n1p6` block device has been created on the worker-1 node.
 
-1. Create an [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) resource for `worker-2`:
+1. Create an [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) resource for worker-2:
 
    ```yaml
    kubectl apply -f - <<EOF
@@ -210,13 +210,13 @@ The resource becoming `Ready` means that an LVM VG named `vg-1` made up of the `
    EOF
    ```
 
-1. Wait for the created `LVMVolumeGroup` resource to become `Ready`:
+1. Wait for the created LVMVolumeGroup resource to become `Ready`:
 
    ```shell
    kubectl get lvg vg-1-on-worker-2 -w
    ```
 
-The resource becoming `Ready` means that an LVM VG named `vg-1` made up of the `/dev/nvme1n1` and `/dev/nvme0n1p6` block device has been created on the `worker-2` node.
+The resource becoming `Ready` means that an LVM VG named `vg-1` made up of the `/dev/nvme1n1` and `/dev/nvme0n1p6` block device has been created on the worker-2 node.
 
 1. Create a [LocalStorageClass](./cr.html#localstorageclass) resource:
 
@@ -238,7 +238,7 @@ The resource becoming `Ready` means that an LVM VG named `vg-1` made up of the `
    EOF
    ```
 
-1. Wait for the created `LocalStorageClass` resource to become `Created`:
+1. Wait for the created LocalStorageClass resource to become `Created`:
 
    ```shell
    kubectl get lsc local-storage-class -w

diff --git a/docs/README.ru.md b/docs/README.ru.md
@@ -75,7 +75,7 @@ moduleStatus: preview
    kubectl get modules sds-local-volume -w
    ```
 
-1. Убедитесь, что в пространствах имен `d8-sds-local-volume` и `d8-sds-node-configurator` все поды находятся в статусе `Running` или `Completed` и запущены на всех узлах, где планируется использовать ресурсы `LVM`.
+1. Убедитесь, что в пространствах имен `d8-sds-local-volume` и `d8-sds-node-configurator` все поды находятся в статусе `Running` или `Completed` и запущены на всех узлах, где планируется использовать ресурсы LVM.
 
    ```shell
    kubectl -n d8-sds-local-volume get pod -owide -w
@@ -96,10 +96,10 @@ kubectl -n d8-sds-local-volume get pod -owide
 
 ### Настройка хранилища на узлах
 
-Для настройки хранилища на узлах необходимо создать группы томов LVM с использованием ресурсов `LVMVolumeGroup`. В данном примере создается хранилище Thick.
+Для настройки хранилища на узлах необходимо создать группы томов LVM с использованием ресурсов LVMVolumeGroup. В данном примере создается хранилище Thick.
 
 {{< alert level="warning" >}}
-Перед созданием ресурса `LVMVolumeGroup` убедитесь, что на данном узле запущен под `sds-local-volume-csi-node`. Это можно сделать командой:
+Перед созданием ресурса LVMVolumeGroup убедитесь, что на данном узле запущен под `sds-local-volume-csi-node`. Это можно сделать командой:
 
 ```shell
 kubectl -n d8-sds-local-volume get pod -owide
@@ -123,7 +123,7 @@ kubectl -n d8-sds-local-volume get pod -owide
    dev-6c5abbd549100834c6b1668c8f89fb97872ee2b1   worker-2   false        894006140416   /dev/nvme0n1p6
    ```
 
-1. Создайте ресурс [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) для узла `worker-0`:
+1. Создайте ресурс [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) для узла worker-0:
 
    ```yaml
    kubectl apply -f - <<EOF
@@ -146,15 +146,15 @@ kubectl -n d8-sds-local-volume get pod -owide
    EOF
    ```
 
-1. Дождитесь, когда созданный ресурс `LVMVolumeGroup` перейдет в состояние `Ready`:
+1. Дождитесь, когда созданный ресурс LVMVolumeGroup перейдет в состояние `Ready`:
 
    ```shell
    kubectl get lvg vg-1-on-worker-0 -w
    ```
 
-Если ресурс перешел в состояние `Ready`, это значит, что на узле `worker-0` из блочных устройств `/dev/nvme1n1` и `/dev/nvme0n1p6` была создана LVM VG с именем `vg-1`.
+Если ресурс перешел в состояние `Ready`, это значит, что на узле worker-0 из блочных устройств `/dev/nvme1n1` и `/dev/nvme0n1p6` была создана LVM VG с именем `vg-1`.
 
-1. Создайте ресурс [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) для узла `worker-1`:
+1. Создайте ресурс [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) для узла worker-1:
 
    ```yaml
    kubectl apply -f - <<EOF
@@ -177,15 +177,15 @@ kubectl -n d8-sds-local-volume get pod -owide
    EOF
    ```
 
-1. Дождитесь, когда созданный ресурс `LVMVolumeGroup` перейдет в состояние `Ready`:
+1. Дождитесь, когда созданный ресурс LVMVolumeGroup перейдет в состояние `Ready`:
 
    ```shell
    kubectl get lvg vg-1-on-worker-1 -w
    ```
 
-Если ресурс перешел в состояние `Ready`, это значит, что на узле `worker-1` из блочного устройства `/dev/nvme1n1` и `/dev/nvme0n1p6` была создана LVM VG с именем `vg-1`.
+Если ресурс перешел в состояние `Ready`, это значит, что на узле worker-1 из блочного устройства `/dev/nvme1n1` и `/dev/nvme0n1p6` была создана LVM VG с именем `vg-1`.
 
-1. Создайте ресурс [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) для узла `worker-2`:
+1. Создайте ресурс [LVMVolumeGroup](../../sds-node-configurator/stable/cr.html#lvmvolumegroup) для узла worker-2:
 
    ```yaml
    kubectl apply -f - <<EOF
@@ -208,13 +208,13 @@ kubectl -n d8-sds-local-volume get pod -owide
    EOF
    ```
 
-1. Дождитесь, когда созданный ресурс `LVMVolumeGroup` перейдет в состояние `Ready`:
+1. Дождитесь, когда созданный ресурс LVMVolumeGroup перейдет в состояние `Ready`:
 
    ```shell
    kubectl get lvg vg-1-on-worker-2 -w
    ```
 
-Если ресурс перешел в состояние `Ready`, то это значит, что на узле `worker-2` из блочного устройства `/dev/nvme1n1` и `/dev/nvme0n1p6` была создана LVM VG с именем `vg-1`.
+Если ресурс перешел в состояние `Ready`, то это значит, что на узле worker-2 из блочного устройства `/dev/nvme1n1` и `/dev/nvme0n1p6` была создана LVM VG с именем `vg-1`.
 
 1. Создайте ресурс [LocalStorageClass](./cr.html#localstorageclass):
 
@@ -236,7 +236,7 @@ kubectl -n d8-sds-local-volume get pod -owide
    EOF
    ```
 
-1. Дождитесь, когда созданный ресурс `LocalStorageClass` перейдет в состояние `Created`:
+1. Дождитесь, когда созданный ресурс LocalStorageClass перейдет в состояние `Created`:
 
    ```shell
    kubectl get lsc local-storage-class -w