Customizing OpenShift Container Platform Eclipse Che branding images

Customize the branding images for the Eclipse Che dashboard by overriding the default images in the assets/branding directory. The following images can be customized:

  • che-logo.svg — the logo displayed in the dashboard header.

  • loader.svg — the loader icon displayed during dashboard loading. The loader image supports the following formats, in priority order: jpg, jpeg, png, gif, webp, svg. The svg format is used as the default fallback.

  • favicon.ico — the browser tab icon.

Prerequisites

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

Procedure

  1. Create a Secret that mounts custom branding images into the dashboard:

    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:
  che-logo.svg: <Base64_encoded_content_of_the_image> (1)
  loader.svg: <Base64_encoded_content_of_the_image> (2)
  favicon.ico: <Base64_encoded_content_of_the_image> (3)
type: Opaque
EOF
    1 The dashboard logo. Replace che-logo.svg with the Base64-encoded content of your custom logo with disabled line wrapping.
    2 The loader icon. Replace loader.svg with the filename matching your image format (for example, loader.png, loader.webp). The value is the Base64-encoded content of the image with disabled line wrapping.
    3 The favicon. The value is the Base64-encoded content of the .ico file 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. Verify that the rollout completes:

    kubectl rollout status deployment/che-dashboard -n eclipse-che
Verification

  • Open the Eclipse Che dashboard in a browser and confirm that the custom branding images are displayed.

Additional resources