Bug 1383799

Summary: freeipa-server-common debranding
Product: [Fedora] Fedora Reporter: Pat Riehecky <riehecky>
Component: freeipaAssignee: IPA Maintainers <ipa-maint>
Status: CLOSED EOL QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: low Docs Contact:
Priority: unspecified    
Version: 32CC: abokovoy, ipa-maint, jhrozek, mkosek, pvoborni, rcritten, ssorce, vinicius
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-05-25 17:53:06 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Pat Riehecky 2016-10-11 18:50:24 UTC
Description of problem:
freeipa-server-common ships a number of useful common files and branding artwork.

Can a new subpackage that just contains the branding artwork be created?

This should simplify the debranding process performed downstream.  The images could even come from an alternate source rpm provided by RH IDM if they wanted.

Version-Release number of selected component (if applicable):freeipa-server-common-4.4.1-1.fc25


How reproducible: 100%


Steps to Reproduce:
1.Attempt to isolate just the artwork for FreeIPA for alteration
2.Notice a bunch of other shared resources that I don't want to alter in the same package
3.

Actual results:
Debranding FreeIPA involves manipulation of a non-branding specific package.

Expected results:


Additional info:

Probably only these files:
/usr/share/ipa/ui/favicon.ico
/usr/share/ipa/ui/images/facet-tab-off.png
/usr/share/ipa/ui/images/facet-tab-on.png
/usr/share/ipa/ui/images/header-logo.png
/usr/share/ipa/ui/images/login-screen-background.jpg
/usr/share/ipa/ui/images/login-screen-logo.png
/usr/share/ipa/ui/images/product-name.png

Comment 1 Petr Vobornik 2016-10-12 10:10:42 UTC
This bug suggests a certain approach to a problem  you want to solve. Could you describe the "problem" or let's say use case in more details. Maybe there is a better solution.

E.g. I can imagine that branding change would sometimes require additional image and/or change of CSS.

Other question here is how rpm dependencies should behave. If a possibility to replace stock rpm with custom is required then the stock needs to be, e.g., a weak dependency otherwise uninstallation of it might cause uninstallation of whole IPA.

Comment 2 Pat Riehecky 2016-10-12 13:38:49 UTC
Hi Petr,

The specific problem I'm looking at is in the maintenance of RHEL rebuilds.  A number of debranding passes inevitably misses items.  Today the various rebuilds each maintain their own patch set to remove the RHEL IDM branding.  I'm hopeful there is a way to get the branding shifted somewhere so that the process is cleaner and less likely to error out.

Each time an errata is released today the package needs to be customized and there is potential that the various diff's do not apply correctly - generating maintenance cost.

My initial thoughts on having the branding in a separate package allow the rebuild community to simply not publish the one branding package and instead provide a different one that has similar RPM provides.

If the branding files are truly separate from the application files, a number of options open up to the rebuild community.  That being said; it makes sense that FreeIPA provide the FreeIPA artwork.

Comment 3 Martin Kosek 2016-10-18 11:29:02 UTC
Taking this from different angle... Petr, would it be maybe more achievable to change the branding via FreeIPA Web UI plugin that the customer would deploy? If the plugin is able to change paths to different design elements, the customer would not have to change RPMs.

Comment 4 Petr Vobornik 2016-10-18 12:05:14 UTC
Web UI plugin is able to do that. But some parts might not be straightforward - requires modification of render/create methods or changing the html after render/creation.

Changing files is usually easier but more limiting.

Plugin itself can be delivered as an additional rpm.

Plugin examples:
- https://pvoborni.fedorapeople.org/plugins/
- https://pvoborni.fedorapeople.org/plugins/demo/demo.js

Plugin docs:
- https://pvoborni.fedorapeople.org/doc/#!/guide/Plugins

Comment 5 Pat Riehecky 2016-10-18 13:25:10 UTC
That seems viable to me.  My javascript is terribly rusty, but if the hooks are in place for the page render that should be pretty elegant overall.

Comment 6 Martin Kosek 2016-10-18 13:52:20 UTC
Right. I think that any solution that would let you avoid rebuilding RPMs with every update is better than what you have currently :-)

BTW, you can see a public FreeIPA demo, to see Petr's example plugin in action:
https://ipa.demo1.freeipa.org/ipa/ui/

Comment 7 Pat Riehecky 2016-10-18 15:14:42 UTC
I'll see about whipping up a plugin that changes out:
 - header-logo.png
 - login-screen-logo.png
 - product-name.png
 - favicon.ico

Any pointers would be helpful. Looking over the sample plugins there I've realized my javascript experience pre-dates jquery.  Yark!

