Merge remote-tracking branch 'ce/master'

application/src/main/data/json/edge/install_instructions/centos/instructions.md → application/src/main/data/json/edge/instructions/install/centos/instructions.md

@@ -1,4 +1,4 @@
-Here is the list of commands, that can be used to quickly install ThingsBoard Edge on RHEL/CentOS 7/8 and connect to the cloud.
+Here is the list of commands, that can be used to quickly install ThingsBoard Edge on RHEL/CentOS 7/8 and connect to the server.
 
 #### Prerequisites
 Before continue to installation execute the following commands in order to install necessary tools:
@@ -56,13 +56,13 @@ sudo yum update
 sudo yum -y install https://download.postgresql.org/pub/repos/yum/reporpms/EL-7-x86_64/pgdg-redhat-repo-latest.noarch.rpm
 # Install packages
 sudo yum -y install epel-release yum-utils
-sudo yum-config-manager --enable pgdg12
-sudo yum install postgresql12-server postgresql12
+sudo yum-config-manager --enable pgdg15
+sudo yum install postgresql15-server postgresql15
 # Initialize your PostgreSQL DB
-sudo /usr/pgsql-12/bin/postgresql-12-setup initdb
-sudo systemctl start postgresql-12
+sudo /usr/pgsql-15/bin/postgresql-15-setup initdb
+sudo systemctl start postgresql-15
 # Optional: Configure PostgreSQL to start on boot
-sudo systemctl enable --now postgresql-12
+sudo systemctl enable --now postgresql-15
 
 {:copy-code}
 ```
@@ -74,12 +74,12 @@ sudo systemctl enable --now postgresql-12
 sudo yum -y install https://download.postgresql.org/pub/repos/yum/reporpms/EL-8-x86_64/pgdg-redhat-repo-latest.noarch.rpm
 # Install packages
 sudo dnf -qy module disable postgresql
-sudo dnf -y install postgresql12 postgresql12-server
+sudo dnf -y install postgresql15 postgresql15-server
 # Initialize your PostgreSQL DB
-sudo /usr/pgsql-12/bin/postgresql-12-setup initdb
-sudo systemctl start postgresql-12
+sudo /usr/pgsql-15/bin/postgresql-15-setup initdb
+sudo systemctl start postgresql-15
 # Optional: Configure PostgreSQL to start on boot
-sudo systemctl enable --now postgresql-12
+sudo systemctl enable --now postgresql-15
 
 {:copy-code}
 ```
@@ -101,7 +101,7 @@ After configuring the password, edit the pg_hba.conf to use MD5 authentication w
 Edit pg_hba.conf file:
 
 ```bash
-sudo nano /var/lib/pgsql/12/data/pg_hba.conf
+sudo nano /var/lib/pgsql/15/data/pg_hba.conf
 {:copy-code}
 ```
 
@@ -121,7 +121,7 @@ host    all             all             127.0.0.1/32            md5
 Finally, you should restart the PostgreSQL service to initialize the new configuration:
 
 ```bash
-sudo systemctl restart postgresql-12.service
+sudo systemctl restart postgresql-15.service
 {:copy-code}
 ```
 

application/src/main/data/json/edge/install_instructions/docker/instructions.md → application/src/main/data/json/edge/instructions/install/docker/instructions.md

@@ -1,25 +1,11 @@
-Here is the list of commands, that can be used to quickly install ThingsBoard Edge using docker compose and connect to the cloud.
+Here is the list of commands, that can be used to quickly install ThingsBoard Edge using docker compose and connect to the server.
 
 #### Prerequisites
 
 Install <a href="https://docs.docker.com/engine/install/" target="_blank"> Docker CE</a> and <a href="https://docs.docker.com/compose/install/" target="_blank"> Docker Compose</a>.
 
-#### Create data and logs folders
-
-Run following commands, before starting docker container(s), to create folders for storing data and logs.
-These commands additionally will change owner of newly created folders to docker container user.
-To do this (to change user) **chown** command is used, and this command requires *sudo* permissions (command will request password for a *sudo* access):
-
-```bash
-mkdir -p ~/.mytb-edge-data && sudo chown -R 799:799 ~/.mytb-edge-data
-mkdir -p ~/.mytb-edge-logs && sudo chown -R 799:799 ~/.mytb-edge-logs
-{:copy-code}
-```
-
 #### Running ThingsBoard Edge as docker service
 
-${LOCALHOST_WARNING}
-
 Create docker compose file for ThingsBoard Edge service:
 
 ```bash
@@ -30,7 +16,7 @@ nano docker-compose.yml
 Add the following lines to the yml file:
 
 ```bash
-version: '3.0'
+version: '3.8'
 services:
   mytbedge:
     restart: always
@@ -47,8 +33,9 @@ services:
       CLOUD_RPC_PORT: ${CLOUD_RPC_PORT}
       CLOUD_RPC_SSL_ENABLED: ${CLOUD_RPC_SSL_ENABLED}
     volumes:
