Bug 1804774
| Summary: | Simplify the process to add a msg on the RHVM Admin Portal Login | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Product: | Red Hat Enterprise Virtualization Manager | Reporter: | Robert McSwain <rmcswain> | ||||||||
| Component: | ovirt-engine | Assignee: | Scott Dickerson <sdickers> | ||||||||
| Status: | CLOSED ERRATA | QA Contact: | Pavel Novotny <pnovotny> | ||||||||
| Severity: | high | Docs Contact: | |||||||||
| Priority: | unspecified | ||||||||||
| Version: | 4.3.0 | CC: | emarcus, gdeolive, michal.skrivanek, sdickers, sgratch, tnisan | ||||||||
| Target Milestone: | ovirt-4.4.7 | ||||||||||
| Target Release: | --- | ||||||||||
| Hardware: | All | ||||||||||
| OS: | All | ||||||||||
| Whiteboard: | |||||||||||
| Fixed In Version: | ovirt-engine-4.4.7.5 | Doc Type: | Release Note | ||||||||
| Doc Text: |
Adding a message banner to the web administration welcome page is straight forward using custom branding that only contains a preamble section.
An example of preamble branding is given here: https://bugzilla.redhat.com/attachment.cgi?id=1783329.
In an engine upgrade, the custom preamble brand remains in place and will work without issue.
During engine backup and subsequent restore, on engine restore the custom preamble branding needs to be manually restored/reinstalled and verified.
|
Story Points: | --- | ||||||||
| Clone Of: | Environment: | ||||||||||
| Last Closed: | 2021-07-22 15:12:18 UTC | Type: | Bug | ||||||||
| Regression: | --- | Mount Type: | --- | ||||||||
| Documentation: | --- | CRM: | |||||||||
| Verified Versions: | Category: | --- | |||||||||
| oVirt Team: | UX | RHEL 7.3 requirements from Atomic Host: | |||||||||
| Cloudforms Team: | --- | Target Upstream Version: | |||||||||
| Embargoed: | |||||||||||
| Attachments: |
|
||||||||||
There used to be an engine-config setting for this iirc, and I think it only showed on the old userportal. It was removed. For example: https://gerrit.ovirt.org/#/c/24282/1/frontend/webadmin/modules/gwt-common/src/main/java/org/ovirt/engine/ui/common/presenter/AbstractLoginPopupPresenterWidget.java Since this was removed, is there any expectation that this will be added back in the future, via either this RFE or any others? (In reply to Robert McSwain from comment #2) > Since this was removed, is there any expectation that this will be added > back in the future, via either this RFE or any others? Yes we will, but probably only to 4.4.z. I've confirmed with the customer this is what they would like - branding isn't necessary and text would be the following as described by the customer: ~~~ What we are looking for is an easier way to simply add below verbage (see below) to the initial splash screen, when hitting "https://RHVM/ovirt-engine". from there you have option of hitting the "Administraton Portal" or "VM Portal". Warning: Use of this System is Restricted to Authorized Users This computer system is the private property of the Company and may be used only by those individuals authorized by the Company, in accordance with Company policy. Unauthorized, illegal or improper use may result in disciplinary action and/or civil or criminal prosecution. Your use of Company electronic systems is subject to monitoring and disclosure in accordance with Company policy and applicable law. By continuing to access this system, you agree to comply with all Company policies, that your use of Company electronic systems is subject to the foregoing and that you have no expectation of privacy in regard to any files or data stored. Company policies can be accessed on the Company website. We do not want to change any branding, just add text. Red Hat Satellite 6.7 gives the option to add "Login page footer text" verbage in it "settings" page. The way RHV is right now, you have to find the correct splash image, add the text to the image, play with the font and color and copy the modifications to "/etc/ovirt-engine/branding/50-rhv-2.brand/bundled/rcue/img/bg-login-2.png". ~~~ moving to 4.4.6 due to capacity reason. With patch 114809, the ability to add a "preamble" section on the welcome page with a small custom branding works pretty well. I'll attach the simple custom branding I tested along with a screen shot of how it looks on top of the default ovirt branding and on top of the RHV branding. Created attachment 1783327 [details]
preamble on ovirt branding
Created attachment 1783328 [details]
preamble on RHV branding
Created attachment 1783329 [details]
small brand to add a preamble section on the welcome page
Extra the zip to /etc/ovirt-engine/branding
3 files:
99-preamble.brand/branding.properties
99-preamble.brand/preamble.css
99-preamble.brand/preamble.template
I can create a bare bones project to create an rpm from these files to make it easy to install the preamble brand if that would be easier.
Note: I tested an upgrade from 4.4.5 to 4.4.6 and the custom branding I had installed on 4.4.5 was there and worked after the upgrade. During a backup and restore, the custom branding would not be included. In that case, it would be expected to have to reinstall the custom branding on the restored system. Verified in ovirt-engine-4.4.7.6-0.11.el8ev. Verified with Scott's custom branding in attachment 1783329 [details]. The result looks exactly the same as in the screenshot in attachment 1783328 [details]. Please also open a documentation bug to get information about how to let system administrators use this feature. A few examples where this feature can be useful: - communicate planned maintenance of the infrastructure - quickly add some company logo image (but I think for this part a full portal branding would be nicer https://ovirt.org/documentation/administration_guide/index.html#Re-Branding_the_Manager1 ) I also got a note about documenting that ovirt engine restart is needed in order to make the change active. (In reply to Sandro Bonazzola from comment #25) > Please also open a documentation bug to get information about how to let > system administrators use this feature. > > A few examples where this feature can be useful: > - communicate planned maintenance of the infrastructure > - quickly add some company logo image (but I think for this part a full > portal branding would be nicer > https://ovirt.org/documentation/administration_guide/index.html#Re- > Branding_the_Manager1 ) > > I also got a note about documenting that ovirt engine restart is needed in > order to make the change active. Opened docs BZ 1982773. Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory (Moderate: RHV Manager (ovirt-engine) security update [ovirt-4.4.7]), and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHSA-2021:2865 |
We were able to apply a banner by modifying and replacing a bundled image. /etc/ovirt-engine/branding/50-rhv-2.brand/bundled/rcue/img/bg-login-2.png This is sub-optimal because: 1) An update will overwrite the image, requiring a redeploy of the .png 2) In future releases the .css or image could change Requesting an RFE to add this feature to RHV-M? Adding this message in Satellite is done via the UI as described in https://access.redhat.com/documentation/en-us/red_hat_satellite/6.6/html/administering_red_hat_satellite/chap-red_hat_satellite-administering_red_hat_satellite-accessing_red_hat_satellite#sect-Red_Hat_Satellite-Administering_Red_Hat_Satellite-Setting_a_Custom_Login_Message is very easy. It is not simple or permanent in RHV-M