Sync custom logos to console Deployment volumes and console config.

Co-authored-by: Jakub Hadvig <[email protected]>
Co-authored-by: Marek Ziska <[email protected]>

Author: 3 people

pkg/console/operator/sync_v400.go

@@ -147,7 +147,7 @@ func (co *consoleOperator) sync_v400(ctx context.Context, controllerContext fact
 	}
 
 	// TODO: why is this missing a toUpdate change?
-	_, customLogosErrReason, customLogosErr := co.SyncCustomLogoConfigMaps(ctx, updatedOperatorConfig)
+	configMapsToSync, customLogosErrReason, customLogosErr := co.SyncCustomLogoConfigMaps(ctx, updatedOperatorConfig)
 	// If the custom logo sync fails for any reason, we are degraded, not progressing.
 	// The sync loop may not settle, we are unable to honor it in current state.
 	statusHandler.AddConditions(status.HandleProgressingOrDegraded("CustomLogoSync", customLogosErrReason, customLogosErr))
@@ -187,7 +187,7 @@ func (co *consoleOperator) sync_v400(ctx context.Context, controllerContext fact
 		sessionSecret,
 		set.Proxy,
 		set.Infrastructure,
-		customLogosErr == nil, // TODO update this to accept result of SyncCustomLogoConfigMaps
+		configMapsToSync,
 		controllerContext.Recorder(),
 	)
 	toUpdate = toUpdate || depChanged
