Skip to content

Commit 38121c4

Browse files
Update Central Dashboard docs for 1.9.0 (#3806)
Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
1 parent f67dd9f commit 38121c4

17 files changed

Lines changed: 70 additions & 33 deletions

content/en/docs/components/central-dash/customize.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,23 @@ weight = 90
88

99
The Kubeflow Central Dashboard provides a way to customize the menu items and integrate third-party apps.
1010

11-
For example, the below image shows the Kubeflow Central Dashboard with a custom "My App" menu item:
11+
For example, the below image shows the Kubeflow Central Dashboard with a custom **"My App"** menu item:
1212

13-
<img src="/docs/images/customize-menu-add-app.png" alt="Display third party app on a kubeflow dashboard" class="mt-3 mb-3 border border-info rounded"></img>
13+
<img src="/docs/images/dashboard/custom-menu-item.png"
14+
alt="Kubeflow Central Dashboard - Customize Menu Items"
15+
class="mt-3 mb-3 border border-info rounded">
16+
</img>
1417

1518
## Central Dashboard ConfigMap
1619

1720
The Kubeflow Central Dashboard is configured using a Kubernetes ConfigMap.
1821

19-
The `CD_CONFIGMAP_NAME` environment variable on the central-dashboard Deployment specifies the name of the ConfigMap.
20-
By default, the ConfigMap is named `centraldashboard-config`. You can find the default ConfigMap in the [`/apps/centraldashboard/upstream/base/configmap.yaml` file of the `kubeflow/manifests`](https://github.com/kubeflow/manifests/blob/v1.8.0/apps/centraldashboard/upstream/base/configmap.yaml) repository.
22+
The `CD_CONFIGMAP_NAME` environment variable on the central-dashboard Deployment specifies the name of the ConfigMap (`centraldashboard-config` by default).
23+
24+
You can find examples of the ConfigMap in the following locations:
25+
26+
- [Default](https://github.com/kubeflow/kubeflow/blob/v1.9.0/components/centraldashboard/manifests/base/configmap.yaml)
27+
- [Default + KServe](https://github.com/kubeflow/kubeflow/blob/v1.9.0/components/centraldashboard/manifests/overlays/kserve/patches/configmap.yaml)
2128

2229
## External Links
2330

content/en/docs/components/central-dash/overview.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ Some core features of the central dashboard include:
2121

2222
Here is a screenshot of the Kubeflow Central Dashboard:
2323

24-
<img src="/docs/images/central-ui.png" alt="Kubeflow central UI" class="mt-3 mb-3 border border-info rounded"></img>
24+
<img src="/docs/images/dashboard/homepage.png"
25+
alt="Kubeflow Central Dashboard - Homepage"
26+
class="mt-3 mb-3 border border-info rounded">
27+
</img>
2528

2629
## Navigation
2730

@@ -33,38 +36,46 @@ Here is a list of the main pages, grouped by component.
3336

3437
The following sections are available in all Kubeflow deployments:
3538

36-
- **Home**: landing page for the Kubeflow Central Dashboard
37-
- **Manage Contributors**: manage contributors for the current profile/namespace
39+
- **Home**: landing page for Kubeflow Central Dashboard
40+
- **Manage Contributors**: manage contributors of profiles (namespaces) that you own
3841

3942
### Kubeflow Notebooks
4043

4144
The following sections are available when [Kubeflow Notebooks](/docs/components/notebooks/) is installed:
4245

4346
- **Notebooks**: manage Kubeflow Notebooks
47+
- **TensorBoards**: manage TensorBoard instances
4448
- **Volumes**: manage Kubernetes PVC Volumes
4549

46-
### Kubeflow Pipelines
47-
48-
The following sections are available when [Kubeflow Pipelines](/docs/components/pipelines/) is installed:
49-
50-
- **Experiments (KFP)**: manage KFP experiments
51-
- **Runs**: manage KFP runs
52-
- **Recurring Runs**: To manage KFP recurring runs
53-
- **Pipelines**: manage KFP pipelines
54-
- **Artifacts**: track ML Metadata (MLMD) artifacts
55-
- **Executions**: track various component executions in MLMD
56-
57-
### Katib
50+
### Kubeflow Katib
5851

5952
The following sections are available when [Katib](/docs/components/katib/) is installed:
6053

61-
- **Experiments (AutoML)**: manage Katib experiments
54+
- **Katib Experiments**: manage Katib AutoML experiments
6255

6356
### KServe
6457

6558
The following sections are available when [KServe](/docs/external-add-ons/kserve/) is installed:
6659

67-
- **Models**: manage deployed KServe models
60+
- **KServe Endpoints**: manage deployed KServe model endpoints
61+
62+
### Kubeflow Pipelines
63+
64+
When [Kubeflow Pipelines](/docs/components/pipelines/) is installed, you can select **Pipelines** from the sidebar:
65+
66+
<img src="/docs/images/dashboard/pipelines-runs.png"
67+
alt="Kubeflow Central Dashboard - Pipelines - Runs"
68+
class="mt-3 mb-3 border border-info rounded">
69+
</img>
70+
71+
In the **Pipelines** section, you can access the following pages:
72+
73+
- **Pipelines**: manage pipeline definitions
74+
- **Experiments**: manage pipeline experiments
75+
- **Runs**: manage pipeline runs
76+
- **Recurring Runs**: manage recurring pipeline runs
77+
- **Artifacts**: track artifacts produced by pipelines stored in MLMD
78+
- **Executions**: track executions of pipeline components stored in MLMD
6879

6980
## Next steps
7081

content/en/docs/components/central-dash/profiles.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,15 @@ Profiles and their child Namespaces are reconciled by the [Kubeflow Profile Cont
1414

1515
## Central Dashboard
1616

17-
You can select the active profile from the top bar on the Kubeflow Central Dashboard.
18-
Users can only see profiles to which they have owner, modify, or view access.
19-
17+
Select the active profile with the drop-down found in the top bar of Kubeflow Central Dashboard.
2018
Most Kubeflow components use the active profile to determine which resources to display, and what permissions to grant.
2119

22-
<img src="/docs/images/select-profile.png" alt="Select active profile" class="mt-3 mb-3 border border-info rounded"></img>
20+
Users can only see profiles to which they have owner, contributor (read + write), or viewer (read) access.
21+
22+
<img src="/docs/images/dashboard/homepage-profile-selector.png"
23+
alt="Kubeflow Central Dashboard - Profile Selector"
24+
class="mt-3 mb-3 border border-info rounded">
25+
</img>
2326

2427
## Automatic Profile Creation
2528

@@ -42,11 +45,19 @@ Here is an example of the automatic profile creation flow:
4245

4346
1. A new user logs into Kubeflow for the first time:
4447

45-
<img src="/docs/images/auto-profile1-crop.png" alt="Automatic profile creation step 1" class="mt-3 mb-3 border border-info rounded" style="width: 100%; max-width: 30em"></img>
48+
<img src="/docs/images/dashboard/auto-profile-step-1.png"
49+
alt="Kubeflow Central Dashboard - Automatic Profile Creation - Step 1"
50+
class="mt-3 mb-3 border border-info rounded"
51+
style="width: 100%; max-width: 30em">
52+
</img>
4653

4754
2. The user can name their profile and click *Finish*:
4855

49-
<img src="/docs/images/auto-profile2.png" alt="Automatic profile creation step 2" class="mt-3 mb-3 border border-info rounded" style="width: 100%; max-width: 30em"></img>
56+
<img src="/docs/images/dashboard/auto-profile-step-2.png"
57+
alt="Kubeflow Central Dashboard - Automatic Profile Creation - Step 2"
58+
class="mt-3 mb-3 border border-info rounded"
59+
style="width: 100%; max-width: 30em">
60+
</img>
5061

5162
## Profile Resources
5263

@@ -153,11 +164,18 @@ To add contributors with "view" access, you must use the [manual method](#manage
153164

154165
The __owner__ of a profile can use the __Manage Contributors__ tab in the Kubeflow Central Dashboard to add or remove contributors.
155166

156-
<img src="/docs/images/multi-user-contributors.png" alt="Manage Contributors in Profiles" class="mt-3 mb-3 border border-info rounded"></img>
167+
<img src="/docs/images/dashboard/homepage-manage-contributors.png"
168+
alt="Kubeflow Central Dashboard - Manage Contributors Link"
169+
class="mt-3 mb-3 border border-info rounded">
170+
</img>
157171

158172
Contributors are managed with the "Contributors to your namespace" field.
159173

160-
<img src="/docs/images/add-contributors.png" alt="Add Contributors" class="mt-3 mb-3 border border-info rounded"></img>
174+
<img src="/docs/images/dashboard/manage-contributors.png"
175+
alt="Kubeflow Central Dashboard - Manage Contributors"
176+
class="mt-3 mb-3 border border-info rounded"
177+
style="width: 100%; max-width: 40em">
178+
</img>
161179

162180
### Manage Contributors Manually
163181

-90 KB
Binary file not shown.
-260 KB
Binary file not shown.
File renamed without changes.
File renamed without changes.
174 KB
Loading
385 KB
Loading
380 KB
Loading

0 commit comments

Comments
 (0)