Skip to content

Commit e791c38

Browse files
Milvus-doc-botMilvus-doc-bot
Milvus-doc-bot
authored and
Milvus-doc-bot
committed
Release new docs to master
1 parent ca1bc2b commit e791c38

File tree

3 files changed

+167
-6
lines changed

3 files changed

+167
-6
lines changed

v2.5.x/site/en/adminGuide/upgrade-pulsar-v3.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ title: Upgrade Pulsar in Milvus from V2 to V3
77

88
# Upgrading Pulsar ​
99

10-
This article describes the proceure for you to upgrade your Pulsar component from V2 to V3 if you already have a working Milvus deployment with Pulsar V2.​ Since Milvus v2.5, **milvus-helm** and **milvus-operator** will use Pulsar V3 by default to fix some bugs and security vulnerabilities.​ While Milvus 2.5 is compatible with Pulsar 2.x, upgrading to Pulsar V3 is optional. For enhanced stability and performance, we recommend upgrading to Pulsar V3.
10+
This article describes the proceure for you to upgrade your Pulsar component from V2 to V3 if you already have a working Milvus deployment with Pulsar V2.​
11+
12+
Since Milvus v2.5, **milvus-helm** and **milvus-operator** will use Pulsar V3 by default to fix some bugs and security vulnerabilities.​ While Milvus 2.5 is compatible with Pulsar 2.x, upgrading to Pulsar V3 is optional. For enhanced stability and performance, we recommend upgrading to Pulsar V3.
13+
14+
If you prefer to use Pulsar V2 with Milvus v2.5.x, read [Use Pulsar V2 with Milvus v2.5.x](use-pulsar-v2.md).
1115

1216
<div class="alert note">
1317

@@ -144,11 +148,11 @@ In this step, you need to stop the Milvus pod and delete the Pulsar V2 deploymen
144148

145149
- For Milvus Helm users
146150

