Skip to content

Commit bcef611

Browse files
authored
add note for deprecation of --persist flag for virtctl add/remove volume (#963)
Signed-off-by: dsanatar <dsanatar@redhat.com>
1 parent af1c171 commit bcef611

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

docs/storage/hotplug_volumes.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -170,10 +170,12 @@ Remove `disk1` from the `spec.template.spec.domain.devices.disks` section of the
170170

171171
Volumes may also be added to VirtualMachines with virtctl. Virtctl is also the only way to hotplug a volume directly into a VirtualMachineInstance. Virtctl does not support CD-ROM inject/eject.
172172

173+
> **_NOTE:_** the `--persist` flag for `virtctl addvolume` and `virtctl removevolume` has been deprecated and will be removed in a future release. The default behavior for these commands will be to alway persist hotplug changes to both VirtualMachineInstance and owner VirtualMachine (if one exists)
174+
173175
### Add a disk to a VirtualMachine
174176

175177
```bash
176-
$ virtctl addvolume testvm --volume-name=hotplug-disk --persist
178+
$ virtctl addvolume testvm --volume-name=hotplug-disk
177179
```
178180

179181
### Add a disk to a VirtualMachineInstance
@@ -187,7 +189,7 @@ $ virtctl addvolume testvmi --volume-name=hotplug-disk
187189
### Add a LUN to a VirtualMachine
188190

189191
```bash
190-
$ virtctl addvolume testvm --volume-name=hotplug-disk --persist --disk-type=lun
192+
$ virtctl addvolume testvm --volume-name=hotplug-disk --disk-type=lun
191193
```
192194

193195
### Additional `addvolume` args
@@ -201,7 +203,7 @@ $ virtctl addvolume testvm --volume-name=hotplug-disk --persist --disk-type=lun
201203
### Unplug a disk/LUN from a VirtualMachine
202204

203205
```bash
204-
$ virtctl removevolume testvm --volume-name=hotplug-disk --persist
206+
$ virtctl removevolume testvm --volume-name=hotplug-disk
205207
```
206208

207209
### VolumeStatus

0 commit comments

Comments
 (0)