Skip to content

Commit c35a42a

Browse files
vikstrousjoaofnfernandes
authored andcommitted
improve dtr upgrade docs (docker#1839)
* improve dtr upgrade docs * move examples to table
1 parent b40c280 commit c35a42a

File tree

1 file changed

+54
-13
lines changed
  • datacenter/dtr/2.2/guides/admin/upgrade

1 file changed

+54
-13
lines changed

datacenter/dtr/2.2/guides/admin/upgrade/index.md

Lines changed: 54 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,65 @@ keywords: docker, dtr, upgrade, install
44
title: Upgrade DTR
55
---
66

7-
The first step in upgrading to a new minor version or patch release of DTR 2.2,
8-
is ensuring you're running DTR 2.1. If that's not the case, start by upgrading
9-
your installation to version 2.1, and then upgrade to 2.2.
7+
DTR uses [semantic versioning](http://semver.org/) and we aim to achieve specific
8+
guarantees while upgrading between versions. We never support downgrading. We
9+
support upgrades according to the following rules:
1010

11-
There is no downtime when upgrading a highly-available DTR cluster. If your
12-
DTR deployment has a single replica, schedule the upgrade to take place outside
13-
business peak hours to ensure the impact on your business is close to none.
11+
* When upgrading from one patch version to another you can skip patch versions
12+
because no data migraiton is done for patch versions.
13+
* When upgrading between minor versions, you can't skip versions, but you can
14+
upgrade from any patch versions of the previous minor version to any patch
15+
version of the current minor version.
16+
* When upgrading between major versions you also have to upgrade one major
17+
version at a time, but you have to upgrade to the earliest available minor
18+
version. We also strongly recommend upgrading to the latest minor/patch
19+
version for your major version first.
1420

15-
## Step 1. Upgrade DTR to 2.1
21+
|From| To| Description| Supported|
22+
|:----|:---|:------------|----------|
23+
| 2.2.0 | 2.2.1 | patch upgrade | yes |
24+
| 2.2.0 | 2.2.2 | skip patch version | yes |
25+
| 2.2.2 | 2.2.1 | patch downgrade | no |
26+
| 2.1.0 | 2.2.0 | minor upgrade | yes |
27+
| 2.1.1 | 2.2.0 | minor upgrade | yes |
28+
| 2.1.2 | 2.2.2 | minor upgrade | yes |
29+
| 2.0.1 | 2.2.0 | skip minor version | no |
30+
| 2.2.0 | 2.1.0 | minor downgrade | no |
31+
| 1.4.3 | 2.0.0 | major upgrade | yes |
32+
| 1.4.3 | 2.0.3 | major upgrade | yes |
33+
| 1.4.3 | 3.0.0 | skip major version | no |
34+
| 1.4.1 | 2.0.3 | major upgrade from an old version | no |
35+
| 1.4.3 | 2.1.0 | major upgrade skipping minor version | no |
36+
| 2.0.0 | 1.4.3 | major downgrade | no |
1637

17-
Make sure you're running DTR 2.1. If that's not the case, [upgrade your installation to the 2.1 version](/datacenter/dtr/2.1/guides/install/upgrade/.md).
38+
There may be at most a few seconds of interruption during the upgrade of a
39+
DTR cluster. Schedule the upgrade to take place outside business peak hours
40+
to ensure the impact on your business is close to none.
41+
42+
## Minor upgrade
1843

19-
## Step 2. Upgrade DTR
44+
Before starting your upgrade planning, make sure that the version of UCP you are
45+
using is supported by the version of DTR you are trying to upgrade to. <!--(TODO:
46+
link to the compatibility matrix)-->
2047

48+
### Step 1. Upgrade DTR to 2.1 if necessary
49+
50+
Make sure you're running DTR 2.1. If that's not the case, [upgrade your installation to the 2.1 version](/datacenter/dtr/2.1/guides/install/upgrade/.md).
2151

52+
### Step 2. Upgrade DTR
2253

23-
To upgrade DTR, **login with ssh** into a node that's part of the UCP cluster.
2454
Then pull the latest version of DTR:
2555

2656
```none
2757
$ docker pull {{ page.docker_image }}
2858
```
2959

3060
If the node you're upgrading doesn't have access to the internet, you can
31-
use a machine with internet connection to
32-
[pull all the DTR images](../install/install-offline.md).
61+
follow the [offline installation documentation](../install/install-offline.md)
62+
to get the images.
3363

34-
Once you have the latest images on the node, run the upgrade command:
64+
Once you have the latest image on your machine (and the images on the target
65+
nodes if upgrading offline), run the upgrade command:
3566

3667
```none
3768
$ docker run -it --rm \
@@ -43,6 +74,16 @@ By default the upgrade command runs in interactive mode and prompts you for
4374
any necessary information. You can also check the
4475
[reference documentation](../../../reference/cli/index.md) for other existing flags.
4576

77+
The upgrade command will start replacing every container in your DTR cluster,
78+
one replica at a time. It will also perform certain data migrations. If anything
79+
fails or the upgrade is interrupted for any reason, you can re-run the upgrade
80+
command and it will resume from where it left off.
81+
82+
## Patch upgrade
83+
84+
A patch upgrade changes only the DTR containers and it should be a relatively
85+
safe operation. The command is the same as for a minor upgrade.
86+
4687
## Where to go next
4788

4889
* [Release notes](release-notes.md)

0 commit comments

Comments
 (0)