Merge pull request #86 from appuio/fix/custom-logo

Don't configure legacy custom logo if we have a 4.19 logo configuration

Author: simu

component/main.jsonnet

@@ -82,7 +82,10 @@ local favicon =
 
 local legacyLogoFileName =
   local legacy_logo = std.get(params, 'custom_logo', {});
-  if std.length(std.objectFields(legacy_logo)) > 0 then
+  // OpenShift doesn't allow `customLogoFile` and `logos` to be set at the
+  // same time, so we never try to configure the legacy `customLogoFile` if
+  // we're configuring the new `logos`.
+  if std.length(std.objectFields(legacy_logo)) > 0 && std.length(customLogos) == 0 then
     assert std.length(std.objectFields(legacy_logo)) == 1 :
            'The parameter custom_logo can only contain a single logo';
     local name = std.objectFields(legacy_logo)[0];

docs/modules/ROOT/pages/references/parameters.adoc

@@ -133,6 +133,8 @@ default:: `{}`
 ====
 This parameter is deprecated on OpenShift 4.19 and newer.
 Use `custom_logos` and `custom_favicon` instead.
+
+When `custom_logos` is set for OpenShift 4.19 and newer, any configuration in this parameter will be ignored.
 ====
 
 Add a custom logo to the console.
@@ -162,6 +164,8 @@ Configure custom logos for the console.
 This parameter only has an effect on OpenShift 4.19 and newer.
 For older versions of OpenShift, use parameter `custom_logo`.
 
+NOTE: When setting this parameter on OpenShift 4.19 and newer, the component will ignore the contents of `custom_logo`.
+
 OpenShift 4.19 introduces a new console look with a dark and light theme.
 The new custom logo mechanism allows configuring separate logos for each theme.
 The component supports keys `dark` and `light` to specify logos for the dark and light theme respectively.

tests/golden/custom-logo/openshift4-console/openshift4-console/01_logo.yaml

@@ -14,9 +14,6 @@ spec:
       - name: LightspeedButton
         visibility:
           state: Disabled
-    customLogoFile:
-      key: logo.png
-      name: console-logo
     customProductName: Company Cloud
     logos:
       - themes: