Skip to content

Commit f2c4684

Browse files
committed
feat: update README.md for upgrade instructions
Signed-off-by: Kimonas Sotirchos <[email protected]>
1 parent ae66bf2 commit f2c4684

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
It exposes the access controlled web interfaces for Kubeflow components and more.
77

88
> ⚠️ __Note__ ⚠️
9-
>
9+
>
1010
> We are currently moving the Kubeflow Dashboard codebase from [`kubeflow/kubeflow`](https://github.com/kubeflow/kubeflow) to this repository ([`kubeflow/dashboard`](https://github.com/kubeflow/dashboard)).
1111
> Please see [`kubeflow/kubeflow#7549`](https://github.com/kubeflow/kubeflow/issues/7549) for more information.
1212
@@ -38,6 +38,34 @@ Please refer to the [Installing Kubeflow](https://www.kubeflow.org/docs/started/
3838

3939
The official documentation for Kubeflow Dashboard can be found [here](https://www.kubeflow.org/docs/components/central-dash/).
4040

41+
## Migrate from V1
42+
43+
In the past, up until the Kubeflow 1.10 release, the components hosed in this repo were living in the
44+
[`kubeflow/kubeflow`](https://github.com/kubeflow/kubeflow) repository.
45+
46+
To accomodate the migration, the first `v2.0.0` release of this repository contains the same artifacts
47+
from the corresponding [`v1.10.0`](https://github.com/kubeflow/kubeflow/releases/tag/v1.10.0) tag from the `kubeflow/kubeflow` repo. This was done to ensure a smooth transition
48+
between the components of the different repos. You can find more details about the migration in https://github.com/kubeflow/dashboard/issues/118.
49+
50+
### Prerequisites
51+
52+
1. A Kubeflow cluster with 1.10.0 or above
53+
2. `kubectl` configured for access to the above cluster
54+
55+
### Script
56+
57+
You can use the following script to perform the migration from `v1.10.0` components to the `v2.0.0` ones from this repo. The script will
58+
perform the following actions:
59+
1. Remove the existing components of CentralDashboard, Profiles Controller and PodDefaults Webhook
60+
* The script will not remove any CR or CRD, to ensure no data loss
61+
* Only K8s resources relevant to the Deployments will be removed (Deployment, ServiceAccount, Service etc)
62+
* The [`NetworkPolicy`](https://github.com/kubeflow/manifests/blob/v1.10-branch/common/networkpolicies/base/centraldashboard.yaml) from the `kubeflow/manifests` repo, of the CentralDashboard, will be removed
63+
2. Install the manifests from this repo for the Dashboard, Profiles Controller and PodDefaults webhook
64+
65+
```bash
66+
./scripts/upgrade_v1_to_v1.sh
67+
```
68+
4169
## Community
4270

4371
Kubeflow Dashboard is part of the Kubeflow project, refer to the [Kubeflow Community](https://www.kubeflow.org/docs/about/community/) page for more information.

0 commit comments

Comments
 (0)