147-
If you have installed Milvus using the Milvus Helm chart, go to [For Helm User](#Delete-Pulsar-V2-using-Helm).
151+
If you have installed Milvus using the Milvus Helm chart, go to [Delete Pulsar v2 using Helm](#Delete-Pulsar-V2-using-Helm).
148152

149153
- For Milvus Operator users
150154

151-
If you have installed Milvus using the Milvus Operator, go to [For Milvus Operator User](#Delete-Pulsar-V2-using-Milvus-Operator).
155+
If you have installed Milvus using the Milvus Operator, go to [Delete Pulsar v2 using Milvus Operator](#Delete-Pulsar-V2-using-Milvus-Operator).
152156

153157
#### Delete Pulsar V2 using Helm
154158

+143
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
id: use-pulsar-v2.md
3+
related_key: use pulsar v2 with milvus v2.5.x
4+
summary: Milvus recommands you to upgrade Pulsar to v3 for Milvus v2.5.x. However, if you prefer to use Pulsar v2, this article will guide you through the steps to continue using Pulsar v2 with Milvus v2.5.x.
5+
title: Use Pulsar v2 with Milvus v2.5.x
6+
---
7+
8+
# Use Pulsar v2 with Milvus v2.5.x
9+
10+
Milvus recommands you to upgrade Pulsar to v3 for running Milvus v2.5.x. For details, refer to [Upgrade Pulsar](upgrade-pulsar-v3.md). However, if you prefer to use Pulsar v2 with Milvus v2.5.x, this article will guide you through the procedure for running Milvus v2.5.x with Pulsar v2.
11+
12+
If you already have a running Milvus instance and want to upgrade it to v2.5.x but continue using Pulsar v2, you can follow the steps on this page.
13+
14+
## Continue using Pulsar v2 while upgrading Milvus v2.5.x
15+
16+
This section will guide you through the steps to continue using Pulsar v2 while upgrading your running Milvus instance to Milvus v2.5.x.
17+
18+
### For Milvus Operator users
19+
20+
Milvus Operator is compatible with Pulsar v2 upgrades by default. You can upgrade your Milvus instance to v2.5.x by referring to [Upgrade Milvus Cluster with Milvus Operator](upgrade_milvus_cluster-operator.md).
21+
22+
Once the upgrade is complete, you can continue using Pulsar v2 with your Milvus instance.
23+
24+
### For Helm users
25+
26+
Before the upgrade, ensure that
27+
28+
- Your Helm version is above v3.12, and the latest version is recommanded.
29+
30+
For more information, refer to [Install Helm](https://helm.sh/docs/intro/install/).
31+
32+
- Your Kubernetes veresion is above v1.20.
33+
34+
Operations in this article assumes that:
35+
36+
- Milvus has been installed in the `default` namespace.
37+
38+
- The release name of Milvus is `my-release`.
39+
40+
You need to change the `values.yaml` file to specify the Pulsar version as v2 before upgrading Milvus. The steps are as follows:
41+
42+
1. Get the current `values.yaml` file of your Milvus instance.
43+
44+
```bash
45+
namespace=default
46+
release=my-release
47+
helm -n ${namespace} get values ${release} -o yaml > values.yaml
48+
cat values.yaml
49+
```
50+
51+
2. Edit the `values.yaml` file to specify the Pulsar version as v2.
52+
53+
```yaml
54+
# ... omit existing values
55+
pulsar:
56+
enabled: true
57+
pulsarv3:
58+
enabled: false
59+
image:
60+
all:
61+
repository: milvusdb/milvus
62+
tag: v2.5.0-beta
63+
```
64+
65+
For `image`, change the `tag` to the desired Milvus version (e.g. `v2.5.0-beta`).
66+
67+
3. Update Milvus Helm chart.
68+
69+
```bash
70+
helm repo add milvus https://zilliztech.github.io/milvus-helm
71+
helm repo update milvus
72+
```
73+
74+
4. Upgrade Milvus instance.
75+
76+
```bash
77+
helm -n $namespace upgrade $releaase milvus/milvus -f values.yaml
78+
```
79+
80+
## Creating a new Milvus instance with Pulsar v2
81+
82+
This section will guide you through the steps to create a new Milvus instance with Pulsar v2.
83+
84+
### For Milvus Operator users
85+
86+
Before you deploy Milvus v2.5.x, you need to download and edit the Milvus Customer Resource Definition (CRD) file. For details on how to install Milvus using Milvus Operator, refer to [Install Milvus Cluster with Milvus Operator](install_cluster-milvusoperator.md).
87+
88+
1. Download the CRD file.
89+
90+
```bash
91+
wget https://raw.githubusercontent.com/zilliztech/milvus-operator/main/config/samples/milvus_cluster_default.yaml
92+
```
93+
94+
2. Edit the `milvus_cluster_default.yaml` file to specify the Pulsar version as v2.
95+
96+
```yaml
97+
apiVersion: milvus.io/v1beta1
98+
kind: Milvus
99+
metadata:
100+
name: my-release
101+
namespace: default
102+
labels:
103+
app: milvus
104+
spec:
105+
mode: cluster
106+
dependencies:
107+
pulsar:
108+
inCluster:
109+
chartVersion: pulsar-v2
110+
```
111+
112+
For `dependencies`, change the `pulsar.inCluster.chartVersion` to `pulsar-v2`.
113+
114+
3. Continue with the steps in [Install Milvus Cluster with Milvus Operator](https://milvus.io/docs/install_cluster-milvusoperator.md#Deploy-Milvus) to deploy Milvus v2.5.x with Pulsar v2 using the edited CRD file.
115+
116+
```bash
117+
kubectl apply -f milvus_cluster_default.yaml
118+
```
119+
120+
### For Helm users
121+
122+
Before you deploy Milvus v2.5.x, you can either prepare a `values.yaml` file or use the inline parameters to specify the Pulsar version. For details on how to install Milvus using Helm, refer to [Install Milvus Cluster with Helm](install_cluster-helm.md).
123+
124+
- Use inline parameters to specify the Pulsar version as v2.
125+
126+
```bash
127+
helm install my-release milvus/milvus --set pulsar.enabled=true,pulsarv3.enabled=false
128+
```
129+
130+
- Use a `values.yaml` file to specify the Pulsar version as v2.
131+
132+
```yaml
133+
pulsar:
134+
enabled: true
135+
pulsarv3:
136+
enabled: false
137+
```
138+
139+
Then, deploy Milvus v2.5.x with Pulsar v2 using the `values.yaml` file.
140+
141+
```bash
142+
helm install my-release milvus/milvus -f values.yaml
143+
```

v2.5.x/site/en/menuStructure/en.json

+17-3
Original file line numberDiff line numberDiff line change
@@ -1170,10 +1170,24 @@
11701170
]
11711171
},
11721172
{
1173-
"label": "Upgrade Pulsar",
1174-
"id": "upgrade-pulsar-v3.md",
1173+
"label": "Use Pulsa with Milvus",
1174+
"id": "pulsar_dependencies",
11751175
"order": 2,
1176-
"children": []
1176+
"isMenu": true,
1177+
"children": [
1178+
{
1179+
"label": "Upgrade to Pulsar v3",
1180+
"id": "upgrade-pulsar-v3.md",
1181+
"order": 0,
1182+
"children": []
1183+
},
1184+
{
1185+
"label": "Continue Using Pulsar v2",
1186+
"id": "use-pulsar-v2.md",
1187+
"order": 1,
1188+
"children": []
1189+
}
1190+
]
11771191
}
11781192
]
11791193
},

0 commit comments

Comments
 (0)