Skip to content

Commit 05ca425

Browse files
bredamcbredamc
authored
Merge pull request #807 from bredamc/ENG-25345_dbd_options_2-21
ENG-25345: Dashboard config options updates for 2.21
2 parents 4e8bbe9 + 6336e62 commit 05ca425

File tree

1 file changed

+68
-33
lines changed

1 file changed

+68
-33
lines changed

‎modules/ref-dashboard-configuration-options.adoc

Lines changed: 68 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -30,36 +30,51 @@ endif::[]
3030
[cols="32%,10%,58%","header"]
3131
|===
3232
| Feature configuration option | Default value | Description
33-
| `spec.dashboardConfig.disableAcceleratorProfiles` | `false`| Shows the *Settings → Accelerator profiles* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
33+
| `spec.dashboardConfig.` +
34+
`disableAcceleratorProfiles` | `false`| Shows the *Settings → Accelerator profiles* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
3435

3536
*Note:* The `spec.dashboardConfig.disableAcceleratorProfiles` option is superseded by the `spec.dashboardConfig.disableHardwareProfiles` option.
3637
If both options are set to `false`, the `disableHardwareProfiles` option overrides the `disableAcceleratorProfiles` option, and the *Settings → Hardware profiles* menu item is shown in the dashboard navigation menu.
37-
| `spec.dashboardConfig.disableAdminConnectionTypes` | `false` | Shows the *Settings → Connection types* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
38-
| `spec.dashboardConfig.disableBYONImageStream` | `false` | Shows the *Settings → Notebook images* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
39-
| `spec.dashboardConfig.disableClusterManager` | `false` | Shows the *Settings → Cluster settings* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
40-
| `spec.dashboardConfig.disableCustomServingRuntimes` | `false` | Shows the *Settings → Serving runtimes* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
41-
| `spec.dashboardConfig.disableDistributedWorkloads` | `false` | Shows the *Distributed workloads* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
42-
| `spec.dashboardConfig.disableFineTuning`
38+
| `spec.dashboardConfig.` +
39+
`disableAdminConnectionTypes` | `false` | Shows the *Settings → Connection types* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
40+
| `spec.dashboardConfig.` +
41+
`disableBYONImageStream` | `false` | Shows the *Settings → Notebook images* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
42+
| `spec.dashboardConfig.` +
43+
`disableClusterManager` | `false` | Shows the *Settings → Cluster settings* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
44+
| `spec.dashboardConfig.` +
45+
`disableCustomServingRuntimes` | `false` | Shows the *Settings → Serving runtimes* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
46+
| `spec.dashboardConfig.` +
47+
`disableDistributedWorkloads` | `false` | Shows the *Distributed workloads* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
48+
| `spec.dashboardConfig.` +
49+
`disableFineTuning`
4350

4451
(Technology Preview) | `true` | Hides the *Models → Model customization* menu item in the dashboard navigation menu, and the *LAB-tune* menu item and button for registered model versions.
4552
To show these items, set the value to `false`.
4653

4754
LAB-tuning is a Technology Preview feature in this {productname-short} release.
48-
| `spec.dashboardConfig.disableHardwareProfiles`
55+
| `spec.dashboardConfig.` +
56+
`disableHardwareProfiles`
4957

5058
(Technology Preview) | `true` | Hides the *Settings → Hardware profiles* menu item in the dashboard navigation menu, and shows the *Settings → Accelerator profiles* menu item if the `spec.dashboardConfig.disableAcceleratorProfiles` value is set to `false`.
5159
To show the *Settings → Hardware profiles* menu item in the dashboard navigation menu, set the value to `false`.
5260

5361
If both options are set to `false`, the `disableHardwareProfiles` option overrides the `disableAcceleratorProfiles` option, and the *Settings → Hardware profiles* menu item is shown in the dashboard navigation menu.
5462

