[docs] Add labels list for BlockDevice (#121)

Signed-off-by: v.oleynikov <[email protected]>

.gitignore

@@ -28,6 +28,7 @@
 .settings
 .idea/
 venv/
+*.code-workspace
 
 # macOS Finder files
 *.DS_Store
@@ -43,3 +44,4 @@ __pycache__/
 # dev
 images/agent/dev
 images/agent/Makefile
+local_build.sh

docs/FAQ.md

@@ -75,3 +75,33 @@ The controller will then stop tracking the selected `Volume Group` and delete th
 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` gains control over these `Volume Groups`.
+
+## Which labels are added by the controller to BlockDevice resources
+
+* status.blockdevice.storage.deckhouse.io/type - LVM type
+
+* status.blockdevice.storage.deckhouse.io/fstype - filesystem type
+
+* status.blockdevice.storage.deckhouse.io/pvuuid - PV UUID
+
+* status.blockdevice.storage.deckhouse.io/vguuid - VG UUID
+
+* status.blockdevice.storage.deckhouse.io/partuuid - partition UUID
+
+* status.blockdevice.storage.deckhouse.io/lvmvolumegroupname - resource name
+
+* status.blockdevice.storage.deckhouse.io/actualvgnameonthenode - actual VG name on the node
+
+* status.blockdevice.storage.deckhouse.io/wwn - WWN (World Wide Name) identifier for the device
+
+* status.blockdevice.storage.deckhouse.io/serial - device serial number
+
+* status.blockdevice.storage.deckhouse.io/size - size
+
+* status.blockdevice.storage.deckhouse.io/model - device model
+
+* status.blockdevice.storage.deckhouse.io/rota - whether it is a rotational device
+
+* status.blockdevice.storage.deckhouse.io/hotplug - hot-plug capability
+
+* status.blockdevice.storage.deckhouse.io/machineid - ID of the server on which the block device is installed

docs/FAQ_RU.md

@@ -76,3 +76,33 @@ vgchange myvg-0 --deltag storage.deckhouse.io/enabled=true
 Это возможно в случае, если вы создавали `LVM Volume Group` через ресурс `LVMVolumeGroup` (в таком случае контроллер автоматически вешает данный LVM-тег на созданную `LVM Volume Group`). Либо на данной `Volume Group` или ее `Thin-pool` был LVM-тег модуля `linstor` — `linstor-*`.
 
 При миграции с встроенного модуля `linstor` на модули `sds-node-configurator` и `sds-drbd` автоматически происходит изменение LVM-тегов `linstor-*` на LVM-тег `storage.deckhouse.io/enabled=true` в `Volume Group`. Таким образом, управление этими `Volume Group` передается модулю `sds-node-configurator`.
+
+## Какие лейблы добавляются контроллером на ресурсы BlockDevices
+
+* status.blockdevice.storage.deckhouse.io/type - тип LVM
+
+* status.blockdevice.storage.deckhouse.io/fstype - тип файловой системы
+
+* status.blockdevice.storage.deckhouse.io/pvuuid - UUID PV
+
+* status.blockdevice.storage.deckhouse.io/vguuid - UUID VG
+
+* status.blockdevice.storage.deckhouse.io/partuuid - UUID раздела
+
+* status.blockdevice.storage.deckhouse.io/lvmvolumegroupname - имя этого ресурса
+
+* status.blockdevice.storage.deckhouse.io/actualvgnameonthenode - название VolumeGroup на ноде
+
+* status.blockdevice.storage.deckhouse.io/wwn - идентификатор WWN (World Wide Name) для устройства
+
+* status.blockdevice.storage.deckhouse.io/serial - серийный номер устройства
+
+* status.blockdevice.storage.deckhouse.io/size - раздел
+
+* status.blockdevice.storage.deckhouse.io/model - модель устройства
+
+* status.blockdevice.storage.deckhouse.io/rota - является ли ротационным  устройством
+
+* status.blockdevice.storage.deckhouse.io/hotplug - возможность hot подключения
+
+* status.blockdevice.storage.deckhouse.io/machineid - ID сервера, на котором установлено блочное устройство