README

Overview

Milvus 2.2 has changed the meta structure for segment index. To upgrade a Milvus cluster of 2.1.x version you have installed, run this script to migrate the meta and upgrade the Milvus image version.

Note:

This script only applies to Milvus installed on a K8s cluster which has storageclass. You can verify storageclass by running kubectl get storageclass. If you don't have a default storageclass, you need specify a storageclass via -c <storage-class> when running this script.

This script only supports upgrading from Milvus v2.1.x to v2.2.0.

If your milvus cluster use an external etcd service (which isn't installed with milvus), you need specify etcd service explicitly via -e <etcd-service-ip:etcd-service-port> otherwise we use the default etcd service which installed with milvus.

Parameters

Parameters	Description	Default value	Required
`i`	The Milvus instance name.	`None`	True
`n`	The namespace that Milvus is installed in.	`default`	False
`s`	The source Milvus version.	`None`	True
`t`	The target Milvus version.	`None`	True
`r`	The root path of Milvus meta.	`by-dev`	False
`w`	The new Milvus image tag.	`milvusdb/milvus:v2.2.0`	False
`m`	The meta migration image tag.	`milvusdb/meta-migration:v2.2.0-bugfix-20220112`	False
`o`	The meta migration operation.	`migrate`	False
`d`	Whether to cleanup after migration is completed.	`false`	False
`c`	The storage class for meta migration pvc.	`default storage class`	False
`e`	The endpoints for etcd which used by milvus.	`etcd svc installed with milvus`	False

By default, the script only applies to migration from v2.1.x to v2.2.x. Rollback to the older version with the rollback operation first if an error occurs.

Overview of migration procedures

Stop the Milvus components. Any live session in the Milvus Etcd can cause the migration to fail.
Create a backup for Milvus meta.
Migrate the Milvus meta.
Start Milvus components with a new image.

Migration guide

Specify Milvus instance name, source Milvus version, and target Milvus version.

shell

./migrate.sh -i my-release -s 2.1.1 -t 2.2.0

Specify namespace with -n if your Milvus is not installed in the default K8s namespace.

shell

./migrate.sh -i my-release -n milvus -s 2.1.1 -t 2.2.0

Specify rootpath with -r if your Milvus is installed with the custom rootpath.

shell

./migrate.sh -i my-release -n milvus -s 2.1.1 -t 2.2.0 -r by-dev

Specify the image tag with -w if your Milvus is installed with custom image.

shell

./migrate.sh -i my-release -n milvus -s 2.1.1 -t 2.2.0 -r by-dev -w milvusdb/milvus:master-20221016-15878781

Set -d true if you want to automatically remove the migration pod after the migration is completed.

shell

./migrate.sh -i my-release -n milvus -s 2.1.1 -t 2.2.0 -w milvusdb/milvus:master-20221016-15878781 -d true

Rollback and migrate again if the migration fails.

./migrate.sh -i my-release -n milvus -s 2.1.1 -t 2.2.0 -r by-dev -o rollback -w <milvus-2-1-1-image>
./migrate.sh -i my-release -n milvus -s 2.1.1 -t 2.2.0 -r by-dev -o migrate -w <milvus-2-2-0-image>

Specify the storage class explicitly.

shell

./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.2.0 -c <special-storage-class>

Specify external etcd service.

shell

./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.2.0 -e <etcd-svc-ip:etcd-svc-port>