Add caution/info boxes for VM image virtual size #631
Conversation
When creating volumes from images, it's important the the volume size be greater than or equal to the size of the underlying image. If this is not the case, you'll potentially end up with a corrupt or truncated filesystem in the volume. This is particularly likely to occur with qcow2 images, which can have a virtual size larger than the physical image size. In Harvester v1.3 and earlier, when creating VMs, the volume size just defaults to 10GiB, regardless of the size of the underyling image. When creating volumes on the volume screen, the size has no default. In both cases it's hard to know the correct size to use, because Harvester prior to v1.4 doesn't expose the virtual size of qcow2 images anywhere. Because of this, I've used "caution" boxes for the v1.3 docs. In Harvester v1.4, the dashboard will default to setting the size of volumes so they're at least as large as the virtual size of the image, which means users are unlikely to run into trouble (unless they deliberately choose to make the volume size smaller for some reason), so I've dialed it back a bit and used the "info important" style for this version. If this looks generally OK, I'll copy the v1.3 docs back to v1.2 as well. Related issue: harvester/harvester#4905 Signed-off-by: Tim Serong <tserong@suse.com>
|
|
Thinking about this some more, I should probably make the v1.3 VM creation note explicitly say that Harvester defaults to 10GiB, something like this:
It's getting pretty wordy though :-/ |
There was a problem hiding this comment.
@tserong Looks good overall, just rephrased in a few places for clarity. Let me know what you think.
Co-authored-by: Jillian <67180770+jillian-maroket@users.noreply.github.com>
Co-authored-by: Jillian <67180770+jillian-maroket@users.noreply.github.com>
Signed-off-by: Tim Serong <tserong@suse.com>
Signed-off-by: Tim Serong <tserong@suse.com>
|
Thanks @jillian-maroket that's excellent. I've also applied what you suggested to the volume creation pages, and then copied the v1.3 changes back to v1.2. |
There was a problem hiding this comment.
@tserong LGTM. The context you provided made all the difference. Massive thanks for making my job easier.
When creating volumes from images, it's important the the volume size be greater than or equal to the size of the underlying image. If this is not the case, you'll potentially end up with a corrupt or truncated filesystem in the volume. This is particularly likely to occur with qcow2 images, which can have a virtual size larger than the physical image size.
In Harvester v1.3 and earlier, when creating VMs, the volume size just defaults to 10GiB, regardless of the size of the underyling image. When creating volumes on the volume screen, the size has no default. In both cases it's hard to know the correct size to use, because Harvester prior to v1.4 doesn't expose the virtual size of qcow2 images anywhere. Because of this, I've used "caution" boxes for the v1.3 docs.
In Harvester v1.4, the dashboard will default to setting the size of volumes so they're at least as large as the virtual size of the image, which means users are unlikely to run into trouble (unless they deliberately choose to make the volume size smaller for some reason), so I've dialed it back a bit and used the "info important" style for this version.
If this looks generally OK, I'll copy the v1.3 docs back to v1.2 as well.
Related issue: harvester/harvester#4905