5563
Hardware profiles is a Technology Preview feature in this {productname-short} release.
56-
| `spec.dashboardConfig.disableHome` | `false` | Shows the *Home* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
57-
| `spec.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`.
58-
| `spec.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`.
59-
| `spec.dashboardConfig.disableKServe` | `false` | Enables the ability to select KServe as a model-serving platform. To disable this ability, set the value to `true`.
60-
| `spec.dashboardConfig.disableKServeAuth` | `false` | Enables the ability to use authentication with KServe. To disable this ability, set the value to `true`.
61-
| `spec.dashboardConfig.disableKServeMetrics` | `false` | Enables the ability to view KServe metrics. To disable this ability, set the value to `true`.
62-
| `spec.dashboardConfig.disableKServeRaw` | `false` | On the *Settings → Cluster settings* page, in the *Single-model serving platform* section, shows the *Default deployment mode* list.
64+
| `spec.dashboardConfig.` +
65+
`disableHome` | `false` | Shows the *Home* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
66+
| `spec.dashboardConfig.` +
67+
`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`.
68+
| `spec.dashboardConfig.` +
69+
`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`.
70+
| `spec.dashboardConfig.` +
71+
`disableKServe` | `false` | Enables the ability to select KServe as a model-serving platform. To disable this ability, set the value to `true`.
72+
| `spec.dashboardConfig.` +
73+
`disableKServeAuth` | `false` | Enables the ability to use authentication with KServe. To disable this ability, set the value to `true`.
74+
| `spec.dashboardConfig.` +
75+
`disableKServeMetrics` | `false` | Enables the ability to view KServe metrics. To disable this ability, set the value to `true`.
76+
| `spec.dashboardConfig.` +
77+
`disableKServeRaw` | `false` | On the *Settings → Cluster settings* page, in the *Single-model serving platform* section, shows the *Default deployment mode* list.
6378

6479
On the *Deploy model* dialog when using the single-model serving platform:
6580

@@ -68,41 +83,61 @@ On the *Deploy model* dialog when using the single-model serving platform:
6883
      - If the {org-name} OpenShift Serverless Operator and {org-name} OpenShift Service Mesh Operator are not installed, hides the *Deployment mode* list, and sets the deployment mode to *Standard*.
6984

7085
To hide these deployment-mode lists and set the deployment mode to *Advanced* when using the single-model serving platform, set the `spec.dashboardConfig.disableKServeRaw` value to `true`.
71-
| `spec.dashboardConfig.disableModelCatalog`
86+
| `spec.dashboardConfig.` +
87+
`disableModelCatalog`
7288

7389
(Technology Preview) | `true` | Hides the *Models → Model catalog* menu item in the dashboard navigation menu.
7490
To show this menu item, set the value to `false`.
7591

7692
Model catalog is a Technology Preview feature in this {productname-short} release.
77-
| `spec.dashboardConfig.disableModelMesh` | `false` | Enables the ability to select ModelMesh as a model-serving platform. To disable this ability, set the value to `true`.
78-
| `spec.dashboardConfig.disableModelRegistry`
93+
| `spec.dashboardConfig.` +
94+
`disableModelMesh` | `false` | Enables the ability to select ModelMesh as a model-serving platform. To disable this ability, set the value to `true`.
95+
| `spec.dashboardConfig.` +
96+
`disableModelRegistry`
7997

8098
(Technology Preview) | `false` | Shows the *Models → Model registry* menu item and the *Settings → Model registry settings* menu item in the dashboard navigation menu. To hide these menu items, set the value to `true`.
8199

82100
Model registry is a Technology Preview feature in this {productname-short} release.
83-
| `spec.dashboardConfig.disableModelRegistrySecureDB`
101+
| `spec.dashboardConfig.` +
102+
`disableModelRegistrySecureDB`
84103

85104
(Technology Preview) | `false` | Shows the *Add CA certificate to secure database connection* section in the *Create model registry* dialog and the *Edit model registry* dialog. To hide this section, set the value to `true`.
86105

