Chapter 1. Customizing the dashboard

The OpenShift AI dashboard provides features that are designed to work for most scenarios. These features are configured in the OdhDashboardConfig custom resource (CR) file.

To see a description of the options in the OpenShift AI dashboard configuration file, see Dashboard configuration options.

As an administrator, you can customize the interface of the dashboard, for example to show or hide some of the dashboard navigation menu options. To change the default settings of the dashboard, edit the OdhDashboardConfig custom resource (CR) file as described in Editing the dashboard configuration file.

1.1. Editing the dashboard configuration file

As an administrator, you can customize the interface of the dashboard by editing the dashboard configuration file.

Prerequisites

  • You have cluster administrator privileges for your OpenShift cluster.

Procedure

  1. Log in to the OpenShift console as a cluster administrator.
  2. In the Administrator perspective, click HomeAPI Explorer.
  3. In the search bar, enter OdhDashboardConfig to filter by kind.
  4. Click the OdhDashboardConfig custom resource (CR) to open the resource details page.
  5. Select the redhat-ods-applications project from the Project list.
  6. Click the Instances tab.
  7. Click the odh-dashboard-config instance to open the details page.
  8. Click the YAML tab. Here is an example OdhDashboardConfig file showing default values:

    apiVersion: opendatahub.io/v1alpha
    kind: OdhDashboardConfig
    metadata:
      name: odh-dashboard-config
    spec:
      dashboardConfig:
        enablement: true
        disableBYONImageStream: false
        disableClusterManager: false
        disableISVBadges: false
        disableInfo: false
        disableSupport: false
        disableTracking: true
        disableProjects: true
        disablePipelines: true
        disableModelServing: true
        disableProjectSharing: true
        disableCustomServingRuntimes: false
        disableAcceleratorProfiles: true
        modelMetricsNamespace: ''
        disablePerformanceMetrics: false
      notebookController:
        enabled: true
      notebookSizes:
        - name: Small
          resources:
            limits:
              cpu: '2'
              memory: 2Gi
            requests:
              cpu: '1'
              memory: 1Gi
        - name: Medium
          resources:
            limits:
              cpu: '4'
              memory: 4Gi
            requests:
              cpu: '2'
              memory: 2Gi
        - name: Large
          resources:
            limits:
              cpu: '8'
              memory: 8Gi
            requests:
              cpu: '4'
              memory: 4Gi
      modelServerSizes:
        - name: Small
          resources:
            limits:
              cpu: '2'
              memory: 8Gi
            requests:
              cpu: '1'
              memory: 4Gi
        - name: Medium
          resources:
            limits:
              cpu: '8'
              memory: 10Gi
            requests:
              cpu: '4'
              memory: 8Gi
        - name: Large
          resources:
            limits:
              cpu: '10'
              memory: 20Gi
            requests:
              cpu: '6'
              memory: 16Gi
      groupsConfig:
        adminGroups: 'odh-admins'
        allowedGroups: 'system:authenticated'
      templateOrder:
        - 'ovms'
      templateDisablement:
        - 'ovms'
  9. Edit the values of the options that you want to change.
  10. Click Save to apply your changes and then click Reload to make sure that your changes are synced to the cluster.

Verification

Log in to OpenShift AI and verify that your dashboard configurations apply.

1.2. Dashboard configuration options

The OpenShift AI dashboard includes a set of core features enabled by default that are designed to work for most scenarios. Administrators can configure the OpenShift AI dashboard from the OdhDashboardConfig custom resource (CR) in OpenShift.

Table 1.1. Dashboard feature configuration options

Feature

Default

Description

dashboardConfig: enablement

true

Enables admin users to add applications to the OpenShift AI dashboard Application → Enabled page. To disable this ability, set the value to false.

dashboardConfig: disableInfo

false

On the Applications → Explore page, when a user clicks on an application tile, an information panel opens with more details about the application. To disable the information panel for all applications on the Applications → Explore page , set the value to true.

dashboardConfig: disableSupport

false

Shows the Support menu option when a user clicks the Help icon in the dashboard toolbar. To hide this menu option, set the value to true.

dashboardConfig: disableClusterManager

false

Shows the Settings → Cluster settings option in the dashboard navigation menu. To hide this menu option, set the value to true.

dashboardConfig: disableTracking

true

Allows Red Hat to collect data about OpenShift AI usage in your cluster. To enable data collection, set the value to false. You can also set this option in the OpenShift AI dashboard interface from the Settings → Cluster settings navigation menu.

dashboardConfig: disableBYONImageStream

false

Shows the Settings → Notebook images option in the dashboard navigation menu. To hide this menu option, set the value to false.

dashboardConfig: disableISVBadges

false

Shows the label on a tile that indicates whether the application is “Red Hat managed”, “Partner managed”, or “Self-managed”. To hide these labels, set the value to true.

dashboardConfig: disableUserManagement

false

Shows the Settings → User management option in the dashboard navigation menu. To hide this menu option, set the value to true.

dashboardConfig: disableProjects

false

Shows the Data Science Projects option in the dashboard navigation menu. To hide this menu option, set the value to true.

dashboardConfig: disablePipelines

false

Shows the Data Science Pipelines option in the dashboard navigation menu. To hide this menu option, set the value to true.

dashboardConfig: disableModelServing

false

Shows the Model Serving option in the dashboard navigation menu and in the list of components for the data science projects. To hide Model Serving from the dashboard navigation menu and from the list of components for data science projects, set the value to true.

dashboardConfig: disableProjectSharing

false

Allows users to share access to their data science projects with other users. To prevent users from sharing data science projects, set the value to true.

dashboardConfig: disableCustomServingRuntimes

false

Shows the Serving runtimes option in the dashboard navigation menu. To hide this menu option, set the value to true.

dashboardConfig: disableKServe

false

Enables the ability to select KServe as a Serving Platform. To disable this ability, set the value to true.

dashboardConfig: disableModelMesh

false

Enables the ability to select ModelMesh as a Serving Platform. To disable this ability, set the value to true.

dashboardConfig: disableAcceleratorProfiles

false

Shows the Accelerator profiles option in the dashboard navigation menu. To hide this menu option, set the value to true.

dashboardConfig: modelMetricsNamespace

false

Enables the namespace in which the Model Serving Metrics' Prometheus Operator is installed.

dashboardConfig: disablePerformanceMetrics

false

Shows the Endpoint Performance tab on the Model Serving page. To hide this tab, set the value to true.

notebookController: enabled

true

Controls the Notebook Controller options, such as whether it is enabled in the dashboard and which parts are visible.

notebookSizes

 

Allows you to customize names and resources for notebooks. The Kubernetes-style sizes are shown in the dropdown menu that appears when spawning notebooks with the Notebook Controller. Note: These sizes must follow conventions. For example, requests must be smaller than limits.

ModelServerSizes

 

Allows you to customize names and resources for model servers.

groupsConfig

 

Controls access to dashboard features, such as the spawner for allowed users and the cluster settings UI for admin users.

templateOrder

 

Specifies the order of custom Serving Runtime templates. When the user creates a new template, it is added to this list.