-      - ~/.mytb-edge-data:/data
-      - ~/.mytb-edge-logs:/var/log/tb-edge
+      - tb-edge-data:/data
+      - tb-edge-logs:/var/log/tb-edge
+    ${EXTRA_HOSTS}
   postgres:
     restart: always
     image: "postgres:15"
@@ -58,7 +45,15 @@ services:
       POSTGRES_DB: tb-edge
       POSTGRES_PASSWORD: postgres
     volumes:
-      - ~/.mytb-edge-data/db:/var/lib/postgresql/data
+      - tb-edge-postgres-data:/var/lib/postgresql/data
+
+volumes:
+  tb-edge-data:
+    name: tb-edge-data
+  tb-edge-logs:
+    name: tb-edge-logs
+  tb-edge-postgres-data:
+    name: tb-edge-postgres-data
 {:copy-code}
 ```
 

application/src/main/data/json/edge/install_instructions/ubuntu/instructions.md → application/src/main/data/json/edge/instructions/install/ubuntu/instructions.md

@@ -1,4 +1,4 @@
-Here is the list of commands, that can be used to quickly install ThingsBoard Edge on Ubuntu Server and connect to the cloud.
+Here is the list of commands, that can be used to quickly install ThingsBoard Edge on Ubuntu Server and connect to the server.
 
 #### Install Java 11 (OpenJDK)
 ThingsBoard service is running on Java 11. Follow these instructions to install OpenJDK 11:
@@ -49,7 +49,7 @@ echo "deb http://apt.postgresql.org/pub/repos/apt/ ${RELEASE}"-pgdg main | sudo
 
 # install and launch the postgresql service:
 sudo apt update
-sudo apt -y install postgresql-12
+sudo apt -y install postgresql-15
 sudo service postgresql start
 {:copy-code}
 ```

application/src/main/data/json/edge/instructions/upgrade/centos/instructions.md

@@ -0,0 +1,15 @@
+#### Upgrading to ${TB_EDGE_VERSION}EDGE
+
+**ThingsBoard Edge package download:**
+```bash
+wget https://github.com/thingsboard/thingsboard-edge/releases/download/v${TB_EDGE_TAG}/tb-edge-${TB_EDGE_TAG}.rpm
+{:copy-code}
+```
+##### ThingsBoard Edge service upgrade
+
+Install package:
+```bash
+sudo rpm -Uvh tb-edge-${TB_EDGE_TAG}.rpm
+{:copy-code}
+```
+${UPGRADE_DB}

application/src/main/data/json/edge/instructions/upgrade/docker/instructions.md

@@ -0,0 +1,10 @@
+#### Upgrading to ${TB_EDGE_VERSION}
+
+Execute the following command to pull **${TB_EDGE_VERSION}** image:
+
+```bash
+docker pull thingsboard/tb-edge:${TB_EDGE_VERSION}
+{:copy-code}
+```
+
+${UPGRADE_DB}

application/src/main/data/json/edge/instructions/upgrade/docker/start_service.md

@@ -0,0 +1,23 @@
+Modify ‘main’ docker compose (`docker-compose.yml`) file for ThingsBoard Edge and update version of the image:
+```bash
+nano docker-compose.yml
+{:copy-code}
+```
+
+```text
+version: '3.8'
+services:
+    mytbedge:
+        restart: always
+        image: "thingsboard/tb-edge:${TB_EDGE_VERSION}"
+...
+```
+
+Make sure your image is the set to **tb-edge-${TB_EDGE_VERSION}**.
+Execute the following commands to up this docker compose directly:
+
+```bash
+docker compose up -d
+docker compose logs -f mytbedge
+{:copy-code}
+```

application/src/main/data/json/edge/instructions/upgrade/docker/upgrade_db.md

@@ -0,0 +1,61 @@
+Create docker compose file for ThingsBoard Edge upgrade process:
+
+```bash
+> docker-compose-upgrade.yml && nano docker-compose-upgrade.yml
+{:copy-code}
+```
+
+Add the following lines to the yml file:
+
+```bash
+version: '3.8'
+services:
+  mytbedge:
+    restart: on-failure
+    image: "thingsboard/tb-edge:${TB_EDGE_VERSION}"
+    environment:
+      SPRING_DATASOURCE_URL: jdbc:postgresql://postgres:5432/tb-edge
+    volumes:
+      - tb-edge-data:/data
+      - tb-edge-logs:/var/log/tb-edge
+    entrypoint: upgrade-tb-edge.sh
+  postgres:
+    restart: always
+    image: "postgres:15"
+    ports:
+      - "5432"
+    environment:
+      POSTGRES_DB: tb-edge
+      POSTGRES_PASSWORD: postgres
+    volumes:
+      - tb-edge-postgres-data:/var/lib/postgresql/data
+
+volumes:
+  tb-edge-data:
+    name: tb-edge-data
+  tb-edge-logs:
+    name: tb-edge-logs
+  tb-edge-postgres-data:
+    name: tb-edge-postgres-data
+{:copy-code}
+```
+
+Execute the following command to start upgrade process:
+
+```bash
+docker compose -f docker-compose-upgrade.yml up
+{:copy-code}
+```
+
+Once upgrade process successfully completed, exit from the docker-compose shell by this combination:
+
+```text
+Ctrl + C
+```
+
+Execute the following command to stop TB Edge upgrade container:
+
+```bash
+docker compose -f docker-compose-upgrade.yml stop
+{:copy-code}
+```