Comment 8 Petr Vobornik 2016-10-18 17:23:43 UTC
If it is just about files then it might be possible to replace them via url rewrites, basically create:

# cat /etc/httpd/conf.d/ipa-z-brand.conf 
RewriteEngine on

RewriteRule ^/ipa/ui/images/(.*)    /ipa/ui/custombrand/images/$1 [PT,NC]
RewriteRule ^/ipa/ui/favicon.ico    /ipa/ui/custombrand/favicon.ico [PT,NC]

Unfortunately this alone doesn't work because the rewrite rule is not loaded in virtual host for port 443 so following line is required to be added to /etc/httpd/conf.d/nss.conf in the VirtualHost element:
  Include /etc/httpd/conf.d/ipa-*-brand.conf

A possible fix would be IPA to include this rewrite rule and then anybody can put files to location(s) based on the rewrite(s).

Comment 9 Petr Vobornik 2016-10-21 20:56:03 UTC
Upstream ticket:
https://fedorahosted.org/freeipa/ticket/6421

Comment 10 Fedora End Of Life 2017-02-28 10:26:04 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 26 development cycle.
Changing version to '26'.

Comment 11 Fedora End Of Life 2018-05-03 08:15:08 UTC
This message is a reminder that Fedora 26 is nearing its end of life.
Approximately 4 (four) weeks from now Fedora will stop maintaining
and issuing updates for Fedora 26. It is Fedora's policy to close all
bug reports from releases that are no longer maintained. At that time
this bug will be closed as EOL if it remains open with a Fedora  'version'
of '26'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, simply change the 'version'
to a later Fedora version.

Thank you for reporting this issue and we are sorry that we were not
able to fix it before Fedora 26 is end of life. If you would still like
to see this bug fixed and are able to reproduce it against a later version
of Fedora, you are encouraged  change the 'version' to a later Fedora
version prior this bug is closed as described in the policy above.

Although we aim to fix as many bugs as possible during every release's
lifetime, sometimes those efforts are overtaken by events. Often a
more recent Fedora release includes newer upstream software that fixes
bugs or makes them obsolete.

Comment 12 Jan Kurik 2018-08-14 11:12:55 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 29 development cycle.
Changing version to '29'.

Comment 13 Ben Cotton 2019-10-31 20:44:28 UTC
This message is a reminder that Fedora 29 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora 29 on 2019-11-26.
It is Fedora's policy to close all bug reports from releases that are no longer
maintained. At that time this bug will be closed as EOL if it remains open with a
Fedora 'version' of '29'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, simply change the 'version' 
to a later Fedora version.

Thank you for reporting this issue and we are sorry that we were not 
able to fix it before Fedora 29 is end of life. If you would still like 
to see this bug fixed and are able to reproduce it against a later version 
of Fedora, you are encouraged  change the 'version' to a later Fedora 
version prior this bug is closed as described in the policy above.

Although we aim to fix as many bugs as possible during every release's 
lifetime, sometimes those efforts are overtaken by events. Often a 
more recent Fedora release includes newer upstream software that fixes 
bugs or makes them obsolete.

Comment 14 Ben Cotton 2020-02-11 15:41:52 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 32 development cycle.
Changing version to 32.

Comment 15 Fedora Program Management 2021-04-29 17:08:27 UTC
This message is a reminder that Fedora 32 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora 32 on 2021-05-25.
It is Fedora's policy to close all bug reports from releases that are no longer
maintained. At that time this bug will be closed as EOL if it remains open with a
Fedora 'version' of '32'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, simply change the 'version' 
to a later Fedora version.

Thank you for reporting this issue and we are sorry that we were not 
able to fix it before Fedora 32 is end of life. If you would still like 
to see this bug fixed and are able to reproduce it against a later version 
of Fedora, you are encouraged  change the 'version' to a later Fedora 
version prior this bug is closed as described in the policy above.

Although we aim to fix as many bugs as possible during every release's 
lifetime, sometimes those efforts are overtaken by events. Often a 
more recent Fedora release includes newer upstream software that fixes 
bugs or makes them obsolete.

Comment 16 Ben Cotton 2021-05-25 17:53:06 UTC
Fedora 32 changed to end-of-life (EOL) status on 2021-05-25. Fedora 32 is
no longer maintained, which means that it will not receive any further
security or bug fix updates. As a result we are closing this bug.

If you can reproduce this bug against a currently maintained version of
Fedora please feel free to reopen this bug against that version. If you
are unable to reopen this bug, please file a new report against the
current release. If you experience problems, please add a comment to this
bug.

Thank you for reporting this bug and we are sorry it could not be fixed.