87106
Model registry is a Technology Preview feature in this {productname-short} release.
88-
| `spec.dashboardConfig.disableModelServing` | `false` | Shows the *Models → Model deployments* menu item in the dashboard navigation menu, and the *Models* tab in data science projects. To hide these items, set the value to `true`.
89-
| `spec.dashboardConfig.disableNIMModelServing` | `false` | Enables the ability to select NVIDIA NIM as a model-serving platform. To disable this ability, set the value to `true`.
90-
| `spec.dashboardConfig.disablePerformanceMetrics` | `false` | Shows the *Endpoint Performance* tab on the *Model deployments* page. To hide this tab, set the value to `true`.
91-
| `spec.dashboardConfig.disablePipelines` | `false` | Shows the *Data science pipelines* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
92-
| `spec.dashboardConfig.disableProjects` | `false` | Shows the *Data science projects* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
93-
| `spec.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`.
94-
| `spec.dashboardConfig.disableServingRuntimeParams` | `false` | Shows the *Configuration parameters* section in the *Deploy model* dialog and the *Edit model* dialog when using the single-model serving platform. To hide this section, set the value to `true`.
95-
| `spec.dashboardConfig.disableStorageClasses` | `false` | Shows the *Settings → Storage classes* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
96-
| `spec.dashboardConfig.disableSupport` | `false` | Shows the *Support* menu item when a user clicks the Help icon in the dashboard toolbar. To hide this menu item, set the value to `true`.
107+
| `spec.dashboardConfig.` +
108+
`disableModelServing` | `false` | Shows the *Models → Model deployments* menu item in the dashboard navigation menu, and the *Models* tab in data science projects. To hide these items, set the value to `true`.
109+
| `spec.dashboardConfig.` +
110+
`disableNIMModelServing` | `false` | Enables the ability to select NVIDIA NIM as a model-serving platform. To disable this ability, set the value to `true`.
111+
| `spec.dashboardConfig.` +
112+
`disablePerformanceMetrics` | `false` | Shows the *Endpoint Performance* tab on the *Model deployments* page. To hide this tab, set the value to `true`.
113+
| `spec.dashboardConfig.` +
114+
`disablePipelines` | `false` | Shows the *Data science pipelines* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
115+
| `spec.dashboardConfig.` +
116+
`disableProjects` | `false` | Shows the *Data science projects* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
117+
| `spec.dashboardConfig.` +
118+
`disableProjectScoped` | `false` | Distinguishes between global items and project-scoped items (if project-scoped items exist) in the {productname-short} web console. This option applies to workbench images, hardware profiles, accelerator profiles, and model-serving runtimes for KServe. To disable this functionality, set the value to `true`.
119+
| `spec.dashboardConfig.` +
120+
`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`.
121+
| `spec.dashboardConfig.` +
122+
`disableServingRuntimeParams` | `false` | Shows the *Configuration parameters* section in the *Deploy model* dialog and the *Edit model* dialog when using the single-model serving platform. To hide this section, set the value to `true`.
123+
| `spec.dashboardConfig.` +
124+
`disableStorageClasses` | `false` | Shows the *Settings → Storage classes* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
125+
| `spec.dashboardConfig.` +
126+
`disableSupport` | `false` | Shows the *Support* menu item when a user clicks the Help icon in the dashboard toolbar. To hide this menu item, set the value to `true`.
97127
ifdef::upstream[]
98-
| `spec.dashboardConfig.disableTracking` | `true` | Disables the collection of 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.
128+
| `spec.dashboardConfig.` +
129+
`disableTracking` | `true` | Disables the collection of 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.
99130
endif::[]
100131
ifndef::upstream[]
101-
| `spec.dashboardConfig.disableTracking` | `false` | Allows {org-name} to collect data about {productname-short} usage in your cluster. To disable data collection, set the value to `true`. You can also set this option in the {productname-short} dashboard interface from the *Settings → Cluster settings* navigation menu.
132+
| `spec.dashboardConfig.` +
133+
`disableTracking` | `false` | Allows {org-name} to collect data about {productname-short} usage in your cluster. To disable data collection, set the value to `true`. You can also set this option in the {productname-short} dashboard interface from the *Settings → Cluster settings* navigation menu.
102134
endif::[]
103-
| `spec.dashboardConfig.disableTrustyBiasMetrics` | `false` | Shows the *Model Bias* tab on the *Models* page. To hide this tab, set the value to `true`.
104-
| `spec.dashboardConfig.disableUserManagement` | `false` | Shows the *Settings → User management* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
105-
| `spec.dashboardConfig.enablement` | `true` | Enables {productname-short} administrators to add applications to the {productname-short} dashboard *Applications → Enabled* page. To disable this ability, set the value to `false`.
135+
| `spec.dashboardConfig.` +
136+
`disableTrustyBiasMetrics` | `false` | Shows the *Model Bias* tab on the *Models* page. To hide this tab, set the value to `true`.
137+
| `spec.dashboardConfig.` +
138+
`disableUserManagement` | `false` | Shows the *Settings → User management* menu item in the dashboard navigation menu. To hide this menu item, set the value to `true`.
139+
| `spec.dashboardConfig.` +
140+
`enablement` | `true` | Enables {productname-short} administrators to add applications to the {productname-short} dashboard *Applications → Enabled* page. To disable this ability, set the value to `false`.
106141
| `spec.groupsConfig` | No longer used | Read-only. To configure access to the {productname-short} dashboard, use the `spec.adminGroups` and `spec.allowedGroups` options in the {openshift-platform} `Auth` resource in the `services.platform.opendatahub.io` API group.
107142
| `spec.modelServerSizes` | `Small`, `Medium`, `Large` | Allows you to customize names and resources for model servers.
108143
| `spec.notebookController.enabled` | `true` | Controls the Notebook Controller behavior, such as whether it is enabled in the dashboard and which parts are visible.

0 commit comments

Comments
 (0)