application/src/main/data/json/edge/instructions/upgrade/docker/upgrade_preparing.md

@@ -0,0 +1,83 @@
+Here is the list of commands, that can be used to quickly upgrade ThingsBoard Edge on Docker (Linux or MacOS).
+
+#### Prepare for upgrading ThingsBoard Edge
+Set the terminal in the directory which contains the `docker-compose.yml` file and execute the following command
+to stop and remove currently running TB Edge container:
+
+```bash
+docker compose stop
+docker compose rm mytbedge
+{:copy-code}
+```
+
+**OPTIONAL:** If you still rely on Docker Compose as docker-compose (with a hyphen) here is the list of the above commands:
+```text
+docker-compose stop
+docker-compose rm mytbedge
+```
+
+##### Migrating Data from Docker Bind Mount Folders to Docker Volumes
+Starting with the **3.6.2** release, the ThingsBoard team has transitioned from using Docker bind mount folders to Docker volumes.
+This change aims to enhance security and efficiency in storing data for Docker containers and to mitigate permission issues across various environments.
+
+To migrate from Docker bind mounts to Docker volumes, please execute the following commands:
+
+```bash
+docker run --rm -v tb-edge-data:/volume -v ~/.mytb-edge-data:/backup busybox sh -c "cp -a /backup/. /volume"
+docker run --rm -v tb-edge-logs:/volume -v ~/.mytb-edge-logs:/backup busybox sh -c "cp -a /backup/. /volume"
+docker run --rm -v tb-edge-postgres-data:/volume -v ~/.mytb-edge-data/db:/backup busybox sh -c "cp -a /backup/. /volume"
+{:copy-code}
+```
+
+After completing the data migration to the newly created Docker volumes, you'll need to update the volume mounts in your Docker Compose configuration.
+Modify the `docker-compose.yml` file for ThingsBoard Edge to update the volume settings.
+
+First, please update docker compose file version. Find next snippet:
+```text
+version: '3.0'
+...
+```
+
+And replace it with:
+```text
+version: '3.8'
+...
+```
+
+Then update volume mounts. Locate the following snippet:
+```text
+    volumes:
+      - ~/.mytb-edge-data:/data
+      - ~/.mytb-edge-logs:/var/log/tb-edge
+...
+```
+
+And replace it with:
+```text
+    volumes:
+      - tb-edge-data:/data
+      - tb-edge-logs:/var/log/tb-edge
+...
+```
+
+Apply a similar update for the PostgreSQL service. Find the section:
+```text
+    volumes:
+      - ~/.mytb-edge-data/db:/var/lib/postgresql/data
+...
+```
+
+And replace it with:
+```text
+    volumes:
+      - tb-edge-postgres-data/:/var/lib/postgresql/data
+...
+```
+
+##### Backup Database
+Make a copy of the database volume before upgrading:
+
+```bash
+docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
+{:copy-code}
+```

application/src/main/data/json/edge/instructions/upgrade/start_service.md

@@ -0,0 +1,6 @@
+Start the service
+
+```bash
+sudo systemctl tb-edge start
+{:copy-code}
+```

application/src/main/data/json/edge/instructions/upgrade/ubuntu/instructions.md

@@ -0,0 +1,15 @@
+#### Upgrading to ${TB_EDGE_VERSION}EDGE
+
+**ThingsBoard Edge package download:**
+```bash
+wget https://github.com/thingsboard/thingsboard-edge/releases/download/v${TB_EDGE_TAG}/tb-edge-${TB_EDGE_TAG}.deb
+{:copy-code}
+```
+##### ThingsBoard Edge service upgrade
+
+Install package:
+```bash
+sudo dpkg -i tb-edge-${TB_EDGE_TAG}.deb
+{:copy-code}
+```
+${UPGRADE_DB}

application/src/main/data/json/edge/instructions/upgrade/upgrade_db.md

@@ -0,0 +1,8 @@
+**NOTE**: Package installer may ask you to merge your tb-edge configuration. It is preferred to use **merge option** to make sure that all your previous parameters will not be overwritten.
+
+Execute regular upgrade script:
+
+```bash
+sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=${FROM_TB_EDGE_VERSION}
+{:copy-code}
+```