Skip to content

Commit

Permalink
Release new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Milvus-doc-bot authored and Milvus-doc-bot committed Nov 5, 2024
1 parent 3a68ab2 commit 93ffc1e
Show file tree
Hide file tree
Showing 13 changed files with 104 additions and 74 deletions.
6 changes: 3 additions & 3 deletions v2.4.x/Variables.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"milvus_release_version": "2.4.14",
"milvus_release_tag": "2.4.14",
"milvus_release_version": "2.4.15",
"milvus_release_tag": "2.4.15",
"milvus_deb_name": "milvus_2.2.0-1_amd64",
"milvus_rpm_name": "milvus-2.2.0-1.el7.x86_64",
"milvus_python_sdk_version": "2.4.x",
Expand All @@ -10,7 +10,7 @@
"milvus_go_sdk_version": "2.3.x",
"milvus_go_sdk_real_version": "2.4.0",
"milvus_java_sdk_version": "2.4.x",
"milvus_java_sdk_real_version": "2.4.7",
"milvus_java_sdk_real_version": "2.4.8",
"milvus_csharp_sdk_version": "2.2.x",
"milvus_csharp_sdk_real_version": "2.2.14",
"milvus_restful_sdk_version": "2.4.x",
Expand Down
8 changes: 4 additions & 4 deletions v2.4.x/site/en/adminGuide/configure-docker.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ In current release, all parameters take effect only after Milvus restarts.

## Download a configuration file

