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

   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> ...

   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

   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

   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

   To check the console Operator configuration, run:

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

Procedure

1. Create a TLS secret in the openshift-config namespace that has your custom domain’s certificate and private key by running the following command:

   $ oc create secret tls <secret_name> --cert=<path_to_tls_cert> --key=<path_to_tls_key> -n openshift-config

   where:

   <secret_name>

   Specifies a name for the TLS secret, for example, custom-console-tls.

   <path_to_tls_cert>

   Specifies the path to your TLS certificate file.

   <path_to_tls_key>

   Specifies the path to your TLS private key file.

2. In your DNS provider’s management console, add a CNAME or an A record pointing your custom domain to your cluster’s router canonical domain name. The router canonical domain name is the load balancer hostname value for your cluster.

   • For example, in your AWS Route 53 Dashboard, add a CNAME record where

     • Name: my-custom-hostname.dev (your custom hostname)

     • Value: a234gsr3242rsfsfs-1342r624.us-east-1.elb.amazonaws.com (your cluster’s load balancer hostname)

       Important

       If you do not configure proper DNS records, you cannot access the custom routes.

3. Update the component routes by using the rosa CLI:

   • To set a custom domain for the web console, run the following command:

     $ rosa edit ingress -c <cluster_name> <ingress_id> --component-routes 'console: hostname=<custom_hostname>;tlsSecretRef=<secret_name>'

     where:

     <custom_hostname>

     Specifies the custom hostname for the web console, for example, my-custom-hostname.dev.

     <secret_name>

     Specifies the name of the TLS secret you created earlier.

   • To set a custom domain for the downloads page, run the following command:

     $ rosa edit ingress -c <cluster_name> <ingress_id> --component-routes 'downloads: hostname=<custom_hostname>;tlsSecretRef=<secret_name>'

     where:

     <custom_hostname>

     Specifies the custom hostname for the downloads page, for example, my-custom-hostname.dev.

     <secret_name>

     Specifies the name of the TLS secret you created for the downloads page.

     Note

     You can update both routes by running the following single command:

     $ rosa edit ingress -c <cluster_name> <ingress_id> --component-routes 'console: hostname=<custom_hostname>;tlsSecretRef=<secret_name>, downloads: hostname=<custom_hostname>;tlsSecretRef=<secret_name>'

Verification

1. Verify the ingress is updated by running the following command:

   $ rosa list ingress -c <cluster_name>

   Example output

   ID    APPLICATION ROUTER                                                         PRIVATE
   r218  https://openshift-console.apps.rosa.dy5e.p1.my-custom-hostname.dev         true

2. Add your certificate to the truststore on your local system, then confirm that you can access your components at their new routes by using your local web browser.