Project

General

Profile

Bug #40492

Add ability to display iocage plugins post-install notes

Added by Martin Wilke about 2 years ago. Updated about 2 years ago.

Status:
Done
Priority:
No priority
Assignee:
Brandon Schneider
Category:
Middleware
Target version:
Seen in:
Severity:
Med High
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

When installing the iocage plugins with the new webui there is no output for users. As example we do have plugins were we inform the users about the Access to there Databases, Username, Passwords, etc, or in some cases even the url with a port like IP:8080.

Plugin Examples:
Username / Password, URL with port output in plugins like qbittorrent are important because the User dont know the Username and Password we create during the installation and which port is used to access the Web frontend.

Web Applications: such as nextcloud, we pass Database, DBUSER, DBPW normally to the User that they can complete the installation over the frontend. Also for Backup purposes, in case when she/he as example update or move the jail to another server.


Related issues

Related to FreeNAS - Feature #36948: Use callback to return iocage plugin progressDone
Copied to FreeNAS - Bug #41544: Add field to display iocage plugins post-install notesDone

History

#1 Updated by William Grzybowski about 2 years ago

  • Project changed from 93 to FreeNAS
  • Category set to Middleware
  • Assignee set to Brandon Schneider
  • Target version set to 11.2-BETA3
  • Seen in set to 11.2-BETA2
  • Severity set to Med High
  • Needs QA set to Yes
  • Needs Doc set to Yes
  • Needs Merging set to Yes
  • Needs Automation set to No
  • Support Suite Ticket set to n/a
  • ChangeLog Required set to No

Brandon, is there a way for the UI get these from middleware yet?

#2 Updated by Brandon Schneider about 2 years ago

  • Status changed from Unscreened to Not Started

#3 Updated by Brandon Schneider about 2 years ago

Not currently

#4 Updated by Brandon Schneider about 2 years ago

  • Related to Feature #36948: Use callback to return iocage plugin progress added

#5 Updated by Brandon Schneider about 2 years ago

  • Status changed from Not Started to Ready for Testing

This is handled in #36948

#6 Updated by William Grzybowski about 2 years ago

  • Status changed from Ready for Testing to Unscreened

Brandon Schneider wrote:

This is handled in #36948

I dont see how. That one is for progress, I dont think we can ask UI to use the progress of the job to show the readme.
We need a way to show it as a result of the install, as a return value of the call.

Does that make sense?

#7 Updated by Brandon Schneider about 2 years ago

Sure, but the internal process doesn't know that's the final message, so returning the message isn't any more special. The UI can grab the final output by parsing the job's description when the progress hits 100%. That should contain the entire message.

#8 Updated by Brandon Schneider about 2 years ago

  • Status changed from Unscreened to In Progress

#9 Updated by Brandon Schneider about 2 years ago

PR: https://github.com/freenas/freenas/compare/FIX-40492?expand=1
DESC: Return the plugin's install notes in a dictionary for the UI to parse
RISK: Low
ACCEPTANCE: Fetch a plugin with midclt, when it's finished use core.get_jobs and verify the install_notes key of the result is the install directions.

[{"id": 2, "method": "jail.fetch", "arguments": [{"name": "btsync", "props": ["dhcp=on", "bpf=yes", "vnet=on"]}], "logs_path": null, "logs_excerpt": null, "progress": {"percent": 100, "description": "Plugin: btsync installed", "extra": null}, "result": {"error": false, "install_notes": ["rslsync_enable:  -> YES", "Starting rslsync.", "Admin Portal:", "http://192.168.122.169:8888/"]}, "error": null, "exception": null, "state": "SUCCESS", "time_started": {"$date": 1533727917928}, "time_finished": {"$date": 1533727953770}}]

#10 Updated by Bug Clerk about 2 years ago

  • Status changed from In Progress to Ready for Testing

#11 Updated by Dru Lavigne about 2 years ago

  • Subject changed from Webui Iocage plugins should show install notes to Add ability to display iocage plugins post-install notes
  • Needs Doc changed from Yes to No
  • Needs Merging changed from Yes to No

#12 Updated by Dru Lavigne about 2 years ago

  • Copied to Bug #41544: Add field to display iocage plugins post-install notes added

#13 Updated by Dru Lavigne about 2 years ago

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

Also available in: Atom PDF