Configuring your logo in the IBM Cloud Private management console

You can configure your logo in the following features in the IBM® Cloud Private management console: Login, About modal, and Common header.

Required user type or access level: Cluster administrator or team administrator

Prerequisite

You need kubectl. See Installing the Kubernetes CLI (kubectl) to install.

  1. Run the following command to view and edit your ConfigMap:

    kubectl edit configmap platform-ui-config -n kube-system
    
  2. Edit the login, about, and header properties in the ui-config.json section. You need to edit paths, widths, and heights for your logo.

    For example, edit the path for login with the following entry:

    "path": "http(s)://<server-stored-images>/path/to/logo.svg|png|jpg"
    

If you configured IBM Multicloud Manager, you can edit the extra parameters in the about and header sections to further customize the views.

Note: The Login page is integrated and does not require more parameters.

See the following sample ConfigMap with login, about, and header configured paths, widths, and heights:

apiVersion: v1
data:
  ui-config.json: |-
    {
      "icpText": "IBM Cloud Private",
      "loginDialog": {
        "enable": "false",
        "headerText": "Header text here",
        "dialogText": "You must set your dialog for this environment. To set the dialog: SSH into your boot/master node and run the following command: 'kubectl edit configmap platform-ui-config -n kube-system'. In the ConfigMap, locate the 'ui-config.json' parameter and find the 'loginDialog' > 'dialogText' key. Replace the default text with your dialog text, then save your changes.",
        "acceptText": "Your acceptance text here"
      },
      "login": {
        "path": "/console/api/graphics/login-icp-logo.svg",
        "width": "239px",
        "height": "47px"
      },
      "about": {
        "path": "/header/graphics/ICP-AboutModal-TextLogo.svg",
        "width": "228px",
        "height": "23px",
        "mcm_path": "/header/graphics/MCM-AboutModal-TextLogo.svg",
        "mcm_width": "314px",
        "mcm_height": "27px"
      },
      "header": {
        "path": "/header/graphics/CloudPrivate-Text_Logo.svg",
        "width": "147px",
        "height": "14px",
        "mcm_path": "/header/graphics/mcm-logo.svg",
        "mcm_width": "202px",
        "mcm_height": "18px"
      }
    }
kind: ConfigMap
metadata:
  creationTimestamp: 2019-04-19T14:24:30Z
  name: platform-ui-config
  namespace: kube-system
  resourceVersion: "2937"
  selfLink: /api/v1/namespaces/kube-system/configmaps/platform-ui-config
  uid: d8434e8f-62ae-11e9-ac0f-00000a150252