Chapter 2. Managing applications that show in the dashboard

2.1. Adding an application to the dashboard

If you have installed an application in your OpenShift cluster, you can add a tile for that application to the OpenShift AI dashboard (the ApplicationsEnabled page) to make it accessible for OpenShift AI users.

Prerequisites

Procedure

  1. Log in to the OpenShift console as a cluster administrator.
  2. In the Administrator perspective, click HomeAPI Explorer.
  3. On the API Explorer page, search for the OdhApplication kind.
  4. Click the OdhApplication kind to open the resource details page.
  5. On the OdhApplication details page, select the redhat-ods-applications project from the Project list.
  6. Click the Instances tab.
  7. Click Create OdhApplication.
  8. On the Create OdhApplication page, copy the following code and paste it into the YAML editor.

    apiVersion: dashboard.opendatahub.io/v1
    kind: OdhApplication
    metadata:
      name: examplename
      namespace: redhat-ods-applications
      labels:
        app: odh-dashboard
        app.kubernetes.io/part-of: odh-dashboard
    spec:
      enable:
        validationConfigMap: examplename-enable
      img: >-
        <svg width="24" height="25" viewBox="0 0 24 25" fill="none" xmlns="http://www.w3.org/2000/svg">
        <path d="path data" fill="#ee0000"/>
        </svg>
      getStartedLink: 'https://example.org/docs/quickstart.html'
      route: exampleroutename
      routeNamespace: examplenamespace
      displayName: Example Name
      kfdefApplications: []
      support: third party support
      csvName: ''
      provider: example
      docsLink: 'https://example.org/docs/index.html'
      quickStart: ''
      getStartedMarkDown: >-
        # Example
    
        Enter text for the information panel.
    
      description: >-
        Enter summary text for the tile.
      category: Self-managed | Partner managed | {org-name} managed
  9. Modify the parameters in the code for your application.

    Tip

    To see example YAML files, click HomeAPI Explorer, select OdhApplication, click the Instances tab, select an instance, and then click the YAML tab.

  10. Click Create. The application details page appears.
  11. Log in to OpenShift AI.
  12. In the left menu, click ApplicationsExplore.
  13. Locate the new tile for your application and click it.
  14. In the information pane for the application, click Enable.

Verification

  • In the left menu of the OpenShift AI dashboard, click ApplicationsEnabled and verify that your application is available.

2.2. Preventing users from adding applications to the dashboard

By default, admin users are allowed to add applications to the OpenShift AI dashboard Application → Enabled page.

You can disable the ability for admin users to add applications to the dashboard.

Note: The Jupyter tile is enabled by default. To disable it, see Hiding the default Jupyter application.

Prerequisite

  • You have cluster administrator privileges for your OpenShift cluster.

Procedure

  1. Log in to the OpenShift console as a cluster administrator.
  2. Open the dashboard configuration file:

    1. In the Administrator perspective, click HomeAPI Explorer.
    2. In the search bar, enter OdhDashboardConfig to filter by kind.
    3. Click the OdhDashboardConfig custom resource (CR) to open the resource details page.
    4. Select the redhat-ods-applications project from the Project list.
    5. Click the Instances tab.
    6. Click the odh-dashboard-config instance to open the details page.
    7. Click the YAML tab.
  3. In the spec:dashboardConfig section, set the value of enablement to false to disable the ability for dashboard users to add applications to the dashboard.
  4. Click Save to apply your changes and then click Reload to make sure that your changes are synced to the cluster.

Verification

Open the OpenShift AI dashboard Application → Enabled page.

2.3. Showing or hiding information about enabled applications

If you have installed another application in your OpenShift cluster, you can add a tile for that application to the OpenShift AI dashboard (the ApplicationsEnabled page) to make it accessible for OpenShift AI users.

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. On the API Explorer page, search for the OdhApplication kind.
  4. Click the OdhApplication kind to open the resource details page.
  5. On the OdhApplication details page, select the redhat-ods-applications project from the Project list.
  6. Click the Instances tab.
  7. Click Create OdhApplication.
  8. On the Create OdhApplication page, copy the following code and paste it into the YAML editor.

    apiVersion: dashboard.opendatahub.io/v1
    kind: OdhApplication
    metadata:
      name: examplename
      namespace: redhat-ods-applications
      labels:
        app: odh-dashboard
        app.kubernetes.io/part-of: odh-dashboard
    spec:
      enable:
        validationConfigMap: examplename-enable
      img: >-
        <svg width="24" height="25" viewBox="0 0 24 25" fill="none" xmlns="http://www.w3.org/2000/svg">
        <path d="path data" fill="#ee0000"/>
        </svg>
      getStartedLink: 'https://example.org/docs/quickstart.html'
      route: exampleroutename
      routeNamespace: examplenamespace
      displayName: Example Name
      kfdefApplications: []
      support: third party support
      csvName: ''
      provider: example
      docsLink: 'https://example.org/docs/index.html'
      quickStart: ''
      getStartedMarkDown: >-
        # Example
    
        Enter text for the information panel.
    
      description: >-
        Enter summary text for the tile.
      category: Self-managed | Partner managed | Red Hat managed
  9. Modify the parameters in the code for your application.

    Tip

    To see example YAML files, click HomeAPI Explorer, select OdhApplication, click the Instances tab, select an instance, and then click the YAML tab.

  10. Click Create. The application details page appears.
  11. Log in to OpenShift AI.
  12. In the left menu, click ApplicationsExplore.
  13. Locate the new tile for your application and click it.
  14. In the information pane for the application, click Enable.

Verification

  • In the left menu of the OpenShift AI dashboard, click ApplicationsEnabled and verify that your application is available.

2.4. Hiding the default Jupyter application

The OpenShift AI dashboard includes Jupyter as an enabled application by default.

To hide the Jupyter tile from the list of Enabled applications, edit the dashboard configuration file.

Prerequisite

  • You have cluster administrator privileges for your OpenShift cluster.

Procedure

  1. Log in to the OpenShift console as a cluster administrator.
  2. Open the dashboard configuration file:

    1. In the Administrator perspective, click HomeAPI Explorer.
    2. In the search bar, enter OdhDashboardConfig to filter by kind.
    3. Click the OdhDashboardConfig custom resource (CR) to open the resource details page.
    4. Select the redhat-ods-applications project from the Project list.
    5. Click the Instances tab.
    6. Click the odh-dashboard-config instance to open the details page.
    7. Click the YAML tab.
  3. In the spec:notebookController section, set the value of enabled to false to hide the Jupyter tile from the list of Enabled applications.
  4. Click Save to apply your changes and then click Reload to make sure that your changes are synced to the cluster.

Verification

In the OpenShift AI dashboard, select Applications> Enabled. You should not see the Jupyter tile.