@@ -291,7 +291,7 @@ func (co *consoleOperator) SyncDeployment(
 	sessionSecret *corev1.Secret,
 	proxyConfig *configv1.Proxy,
 	infrastructureConfig *configv1.Infrastructure,
-	canMountCustomLogo bool,
+	customLogos []configmapsub.CustomLogoRef,
 	recorder events.Recorder,
 ) (consoleDeployment *appsv1.Deployment, changed bool, reason string, err error) {
 	updatedOperatorConfig := operatorConfig.DeepCopy()
@@ -306,7 +306,7 @@ func (co *consoleOperator) SyncDeployment(
 		sessionSecret,
 		proxyConfig,
 		infrastructureConfig,
-		canMountCustomLogo,
+		customLogos,
 	)
 	genChanged := operatorConfig.ObjectMeta.Generation != operatorConfig.Status.ObservedGeneration
 
@@ -554,36 +554,31 @@ func (co *consoleOperator) SyncTrustedCAConfigMap(ctx context.Context, operatorC
 	return actual, true, "", err
 }
 
-type operatorCustomLogo struct {
-	location  operatorv1.LogoType
-	theme     operatorv1.ThemeType
-	file      configv1.ConfigMapFileReference
-	okToMount bool
-}
-
-func (co *consoleOperator) SyncCustomLogoConfigMaps(ctx context.Context, operatorConfig *operatorv1.Console) ([]operatorCustomLogo, string, error) {
+func (co *consoleOperator) SyncCustomLogoConfigMaps(ctx context.Context, operatorConfig *operatorv1.Console) ([]configmapsub.CustomLogoRef, string, error) {
 	configMapsToSync := getConfigMapsToSync(operatorConfig)
 	var (
-		aggregatedError  error
-		aggregatedReason string
+		aggregatedError error
+		err             error
+		reason          string
 	)
 	for _, logoToSync := range configMapsToSync {
-		reason, err := co.SyncCustomLogoConfigMap(ctx, logoToSync)
+		logoToSync.OkToMount, reason, err = co.SyncCustomLogoConfigMap(ctx, logoToSync)
 		if err != nil {
 			if aggregatedError == nil {
 				aggregatedError = fmt.Errorf("One or more errors were encountered while configuring custom logos:\n\t- %v, %s", logoToSync, err.Error())
-				aggregatedReason = reason
 			} else {
 				aggregatedError = fmt.Errorf("%s\n\t- %v, %s", aggregatedError.Error(), logoToSync, err.Error())
-				aggregatedReason = fmt.Sprintf("%s, %s", aggregatedReason, reason)
 			}
 		}
 	}
-	return configMapsToSync, aggregatedReason, aggregatedError
+	if aggregatedError != nil {
+		return nil, reason, aggregatedError
+	}
+	return configMapsToSync, "", nil
 }
 
-func getConfigMapsToSync(operatorConfig *operatorv1.Console) []operatorCustomLogo {
-	var normalizedLogos = []operatorCustomLogo{}
+func getConfigMapsToSync(operatorConfig *operatorv1.Console) []configmapsub.CustomLogoRef {
+	var normalizedLogos = []configmapsub.CustomLogoRef{}
 	var skipDeprecatedLogoSync = false
 	if operatorConfig.Spec.Customization.CustomLogos != nil {
 		for _, logo := range operatorConfig.Spec.Customization.CustomLogos {
@@ -593,10 +588,10 @@ func getConfigMapsToSync(operatorConfig *operatorv1.Console) []operatorCustomLog
 			for _, theme := range logo.Themes {
 				normalizedLogos = append(
 					normalizedLogos,
-					operatorCustomLogo{
-						location: logo.Type,
-						theme:    theme.Type,
-						file:     theme.File,
+					configmapsub.CustomLogoRef{
+						Location: logo.Type,
+						Theme:    theme.Type,
+						File:     theme.File,
 					},
 				)
 			}
@@ -606,10 +601,10 @@ func getConfigMapsToSync(operatorConfig *operatorv1.Console) []operatorCustomLog
 	if !skipDeprecatedLogoSync && &operatorConfig.Spec.Customization.CustomLogoFile != nil {
 		normalizedLogos = append(
 			normalizedLogos,
-			operatorCustomLogo{
-				location: operatorv1.LogoTypeMasthead,
-				theme:    operatorv1.ThemeTypeDefault,
-				file:     operatorConfig.Spec.Customization.CustomLogoFile,
+			configmapsub.CustomLogoRef{
+				Location: operatorv1.LogoTypeMasthead,
+				Theme:    operatorv1.ThemeTypeDefault,
+				File:     operatorConfig.Spec.Customization.CustomLogoFile,
 			},
 		)
 	}
@@ -622,18 +617,15 @@ func getConfigMapsToSync(operatorConfig *operatorv1.Console) []operatorCustomLog
 // - Validate existence of custom icon configmaps defined in the console operator config,
 // - populate to the console config
 // - create volumes/volumemounts in console deployment
-func (co *consoleOperator) SyncCustomLogoConfigMap(ctx context.Context, customLogo operatorCustomLogo) (string, error) {
+func (co *consoleOperator) SyncCustomLogoConfigMap(ctx context.Context, customLogo configmapsub.CustomLogoRef) (bool, string, error) {
 	// validate first, to avoid a broken volume mount & a crashlooping console
-	okToMount, reason, err := co.ValidateCustomLogo(ctx, customLogo.file)
-	if customLogo.okToMount {
-		if err := co.UpdateCustomLogoSyncSource(&customLogo.file); err != nil {
-			okToMount = false
-			reason = "FailedSyncSource"
-			err = customerrors.NewCustomLogoError("custom logo sync source update error")
+	okToMount, reason, err := co.ValidateCustomLogo(ctx, customLogo.File)
+	if okToMount {
+		if err := co.UpdateCustomLogoSyncSource(customLogo.File); err != nil {
+			return false, "FailedSyncSource", customerrors.NewCustomLogoError(fmt.Sprintf("custom logo sync source update error, %v", err))
 		}
 	}
-	customLogo.okToMount = okToMount // TODO get rid of side-effect
-	return reason, err
+	return okToMount, reason, err
 }
 
 func (co *consoleOperator) ValidateOAuthServingCertConfigMap(ctx context.Context) (oauthServingCert *corev1.ConfigMap, reason string, err error) {
@@ -657,7 +649,7 @@ func (co *consoleOperator) ValidateOAuthServingCertConfigMap(ctx context.Context
 // sync loop will run later.  Our operator is waiting to receive
 // the copied configmap into the console namespace for a future
 // sync loop to mount into the console deployment.
-func (c *consoleOperator) UpdateCustomLogoSyncSource(cmRef *configv1.ConfigMapFileReference) error {
+func (c *consoleOperator) UpdateCustomLogoSyncSource(cmRef configv1.ConfigMapFileReference) error {
 	source := resourcesynccontroller.ResourceLocation{}
 	logoConfigMapName := cmRef.Name
 

pkg/console/subresource/configmap/brand_custom_logo.go

@@ -1,6 +1,16 @@
 package configmap
 
-import v1 "github.com/openshift/api/operator/v1"
+import (
+	configv1 "github.com/openshift/api/config/v1"
+	v1 "github.com/openshift/api/operator/v1"
+)
+
+type CustomLogoRef struct {
+	Location  v1.LogoType
+	Theme     v1.ThemeType
+	File      configv1.ConfigMapFileReference
+	OkToMount bool
+}
 
 // borrowed from the image package
 // image.RegisterFormat()

pkg/console/subresource/configmap/configmap.go

@@ -89,7 +89,7 @@ func DefaultConfigMap(
 		ContentSecurityPolicies(aggregateCSPDirectives(availablePlugins)).
 		ContentSecurityPolicyEnabled(contentSecurityPolicyEnabled).
 		Proxy(getPluginsProxyServices(availablePlugins)).
-		CustomLogoFile(operatorConfig.Spec.Customization.CustomLogoFile.Key). // Update/replace this function. We now need to handle multiple custom logo files instead of just one.
+		CustomLogos(operatorConfig.Spec.Customization.CustomLogos). // Update/replace this function. We now need to handle multiple custom logo files instead of just one.
 		CustomProductName(operatorConfig.Spec.Customization.CustomProductName).
 		CustomDeveloperCatalog(operatorConfig.Spec.Customization.DeveloperCatalog).
 		ProjectAccess(operatorConfig.Spec.Customization.ProjectAccess).

pkg/console/subresource/consoleserver/config_builder.go

@@ -55,10 +55,10 @@ type ConsoleServerCLIConfigBuilder struct {
 	quickStarts                  operatorv1.QuickStarts
 	addPage                      operatorv1.AddPage
 	perspectives                 []operatorv1.Perspective
-	customLogoFile               string
 	CAFile                       string
 	monitoring                   map[string]string
 	customHostnameRedirectPort   int
+	customLogos                  []operatorv1.CustomLogo
 	inactivityTimeoutSeconds     int
 	pluginsList                  map[string]string
 	i18nNamespaceList            []string
@@ -130,9 +130,9 @@ func (b *ConsoleServerCLIConfigBuilder) Perspectives(perspectives []operatorv1.P
 }
 
 // Update/replace this function
-func (b *ConsoleServerCLIConfigBuilder) CustomLogoFile(customLogoFile string) *ConsoleServerCLIConfigBuilder {
-	if customLogoFile != "" {
-		b.customLogoFile = "/var/logo/" + customLogoFile // append path here to prevent customLogoFile from always being just /var/logo/
+func (b *ConsoleServerCLIConfigBuilder) CustomLogos(customLogos []operatorv1.CustomLogo) *ConsoleServerCLIConfigBuilder {
+	if len(customLogos) > 0 {
+		b.customLogos = customLogos
 	}
 	return b
 }
@@ -397,8 +397,8 @@ func (b *ConsoleServerCLIConfigBuilder) customization() Customization {
 	if len(b.customProductName) > 0 {
 		conf.CustomProductName = b.customProductName
 	}
-	if len(b.customLogoFile) > 0 {
-		conf.CustomLogoFile = b.customLogoFile
+	if len(b.customLogos) > 0 {
+		conf.CustomLogos = b.customLogos
 	}
 
 	if b.devCatalogCustomization.Categories != nil {

pkg/console/subresource/consoleserver/types.go

@@ -104,10 +104,10 @@ type Session struct {
 
 // Customization holds configuration such as what logo to use.
 type Customization struct {
-	Branding             string `yaml:"branding,omitempty"`
-	DocumentationBaseURL string `yaml:"documentationBaseURL,omitempty"`
-	CustomProductName    string `yaml:"customProductName,omitempty"`
-	CustomLogoFile       string `yaml:"customLogoFile,omitempty"`
+	Branding             string                  `yaml:"branding,omitempty"`
+	DocumentationBaseURL string                  `yaml:"documentationBaseURL,omitempty"`
+	CustomProductName    string                  `yaml:"customProductName,omitempty"`
+	CustomLogos          []operatorv1.CustomLogo `yaml:"customLogos,omitempty"`
 	// developerCatalog allows to configure the shown developer catalog categories.
 	DeveloperCatalog *DeveloperConsoleCatalogCustomization `yaml:"developerCatalog,omitempty"`
 	ProjectAccess    ProjectAccess                         `yaml:"projectAccess,omitempty"`

pkg/console/subresource/deployment/deployment.go

@@ -17,6 +17,7 @@ import (
 	operatorv1 "github.com/openshift/api/operator/v1"
 	"github.com/openshift/console-operator/bindata"
 	"github.com/openshift/console-operator/pkg/api"
+	configmapsub "github.com/openshift/console-operator/pkg/console/subresource/configmap"
 	"github.com/openshift/console-operator/pkg/console/subresource/util"
 	"github.com/openshift/library-go/pkg/operator/resource/resourceread"
 )
@@ -74,7 +75,7 @@ func DefaultDeployment(
 	sessionSecret *corev1.Secret,
 	proxyConfig *configv1.Proxy,
 	infrastructureConfig *configv1.Infrastructure,
-	canMountCustomLogo bool,
+	customLogos []configmapsub.CustomLogoRef,
 ) *appsv1.Deployment {
 	authnCATrustConfigMap := localOAuthServingCertConfigMap
 	if authnCATrustConfigMap == nil {
@@ -102,7 +103,7 @@ func DefaultDeployment(
 		authServerCAConfigMap,
 		trustedCAConfigMap,
 		sessionSecret,
-		canMountCustomLogo,
+		customLogos,
 	)
 	withConsoleContainerImage(deployment, operatorConfig, proxyConfig)
 	withConsoleNodeSelector(deployment, infrastructureConfig)
@@ -233,7 +234,7 @@ func withConsoleVolumes(
 	authServerCAConfigMap *corev1.ConfigMap,
 	trustedCAConfigMap *corev1.ConfigMap,
 	sessionSecret *corev1.Secret,
-	canMountCustomLogo bool) {
+	customLogos []configmapsub.CustomLogoRef) {
 	volumeConfig := defaultVolumeConfig()
 
 	caBundle, caBundleExists := trustedCAConfigMap.Data["ca-bundle.crt"]
@@ -242,8 +243,10 @@ func withConsoleVolumes(
 	}
 
 	// Update to handle multiple custom logos
-	if canMountCustomLogo {
-		volumeConfig = append(volumeConfig, customLogoVolume())
+	if len(customLogos) > 0 {
+		for _, customLogo := range customLogos {
+			volumeConfig = append(volumeConfig, customLogoVolume(customLogo))
+		}
 	}
 
 	if oauthServingCert != nil {
@@ -498,9 +501,9 @@ func trustedCAVolume() volumeConfig {
 }
 
 // Udpate to handle multiple custom logos
-func customLogoVolume() volumeConfig {
+func customLogoVolume(customLogo configmapsub.CustomLogoRef) volumeConfig {
 	return volumeConfig{
-		name:        api.OpenShiftCustomLogoConfigMapName,
+		name:        customLogo.File.Name,
 		path:        "/var/logo/",
 		isConfigMap: true}
 }

pkg/console/subresource/deployment/deployment_test.go

@@ -48,7 +48,7 @@ func TestDefaultDeployment(t *testing.T) {
 		sessionSecret                  *corev1.Secret
 		proxyConfig                    *configv1.Proxy
 		infrastructureConfig           *configv1.Infrastructure
-		canMountCustomLogo             bool
+		canMountCustomLogo             []configmap.CustomLogoRef
 	}
 
 	consoleOperatorConfig := &operatorsv1.Console{
@@ -183,12 +183,12 @@ func TestDefaultDeployment(t *testing.T) {
 	withConsoleContainerImage(consoleDeploymentTemplate, consoleOperatorConfig, proxyConfig)
 	withConsoleVolumes(consoleDeploymentTemplate, &corev1.ConfigMap{
 		Data: map[string]string{"ca-bundle.crt": "test"},
-	}, nil, trustedCAConfigMapEmpty, nil, false)
+	}, nil, trustedCAConfigMapEmpty, nil, []configmap.CustomLogoRef{})
 	consoleDeploymentContainer := consoleDeploymentTemplate.Spec.Template.Spec.Containers[0]
 	consoleDeploymentVolumes := consoleDeploymentTemplate.Spec.Template.Spec.Volumes
 	withConsoleVolumes(consoleDeploymentTemplate, &corev1.ConfigMap{
 		Data: map[string]string{"ca-bundle.crt": "test"},
-	}, nil, trustedCAConfigMapSet, nil, false)
+	}, nil, trustedCAConfigMapSet, nil, []configmap.CustomLogoRef{})
 	consoleDeploymentContainerTrusted := consoleDeploymentTemplate.Spec.Template.Spec.Containers[0]
 	consoleDeploymentVolumesTrusted := consoleDeploymentTemplate.Spec.Template.Spec.Volumes
 
@@ -901,7 +901,7 @@ func TestWithConsoleVolumes(t *testing.T) {
 		deployment         *appsv1.Deployment
 		trustedCAConfigMap *corev1.ConfigMap
 		sessionSecret      *corev1.Secret
-		canMountCustomLogo bool
+		canMountCustomLogo []configmap.CustomLogoRef
 	}
 
 	trustedCAConfigMap := &corev1.ConfigMap{
@@ -1076,7 +1076,7 @@ func TestWithConsoleVolumes(t *testing.T) {
 			args: args{
 				deployment:         consoleDeployment,
 				trustedCAConfigMap: trustedCAConfigMap,
-				canMountCustomLogo: false,
+				canMountCustomLogo: []configmap.CustomLogoRef{},
 			},
 			want: &appsv1.Deployment{
 				Spec: appsv1.DeploymentSpec{
@@ -1099,7 +1099,7 @@ func TestWithConsoleVolumes(t *testing.T) {
 			args: args{
 				deployment:         consoleDeployment,
 				trustedCAConfigMap: &corev1.ConfigMap{},
-				canMountCustomLogo: false,
+				canMountCustomLogo: []configmap.CustomLogoRef{},
 			},
 			want: &appsv1.Deployment{
 				Spec: appsv1.DeploymentSpec{
@@ -1122,7 +1122,7 @@ func TestWithConsoleVolumes(t *testing.T) {
 			args: args{
 				deployment:         consoleDeployment,
 				trustedCAConfigMap: &corev1.ConfigMap{},
-				canMountCustomLogo: true,
+				canMountCustomLogo: []configmap.CustomLogoRef{},
 			},
 			want: &appsv1.Deployment{
 				Spec: appsv1.DeploymentSpec{
@@ -1145,7 +1145,7 @@ func TestWithConsoleVolumes(t *testing.T) {
 			args: args{
 				deployment:         consoleDeployment,
 				trustedCAConfigMap: trustedCAConfigMap,
-				canMountCustomLogo: true,
+				canMountCustomLogo: []configmap.CustomLogoRef{},
 			},
 			want: &appsv1.Deployment{
 				Spec: appsv1.DeploymentSpec{

test/e2e/brand_customization_test.go

@@ -189,8 +189,8 @@ func hasCustomBranding(cm *v1.ConfigMap, desiredProductName string, desiredLogoF
 	consoleConfig := consoleserver.Config{}
 	yaml.Unmarshal([]byte(cm.Data["console-config.yaml"]), &consoleConfig)
 	actualProductName := consoleConfig.Customization.CustomProductName
-	actualLogoFile := consoleConfig.Customization.CustomLogoFile
-	return (desiredProductName == actualProductName) && ("/var/logo/"+desiredLogoFileName == actualLogoFile)
+	actualLogoFile := consoleConfig.Customization.CustomLogos[0].Themes[0].File.Name
+	return (desiredProductName == actualProductName) && (desiredLogoFileName == actualLogoFile)
 }
 
 func findCustomLogoVolume(deployment *appsv1.Deployment) bool {