Project

General

Profile

Bug #19096

Installer "Upgrade Method" screen is inconsistent and assumes too much knowledge of ZFS and FreeNAS

Added by Warren Block about 3 years ago. Updated almost 2 years ago.

Status:
Resolved
Priority:
Nice to have
Assignee:
Vaibhav Chauhan
Category:
OS
Target version:
Seen in:
Severity:
New
Reason for Closing:
Reason for Blocked:
Needs QA:
Yes
Needs Doc:
Yes
Needs Merging:
Yes
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:
ChangeLog Required:
No

Description

The new Upgrade Method screen (attached) is inconsistent in the terms it uses, assumes ZFS and FreeNAS knowledge on the part of the user, and is not clear about what it will do.

Questions the typical FreeNAS user will ask:

  • What is a "boot environment"?
  • What is a "dataset"?
  • Why does this screen say I can install into a boot environment, but then only offer to "Save old system dataset"?
  • What does "Save old system dataset" mean?
  • How can I install into a boot environment?
  • Won't formatting the disk erase all my data?
  • Won't formatting the disk lose my configuration?
  • Won't formatting the disk erase all my old boot environments?

Suggestions:

  • Be clear about the choices here. Do not switch terms. Stick with "boot environment".
  • Be specific: not "the disk", but "the boot device".
  • Mention that only the boot device will be affected, storage volumes are not touched.
  • Mention that user configuration data is preserved even when the boot device is formatted.
  • Change the choices to "Install into a new boot environment" and "Format the boot device".
  • "Install into a new boot environment" should be the default, as the less destructive option.
  • Actually, either way will install into a new boot environment, so maybe "Format the boot device" should just be a checkbox (off by default), and this should just have a Continue button after the user makes that choice.

I can make suggestions on rewording after it is clear what this actually means.

upgrademethod.jpg (46.4 KB) upgrademethod.jpg upgrade method screenshot Warren Block, 11/21/2016 10:56 AM
upgrademethod-new.jpg (39.8 KB) upgrademethod-new.jpg Warren Block, 11/22/2016 01:36 PM
install_inplace.diff (945 Bytes) install_inplace.diff Warren Block, 12/08/2016 10:27 AM
7821
7833

Related issues

Related to FreeNAS - Feature #17132: When doing upgrades, install direct to existing zpoolResolved2016-08-30

Associated revisions

Revision 0c9b828c (diff)
Added by Kris Moore about 3 years ago

Improve the wording of installing into a new BE vs formatting the disk. Ticket: #19096

Revision 8b4d742d (diff)
Added by Kris Moore about 3 years ago

Fix reversed logic in install question about inplace vs format installation and fix spacing issue Ticket: #19096

Revision e40673bb (diff)
Added by Kris Moore about 3 years ago

Fix reversed logic in install question about inplace vs format installation and fix spacing issue Ticket: #19096

Revision bc433765 (diff)
Added by Kris Moore about 3 years ago

Fix reversed logic in install question about inplace vs format installation and fix spacing issue Ticket: #19096

Revision f0237746 (diff)
Added by Kris Moore about 3 years ago

I misunderstood the wording of reverse the options. Fixing it correctly this time. Thanks wblock! Ticket: #19096

Revision b8537fe9 (diff)
Added by Kris Moore about 3 years ago

I misunderstood the wording of reverse the options. Fixing it correctly this time. Thanks wblock! Ticket: #19096

Revision 9cdb6961 (diff)
Added by Kris Moore about 3 years ago

I misunderstood the wording of reverse the options. Fixing it correctly this time. Thanks wblock! Ticket: #19096

History

#1 Updated by Heather Ownby about 3 years ago

  • Assignee set to Kris Moore

#2 Updated by Warren Block about 3 years ago

  • Related to Feature #17132: When doing upgrades, install direct to existing zpool added

#3 Avatar?id=14398&size=24x24 Updated by Kris Moore about 3 years ago

  • Status changed from Unscreened to Screened

It should probably be just "Format the Boot Device" or "Install into existing Boot-Environment". It basically means exactly that. First option will wipe the boot device, second will preserve the old boot device setup.

Any thoughts on how to word that into a newbie friendly way?

#4 Updated by Warren Block about 3 years ago

7833

How about this?

dialog --trim --title 'Update Method Selection' --yes-label 'Install in new boot environment' --no-label 'Format the boot device' --yesno 'User configuration settings and storage volumes are preserved and not affected by this step.\n\nThe boot device can be formatted to remove old versions, or the upgrade can be installed in a new boot environment without affecting any existing versions.' 0 0

Sample attached.

#5 Avatar?id=14398&size=24x24 Updated by Kris Moore about 3 years ago

  • 1 added project (FreeNAS 10)
  • Status changed from Screened to Ready For Release
  • Assignee changed from Kris Moore to Vaibhav Chauhan

Wording change included, does seem to be a bit clearer now. Thanks Warren!

#6 Updated by Warren Block about 3 years ago

  • Status changed from Ready For Release to Unscreened
  • Assignee changed from Vaibhav Chauhan to Kris Moore

Kris Moore wrote:

Wording change included, does seem to be a bit clearer now. Thanks Warren!

Thank you. Just two things:

1. There really should be a blank line after the first sentence to separate that thought from the rest of it.
2. The logic in the dialog changed, but the logic in the code has not. So if the user chooses "Install in new boot environment", the next dialog says "This will erase ALL partitions and data on ada0." So the test in the code for what the dialog returns needs to be inverted. (Seen in 9.10.2-154.)

#7 Avatar?id=14398&size=24x24 Updated by Kris Moore about 3 years ago

  • Status changed from Unscreened to Reviewed
  • Assignee changed from Kris Moore to Vaibhav Chauhan

Over to VB for merge into 9.10.2

#8 Updated by Warren Block about 3 years ago

This change reverses the options, so "format" is now the default. Patch to switch back to the other way attached, just inverting the test where ask_upgrade_inplace is called. (untested)

#9 Updated by Vaibhav Chauhan about 3 years ago

  • Status changed from Reviewed to Ready For Release

#10 Updated by Dru Lavigne almost 2 years ago

  • Status changed from Ready For Release to Resolved

Also available in: Atom PDF