Customizing OpenShift Container Platform Eclipse Che branding images

This procedure describes how to customize Eclipse Che branding images, including the logo shown in the Eclipse Che dashboard, the loader icon and the ConsoleLink icon.

The branding images are located in the assets/branding directory. Supported image formats, in priority order: jpg, jpeg, png, gif, webp, svg. The svg format is used as the default fallback.

Prerequisites

  • An active kubectl session with administrative permissions to the Kubernetes cluster. See Overview of kubectl.

Procedure

  1. Create a Secret to override branding images:

    kubectl apply -f - <<EOF
apiVersion: v1
kind: Secret
metadata:
  name: che-dashboard-customization
  namespace: eclipse-che
  annotations:
    che.eclipse.org/mount-as: subpath
    che.eclipse.org/mount-path: /public/dashboard/assets/branding
  labels:
    app.kubernetes.io/component: che-dashboard-secret
    app.kubernetes.io/part-of: che.eclipse.org
data:
  loader.svg: <Base64_encoded_content_of_the_image> (1)
  favicon.ico: <Base64_encoded_content_of_the_image> (2)
type: Opaque
EOF
    1 The loader image file name and Base64-encoded content with disabled line wrapping. You can use any supported format (jpg, jpeg, png, gif, webp, svg). For example, loader.png with its Base64-encoded content.
    2 The favicon file name and Base64-encoded content with disabled line wrapping.
    You can override one or all images from the /public/dashboard/assets/branding directory in the dashboard pod. Only the images specified in the Secret data section are overridden; unspecified images remain unchanged.

  2. Wait until the rollout of che-dashboard finishes.

Additional resources