2
2
3
3
Starting from versions 3.2.15 and 3.3.8, the ArangoDB [ _ Starter_ ] ( ../../Programs/Starter/README.md )
4
4
supports a new, automated, procedure to perform upgrades, including rolling upgrades
5
- of a [ Cluster] ( ../../Architecture/DeploymentModes/README.md ) setup.
5
+ of a [ Cluster] ( ../../Architecture/DeploymentModes/Cluster/ README.md ) setup.
6
6
7
7
The upgrade procedure of the _ Starter_ described in this _ Section_ can be used to
8
8
upgrade to a new hotfix, or to perform an upgrade to a new minor version of ArangoDB.
9
+ Please refer to the [ Upgrade Paths] ( ../GeneralInfo/README.md#upgrade-paths ) section
10
+ for detailed information.
9
11
10
12
** Important:** rolling upgrades of Cluster setups from 3.2 to 3.3 are only supported
11
- from versions 3.2.16 and 3.3.12 .
13
+ from versions 3.2.15 and 3.3.9 .
12
14
13
15
## Upgrade Procedure
14
16
@@ -25,17 +27,17 @@ The first step is to install the new ArangoDB package.
25
27
26
28
** Note:** you do not have to stop the _ Starter_ processes before upgrading it.
27
29
28
- For example, if you want to upgrade to ` 3.3.12 -1 ` on Debian or Ubuntu, either call
30
+ For example, if you want to upgrade to ` 3.3.14 -1 ` on Debian or Ubuntu, either call
29
31
30
32
``` bash
31
- apt install arangodb=3.3.12
33
+ apt install arangodb=3.3.14
32
34
```
33
35
34
36
(` apt-get ` on older versions) if you have added the ArangoDB repository. Or
35
37
install a specific package using
36
38
37
39
``` bash
38
- dpkg -i arangodb3-3.3.12 -1_amd64.deb
40
+ dpkg -i arangodb3-3.3.14 -1_amd64.deb
39
41
```
40
42
41
43
after you have downloaded the corresponding file from https://download.arangodb.com/ .
@@ -84,7 +86,7 @@ The output of the command above does not only show the PID's of all _arangodb_
84
86
processes but also the used commands, which can be useful for the following
85
87
restart of all _ arangodb_ processes.
86
88
87
- The output belove is from a test machine where three instances of a _ Starter_ are
89
+ The output below is from a test machine where three instances of a _ Starter_ are
88
90
running locally. In a more production-like scenario, you will find only one instance
89
91
of _ arangodb_ running:
90
92
@@ -120,6 +122,20 @@ arangodb upgrade --starter.endpoint=<endpoint-of-a-starter>
120
122
The ` --starter.endpoint ` option can be set to the endpoint of any
121
123
of the starters. E.g. ` http://localhost:8528 ` .
122
124
125
+ ** Important:**
126
+
127
+ The command above was introduced with 3.3.14 (and 3.2.17). If you are rolling upgrade a 3.3.x version
128
+ to a version higher or equal to 3.3.14, or if you are rolling upgrade a 3.2.x version to a version higher
129
+ or equal to 3.2.17 please use the command above.
130
+
131
+ If you are doing the rolling upgrade of a 3.3.x version to a version between 3.3.8 and 3.3.13 (included),
132
+ or if you are rolling upgrade a 3.2.x version to 3.2.15 or 3.2.16, a different command has to be used
133
+ (on all _ Starters_ one by one):
134
+
135
+ ```
136
+ curl -X POST --dump - http://localhost:8538/database-auto-upgrade
137
+ ```
138
+
123
139
#### Deployment mode ` single `
124
140
125
141
For deployment mode ` single ` , the ` arangodb upgrade ` command will:
@@ -134,17 +150,17 @@ Inspect the log of the _Starter_ to know when the upgrade has finished.
134
150
#### Deployment mode ` activefailover ` or ` cluster `
135
151
136
152
The _ Starters_ will now perform an initial check that upgrading is possible
137
- and when that all succeeds, create an upgrade plan.
138
- This plan is then executed by every _ Starter_ .
153
+ and when that all succeeds, create an upgrade _ plan _ . This _ plan _ is then
154
+ executed by every _ Starter_ .
139
155
140
156
The ` arangodb upgrade ` command will show the progress of the upgrade
141
157
and stop when the upgrade has either finished successfully or finished
142
158
with an error.
143
159
144
160
### Retrying a failed upgrade
145
161
146
- When an upgrade plan (in deployment mode ` activefailover ` or ` cluster ` )
147
- has failed, it can be retried.
162
+ Starting with 3.3.14 and 3.2.17, when an upgrade _ plan _ (in deployment
163
+ mode ` activefailover ` or ` cluster ` ) has failed, it can be retried.
148
164
149
165
To retry, run:
150
166
@@ -157,8 +173,9 @@ of the starters. E.g. `http://localhost:8528`.
157
173
158
174
### Aborting an upgrade
159
175
160
- When an upgrade plan (in deployment mode ` activefailover ` or ` cluster ` )
161
- is in progress or has failed, it can be aborted.
176
+ Starting with 3.3.14 and 3.2.17, when an upgrade _ plan_ (in deployment
177
+ mode ` activefailover ` or ` cluster ` ) is in progress or has failed, it can
178
+ be aborted.
162
179
163
180
To abort, run:
164
181
@@ -171,5 +188,5 @@ of the starters. E.g. `http://localhost:8528`.
171
188
172
189
Note that an abort does not stop all upgrade processes immediately.
173
190
If an _ arangod_ or _ arangosync_ server is being upgraded when the abort
174
- was issued, this upgrade will be finished.
175
- Remaining servers will not be upgraded.
191
+ was issued, this upgrade will be finished. Remaining servers will not be
192
+ upgraded.
0 commit comments