From 67ae43bfea27e9d85597676e62500f7f51a931ae Mon Sep 17 00:00:00 2001 From: mortelumina98 Date: Tue, 3 Dec 2024 10:35:35 +0300 Subject: [PATCH] update readme doc Signed-off-by: mortelumina98 --- docs/README.md | 28 ++++++++++++++-------------- docs/README.ru.md | 26 +++++++++++++------------- 2 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/README.md b/docs/README.md index 10707fe9..d2e261d2 100644 --- 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 - <}} -Перед созданием ресурса `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 - <