Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

odh-766-mf-2 updates after downstream fetch 1 #215

Merged
merged 2 commits into from
Mar 6, 2024
Merged

odh-766-mf-2 updates after downstream fetch 1 #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6abf54e
odh-766-mf-2 updates after downstream fetch 1
MelissaFlinn Mar 6, 2024
0ef5618
odh-766-mf-2 peer edit
MelissaFlinn Mar 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions assemblies/customizing-the-dashboard.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ endif::preview[]

The {productname-short} 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 {productname-short} dashboard configuration file, see link:{odhdocshome}/managing_resources/#ref-dashboard-configuration-options_dashboard[Dashboard configuration options].
To see a description of the options in the {productname-short} dashboard configuration file, see link:{odhdocshome}/managing-resources/#ref-dashboard-configuration-options_dashboard[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 link:{odhdocshome}/managing_resources/#editing-the-dashboard-configuration-file_dashboard[Editing the dashboard configuration file].
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 link:{odhdocshome}/managing-resources/#editing-the-dashboard-configuration-file_dashboard[Editing the dashboard configuration file].

include::modules/editing-the-dashboard-configuration-file.adoc[leveloffset=+1]
include::modules/ref-dashboard-configuration-options.adoc[leveloffset=+1]
Expand Down
59 changes: 39 additions & 20 deletions modules/ref-dashboard-configuration-options.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,47 @@
The {productname-short} dashboard includes a set of core features enabled by default that are designed to work for most scenarios. Administrators can configure the {productname-short} dashboard from the `OdhDashboardConfig` custom resource (CR) in {openshift-platform}.

.Dashboard feature configuration options
[cols="20%,5%,75%","header"]
[cols="32%,10%,58%","header"]
|===
| Feature | Default | Description
| `dashboardConfig:enablement` | `true` | Enables admin users to add applications to the {productname-short} 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 {org-name} to collect data about {productname-short} usage in your cluster. To enable data collection, set the value to `false`. You can also set this option in the {productname-short} dashboard interface from the *Settings → Cluster settings* navigation menu.
| `dashboardConfig:disableBYONImageStream` | `false` | Shows the *Settings → Notebook image settings* 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 “{org-name} 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.
| `dashboardConfig:
enablement` | `true` | Enables admin users to add applications to the {productname-short} 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 {org-name} to collect data about {productname-short} usage in your cluster. To enable data collection, set the value to `false`. You can also set this option in the {productname-short} dashboard interface from the *Settings → Cluster settings* navigation menu.
| `dashboardConfig:
disableBYONImageStream` | `false` | Shows the *Settings → Notebook image settings* 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 “{org-name} 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.
Expand Down
2 changes: 1 addition & 1 deletion modules/showing-hiding-information-about-enabled-applications.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_module-type: PROCEDURE

[id="showing-hiding-information-about-enabled applications_{context}"]
[id="showing-hiding-information-about-enabled-applications_{context}"]
= Showing or hiding information about enabled applications

[role='_abstract']
Expand Down