Skip to content

Commit 48955d4

Browse files
Bobgyk8s-ci-robot
authored andcommitted
Update kubeflow pipelines upgrade guide for kubeflow 0.6 (kubeflow#1055)
* Fix kfp upgrade/reinstall preparation guide. * Update upgrade instructions for kubeflow deployment. * Remove kfp upgrade related instructions because they don't work * Rephrase PV to PD to be more accurate
1 parent 384368d commit 48955d4

File tree

1 file changed

+22
-42
lines changed

1 file changed

+22
-42
lines changed

content/docs/pipelines/upgrade.md

+22-42
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ Starting from Kubeflow version 0.5, Kubeflow Pipelines persists the
88
pipeline data in a permanent storage volume. Kubeflow Pipelines therefore
99
supports the following capabilities:
1010

11-
* **Upgrade:** You can upgrade your Kubeflow Pipelines deployment to a
12-
later version without deleting and recreating the cluster.
1311
* **Reinstall:** You can delete a cluster and create a new cluster, specifying
1412
the storage to retrieve the original data in the new cluster.
1513

14+
Note that upgrade isn't currently supported, check [this issue](https://github.com/kubeflow/kubeflow/issues/3727)
15+
for progress.
16+
1617
## Context
1718

1819
Kubeflow Pipelines creates and manages the following data related to your
@@ -36,7 +37,7 @@ The MySQL database and the Minio server are both backed by the Kubernetes
3637
## Deploying Kubeflow
3738

3839
This section describes how to deploy Kubeflow in a way that ensures you can use
39-
the Kubeflow Pipelines upgrade/installation capability.
40+
the Kubeflow Pipelines reinstallation capability.
4041

4142
### Deploying Kubeflow on GCP
4243

@@ -86,12 +87,20 @@ The steps below assume that you already have a Kubernetes cluster set up.
8687
kfctl apply all -V
8788
```
8889
89-
You must run the following commands to specify your PVs:
90+
You should first edit the following files to specify your PVs:
91+
92+
`${KFAPP}/kustomize/minio/overlays/minioPd/params.env`
93+
```
94+
...
95+
minioPd=[YOUR-PRE-CREATED-MINIO-PV-NAME]
96+
...
97+
```
9098
99+
`${KFAPP}/kustomize/mysql/overlays/mysqlPd/params.env`
91100
```
92-
cd ks_app
93-
ks param set pipeline mysqlPvName [YOUR-PRE-CREATED-MYSQL-PV-NAME]
94-
ks param set pipeline minioPvName [YOUR-PRE-CREATED-MINIO-PV-NAME]
101+
...
102+
mysqlPd=[YOUR-PRE-CREATED-MYSQL-PV-NAME]
103+
...
95104
```
96105
97106
1. Then run the `apply` command as usual:
@@ -100,37 +109,6 @@ The steps below assume that you already have a Kubernetes cluster set up.
100109
kfctl apply k8s
101110
```
102111
103-
## Upgrading your Kubeflow Pipelines deployment
104-
105-
To upgrade your Kubeflow Pipelines deployment to the latest version, run the following script in the
106-
Kubeflow application directory. That is, in the same directory where you
107-
performed the original deployment, represented in the deployment guide as
108-
`${KFAPP}`:
109-
110-
```
111-
cd ${KFAPP}
112-
${KUBEFLOW_SRC}/scripts/upgrade_kfp.sh
113-
```
114-
Alternatively, you can upgrade to a specific version of Kubeflow Pipelines by specifying the version tag. You can find the version tag in the Kubeflow Pipelines [release page](https://github.com/kubeflow/pipelines/releases). For example, to upgrade to v0.1.12
115-
```
116-
${KUBEFLOW_SRC}/scripts/upgrade_kfp.sh a1afdd6c4b297b56dd103a8bb939ddeae67c2c92
117-
```
118-
119-
If you used the web interface
120-
([https://deploy.kubeflow.cloud/#/deploy](https://deploy.kubeflow.cloud/#/deploy))
121-
to deploy Kubeflow, you must first clone the Kubeflow application directory
122-
from your project's
123-
[Cloud Source Repository](https://cloud.google.com/sdk/gcloud/reference/source/repos/clone),
124-
then proceed with the upgrade:
125-
126-
```
127-
export PROJECT=[YOUR-GCP-PROJECT]
128-
export CLOUD_SRC_REPO=${PROJECT}-kubeflow-config
129-
gcloud source repos clone ${CLOUD_SRC_REPO} --project=${PROJECT}
130-
kubectl create clusterrolebinding admin-binding --clusterrole=cluster-admin --user=[YOUR-EMAIL-ADDRESS]
131-
${KUBEFLOW_SRC}/scripts/upgrade_kfp.sh
132-
```
133-
134112
## Reinstalling Kubeflow Pipelines
135113
136114
You can delete a Kubeflow cluster and create a new one, specifying
@@ -145,6 +123,8 @@ To reinstall Kubeflow Pipelines, follow the [command line deployment
145123
instructions](/docs/gke/deploy/deploy-cli/), but note the following
146124
change in the procedure:
147125
126+
1. Warning, when you do `kfctl init ${KFAPP} --other-flags`, you should use a different `${KFAPP}` name from your existing `${KFAPP}`. Otherwise, your data in existing PDs will be deleted during `kfctl apply all -V`.
127+
148128
1. **Before** running the following `apply` command:
149129
150130
```
@@ -163,14 +143,14 @@ change in the procedure:
163143
* Edit the following files to specify the persistent disks created
164144
in a previous deployment:
165145
166-
`kustomize/minio/overlays/minioPd/params.env`
146+
`${KFAPP}/kustomize/minio/overlays/minioPd/params.env`
167147
```
168148
...
169149
minioPd=[NAME-OF-ARTIFACT-STORAGE-DISK]
170150
...
171151
```
172152
173-
`kustomize/mysql/overlays/mysqlPd/params.env`
153+
`${KFAPP}/kustomize/mysql/overlays/mysqlPd/params.env`
174154
```
175155
...
176156
mysqlPd=[NAME-OF-METADATA-STORAGE-DISK]
@@ -205,14 +185,14 @@ PV in the new cluster.
205185
206186
You should first edit the following files to specify your PVs:
207187
208-
`kustomize/minio/overlays/minioPd/params.env`
188+
`${KFAPP}/kustomize/minio/overlays/minioPd/params.env`
209189
```
210190
...
211191
minioPd=[YOUR-PRE-CREATED-MINIO-PV-NAME]
212192
...
213193
```
214194
215-
`kustomize/mysql/overlays/mysqlPd/params.env`
195+
`${KFAPP}/kustomize/mysql/overlays/mysqlPd/params.env`
216196
```
217197
...
218198
mysqlPd=[YOUR-PRE-CREATED-MYSQL-PV-NAME]

0 commit comments

Comments
 (0)