[Download](https://raw.githubusercontent.com/milvus-io/milvus/v2.4.14/configs/milvus.yaml) `milvus.yaml` directly or with the following command.
[Download](https://raw.githubusercontent.com/milvus-io/milvus/v2.4.15/configs/milvus.yaml) `milvus.yaml` directly or with the following command.

```
$ wget https://raw.githubusercontent.com/milvus-io/milvus/v2.4.14/configs/milvus.yaml
$ wget https://raw.githubusercontent.com/milvus-io/milvus/v2.4.15/configs/milvus.yaml
```

## Modify the configuration file
Expand Down Expand Up @@ -178,13 +178,13 @@ Sorted by:

## Download an installation file

Download the installation file for Milvus [standalone](https://github.com/milvus-io/milvus/releases/download/v2.4.14/milvus-standalone-docker-compose.yml), and save it as `docker-compose.yml`.
Download the installation file for Milvus [standalone](https://github.com/milvus-io/milvus/releases/download/v2.4.15/milvus-standalone-docker-compose.yml), and save it as `docker-compose.yml`.

You can also simply run the following command.

```
# For Milvus standalone
$ wget https://github.com/milvus-io/milvus/releases/download/v2.4.14/milvus-standalone-docker-compose.yml -O docker-compose.yml
$ wget https://github.com/milvus-io/milvus/releases/download/v2.4.15/milvus-standalone-docker-compose.yml -O docker-compose.yml
```

## Modify the installation file
Expand Down
2 changes: 1 addition & 1 deletion v2.4.x/site/en/adminGuide/operator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Milvus cluster depends on components including object storage, etcd, and Pulsar.

This topic assumes that you have deployed Milvus Operator.

<div class="alert note">See <a href="https://milvus.io/docs/v2.4.14/install_cluster-milvusoperator.md">Deploy Milvus Operator</a> for more information. </div>
<div class="alert note">See <a href="https://milvus.io/docs/v2.4.15/install_cluster-milvusoperator.md">Deploy Milvus Operator</a> for more information. </div>

You need to specify a configuration file for using Milvus Operator to start a Milvus cluster.

Expand Down
20 changes: 10 additions & 10 deletions v2.4.x/site/en/adminGuide/upgrade_milvus_cluster-docker.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: Upgrade Milvus Cluster with Docker Compose

This topic describes how to upgrade your Milvus using Docker Compose.

In normal cases, you can [upgrade Milvus by changing its image](#Upgrade-Milvus-by-changing-its-image). However, you need to [migrate the metadata](#Migrate-the-metadata) before any upgrade from v2.1.x to v2.4.14.
In normal cases, you can [upgrade Milvus by changing its image](#Upgrade-Milvus-by-changing-its-image). However, you need to [migrate the metadata](#Migrate-the-metadata) before any upgrade from v2.1.x to v2.4.15.

## Upgrade Milvus by changing its image

Expand All @@ -24,35 +24,35 @@ In normal cases, you can upgrade Milvus as follows:
...
rootcoord:
container_name: milvus-rootcoord
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
...
proxy:
container_name: milvus-proxy
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
...
querycoord:
container_name: milvus-querycoord
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
...
querynode:
container_name: milvus-querynode
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
...
indexcoord:
container_name: milvus-indexcoord
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
...
indexnode:
container_name: milvus-indexnode
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
...
datacoord:
container_name: milvus-datacoord
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
...
datanode:
container_name: milvus-datanode
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
```
2. Run the following commands to perform the upgrade.
Expand Down Expand Up @@ -80,7 +80,7 @@ In normal cases, you can upgrade Milvus as follows:
runWithBackup: true
config:
sourceVersion: 2.1.4 # Specify your milvus version
targetVersion: 2.4.14
targetVersion: 2.4.15
backupFilePath: /tmp/migration.bak
metastore:
type: etcd
Expand Down
28 changes: 14 additions & 14 deletions v2.4.x/site/en/adminGuide/upgrade_milvus_cluster-helm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,11 @@ zilliztech/milvus 4.1.0 2.3.0 Milvus is an ope

You can choose the upgrade path for your Milvus as follows:

<div style="display: none;">- [Conduct a rolling upgrade](#conduct-a-rolling-upgrade) from Milvus v2.2.3 and later releases to v2.4.14.</div>
<div style="display: none;">- [Conduct a rolling upgrade](#conduct-a-rolling-upgrade) from Milvus v2.2.3 and later releases to v2.4.15.</div>

- [Upgrade Milvus using Helm](#Upgrade-Milvus-using-Helm) for an upgrade from a minor release before v2.2.3 to v2.4.14.
- [Upgrade Milvus using Helm](#Upgrade-Milvus-using-Helm) for an upgrade from a minor release before v2.2.3 to v2.4.15.

- [Migrate the metadata](#Migrate-the-metadata) before the upgrade from Milvus v2.1.x to v2.4.14.
- [Migrate the metadata](#Migrate-the-metadata) before the upgrade from Milvus v2.1.x to v2.4.15.

<div style="display: none;">

Expand All @@ -101,10 +101,10 @@ The script applies only to the upgrade of Milvus installed with Helm. The follow
| `w` | New Milvus image tag | `milvusdb/milvus:v2.2.3` | True |
| `o` | Operation | `update` | False |

Once you have ensured that all deployments in your Milvus instance are in their normal status. You can run the following command to upgrade the Milvus instance to 2.4.14.
Once you have ensured that all deployments in your Milvus instance are in their normal status. You can run the following command to upgrade the Milvus instance to 2.4.15.

```shell
sh rollingUpdate.sh -n default -i my-release -o update -t 2.4.14 -w 'milvusdb/milvus:v2.4.14'
sh rollingUpdate.sh -n default -i my-release -o update -t 2.4.15 -w 'milvusdb/milvus:v2.4.15'
```

<div class="alert note">
Expand Down Expand Up @@ -214,43 +214,43 @@ The following table lists the operations you can do for meta migration.
4. Migrate the Milvus metadata.
5. Start Milvus components with a new image.

#### 2. Upgrade Milvus from v2.1.x to 2.4.14
#### 2. Upgrade Milvus from v2.1.x to 2.4.15

The following commands assume that you upgrade Milvus from v2.1.4 to 2.4.14. Change them to the versions that fit your needs.
The following commands assume that you upgrade Milvus from v2.1.4 to 2.4.15. Change them to the versions that fit your needs.

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

```
./migrate.sh -i my-release -s 2.1.4 -t 2.4.14
./migrate.sh -i my-release -s 2.1.4 -t 2.4.15
```
2. Specify the namespace with `-n` if your Milvus is not installed in the default K8s namespace.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15
```
3. Specify the root path with `-r` if your Milvus is installed with the custom `rootpath`.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -r by-dev
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -r by-dev
```
4. Specify the image tag with `-w` if your Milvus is installed with a custom `image`.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -r by-dev -w milvusdb/milvus:v2.4.14
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -r by-dev -w milvusdb/milvus:v2.4.15
```
5. Set `-d true` if you want to automatically remove the migration pod after the migration is completed.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -w milvusdb/milvus:v2.4.14 -d true
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -w milvusdb/milvus:v2.4.15 -d true
```
6. Rollback and migrate again if the migration fails.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -r by-dev -o rollback -w milvusdb/milvus:v2.1.1
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -r by-dev -o migrate -w milvusdb/milvus:v2.4.14
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -r by-dev -o rollback -w milvusdb/milvus:v2.1.1
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -r by-dev -o migrate -w milvusdb/milvus:v2.4.15
```
20 changes: 10 additions & 10 deletions v2.4.x/site/en/adminGuide/upgrade_milvus_cluster-operator.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ helm -n milvus-operator upgrade milvus-operator zilliztech-milvus-operator/milvu

Once you have upgraded your Milvus operator to the latest version, you have the following choices:

- To upgrade Milvus from v2.2.3 or later releases to 2.4.14, you can [conduct a rolling upgrade](#Conduct-a-rolling-upgrade).
- To upgrade Milvus from a minor release before v2.2.3 to 2.4.14, you are advised to [upgrade Milvus by changing its image version](#Upgrade-Milvus-by-changing-its-image).
- To upgrade Milvus from v2.1.x to 2.4.14, you need to [migrate the metadata](#Migrate-the-metadata) before the actual upgrade.
- To upgrade Milvus from v2.2.3 or later releases to 2.4.15, you can [conduct a rolling upgrade](#Conduct-a-rolling-upgrade).
- To upgrade Milvus from a minor release before v2.2.3 to 2.4.15, you are advised to [upgrade Milvus by changing its image version](#Upgrade-Milvus-by-changing-its-image).
- To upgrade Milvus from v2.1.x to 2.4.15, you need to [migrate the metadata](#Migrate-the-metadata) before the actual upgrade.

## Conduct a rolling upgrade

Expand All @@ -47,7 +47,7 @@ spec:
components:
enableRollingUpdate: true
imageUpdateMode: rollingUpgrade # Default value, can be omitted
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
```
In this above configuration file, set `spec.components.enableRollingUpdate` to `true` and set `spec.components.image` to the desired Milvus version.
Expand All @@ -63,7 +63,7 @@ spec:
components:
enableRollingUpdate: true
imageUpdateMode: all
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
```

You can set `spec.components.imageUpdateMode` to `rollingDowngrade` to have Milvus replace coordinator pod images with a lower version.
Expand Down Expand Up @@ -101,7 +101,7 @@ metadata:
spec:
# Omit other fields ...
components:
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
```

Then run the following to perform the upgrade:
Expand All @@ -112,11 +112,11 @@ kubectl apply -f milvusupgrade.yaml

## Migrate the metadata

Since Milvus 2.2.0, the metadata is incompatible with that in previous releases. The following example snippets assume an upgrade from Milvus 2.1.4 to Milvus 2.4.14.
Since Milvus 2.2.0, the metadata is incompatible with that in previous releases. The following example snippets assume an upgrade from Milvus 2.1.4 to Milvus 2.4.15.

### 1. Create a `.yaml` file for metadata migration

Create a metadata migration file. The following is an example. You need to specify the `name`, `sourceVersion`, and `targetVersion` in the configuration file. The following example sets the `name` to `my-release-upgrade`, `sourceVersion` to `v2.1.4`, and `targetVersion` to `v2.4.14`. This means that your Milvus cluster will be upgraded from v2.1.4 to v2.4.14.
Create a metadata migration file. The following is an example. You need to specify the `name`, `sourceVersion`, and `targetVersion` in the configuration file. The following example sets the `name` to `my-release-upgrade`, `sourceVersion` to `v2.1.4`, and `targetVersion` to `v2.4.15`. This means that your Milvus cluster will be upgraded from v2.1.4 to v2.4.15.

```
apiVersion: milvus.io/v1beta1
Expand All @@ -128,9 +128,9 @@ spec:
namespace: default
name: my-release
sourceVersion: "v2.1.4"
targetVersion: "v2.4.14"
targetVersion: "v2.4.15"
# below are some omit default values:
# targetImage: "milvusdb/milvus:v2.4.14"
# targetImage: "milvusdb/milvus:v2.4.15"
# toolImage: "milvusdb/meta-migration:v2.2.0"
# operation: upgrade
# rollbackIfFailed: true
Expand Down
6 changes: 3 additions & 3 deletions v2.4.x/site/en/adminGuide/upgrade_milvus_standalone-docker.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ title: Upgrade Milvus Standalone with Docker Compose

This topic describes how to upgrade your Milvus using Docker Compose.

In normal cases, you can [upgrade Milvus by changing its image](#Upgrade-Milvus-by-changing-its-image). However, you need to [migrate the metadata](#Migrate-the-metadata) before any upgrade from v2.1.x to v2.4.14.
In normal cases, you can [upgrade Milvus by changing its image](#Upgrade-Milvus-by-changing-its-image). However, you need to [migrate the metadata](#Migrate-the-metadata) before any upgrade from v2.1.x to v2.4.15.

<div class="alter note">

Expand All @@ -32,7 +32,7 @@ In normal cases, you can upgrade Milvus as follows:
...
standalone:
container_name: milvus-standalone
image: milvusdb/milvus:v2.4.14
image: milvusdb/milvus:v2.4.15
```
2. Run the following commands to perform the upgrade.
Expand Down Expand Up @@ -60,7 +60,7 @@ In normal cases, you can upgrade Milvus as follows:
runWithBackup: true
config:
sourceVersion: 2.1.4 # Specify your milvus version
targetVersion: 2.4.14
targetVersion: 2.4.15
backupFilePath: /tmp/migration.bak
metastore:
type: etcd
Expand Down
28 changes: 14 additions & 14 deletions v2.4.x/site/en/adminGuide/upgrade_milvus_standalone-helm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,11 @@ zilliztech/milvus 4.1.0 2.3.0 Milvus is an ope

You can choose the upgrade path for your Milvus as follows:

<div style="display: none;">- [Conduct a rolling upgrade](#conduct-a-rolling-upgrade) from Milvus v2.2.3 and later releases to v2.4.14.</div>
<div style="display: none;">- [Conduct a rolling upgrade](#conduct-a-rolling-upgrade) from Milvus v2.2.3 and later releases to v2.4.15.</div>

- [Upgrade Milvus using Helm](#Upgrade-Milvus-using-Helm) for an upgrade from a minor release before v2.2.3 to v2.4.14.
- [Upgrade Milvus using Helm](#Upgrade-Milvus-using-Helm) for an upgrade from a minor release before v2.2.3 to v2.4.15.

- [Migrate the metadata](#Migrate-the-metadata) before the upgrade from Milvus v2.1.x to v2.4.14.
- [Migrate the metadata](#Migrate-the-metadata) before the upgrade from Milvus v2.1.x to v2.4.15.

<div style="display:none;">

Expand All @@ -102,10 +102,10 @@ The script applies only to the upgrade of Milvus installed with Helm. The follow
| `w` | New Milvus image tag | `milvusdb/milvus:v2.2.3` | True |
| `o` | Operation | `update` | False |

Once you have ensured that all deployments in your Milvus instance are in their normal status. You can run the following command to upgrade the Milvus instance to 2.4.14.
Once you have ensured that all deployments in your Milvus instance are in their normal status. You can run the following command to upgrade the Milvus instance to 2.4.15.

```shell
sh rollingUpdate.sh -n default -i my-release -o update -t 2.4.14 -w 'milvusdb/milvus:v2.4.14'
sh rollingUpdate.sh -n default -i my-release -o update -t 2.4.15 -w 'milvusdb/milvus:v2.4.15'
```

<div class="alert note">
Expand Down Expand Up @@ -193,42 +193,42 @@ The following table lists the operations you can do for meta migration.
4. Migrate the Milvus metadata.
5. Start Milvus components with a new image.

#### 2. Upgrade Milvus from v2.1.x to 2.4.14
#### 2. Upgrade Milvus from v2.1.x to 2.4.15

The following commands assume that you upgrade Milvus from v2.1.4 to 2.4.14. Change them to the versions that fit your needs.
The following commands assume that you upgrade Milvus from v2.1.4 to 2.4.15. Change them to the versions that fit your needs.

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

```
./migrate.sh -i my-release -s 2.1.4 -t 2.4.14
./migrate.sh -i my-release -s 2.1.4 -t 2.4.15
```
2. Specify the namespace with `-n` if your Milvus is not installed in the default K8s namespace.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15
```
3. Specify the root path with `-r` if your Milvus is installed with the custom `rootpath`.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -r by-dev
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -r by-dev
```
4. Specify the image tag with `-w` if your Milvus is installed with a custom `image`.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -r by-dev -w milvusdb/milvus:v2.4.14
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -r by-dev -w milvusdb/milvus:v2.4.15
```
5. Set `-d true` if you want to automatically remove the migration pod after the migration is completed.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -w milvusdb/milvus:v2.4.14 -d true
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -w milvusdb/milvus:v2.4.15 -d true
```
6. Rollback and migrate again if the migration fails.
```
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -r by-dev -o rollback -w milvusdb/milvus:v2.1.1
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.14 -r by-dev -o migrate -w milvusdb/milvus:v2.4.14
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -r by-dev -o rollback -w milvusdb/milvus:v2.1.1
./migrate.sh -i my-release -n milvus -s 2.1.4 -t 2.4.15 -r by-dev -o migrate -w milvusdb/milvus:v2.4.15
Loading

0 comments on commit 93ffc1e

Please sign in to comment.