Skip to content
This repository was archived by the owner on May 22, 2026. It is now read-only.

Commit 7348c10

Browse files
authored
Add docker and docker compose upgrade instructions (#2429)
1 parent aa00e1a commit 7348c10

59 files changed

Lines changed: 6635 additions & 2 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

_data/pages_info.yml

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3855,6 +3855,84 @@
38553855
"/docs/pe/user-guide/install/upgrade-instructions/centos/v4-2-x/":
38563856
url: "/docs/pe/user-guide/install/upgrade-instructions/centos/v4-2-x/"
38573857
redirect_from: []
3858+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-0-x/":
3859+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-0-x/"
3860+
redirect_from: []
3861+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-1-x/":
3862+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-1-x/"
3863+
redirect_from: []
3864+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-2-x/":
3865+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-2-x/"
3866+
redirect_from: []
3867+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-3-x/":
3868+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-3-x/"
3869+
redirect_from: []
3870+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-4-x/":
3871+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-4-x/"
3872+
redirect_from: []
3873+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-5-x/":
3874+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-5-x/"
3875+
redirect_from: []
3876+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-6-x/":
3877+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-6-x/"
3878+
redirect_from: []
3879+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-7-x/":
3880+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-7-x/"
3881+
redirect_from: []
3882+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-8-x/":
3883+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-8-x/"
3884+
redirect_from: []
3885+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v3-9-x/":
3886+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v3-9-x/"
3887+
redirect_from: []
3888+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v4-0-x/":
3889+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v4-0-x/"
3890+
redirect_from: []
3891+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v4-1-x/":
3892+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v4-1-x/"
3893+
redirect_from: []
3894+
"/docs/pe/user-guide/install/upgrade-instructions/docker/v4-2-x/":
3895+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker/v4-2-x/"
3896+
redirect_from: []
3897+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/":
3898+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/"
3899+
redirect_from: []
3900+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-1-x/":
3901+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-1-x/"
3902+
redirect_from: []
3903+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-2-x/":
3904+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-2-x/"
3905+
redirect_from: []
3906+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-3-x/":
3907+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-3-x/"
3908+
redirect_from: []
3909+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-4-x/":
3910+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-4-x/"
3911+
redirect_from: []
3912+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-5-x/":
3913+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-5-x/"
3914+
redirect_from: []
3915+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-6-x/":
3916+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-6-x/"
3917+
redirect_from: []
3918+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-7-x/":
3919+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-7-x/"
3920+
redirect_from: []
3921+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-8-x/":
3922+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-8-x/"
3923+
redirect_from: []
3924+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/":
3925+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/"
3926+
redirect_from: []
3927+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/":
3928+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/"
3929+
redirect_from: []
3930+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/":
3931+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/"
3932+
redirect_from: []
3933+
"/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/":
3934+
url: "/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/"
3935+
redirect_from: []
38583936
"/docs/pe/user-guide/install/upgrade-instructions/":
38593937
url: "/docs/pe/user-guide/install/upgrade-instructions/"
38603938
redirect_from:
@@ -5175,6 +5253,84 @@
51755253
"/docs/user-guide/install/upgrade-instructions/centos/v4-2-x/":
51765254
url: "/docs/user-guide/install/upgrade-instructions/centos/v4-2-x/"
51775255
redirect_from: []
5256+
"/docs/user-guide/install/upgrade-instructions/docker/v3-0-x/":
5257+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-0-x/"
5258+
redirect_from: []
5259+
"/docs/user-guide/install/upgrade-instructions/docker/v3-1-x/":
5260+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-1-x/"
5261+
redirect_from: []
5262+
"/docs/user-guide/install/upgrade-instructions/docker/v3-2-x/":
5263+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-2-x/"
5264+
redirect_from: []
5265+
"/docs/user-guide/install/upgrade-instructions/docker/v3-3-x/":
5266+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-3-x/"
5267+
redirect_from: []
5268+
"/docs/user-guide/install/upgrade-instructions/docker/v3-4-x/":
5269+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-4-x/"
5270+
redirect_from: []
5271+
"/docs/user-guide/install/upgrade-instructions/docker/v3-5-x/":
5272+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-5-x/"
5273+
redirect_from: []
5274+
"/docs/user-guide/install/upgrade-instructions/docker/v3-6-x/":
5275+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-6-x/"
5276+
redirect_from: []
5277+
"/docs/user-guide/install/upgrade-instructions/docker/v3-7-x/":
5278+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-7-x/"
5279+
redirect_from: []
5280+
"/docs/user-guide/install/upgrade-instructions/docker/v3-8-x/":
5281+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-8-x/"
5282+
redirect_from: []
5283+
"/docs/user-guide/install/upgrade-instructions/docker/v3-9-x/":
5284+
url: "/docs/user-guide/install/upgrade-instructions/docker/v3-9-x/"
5285+
redirect_from: []
5286+
"/docs/user-guide/install/upgrade-instructions/docker/v4-0-x/":
5287+
url: "/docs/user-guide/install/upgrade-instructions/docker/v4-0-x/"
5288+
redirect_from: []
5289+
"/docs/user-guide/install/upgrade-instructions/docker/v4-1-x/":
5290+
url: "/docs/user-guide/install/upgrade-instructions/docker/v4-1-x/"
5291+
redirect_from: []
5292+
"/docs/user-guide/install/upgrade-instructions/docker/v4-2-x/":
5293+
url: "/docs/user-guide/install/upgrade-instructions/docker/v4-2-x/"
5294+
redirect_from: []
5295+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/":
5296+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/"
5297+
redirect_from: []
5298+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-1-x/":
5299+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-1-x/"
5300+
redirect_from: []
5301+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-2-x/":
5302+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-2-x/"
5303+
redirect_from: []
5304+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-3-x/":
5305+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-3-x/"
5306+
redirect_from: []
5307+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-4-x/":
5308+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-4-x/"
5309+
redirect_from: []
5310+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-5-x/":
5311+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-5-x/"
5312+
redirect_from: []
5313+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-6-x/":
5314+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-6-x/"
5315+
redirect_from: []
5316+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-7-x/":
5317+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-7-x/"
5318+
redirect_from: []
5319+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-8-x/":
5320+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-8-x/"
5321+
redirect_from: []
5322+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/":
5323+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v3-9-x/"
5324+
redirect_from: []
5325+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/":
5326+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v4-0-x/"
5327+
redirect_from: []
5328+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/":
5329+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v4-1-x/"
5330+
redirect_from: []
5331+
"/docs/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/":
5332+
url: "/docs/user-guide/install/upgrade-instructions/docker-compose/v4-2-x/"
5333+
redirect_from: []
51785334
"/docs/user-guide/install/upgrade-instructions/":
51795335
url: "/docs/user-guide/install/upgrade-instructions/"
51805336
redirect_from: []
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{% assign current_version = include.version %}
2+
3+
1. Change the version of the `thingsboard/tb-pe-node` and `thingsboard/tb-web-report` in the `docker-compose.yml` file to the **{{ current_version }}**.
4+
5+
2. Execute the following commands:
6+
7+
```bash
8+
docker pull thingsboard/tb-pe-node:{{ current_version }}
9+
docker pull thingsboard/tb-web-report:{{ current_version }}
10+
docker compose stop thingsboard-pe
11+
docker compose run --rm -e UPGRADE_TB=true thingsboard-pe
12+
docker compose up -d
13+
```
14+
{: .copy-code}
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{% assign current_version = include.version %}
2+
{% assign from_version = include.fromversion %}
3+
4+
1. Change the parameter `TB_VERSION` in the `.env` file.
5+
6+
```.env
7+
TB_VERSION={{ current_version }}
8+
```
9+
10+
2. Execute the following commands:
11+
12+
```bash
13+
./docker-stop-services.sh
14+
./docker-upgrade-tb.sh --fromVersion={{ from_version }}
15+
./docker-start-services.sh
16+
```
17+
{: .copy-code}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{% assign current_version = include.version %}
2+
3+
1. Change the parameter `TB_VERSION` in the `.env` file.
4+
5+
```.env
6+
TB_VERSION={{ current_version }}
7+
```
8+
9+
2. Execute the following commands:
10+
11+
```bash
12+
./docker-stop-services.sh
13+
./docker-upgrade-tb.sh
14+
./docker-start-services.sh
15+
```
16+
{: .copy-code}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{% assign current_version = include.version %}
2+
3+
1. Change the version of the `thingsboard/tb-node` in the `docker-compose.yml` file to the **{{ current_version }}**.
4+
5+
2. Execute the following commands:
6+
7+
```bash
8+
docker pull thingsboard/tb-node:{{ current_version }}
9+
docker compose stop thingsboard-ce
10+
docker compose run --rm -e UPGRADE_TB=true thingsboard-ce
11+
docker compose up -d
12+
```
13+
{: .copy-code}

_includes/upgrade-instructions-table.liquid

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,10 @@
100100
<a href="/docs/{{ docsPrefix }}user-guide/install/upgrade-instructions/windows/{{ versionFamily }}/{{ hashLinkUpgrade }}" data-tooltip="Windows Instructions">
101101
<img src="/images/windows.svg" alt="Upgrade Windows Instructions">
102102
</a>
103-
<a href="/docs/user-guide/install/{{ docsPrefix }}docker/#upgrading" data-tooltip="Docker Instructions">
103+
<a href="/docs/{{ docsPrefix }}user-guide/install/upgrade-instructions/docker/{{ versionFamily }}/{{ hashLinkUpgrade }}" data-tooltip="Docker Instructions">
104104
<img src="/images/docker.svg" alt="Upgrade Docker Instructions">
105105
</a>
106-
<a class="right-link" href="/docs/user-guide/install/{{ docsPrefix }}cluster/docker-compose-setup/#upgrading" data-tooltip="Docker Compose Instructions">
106+
<a href="/docs/{{ docsPrefix }}user-guide/install/upgrade-instructions/docker-compose/{{ versionFamily }}/{{ hashLinkUpgrade }}" data-tooltip="Docker Compose Instructions">
107107
<img width="24" height="24" src="/images/install/cluster/docker-compose.svg" alt="Docker Compose Instructions">
108108
</a>
109109
</div>
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: docwithnav-pe
3+
title: ThingsBoard PE v3.0.x upgrade instructions for Docker Compose
4+
description: ThingsBoard PE v3.0.x upgrade guide for Docker Compose
5+
active-menu-item-click: "true"
6+
breadcrumbs: true
7+
breadcrumbs-steps: 2
8+
breadcrumbs-show: 2
9+
10+
---
11+
12+
* TOC
13+
{:toc}
14+
15+
### Upgrading ThingsBoard PE to 3.0.1
16+
17+
**NOTE**: These upgrade steps are applicable for ThingsBoard version 3.0PE. In order to upgrade to 3.0.1PE you need to [**upgrade to 3.0PE first**](#upgrading-thingsboard-pe-to-30).
18+
19+
{% include templates/install/tb-30-update.md %}
20+
21+
{% capture update_manifests_note %}
22+
We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
23+
<br>
24+
<br>
25+
If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
26+
{% endcapture %}
27+
{% include templates/warn-banner.md content=update_manifests_note %}
28+
29+
#### ThingsBoard PE service upgrade
30+
31+
{% include docs/user-guide/install/docker-compose-upgrade-steps-fromversion.md version="3.0.1PE" fromversion="3.0.0" %}
32+
33+
### Upgrading ThingsBoard PE to 3.0
34+
35+
{% capture update_manifests_note %}
36+
We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
37+
<br>
38+
<br>
39+
If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
40+
{% endcapture %}
41+
{% include templates/warn-banner.md content=update_manifests_note %}
42+
43+
#### ThingsBoard PE service upgrade
44+
45+
{% include docs/user-guide/install/docker-compose-upgrade-steps-fromversion.md version="3.0.0PE" fromversion="2.5.0" %}
46+
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
layout: docwithnav-pe
3+
title: ThingsBoard PE v3.1.x upgrade instructions for Docker Compose
4+
description: ThingsBoard PE v3.1.x upgrade guide for Docker Compose
5+
active-menu-item-click: "true"
6+
breadcrumbs: true
7+
breadcrumbs-steps: 2
8+
breadcrumbs-show: 2
9+
10+
---
11+
12+
* TOC
13+
{:toc}
14+
15+
### Upgrading ThingsBoard PE to 3.1.1
16+
17+
**NOTE**: These upgrade steps are applicable for ThingsBoard version 3.1PE. In order to upgrade to 3.1.1PE you need to [**upgrade to 3.1PE first**](#upgrading-thingsboard-pe-to-31).
18+
19+
{% capture update_manifests_note %}
20+
We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
21+
<br>
22+
<br>
23+
If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
24+
{% endcapture %}
25+
{% include templates/warn-banner.md content=update_manifests_note %}
26+
27+
#### ThingsBoard PE service upgrade
28+
29+
{% include docs/user-guide/install/docker-compose-upgrade-steps-fromversion.md version="3.1.1PE" fromversion="3.1.0" %}
30+
31+
### Upgrading ThingsBoard PE to 3.1
32+
33+
**NOTE**: These upgrade steps are applicable for ThingsBoard version 3.0.1PE. In order to upgrade to 3.1PE you need to [**upgrade to 3.0.1PE first**](/docs/pe/user-guide/install/upgrade-instructions/docker-compose/v3-0-x/#upgrading-thingsboard-pe-to-301).
34+
35+
{% capture update_manifests_note %}
36+
We strongly recommend that you also update your Docker Compose deployment manifests to [**the latest available version from GitHub repository**](https://github.com/thingsboard/thingsboard-pe-docker-compose/tree/master) with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.
37+
<br>
38+
<br>
39+
If you are running older releases of ThingsBoard - be aware that the manifests in `master` branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.
40+
{% endcapture %}
41+
{% include templates/warn-banner.md content=update_manifests_note %}
42+
43+
#### ThingsBoard PE service upgrade
44+
45+
{% include docs/user-guide/install/docker-compose-upgrade-steps-fromversion.md version="3.1.0PE" fromversion="3.0.1" %}

0 commit comments

Comments
 (0)