Skip to content

Commit 55b2d9c

Browse files
maxkernbachsleto-it
authored andcommitted
Doc - Update README.md (#204)
1 parent c5e8499 commit 55b2d9c

File tree

1 file changed

+31
-14
lines changed

1 file changed

+31
-14
lines changed

docs/Manual/Upgrading/Starter/README.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
Starting from versions 3.2.15 and 3.3.8, the ArangoDB [_Starter_](../../Programs/Starter/README.md)
44
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.
66

77
The upgrade procedure of the _Starter_ described in this _Section_ can be used to
88
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.
911

1012
**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.
1214

1315
## Upgrade Procedure
1416

@@ -25,17 +27,17 @@ The first step is to install the new ArangoDB package.
2527

2628
**Note:** you do not have to stop the _Starter_ processes before upgrading it.
2729

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
2931

3032
```bash
31-
apt install arangodb=3.3.12
33+
apt install arangodb=3.3.14
3234
```
3335

3436
(`apt-get` on older versions) if you have added the ArangoDB repository. Or
3537
install a specific package using
3638

3739
```bash
38-
dpkg -i arangodb3-3.3.12-1_amd64.deb
40+
dpkg -i arangodb3-3.3.14-1_amd64.deb
3941
```
4042

4143
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_
8486
processes but also the used commands, which can be useful for the following
8587
restart of all _arangodb_ processes.
8688

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
8890
running locally. In a more production-like scenario, you will find only one instance
8991
of _arangodb_ running:
9092

@@ -120,6 +122,20 @@ arangodb upgrade --starter.endpoint=<endpoint-of-a-starter>
120122
The `--starter.endpoint` option can be set to the endpoint of any
121123
of the starters. E.g. `http://localhost:8528`.
122124

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+
123139
#### Deployment mode `single`
124140

125141
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.
134150
#### Deployment mode `activefailover` or `cluster`
135151

136152
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_.
139155

140156
The `arangodb upgrade` command will show the progress of the upgrade
141157
and stop when the upgrade has either finished successfully or finished
142158
with an error.
143159

144160
### Retrying a failed upgrade
145161

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.
148164

149165
To retry, run:
150166

@@ -157,8 +173,9 @@ of the starters. E.g. `http://localhost:8528`.
157173

158174
### Aborting an upgrade
159175

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.
162179

163180
To abort, run:
164181

@@ -171,5 +188,5 @@ of the starters. E.g. `http://localhost:8528`.
171188

172189
Note that an abort does not stop all upgrade processes immediately.
173190
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

Comments
 (0)