Description of problem: When creating a new virtual machine using the webadmin UI, the link that is displayed to the end user under Custom Script when clicking the question mark says: "Cloud-Init YAML sections, please refer to: http://www.ovirt.org/Features/vm-init-persistent#Custom_Script" Shouldn't this point to our official documentation ? Version-Release number of selected component (if applicable): How reproducible: Steps to Reproduce: 1. Log in to webadmin portal https://X/ovirt-engine/webadmin 2. Select tab "Virtual Machines", click "New VM" 3. Click "Show Advanced Options", click then "Initial Run" 4. Click "Custom Script", then the question mark that appears. Actual results: Expected results: Displays link to documentation present on access.redhat.com Additional info:
I'm not aware of d/s documentation of cloud-init, so the only thing which may make sense is to copy&paste those 3-4 lines from ovirt wiki, but keep the reference to upstream cloud-init documentation there Andrew, does it make sense?
ping adahms
Hi Michal, Greg, We do have some documentation on the Cloud Init feature, including some notes on the feature as available in the Initial Run tab of the New Virtual Machine and Edit Virtual Machine window - https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html-single/Administration_Guide/index.html#Virtual_Machine_Initial_Run_settings_explained Would this be too long to include? It also seems like a good idea to include the three to four lines that show the template to be put into the section. If this is also too long for the question mark, we can put that into the formal documentation itself. Kind regards, Andrew
Those question marks are called "Info Icons" so I'm going to use that term here. > Shouldn't this point to our official documentation? In RHEV, that makes sense. But we have no way to switch the content of the info icons between upstream and downstream. We may not want oVirt pointing to RHEV documentation, or vice versa. In other words, I think it's a bug to have the "http://www.ovirt.org/Features/vm-init-persistent#Custom_Script" link in there at all. @Einav, your opinion? > Would this be too long to include? @Andrew -- sorry, can you point out specifically what you're suggesting to include, or quote it here? I'm not following. Info icons are usually only a sentence or two, but they can be as long as we need them to be. However, they cannot be right-clicked for copy-paste. > It also seems like a good idea to include the three to four lines that show the template to be put into the section. Asking users to copy and paste / manually type a long template is bad UX design. There has to be a better way to do that for this use case. Outside of the scope of this BZ (and I can open another if people agree), but we could add an "insert template" button on the form. Or better, find a way to get rid of the need for YAML. @Einav, your opinion?
Created attachment 1008637 [details] RHEV Docs: VM Initial Run: Custom Script
Created attachment 1008638 [details] screen-shot: New Storage Domain dialog - NFS - Export Path
> @Einav, your opinion? (1) we can probably switch the content of the info icons between upstream and downstream using a configuration value that will be overridden on downstream or something similar; however (a) sounds like a bit of an overkill to me (Michal should decide), and (b) there is no easy way to retrieve that URL anyway: as Greg mentioned, there isn't any way to copy/paste their content, the tool-tips disappear anyway once you are moving away from the Info Icon (even if you are trying to move into the tool-tip area itself, it disappears), so not much point in providing URLs in general in Info Icons tool-tips or in any tool-tip in our GUI, for that matter. > @Andrew -- sorry, can you point out specifically what you're suggesting to > include, or quote it here? I'm not following. I am assuming that Andrew referred to the "Custom Script" row in the "Virtual_Machine_Initial_Run_settings_explained" table within the documentation (I could be wrong, keeping 'needinfo' on Andrew to confirm). see attachment 1008637 [details]. quoting [1]: """ Custom scripts that will be run on the virtual machine when it starts. The scripts entered in this field are custom YAML sections that are added to those produced by the Manager, and allow you to automate tasks such as creating users and files, configuring yum repositories and running commands. """ to me, it sounds like good text for the Info Icon. [1] https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html-single/Administration_Guide/index.html#Virtual_Machine_Initial_Run_settings_explained > @Einav, your opinion? (2) For field-value format, we sometimes use a label beneath the field, like seen in attachment 1008638 [details]. if the format / template is too long for putting beneath the field, there are a couple of options: (a) Greg's suggestion: an "insert template" button that will fill the "Custom Script" field value with the correct YAML string that contains clear placeholders for whatever needs to be user-defined. (b) Upload a file (potentially similar to the iso uploading planned capability documented in bug 1122970) - maybe worth sync'ing with the storage team on that. (c) Keep it as is (again, as explained above, the oVirt wiki URL should probably be removed from the Info Icon tool-tip content in any case; recommending going with the Custom Script field explanation from the documentation, as explained above). keep in mind that for RHEV, the users have the CSH link in the dialog that should lead them to the 'New VM' dialog documentation which should contain all the info they need, so the RHEV users should be fairly covered already. re: "find a way to get rid of the need for YAML" - that's for the 'virt' team / PM to decide; it may make sense to have this capability available only from the REST API and not from the GUI (I am not familiar with the typical use-cases).
Hi Greg, Einav, Thank you for your responses. Greg - thank you for clarifying that users cannot copy and paste the content from the Info Icon text box. Given that this is the case, I agree that it makes sense to look at other options here. From the documentation side, if we do add a button to insert a default template or otherwise use a default template, perhaps we could include a description of this in the documentation as well and provide some more details there? Einav - yes, that is the section I was referring to. Would there be any issue with using that as the text in the Info Icon? Kind regards, Andrew
(In reply to Andrew Dahms from comment #8) > Hi Greg, Einav, > > From the documentation side, if we do add a button to insert a default > template or otherwise use a default template, perhaps we could include a > description of this in the documentation as well and provide some more > details there? makes sense. I am leaving the decision of whether (and if so - how) to incorporate a YAML-template-assistance in the Custom Script field to the 'virt' team / PM. > > Einav - yes, that is the section I was referring to. Would there be any > issue with using that as the text in the Info Icon? I don't see any issue with that. Pointing out again that I do recommend changing the tool-tip text to the one suggested by Andrew (which I quoted in Comment #7) in any case, i.e. regardless of whether a YAML-template-assistance will be eventually incorporated into the Custom Script field or not. [At least the oVirt wiki link (or any link, for that matter) should not appear in the tool-tip]
I think the best way would be to change the tooltip to the text Einav highlighted in comment #7, having the same text u/s and d/s d/s provide additional documentation and clickable links