Chapter 5. Customizing the web console in Red Hat OpenShift Service on AWS

Procedure

1. Import your logo file into a config map in the openshift-config namespace:

   $ oc create configmap console-custom-logo --from-file /path/to/console-custom-logo.png -n openshift-config

   Copy to Clipboard Toggle word wrap
   Tip

   You can alternatively apply the following YAML to create the config map:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: console-custom-logo
     namespace: openshift-config
   binaryData:
     console-custom-logo.png: <base64-encoded_logo> ...

   Copy to Clipboard Toggle word wrap

   Replace <base64-encoded_logo> with a base64-encoded string of the logo.

2. Edit the web console’s Operator configuration to include customLogoFile and customProductName:

   $ oc edit consoles.operator.openshift.io cluster

   Copy to Clipboard Toggle word wrap

   apiVersion: operator.openshift.io/v1
   kind: Console
   metadata:
     name: cluster
   spec:
     customization:
       customLogoFile:
         key: console-custom-logo.png
         name: console-custom-logo
       customProductName: My Console

   Copy to Clipboard Toggle word wrap

   Once the Operator configuration is updated, it will sync the custom logo config map into the console namespace, mount it to the console pod, and redeploy.

3. Check for success. If there are any issues, the console cluster Operator will report a Degraded status, and the console Operator configuration will also report a CustomLogoDegraded status, but with reasons such as KeyOrFilenameInvalid or NoImageProvided.

   To check the clusteroperator, run:

   $ oc get clusteroperator console -o yaml

   Copy to Clipboard Toggle word wrap

   To check the console Operator configuration, run:

   $ oc get consoles.operator.openshift.io -o yaml

   Copy to Clipboard Toggle word wrap