Skip to content

Commit bfc9a1b

Browse files
committed
docs: post-review updates
Signed-off-by: Vladislav Panfilov <vladislav.panfilov@flant.com>
1 parent a29e584 commit bfc9a1b

File tree

2 files changed

+22
-18
lines changed

2 files changed

+22
-18
lines changed

docs/USER_GUIDE.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2097,11 +2097,6 @@ d8 k get nodes -o custom-columns=NAME:.metadata.name,ZONE:.metadata.labels.topol
20972097

20982098
You can attach disks and images to a virtual machine. They are described as block devices (BlockDevices).
20992099

2100-
Two attachment methods are available:
2101-
2102-
- Static attachment: Devices are listed in the VM specification at creation or start and form the initial configuration.
2103-
- Dynamic attachment (hotplug): Attaching and detaching devices to or from a running VM without a reboot. This can be done either by changing the `.spec.blockDeviceRefs` list or by using the [VirtualMachineBlockDeviceAttachment](/modules/virtualization/cr.html#virtualmachineblockdeviceattachment) resource.
2104-
21052100
Block device types and access modes:
21062101

21072102
| Block device type | Comment |
@@ -2110,13 +2105,20 @@ Block device types and access modes:
21102105
| [ClusterVirtualImage](/modules/virtualization/cr.html#clustervirtualimage) | Connected in read-only mode, or as a CD-ROM for ISO images. |
21112106
| [VirtualDisk](/modules/virtualization/cr.html#virtualdisk) | Connected in read/write mode. |
21122107

2108+
Two attachment methods are available:
2109+
2110+
- Via the VM specification (`.spec.blockDeviceRefs`): Disks are listed in the [VirtualMachine](/modules/virtualization/cr.html#virtualmachine) configuration and boot order is set for them (by position in the list or via the `bootOrder` field). Recommended when configuring the VM manually or via GitOps, or when you need to control boot order (e.g., an ISO for OS installation).
2111+
- Via [VirtualMachineBlockDeviceAttachment](/modules/virtualization/cr.html#virtualmachineblockdeviceattachment) (`vmbda`): Disk is attached via a separate resource and does not participate in boot order. Recommended for automation and when you do not have permission to edit the VM.
2112+
2113+
Both methods support hotplug (add or remove without rebooting the VM).
2114+
21132115
#### Attaching via the VM specification
21142116

21152117
The list of block devices is defined in the `.spec.blockDeviceRefs` field of the [VirtualMachine](/modules/virtualization/cr.html#virtualmachine) resource.
21162118

21172119
By default, boot order follows the order of devices in the list. You can set it explicitly with the optional `bootOrder` field (smaller value means higher priority). If `bootOrder` is set for at least one device, only devices with `bootOrder` set are included in the boot sequence. Allowed values: integers ≥ 1, unique within the list. When you remove a device from the list, boot order is recalculated for the remaining devices.
21182120

2119-
Adding or removing entries in `.spec.blockDeviceRefs` is applied to a running VM without a reboot (hotplug). Changing the order of devices in the list or their `bootOrder` values takes effect after a VM reboot. This allows you to attach an ISO image for OS installation with the desired boot priority, then remove it from the list and detach it without rebooting the VM.
2121+
Changing the order of devices in the list or their `bootOrder` values takes effect after a VM reboot. For example, you can attach an ISO image for OS installation with the desired boot priority, then remove it from the list after installation.
21202122

21212123
Virtual machine configuration fragment with block devices and explicit boot order:
21222124

@@ -2144,7 +2146,7 @@ spec:
21442146
name: <additional-disk-name>
21452147
```
21462148

2147-
To detach a disk, remove it from the list. The disk will be detached from the running virtual machine without a reboot.
2149+
To detach a disk, remove it from the list.
21482150

21492151
How to work with bootable block devices in the web interface:
21502152

@@ -2156,7 +2158,7 @@ How to work with bootable block devices in the web interface:
21562158

21572159
#### Attaching via VirtualMachineBlockDeviceAttachment (vmbda)
21582160

2159-
The [VirtualMachineBlockDeviceAttachment](/modules/virtualization/cr.html#virtualmachineblockdeviceattachment) resource provides hot-plug: attach and detach a block device to or from a running VM without changing its spec and without a reboot. Suited for automation and scenarios when the user does not have permission to edit the VM.
2161+
The [VirtualMachineBlockDeviceAttachment](/modules/virtualization/cr.html#virtualmachineblockdeviceattachment) resource attaches and detaches a block device to or from a VM without changing its spec. Suited for automation and scenarios when the user does not have permission to edit the VM.
21602162

21612163
Create a resource that attaches the empty disk `blank-disk` to the virtual machine `linux-vm`:
21622164

@@ -2219,7 +2221,7 @@ To detach the disk from the virtual machine, delete the previously created resou
22192221
d8 k delete vmbda attach-blank-disk
22202222
```
22212223

2222-
Attaching images is done by analogy. Set `kind` to `VirtualImage` or `ClusterVirtualImage` and specify the image name:
2224+
Attaching images is done by analogy: set the `kind` field to VirtualImage or ClusterVirtualImage and the image name.
22232225

22242226
```bash
22252227
d8 k apply -f - <<EOF

docs/USER_GUIDE.ru.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2119,11 +2119,6 @@ d8 k get nodes -o custom-columns=NAME:.metadata.name,ZONE:.metadata.labels.topol
21192119

21202120
К виртуальной машине можно подключать диски и образы. Они описываются как блочные устройства (BlockDevices).
21212121

2122-
Подключение возможно двумя способами:
2123-
2124-
- Статическое подключение — устройства перечислены в спецификации ВМ при создании или запуске и входят в начальную конфигурацию.
2125-
- Динамическое подключение (hotplug) — подключение и отключение устройств к уже запущенной ВМ без перезагрузки. Реализуется как через изменение списка `.spec.blockDeviceRefs`, так и через отдельный ресурс [VirtualMachineBlockDeviceAttachment](/modules/virtualization/cr.html#virtualmachineblockdeviceattachment).
2126-
21272122
Типы блочных устройств и режимы доступа:
21282123

21292124
| Тип блочного устройства | Комментарий |
@@ -2132,13 +2127,20 @@ d8 k get nodes -o custom-columns=NAME:.metadata.name,ZONE:.metadata.labels.topol
21322127
| [ClusterVirtualImage](/modules/virtualization/cr.html#clustervirtualimage) | Подключается в режиме для чтения, или как CD-ROM для ISO-образов. |
21332128
| [VirtualDisk](/modules/virtualization/cr.html#virtualdisk) | Подключается в режиме для чтения и записи. |
21342129

2130+
Подключение устройств возможно двумя способами:
2131+
2132+
- через спецификацию ВМ (`.spec.blockDeviceRefs`) — диски указываются в конфигурации [VirtualMachine](/modules/virtualization/cr.html#virtualmachine) и для них задаётся порядок загрузки (по позиции в списке или через поле `bootOrder`). Рекомендуется при настройке ВМ вручную, а также когда нужен контроль порядка загрузки (например, ISO для установки ОС).
2133+
- через [VirtualMachineBlockDeviceAttachment](/modules/virtualization/cr.html#virtualmachineblockdeviceattachment) (`vmbda`) — диск подключается отдельным ресурсом и не участвует в порядке загрузки. Рекомендуется для автоматизации и когда нет прав на редактирование ВМ.
2134+
2135+
Оба способа поддерживают hotplug (добавление и удаление устройства без перезагрузки ВМ).
2136+
21352137
#### Подключение через спецификацию ВМ
21362138

21372139
Список блочных устройств задаётся в поле `.spec.blockDeviceRefs` ресурса [VirtualMachine](/modules/virtualization/cr.html#virtualmachine).
21382140

21392141
Порядок загрузки по умолчанию совпадает с порядком устройств в списке. Его можно задать явно с помощью необязательного поля `bootOrder` (меньшее значение — выше приоритет). Если `bootOrder` указан хотя бы у одного устройства, в цепочку загрузки попадают только устройства с заданным `bootOrder`. Допустимые значения: целые ≥ 1, уникальные в пределах списка. При удалении устройства из списка порядок загрузки пересчитывается для оставшихся устройств.
21402142

2141-
Добавление и удаление элементов в `.spec.blockDeviceRefs` применяется к работающей ВМ без перезагрузки (hotplug). Изменение порядка устройств в списке или значений `bootOrder` вступает в силу после перезагрузки ВМ. Это позволяет, например, подключить ISO-образ для установки ОС с нужным приоритетом загрузки, а после установки удалить его из списка и отключить без перезагрузки ВМ.
2143+
Изменение порядка устройств в списке или значений `bootOrder` вступает в силу после перезагрузки ВМ. Например, можно подключить ISO-образ для установки ОС с нужным приоритетом загрузки, а после установки удалить его из списка.
21422144

21432145
Фрагмент конфигурации виртуальной машины с блочными устройствами и явным порядком загрузки:
21442146

@@ -2166,7 +2168,7 @@ spec:
21662168
name: <additional-disk-name>
21672169
```
21682170

2169-
Для отключения диска удалите его из списка. Диск будет отсоединён от работающей виртуальной машины без перезагрузки.
2171+
Для отключения диска удалите его из списка.
21702172

21712173
Как работать со загрузочными блочными устройствами в веб-интерфейсе:
21722174

@@ -2178,7 +2180,7 @@ spec:
21782180

21792181
#### Подключение через VirtualMachineBlockDeviceAttachment (vmbda)
21802182

2181-
Ресурс [VirtualMachineBlockDeviceAttachment](/modules/virtualization/cr.html#virtualmachineblockdeviceattachment) обеспечивает hot-plug: подключение и отключение блочного устройства к работающей ВМ без изменения её спецификации и без перезагрузки. Подходит для автоматизации и сценариев, когда у пользователя нет прав на редактирование ВМ.
2183+
Ресурс [VirtualMachineBlockDeviceAttachment](/modules/virtualization/cr.html#virtualmachineblockdeviceattachment) подключает и отключает блочное устройство у ВМ без изменения её спецификации. Подходит для автоматизации и сценариев, когда у пользователя нет прав на редактирование ВМ.
21822184

21832185
Создайте ресурс, который подключит пустой диск `blank-disk` к виртуальной машине `linux-vm`:
21842186

@@ -2241,7 +2243,7 @@ sdc 8:32 0 95.9M 0 disk <--- динамически подключен
22412243
d8 k delete vmbda attach-blank-disk
22422244
```
22432245

2244-
Подключение образов, осуществляется по аналогии. Для этого в качестве `kind` указать VirtualImage или ClusterVirtualImage и имя образа:
2246+
Подключение образов осуществляется по аналогии: укажите в поле `kind` значение VirtualImage или ClusterVirtualImage и имя образа.
22452247

22462248
```bash
22472249
d8 k apply -f - <<EOF

0 commit comments

Comments
 (0)