Small changes in CRDs

Signed-off-by: Aleksandr Zimin <[email protected]>
deckhouse · Jan 18, 2024 · 01b71cf · 01b71cf
1 parent de50433
commit 01b71cf
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 18 deletions.
diff --git a/crds/blockdevices.yaml b/crds/blockdevices.yaml
@@ -24,20 +24,18 @@ spec:
         openAPIV3Schema:
           type: object
           description: |
-            BlockDevice is a Kubernetes Custom Resource that displays actual information about block devices, which might be used by the sds-node-configurator controller to create Volume Groups, extend Physical Volumes, and so on.
+            The resource displays actual information about block devices, which might be used by the sds-node-configurator controller for operations in LVM.
             
-            > The resource is created and managed by the controller only.
+            > The resource is created and managed by the controller only. Manual modification of the resource is prohibited.
           properties:
             status:
               type: object
-              description: |
-                Defines the current device state.
               required: [size,type,consumable,path,rota,hotPlug,nodeName,machineId]
               properties:
                 type:
                   type: string
                   description: |
-                    The device's type.
+                    The device's type (disk, part, RAID, and others).
                 fsType:
                   type: string
                   enum: [LVM2_member, ""]
@@ -50,7 +48,7 @@ spec:
                 consumable:
                   type: boolean
                   description: |
-                    The flag that defines whether this device can be used by the controller.
+                    The flag that defines whether this device can be used by the controller to create an LVM Physical Volume.
                 pvUUID:
                   type: string
                   description: |
@@ -60,15 +58,15 @@ spec:
                 vgUUID:
                   type: string
                   description: | 
-                    The Volume Group UUID.
+                    The UUID of the Volume Group to which this device belongs as a Physical Volume.
 
                     > Optional: exists only if the device is used as a Physical Volume and is included in a Volume Group.
                 lvmVolumeGroupName:
                   type: string
                   description: | 
                     The LVMVolumeGroup resource name. 
                     
-                    > Optional: exists only if the device is used as a Physical Volume and is included in a Volume Group and LVMVolumeGroup resource.
+                    > Optional: exists only if the device is used as a Physical Volume, included in a Volume Group, and specified in an LVMVolumeGroup resource.
                 actualVGNameOnTheNode:
                   type: string
                   description: |

diff --git a/crds/doc-ru-blockdevices.yaml b/crds/doc-ru-blockdevices.yaml
@@ -4,17 +4,15 @@ spec:
       schema:
         openAPIV3Schema:
           description: |
-            BlockDevice — это пользовательский ресурс Kubernetes, который отображает актуальную информацию о блочных устройствах, которые могут быть использованы контроллером sds-node-configurator для операций создания Volume Group, расширения Physical Volume и других.
+            Ресурс отображает актуальную информацию о блочных устройствах, которые могут быть использованы контроллером sds-node-configurator для операций в LVM.
             
-            > Ресурс создается и обслуживается только контроллером.
+            > Ресурс создается и обслуживается только контроллером. Ручное изменение ресурса запрещено.
           properties:
             status:
-              description: |
-                Определяет текущее состояние девайса.
               properties:
                 type:
                   description: |
-                    Тип девайса.
+                    Тип девайса (диск, партиция, RAID и другие).
                 fsType:
                   description: |
                     Тип файловой системы.
@@ -23,22 +21,22 @@ spec:
                     Имя Kubernetes-узла, на котором находится девайс.
                 consumable:
                   description: |                    
-                    Флаг, определяющий, может ли данный девайс быть использован контроллером.
+                    Флаг, определяющий, может ли данный девайс быть использован контроллером для создания LVM Physical Volume.
                 pvUUID:
                   description: |                    
                     UUID Physical Volume.
                                         
                     > Опциально: присутствует, только если девайс используется как Physical Volume.
                 vgUUID:
                   description: |
-                    UUID Volume Group.
+                    UUID Volume Group, которой принадлежит данный девайс в качестве Physical Volume.
 
                     > Опциально: присутствует, только если девайс используется как Physical Volume и включен в Volume Group.
                 lvmVolumeGroupName:
                   description: |
                     Имя ресурса LVMVolumeGroup.
                     
-                    > Опциально: присутствует, только если девайс используется как Physical Volume и включен в Volume Group и LVMVolumeGroup-ресурс.
+                    > Опциально: присутствует, только если девайс используется как Physical Volume, включен в Volume Group и указан в LVMVolumeGroup-ресурсе.
                 actualVGNameOnTheNode:
                   description: |
                     Фактическое имя Volume Group на узле, в который включен девайс.

diff --git a/crds/doc-ru-lvmvolumegroup.yaml b/crds/doc-ru-lvmvolumegroup.yaml
@@ -4,7 +4,7 @@ spec:
       schema:
         openAPIV3Schema:
           description: |
-            LVMVolumeGroup — это ресурс для управления Volume Group'ами и Thin pool'ами на узлах.
+            Интерфейс управления Volume Group'ами и Thin pool'ами на узлах.
             
             > Этот тип ресурсов может быть создан как самим пользователем, так и контроллером SDS-Node-Configurator.
             Контроллер sds-node-configurator автоматически создаст ресурс LVMVolumeGroup в случае, если найдет на узле существующую Volume Group со специальным тегом 'storage.deckhouse.io/enabled=true', при этом контроллер самостоятельно заполнит как `spec`, так и `status` поля.

diff --git a/crds/lvmvolumegroup.yaml b/crds/lvmvolumegroup.yaml
@@ -24,7 +24,7 @@ spec:
         openAPIV3Schema:
           type: object
           description: |
-            LVMVolumeGroup is a Kubernetes Custom Resource for managing the Volume Groups and Thin pools on the nodes.
+            An interface for managing Volume Groups and Thin pools on the nodes.
             
             > These resources might be created both by a user and the SDS-Node-Configurator controller. 
             The SDS-Node-Configurator controller will automatically create an LVMVolumeGroup resource if it detects an existing Volume Group on a node tagged with 'storage.deckhouse.io/enabled=true'. The controller will fill both the 'Spec' and 'Status' fields.