Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add caution/info boxes for VM image virtual size #631

Merged
merged 5 commits into from
Sep 2, 2024

Commits on Aug 27, 2024

  1. Add caution/info boxes for VM image virtual size

    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>
    tserong committed Aug 27, 2024
    Configuration menu
    Copy the full SHA
    0e267e8 View commit details
    Browse the repository at this point in the history

Commits on Aug 30, 2024

  1. Update docs/vm/create-vm.md

    Co-authored-by: Jillian <67180770+jillian-maroket@users.noreply.github.com>
    tserong and jillian-maroket authored Aug 30, 2024
    Configuration menu
    Copy the full SHA
    d905fcb View commit details
    Browse the repository at this point in the history
  2. Update versioned_docs/version-v1.3/vm/create-vm.md

    Co-authored-by: Jillian <67180770+jillian-maroket@users.noreply.github.com>
    tserong and jillian-maroket authored Aug 30, 2024
    Configuration menu
    Copy the full SHA
    213b72f View commit details
    Browse the repository at this point in the history
  3. Update caution/info boxes for VM image virtual size

    Signed-off-by: Tim Serong <tserong@suse.com>
    tserong committed Aug 30, 2024
    Configuration menu
    Copy the full SHA
    6324a8e View commit details
    Browse the repository at this point in the history
  4. Add caution/info boxes for VM image virtual size (v1.2)

    Signed-off-by: Tim Serong <tserong@suse.com>
    tserong committed Aug 30, 2024
    Configuration menu
    Copy the full SHA
    3e81be7 View commit details
    Browse the repository at this point in the history