Chapter 4. Managing applications that show in the dashboard
4.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 Applications
Prerequisites
- You have cluster administrator privileges for your OpenShift cluster.
-
The dashboard configuration enablement option is set to
true
(the default). Note that a cluster administrator can disable this ability as described in Preventing users from adding applications to the dashboard.
Procedure
- Log in to the OpenShift console as a cluster administrator.
-
In the Administrator perspective, click Home
API Explorer. -
On the API Explorer page, search for the
OdhApplication
kind. -
Click the
OdhApplication
kind to open the resource details page. -
On the OdhApplication details page, select the
redhat-ods-applications
project from the Project list. - Click the Instances tab.
- Click Create OdhApplication.
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
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
Copy to Clipboard Copied! Modify the parameters in the code for your application.
TipTo see example YAML files, click Home
API Explorer, select OdhApplication
, click the Instances tab, select an instance, and then click the YAML tab.- Click Create. The application details page appears.
- Log in to OpenShift AI.
-
In the left menu, click Applications
Explore. - Locate the new tile for your application and click it.
- In the information pane for the application, click Enable.
Verification
-
In the left menu of the OpenShift AI dashboard, click Applications
Enabled and verify that your application is available.
4.2. Preventing users from adding applications to the dashboard
By default, OpenShift AI administrators can add applications to the OpenShift AI dashboard Application
As a cluster administrator, you can disable the ability for OpenShift AI administrators to add applications to the dashboard.
Note: The Start basic workbench tile is enabled by default. To disable it, see Hiding the default basic workbench application.
Prerequisite
- You have cluster administrator privileges for your OpenShift cluster.
Procedure
- Log in to the OpenShift console as a cluster administrator.
Open the dashboard configuration file:
-
In the Administrator perspective, click Home
API Explorer. -
In the search bar, enter
OdhDashboardConfig
to filter by kind. -
Click the
OdhDashboardConfig
custom resource (CR) to open the resource details page. -
Select the
redhat-ods-applications
project from the Project list. - Click the Instances tab.
-
Click the
odh-dashboard-config
instance to open the details page. - Click the YAML tab.
-
In the Administrator perspective, click Home
-
In the
spec.dashboardConfig
section, set the value ofenablement
tofalse
to disable the ability for dashboard users to add applications to the dashboard. - 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.
4.3. Disabling applications connected to OpenShift AI
You can disable applications and components so that they do not appear on the OpenShift AI dashboard when you no longer want to use them, for example, when data scientists no longer use an application or when the application license expires.
Disabling unused applications allows your data scientists to manually remove these application tiles from their OpenShift AI dashboard so that they can focus on the applications that they are most likely to use. See Removing disabled applications from the dashboard for more information about manually removing application tiles.
Prerequisites
- You have logged in to the OpenShift web console.
-
You are part of the
cluster-admins
user group in OpenShift. - You have installed or configured the service on your OpenShift cluster.
- The application or component that you want to disable is enabled and appears on the Enabled page.
Procedure
- In the OpenShift web console, switch to the Administrator perspective.
-
Switch to the
redhat-ods-applications
project. -
Click Operators
Installed Operators. - Click on the Operator that you want to uninstall. You can enter a keyword into the Filter by name field to help you find the Operator faster.
Delete any Operator resources or instances by using the tabs in the Operator interface.
During installation, some Operators require the administrator to create resources or start process instances using tabs in the Operator interface. These must be deleted before the Operator can uninstall correctly.
On the Operator Details page, click the Actions drop-down menu and select Uninstall Operator.
An Uninstall Operator? dialog box is displayed.
- Select Uninstall to uninstall the Operator, Operator deployments, and pods. After this is complete, the Operator stops running and no longer receives updates.
Removing an Operator does not remove any custom resource definitions or managed resources for the Operator. Custom resource definitions and managed resources still exist and must be cleaned up manually. Any applications deployed by your Operator and any configured off-cluster resources continue to run and must be cleaned up manually.
Verification
- The Operator is uninstalled from its target clusters.
- The Operator no longer appears on the Installed Operators page.
-
The disabled application is no longer available for your data scientists to use, and is marked as
Disabled
on the Enabled page of the OpenShift AI dashboard. This action may take a few minutes to occur following the removal of the Operator.
4.4. Showing or hiding information about available applications
You can view a list of available applications in the Exploring applications page of the OpenShift AI dashboard. By default, the following information is provided for each application:
- Any independent software vendor (ISV) application is indicated with a label on the tile indicating “Red Hat managed”, “Partner managed”, or “Self-managed”. As a cluster administrator, you can hide or show the labels. For example, if you are running a self-managed environment, you might want to show all available applications regardless of the support level.
- When a user clicks on an application, an information panel appears and provides more information about the application, including links to quick starts or detailed documentation. You can disable or enable the appearance of application information panels.
Prerequisites
- You have cluster administrator privileges for your OpenShift cluster.
Procedure
- Log in to the OpenShift console as a cluster administrator.
Open the dashboard configuration file:
-
In the Administrator perspective, click Home
API Explorer. -
In the search bar, enter
OdhDashboardConfig
to filter by kind. -
Click the
OdhDashboardConfig
custom resource (CR) to open the resource details page. -
Select the
redhat-ods-applications
project from the Project list. - Click the Instances tab.
-
Click the
odh-dashboard-config
instance to open the details page. - Click the YAML tab.
-
In the Administrator perspective, click Home
In the
spec.dashboardConfig
section, set either or both of the following options:-
disableInfo
: Set totrue
to hide the appearance of application information panel. Set toFalse
(the default) to show the application information panel. -
disableISVBadges
: Set totrue
to hide the appearance of the support-level label. Set toFalse
(the default) to show the support-level label.
-
- 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.
4.5. Hiding the default basic workbench application
The OpenShift AI dashboard includes Start basic workbench as an enabled application by default.
To hide the Start basic workbench tile so that it is no longer included in the list of applications on the Applications
Prerequisite
- You have cluster administrator privileges for your OpenShift cluster.
Procedure
- Log in to the OpenShift console as a cluster administrator.
Open the dashboard configuration file:
-
In the Administrator perspective, click Home
API Explorer. -
In the search bar, enter
OdhDashboardConfig
to filter by kind. -
Click the
OdhDashboardConfig
custom resource (CR) to open the resource details page. -
Select the
redhat-ods-applications
project from the Project list. - Click the Instances tab.
-
Click the
odh-dashboard-config
instance to open the details page. - Click the YAML tab.
-
In the Administrator perspective, click Home
-
In the
spec:notebookController
section, set the value ofenabled
tofalse
to remove the Start basic workbench tile from the list of applications on the ApplicationsEnabled page. - 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, click Applications