Project

General

Profile

Bug #69625

Update tooltips for Init/Shutdown fields in new UI and Guide

Added by Shawn Brenneman almost 3 years ago. Updated over 2 years ago.

Status:
Done
Priority:
No priority
Assignee:
Timothy Moore II
Category:
GUI (new)
Target version:
Severity:
New
Reason for Closing:
Reason for Blocked:
Needs QA:
No
Needs Doc:
No
Needs Merging:
No
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:
ChangeLog Required:
No

Description

It's unclear from the documentation and the GUI how (or if?) "pre init" tasks are supposed to work. I'm filing this as a documentation bug, but it appears to be an interface issue as well.

In Tasks / Init/Shutdown Scripts / Add, the tooltip for the "When" field is:

Select when the command or script runs. Pre Init is very early in
boot process before mounting filesystems, Post Init is
towards the end of boot process before FreeNAS services
start, or at Shutdown.

However, trying to select a script outside the /mnt path is prevented by the UI. For example, trying to refer to a script in the /root directory is blocked with the error

The path must reside within a volume mount point

I don't need this feature, but stumbled across it while trying to debug issues with other init/shutdown tasks. These are the questions I had that either improved documentation or a modified interface might be able to clear up:

1. I guess the overall question: are pre-init scripts possible in FreeNAS? Should they be in the UI at all?
2. When do pre-init tasks actually run? What services are available at that time?
3. How can a pre-init script be selected? The GUI doesn't allow access to files outside the ZFS volumes, but pre-init tasks run before the ZFS volumes are mounted.

The tooltip verbiage is also repeated in the documentation here:
https://www.ixsystems.com/documentation/freenas/11.2/tasks.html#id20

pre-init-docs.png (41.6 KB) pre-init-docs.png Script path warning message and documentation tool tip. Shawn Brenneman, 01/12/2019 09:41 PM
48583

History

#1 Updated by Dru Lavigne almost 3 years ago

  • Category changed from Documentation to GUI (new)
  • Assignee changed from Release Council to Anonymous
  • Target version changed from Backlog to 11.2-U3

#3 Updated by Anonymous almost 3 years ago

  • Assignee changed from Anonymous to Warren Block

So you should be able to select a script as long as it is on a pool (I just tried selecting a script that was on my local pool for example /mnt/tank/somescript.sh) and that does still work as expected. I believe there is a reason that we limit the scripts to be on the pool itself so I think as the user originally mentioned this just needs a bit of documentation to direct users on where the script should reside (currently the tooltip just says "Browse to the script location.") and perhaps the error (which comes from the middleware) should be reworded to be a little more user friendly. Passing to Warren to consider this documentation.

#4 Updated by Anonymous almost 3 years ago

  • Assignee changed from Warren Block to Timothy Moore II

#5 Updated by Timothy Moore II almost 3 years ago

  • Status changed from Unscreened to Screened

#6 Updated by Timothy Moore II almost 3 years ago

  • Status changed from Screened to In Progress

#7 Updated by Timothy Moore II almost 3 years ago

Investigation: discussed with Middleware and determined Pre Init scripts run after filesystems are mounted and networking is started.

Resolution: Update relevant documentation and UI help text in Tasks > Init/Shutdown Scripts to reflect the new information.

#8 Updated by Timothy Moore II almost 3 years ago

Docs PRs: https://github.com/freenas/freenas-docs/pull/727 [angulargui] and https://github.com/freenas/freenas-docs/pull/728 [master]
Webui PRs: https://github.com/freenas/webui/pull/2000 [master] and https://github.com/freenas/webui/pull/2001 [freenas/11.2-stable]

Testing:

1. Open the new UI and go to Tasks > Init/Shutdown Scripts > ADD. Confirm the "Script" and "When" field help text is updated according to the webui PRs.

2. Build the FreeNAS guide [angulargui branch] and go to the Tasks > Init/Shutdown Scripts section. Verify the "Script" field documentation states the script must be chosen from an existing pool. Verify the "When" field documentation is updated to explain that Pre Init commands/scripts run after mounting filesystems and starting networking.

#9 Updated by Dru Lavigne almost 3 years ago

  • Needs Doc changed from Yes to No

#10 Updated by Anonymous almost 3 years ago

  • Status changed from In Progress to Ready for Testing
  • Needs Merging changed from Yes to No

#11 Updated by Dru Lavigne almost 3 years ago

  • Subject changed from Fix documentation for (or disable?) "Pre Init" scripts to Update tooltips for Init/Shutdown fields in new UI and Guide

#14 Avatar?id=55038&size=24x24 Updated by Zackary Welch over 2 years ago

  • Status changed from Ready for Testing to Passed Testing
  • Needs QA changed from Yes to No

Docs and tooltips on the UI have been updated.

#16 Updated by Dru Lavigne over 2 years ago

  • Status changed from Passed Testing to Done

Also available in: Atom PDF