Klyff Platform
Klyff Platform Cloud Edge IoT Gateway Trendz Analytics Mobile Application MQTT Broker
Getting Started Documentation Devices Library Guides Installation Architecture API FAQ
On this page

Old Upgrade instructions

In order to update to new Klyff releases, please follow these CE and PE instructions

Upgrading to 1.0.3

These steps are applicable for 1.0, 1.0.1 and 1.0.2 Klyff versions.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.0.3/thingsboard-1.0.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.0.3/thingsboard-1.0.3.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-1.0.3.deb

1

sudo rpm -Uvh thingsboard-1.0.3.rpm

Database upgrade

This step is required only if you are upgrading from 1.0 or 1.0.1 versions. Please use following instruction to update your single node instance:

Download upgrade scripts:

1
2

wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.0.3/upgrade_1.0_1.0.2.sh
wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.0.3/system_widgets_1.0_1.0.2.cql

Launch main script:

1
2

chmod +x upgrade_1.0_1.0.2.sh
./upgrade_1.0_1.0.2.sh

Start the service

1

sudo service thingsboard start

Upgrading to 1.1.0

These steps are applicable for 1.0.3 Klyff version.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.1/thingsboard-1.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.1/thingsboard-1.1.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-1.1.deb

1

sudo rpm -Uvh thingsboard-1.1.rpm

Database upgrade

Please use the following instruction to update your single node instance:

Download upgrade scripts:

1
2

wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.1.0/upgrade_1.0.3_1.1.0.sh
wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.1.0/system_widgets_1.0.3_1.1.0.cql

Launch main script:

1
2

chmod +x upgrade_1.0.3_1.1.0.sh
./upgrade_1.0.3_1.1.0.sh

Start the service

1

$ sudo service thingsboard start

Upgrading to 1.2.0

These steps are applicable for 1.1.0 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.2/thingsboard-1.2.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.2/thingsboard-1.2.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-1.2.deb

1

sudo rpm -Uvh thingsboard-1.2.rpm

Database upgrade

Download upgrade scripts:

1
2

wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.0/upgrade_1.1.0_1.2.0.sh
wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.0/system_widgets.cql

Launch main script:

1
2

chmod +x upgrade_1.1.0_1.2.0.sh
./upgrade_1.1.0_1.2.0.sh

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-1.2.zip.

Klyff service upgrade

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Uninstall the previous version of Klyff service by running uninstall.bat located in Klyff install dir.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>uninstall.bat
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Run install.bat script to install the new version of Klyff as a Windows service.
1

C:\thingsboard>install.bat

Database upgrade

1

upgrade_1.1.0_1.2.0.bat

Start the service

1

net start thingsboard

Upgrading to 1.2.1

These steps are applicable for 1.2.0 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.1/thingsboard-1.2.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.1/thingsboard-1.2.1.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-1.2.1.deb

1

sudo rpm -Uvh thingsboard-1.2.1.rpm

Database upgrade

Download upgrade scripts:

1
2
3

wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.1/upgrade_1.2.0_1.2.1.sh
wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.1/schema_update.cql
wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.1/system_widgets.cql

Launch main script:

1
2

chmod +x upgrade_1.2.0_1.2.mqtt-js-telemetry-data-as-object.sh
./upgrade_1.2.0_1.2.mqtt-js-telemetry-data-as-object.sh

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-1.2.1.zip.

Klyff service upgrade

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Uninstall the previous version of Klyff service by running uninstall.bat located in Klyff install dir.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>uninstall.bat
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Run install.bat script to install the new version of Klyff as a Windows service.
1

C:\thingsboard>install.bat

Database upgrade

1

upgrade_1.2.0_1.2.1.bat

Start the service

1

net start thingsboard

Upgrading to 1.2.2

These steps are applicable for 1.2.1 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.2/thingsboard-1.2.2.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.2/thingsboard-1.2.2.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-1.2.2.deb

1

sudo rpm -Uvh thingsboard-1.2.2.rpm

Database upgrade

Download upgrade scripts:

1
2

wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.2/upgrade_1.2.1_1.2.2.sh
wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.2/system_widgets.cql

Launch main script:

1
2

chmod +x upgrade_1.2.1_1.2.2.sh
./upgrade_1.2.1_1.2.2.sh

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-1.2.2.zip.

Klyff service upgrade

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Uninstall the previous version of Klyff service by running uninstall.bat located in Klyff install dir.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>uninstall.bat
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Run install.bat script to install the new version of Klyff as a Windows service.
1

C:\thingsboard>install.bat

Database upgrade

1

upgrade_1.2.1_1.2.2.bat

Start the service

1

net start thingsboard

Upgrading to 1.2.3

These steps are applicable for 1.2.2 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.3/thingsboard-1.2.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.3/thingsboard-1.2.3.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-1.2.3.deb

1

sudo rpm -Uvh thingsboard-1.2.3.rpm

Database upgrade

Download upgrade scripts:

1
2
3

wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.3/upgrade_1.2.2_1.2.3.sh
wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.3/schema_update.cql
wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.3/system_widgets.cql

Launch main script:

1
2

chmod +x upgrade_1.2.2_1.2.3.sh
./upgrade_1.2.2_1.2.3.sh

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-1.2.3.zip.

Klyff service upgrade

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Uninstall the previous version of Klyff service by running uninstall.bat located in Klyff install dir.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>uninstall.bat
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Run install.bat script to install the new version of Klyff as a Windows service.
1

C:\thingsboard>install.bat

Database upgrade

1

upgrade_1.2.2_1.2.3.bat

Start the service

1

net start thingsboard

Upgrading to 1.3.0

These steps are applicable for 1.2.3 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.3/thingsboard-1.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.3/thingsboard-1.3.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-1.3.deb

1

sudo rpm -Uvh thingsboard-1.3.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=1.2.3

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-1.3.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2

  database:
      type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=1.2.3

Start the service

1

net start thingsboard

Upgrading to 1.3.1

These steps are applicable for 1.3.0 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-1.3.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-1.3.1.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-1.3.1.deb

1

sudo rpm -Uvh thingsboard-1.3.1.rpm

NOTE: Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=1.3.0

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-1.3.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2

  database:
      type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=1.3.0

Start the service

1

net start thingsboard

Upgrading to 1.4.0

These steps are applicable for 1.3.1 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.4/thingsboard-1.4.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v1.4/thingsboard-1.4.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-1.4.deb

1

sudo rpm -Uvh thingsboard-1.4.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=1.3.1

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-1.4.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2

  database:
      type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=1.3.1

Start the service

1

net start thingsboard

Upgrading to 2.0.0

These steps are applicable for 1.4.0 Klyff version.

Ubuntu/CentOS

info sign

Important note


Please note that during upgrade procedure old rules and plugins will be completely removed from your Klyff instance.

Old rules and plugins functionality is replaced by new rule engine components (rule chains and rule nodes).

If you have configured rules or plugins you need to backup them using export function before performing upgrade. After upgrade you will need to configure new rule chains in order to restore your application logic performed by old rules/plugins.

Please refer to new rule engine documentation for details.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.0/thingsboard-2.0.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.0/thingsboard-2.0.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-2.0.deb

1

sudo rpm -Uvh thingsboard-2.0.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=1.4.0

Start the service

1

sudo service thingsboard start

Windows

info sign

Important note


Please note that during upgrade procedure old rules and plugins will be completely removed from your Klyff instance.

Old rules and plugins functionality is replaced by new rule engine components (rule chains and rule nodes).

If you have configured rules or plugins you need to backup them using export function before performing upgrade. After upgrade you will need to configure new rule chains in order to restore your application logic performed by old rules/plugins.

Please refer to new rule engine documentation for details.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.0.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2

  database:
      type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=1.4.0

Start the service

1

net start thingsboard

Upgrading to 2.0.1

These steps are applicable for 2.0.0 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.1/thingsboard-2.0.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.1/thingsboard-2.0.1.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-2.0.1.deb

1

sudo rpm -Uvh thingsboard-2.0.1.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.0.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2

  database:
      type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

1

net start thingsboard

Upgrading to 2.0.2

These steps are applicable for 2.0.1 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.2/thingsboard-2.0.2.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.2/thingsboard-2.0.2.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-2.0.2.deb

1

sudo rpm -Uvh thingsboard-2.0.2.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.0.2.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2

  database:
      type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

1

net start thingsboard

Upgrading to 2.0.3

These steps are applicable for 2.0.2 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.3/thingsboard-2.0.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.3/thingsboard-2.0.3.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-2.0.3.deb

1

sudo rpm -Uvh thingsboard-2.0.3.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.0.3.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2

  database:
      type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

1

net start thingsboard

Upgrading to 2.1.0

These steps are applicable for 2.0.3 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.1/thingsboard-2.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.1/thingsboard-2.1.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-2.1.deb

1

sudo rpm -Uvh thingsboard-2.1.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2

  database:
      type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

1

net start thingsboard

Upgrading to 2.2.0

These steps are applicable for 2.1.0, 2.1.1, 2.1.2 and 2.1.3 Klyff versions.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.2/thingsboard-2.2.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.2/thingsboard-2.2.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-2.2.deb

1

sudo rpm -Uvh thingsboard-2.2.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5

    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)

Execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.0.0

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.2.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2
3
4
5

  database:
    entities:
      type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
    ts:
      type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=2.0.0

Start the service

1

net start thingsboard

Upgrading to 2.3.0

These steps are applicable for 2.2.0 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.3/thingsboard-2.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.3/thingsboard-2.3.rpm

Klyff service upgrade

1

sudo dpkg -i thingsboard-2.3.deb

1

sudo rpm -Uvh thingsboard-2.3.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5

    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)

Execute upgrade script

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.2.0

Start the service

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.3.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2
3
4
5

  database:
    entities:
      type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
    ts:
      type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=2.2.0

Start the service

1

net start thingsboard

Upgrading to 2.4.0

These steps are applicable for 2.3.1 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4/thingsboard-2.4.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4/thingsboard-2.4.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.4.deb

1

sudo rpm -Uvh thingsboard-2.4.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5

    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)

Execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.3.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.4.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2
3
4
5

  database:
    entities:
      type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
    ts:
      type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=2.3.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.4.1

These steps are applicable for 2.4.0 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.1/thingsboard-2.4.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.1/thingsboard-2.4.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.4.1.deb

1

sudo rpm -Uvh thingsboard-2.4.1.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5

    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)

Execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.4.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2
3
4
5

  database:
    entities:
      type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
    ts:
      type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=2.4.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.4.2.1

These steps are applicable for 2.4.1 and 2.4.2 Klyff versions.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.2.1/thingsboard-2.4.2.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.2.1/thingsboard-2.4.2.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.4.2.1.deb

1

sudo rpm -Uvh thingsboard-2.4.2.1.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5

    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)

Execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.4.2.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2
3
4
5

  database:
    entities:
      type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
    ts:
      type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=2.4.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.4.3

These steps are applicable for 2.4.2 and 2.4.2.1 Klyff versions.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.3/thingsboard-2.4.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.3/thingsboard-2.4.3.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.4.3.deb

1

sudo rpm -Uvh thingsboard-2.4.3.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5

    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)

Execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.2

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.4.3.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2
3
4
5

  database:
    entities:
      type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
    ts:
      type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
  • Run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=2.4.2

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.5

These steps are applicable for 2.4.3 Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5/thingsboard-2.5.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5/thingsboard-2.5.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.5.deb

1

sudo rpm -Uvh thingsboard-2.5.rpm

NOTE: Upgrading Klyff from 2.4.3 to 2.5 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.

Please refer to the guides below that will describe how to upgrade your PostgreSQL service on:

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5
6
7
8

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    entities:
      type: "${DATABASE_ENTITIES_TYPE:sql}" # cassandra OR sql
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  
  # note: timescale works only with postgreSQL database for DATABASE_ENTITIES_TYPE.

NOTE: If you are using PostgreSql(Sql) for time-series data storage before executing the upgrade script, go to the PostgreSQL terminal(psql) and follow the instructions below:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  # Connect to thingsboard database:
  \c thingsboard
  
  # Execute the next commands:
  
  # Update ts_kv table constraints:
  ALTER TABLE ts_kv DROP CONSTRAINT IF EXISTS ts_kv_unq_key;
  ALTER TABLE ts_kv DROP CONSTRAINT IF EXISTS ts_kv_pkey;
  ALTER TABLE ts_kv ADD CONSTRAINT ts_kv_pkey PRIMARY KEY (entity_type, entity_id, key, ts);
  
  # Update ts_kv_latest table constraints:
  ALTER TABLE ts_kv_latest DROP CONSTRAINT IF EXISTS ts_kv_latest_unq_key;
  ALTER TABLE ts_kv_latest DROP CONSTRAINT IF EXISTS ts_kv_latest_pkey;
  ALTER TABLE ts_kv_latest ADD CONSTRAINT ts_kv_latest_pkey PRIMARY KEY (entity_type, entity_id, key);
  
  # exit psql terminal 
  \q

Finally, execute upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.3

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.5.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please note that upgrading Klyff from 2.4.3 to 2.5 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2
3
4
5
6
7
8

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    entities:
      type: "${DATABASE_ENTITIES_TYPE:sql}" # cassandra OR sql
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  
  # note: timescale works only with postgreSQL database for DATABASE_ENTITIES_TYPE.

NOTE: If you are using PostgreSql(Sql) for time-series data storage before executing the upgrade script, you need to access the psql terminal. Once you will be logged to the psql terminal, please follow the instructions below:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

  # Connect to thingsboard database:
  \c thingsboard
  
  # Execute the next commands:
  
  # Update ts_kv table constraints:
  ALTER TABLE ts_kv DROP CONSTRAINT IF EXISTS ts_kv_unq_key;
  ALTER TABLE ts_kv DROP CONSTRAINT IF EXISTS ts_kv_pkey;
  ALTER TABLE ts_kv ADD CONSTRAINT ts_kv_pkey PRIMARY KEY (entity_type, entity_id, key, ts);
  
  # Update ts_kv_latest table constraints:
  ALTER TABLE ts_kv_latest DROP CONSTRAINT IF EXISTS ts_kv_latest_unq_key;
  ALTER TABLE ts_kv_latest DROP CONSTRAINT IF EXISTS ts_kv_latest_pkey;
  ALTER TABLE ts_kv_latest ADD CONSTRAINT ts_kv_latest_pkey PRIMARY KEY (entity_type, entity_id, key);
  
  # exit psql terminal 
  \q
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=2.4.3

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.5.1

These steps are applicable for 2.4.3+ Klyff version.

Ubuntu/CentOS

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.1/thingsboard-2.5.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.1/thingsboard-2.5.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.5.1.deb

1

sudo rpm -Uvh thingsboard-2.5.1.rpm

NOTE: Upgrading Klyff to 2.5.1 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.

Please refer to the guides below that will describe how to upgrade your PostgreSQL service on:

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Finally, execute upgrade script and specify your previous Klyff version:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.3

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.5.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.

  • Please note that upgrading Klyff from 2.4.3 to 2.5 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.

  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=2.4.3

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.5.2

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 2.5.1. In order to upgrade to 2.5.2 you need to upgrade to 2.5.1 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.2/thingsboard-2.5.2.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.2/thingsboard-2.5.2.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.5.2.deb

1

sudo rpm -Uvh thingsboard-2.5.2.rpm

NOTE: Upgrading Klyff to 2.5.2 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.

Please refer to the guides below that will describe how to upgrade your PostgreSQL service on:

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 2.5.1. In order to upgrade to 2.5.2 you need to upgrade to 2.5.1 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.5.2.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.

  • Please note that upgrading Klyff from 2.4.3 to 2.5 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.

  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

1

C:\thingsboard>upgrade.bat --fromVersion=2.4.3

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.5.3

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 2.5.2. In order to upgrade to 2.5.3 you need to upgrade to 2.5.2 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.3/thingsboard-2.5.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.3/thingsboard-2.5.3.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.5.3.deb

1

sudo rpm -Uvh thingsboard-2.5.3.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 2.5.2. In order to upgrade to 2.5.3 you need to upgrade to 2.5.2 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.5.3.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.5.4

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 2.5.3. In order to upgrade to 2.5.4 you need to upgrade to 2.5.3 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.4/thingsboard-2.5.4.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.4/thingsboard-2.5.4.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.5.4.deb

1

sudo rpm -Uvh thingsboard-2.5.4.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 2.5.3. In order to upgrade to 2.5.4 you need to upgrade to 2.5.3 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.5.4.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.5.5

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 2.5.4. In order to upgrade to 2.5.5 you need to upgrade to 2.5.4 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.5/thingsboard-2.5.5.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.5/thingsboard-2.5.5.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.5.5.deb

1

sudo rpm -Uvh thingsboard-2.5.5.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 2.5.4. In order to upgrade to 2.5.5 you need to upgrade to 2.5.4 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.5.5.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 2.5.6

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 2.5.5. In order to upgrade to 2.5.6 you need to upgrade to 2.5.5 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.6/thingsboard-2.5.6.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.6/thingsboard-2.5.6.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-2.5.6.deb

1

sudo rpm -Uvh thingsboard-2.5.6.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 2.5.5. In order to upgrade to 2.5.6 you need to upgrade to 2.5.5 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-2.5.6.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.0

NOTE: These upgrade steps are applicable for Klyff version 2.5.6. In order to upgrade to 3.0 you need to upgrade to 2.5.6 first.

Ubuntu/CentOS

Doc info icon

Important note before upgrading to Klyff 3.0

  • Klyff UI was rewritten from AngularJS 1.5.8 to use Angular 9.
    • What does it mean?
      • Generally speaking, it means: state of the art application, easier development of front-end elements, performance improvements and more flexibility with UI customizations.
    • How to upgrade?
      • You are safe to upgrade if you do NOT use custom widgets or custom actions in the dashboards.
      • New JS framework may not support your current code — custom widgets and custom actions, so they need to be refactored a bit. Thus we encourage you to test your customizations using our cloud environments or your dev instances.
  • Migration from pure Cassandra to Hybrid DB Approach
    • We still support Cassandra for storing telemetry data but not the entities like devices, customers, tenants, etc.
    • What does it mean?
      • This will simplify maintenance and future improvements that will enable advanced search capabilities in v3.1.
    • How to upgrade?
      • If you are using pure PostgreSQL setup or PostgreSQL (for entities) + Cassandra (for telemetry), you are not affected.
      • If you are using pure Cassandra - the upgrade procedure is automatic but takes some time. The downtime depends on the number of devices, attributes, alarms and relations. If you have less than 10 million of those entities the upgrade should take a few minutes and depends on the database performance.


Doc info icon

Since Klyff 3.0 only PostgreSQL database is supported for entities data

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.0/thingsboard-3.0.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.0/thingsboard-3.0.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.0.deb

1

sudo rpm -Uvh thingsboard-3.0.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

NOTE: If you were using Cassandra database for entities data execute the following migration script:

1
2

# Execute migration script from Cassandra to PostgreSQL
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.5.0-cassandra

Otherwise execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.5.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 2.5.6. In order to upgrade to 3.0 you need to upgrade to 2.5.6 first.

Doc info icon

Important note before upgrading to Klyff 3.0

  • Klyff UI was rewritten from AngularJS 1.5.8 to use Angular 9.
    • What does it mean?
      • Generally speaking, it means: state of the art application, easier development of front-end elements, performance improvements and more flexibility with UI customizations.
    • How to upgrade?
      • You are safe to upgrade if you do NOT use custom widgets or custom actions in the dashboards.
      • New JS framework may not support your current code — custom widgets and custom actions, so they need to be refactored a bit. Thus we encourage you to test your customizations using our cloud environments or your dev instances.
  • Migration from pure Cassandra to Hybrid DB Approach
    • We still support Cassandra for storing telemetry data but not the entities like devices, customers, tenants, etc.
    • What does it mean?
      • This will simplify maintenance and future improvements that will enable advanced search capabilities in v3.1.
    • How to upgrade?
      • If you are using pure PostgreSQL setup or PostgreSQL (for entities) + Cassandra (for telemetry), you are not affected.
      • If you are using pure Cassandra - the upgrade procedure is automatic but takes some time. The downtime depends on the number of devices, attributes, alarms and relations. If you have less than 10 million of those entities the upgrade should take a few minutes and depends on the database performance.
Doc info icon

Since Klyff 3.0 only PostgreSQL database is supported for entities data

  • If you are using Cassandra database for entities data please install PostgreSQL database before proceeding upgrade procedure using the following guide:

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.0.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

NOTE: If you were using Cassandra database for entities data execute the following migration script:

1

C:\thingsboard>upgrade.bat --fromVersion=2.5.0-cassandra

Otherwise execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=2.5.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.0.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.0. In order to upgrade to 3.0.1 you need to upgrade to 3.0 first.


Doc info icon

Important note before upgrading to Klyff 3.0

  • Klyff UI was rewritten from AngularJS 1.5.8 to use Angular 9.
    • What does it mean?
      • Generally speaking, it means: state of the art application, easier development of front-end elements, performance improvements and more flexibility with UI customizations.
    • How to upgrade?
      • You are safe to upgrade if you do NOT use custom widgets or custom actions in the dashboards.
      • New JS framework may not support your current code — custom widgets and custom actions, so they need to be refactored a bit. Thus we encourage you to test your customizations using our cloud environments or your dev instances.
  • Migration from pure Cassandra to Hybrid DB Approach
    • We still support Cassandra for storing telemetry data but not the entities like devices, customers, tenants, etc.
    • What does it mean?
      • This will simplify maintenance and future improvements that will enable advanced search capabilities in v3.1.
    • How to upgrade?
      • If you are using pure PostgreSQL setup or PostgreSQL (for entities) + Cassandra (for telemetry), you are not affected.
      • If you are using pure Cassandra - the upgrade procedure is automatic but takes some time. The downtime depends on the number of devices, attributes, alarms and relations. If you have less than 10 million of those entities the upgrade should take a few minutes and depends on the database performance.


Doc info icon

Since Klyff 3.0 only PostgreSQL database is supported for entities data

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.0.1/thingsboard-3.0.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.0.1/thingsboard-3.0.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.0.1.deb

1

sudo rpm -Uvh thingsboard-3.0.1.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

NOTE: If you were using Cassandra database for entities data execute the following migration script:

1
2

# Execute migration script from Cassandra to PostgreSQL
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.5.0-cassandra

Otherwise execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.5.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.0. In order to upgrade to 3.0.1 you need to upgrade to 3.0 first.


Doc info icon

Important note before upgrading to Klyff 3.0

  • Klyff UI was rewritten from AngularJS 1.5.8 to use Angular 9.
    • What does it mean?
      • Generally speaking, it means: state of the art application, easier development of front-end elements, performance improvements and more flexibility with UI customizations.
    • How to upgrade?
      • You are safe to upgrade if you do NOT use custom widgets or custom actions in the dashboards.
      • New JS framework may not support your current code — custom widgets and custom actions, so they need to be refactored a bit. Thus we encourage you to test your customizations using our cloud environments or your dev instances.
  • Migration from pure Cassandra to Hybrid DB Approach
    • We still support Cassandra for storing telemetry data but not the entities like devices, customers, tenants, etc.
    • What does it mean?
      • This will simplify maintenance and future improvements that will enable advanced search capabilities in v3.1.
    • How to upgrade?
      • If you are using pure PostgreSQL setup or PostgreSQL (for entities) + Cassandra (for telemetry), you are not affected.
      • If you are using pure Cassandra - the upgrade procedure is automatic but takes some time. The downtime depends on the number of devices, attributes, alarms and relations. If you have less than 10 million of those entities the upgrade should take a few minutes and depends on the database performance.
Doc info icon

Since Klyff 3.0 only PostgreSQL database is supported for entities data

  • If you are using Cassandra database for entities data please install PostgreSQL database before proceeding upgrade procedure using the following guide:

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.0.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

NOTE: If you were using Cassandra database for entities data execute the following migration script:

1

C:\thingsboard>upgrade.bat --fromVersion=2.5.0-cassandra

Otherwise execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=2.5.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.0.1. In order to upgrade to 3.1 you need to upgrade to 3.0.1 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.1/thingsboard-3.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.1/thingsboard-3.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.1.deb

1

sudo rpm -Uvh thingsboard-3.1.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

NOTE: Cassandra database does not support advanced filters. If you were using Cassandra database for timeseries data please make sure that database.ts_latest.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) is “sql”:

1
2
3
4

  database:
  ...
    ts_latest:
      type: "${DATABASE_TS_LATEST_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

and execute the following migration script:

1
2

# Execute script to migrate latest timeseries data from Cassandra to PostgreSQL
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=cassandra-latest-to-postgres

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.0.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.0.1. In order to upgrade to 3.1 you need to upgrade to 3.0.1 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

NOTE: If you were using Cassandra database for entities data execute the following migration script:

1

C:\thingsboard>upgrade.bat --fromVersion=cassandra-latest-to-postgres

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.0.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.1.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.1. In order to upgrade to 3.1.1 you need to upgrade to 3.1 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.1.1/thingsboard-3.1.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.1.1/thingsboard-3.1.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.1.1.deb

1

sudo rpm -Uvh thingsboard-3.1.1.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.1.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.1. In order to upgrade to 3.1.1 you need to upgrade to 3.1 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.1.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.1.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.2

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.1.1. In order to upgrade to 3.2 you need to upgrade to 3.1.1 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2/thingsboard-3.2.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2/thingsboard-3.2.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.2.deb

1

sudo rpm -Uvh thingsboard-3.2.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.1.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.1.1. In order to upgrade to 3.2 you need to upgrade to 3.1.1 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.2.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.1.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.2.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.2. In order to upgrade to 3.2.1 you need to upgrade to 3.2 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2.1/thingsboard-3.2.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2.1/thingsboard-3.2.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.2.1.deb

1

sudo rpm -Uvh thingsboard-3.2.1.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.2.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.2. In order to upgrade to 3.2.1 you need to upgrade to 3.2 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.2.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.2.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.2.2

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.2.1. In order to upgrade to 3.2.2 you need to upgrade to 3.2.1 first.


doc warn icon

NOTE: Since Klyff version 3.2.2 Java 11 is used

Doc info icon

Please note that Cassandra 4.x is still in beta. Klyff is compatible with Cassandra 3.x as well. However, since Klyff 3.2.2+ requires Java 11 and Cassandra 3.x is not compatible with Java 8, you can’t launch Klyff 3.2.2+ and Cassandra 3.x on the same machine without separate docker containers for both..

Please consider using docker compose or other cluster setup to avoid issues with beta version of Cassandra.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2.2/thingsboard-3.2.2.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2.2/thingsboard-3.2.2.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.2.2.deb

1

sudo rpm -Uvh thingsboard-3.2.2.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.2.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.2.1. In order to upgrade to 3.2.2 you need to upgrade to 3.2.1 first.


doc warn icon

NOTE: Since Klyff version 3.2.2 Java 11 is used

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.2.2.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.2.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.3

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.2.2. In order to upgrade to 3.3 you need to upgrade to 3.2.2 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3/thingsboard-3.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3/thingsboard-3.3.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.3.deb

1

sudo rpm -Uvh thingsboard-3.3.rpm

NOTE: Package installer will ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

NOTE: If you were using MQTT over SSL instead of default MQTT, please make sure you have a proper configuration (thingsboard.conf and/or thingsboard.yml) of ports/addresses:

/etc/thingsboard/conf/thingsboard.conf

1
2
3
4
5
6

export MQTT_SSL_ENABLED=true
export MQTT_SSL_BIND_ADDRESS=0.0.0.0
export MQTT_SSL_BIND_PORT=8883

export MQTT_BIND_ADDRESS=0.0.0.0
export MQTT_BIND_PORT=1883

/etc/thingsboard/conf/thingsboard.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

transport:

. . .

  # Local MQTT transport parameters
  mqtt:
    # Enable/disable mqtt transport protocol.
    enabled: "${MQTT_ENABLED:true}"
    bind_address: "${MQTT_BIND_ADDRESS:0.0.0.0}"
    bind_port: "${MQTT_BIND_PORT:1883}"

. . .

    ssl:
      # Enable/disable SSL support
      enabled: "${MQTT_SSL_ENABLED:true}"
      # MQTT SSL bind address
      bind_address: "${MQTT_SSL_BIND_ADDRESS:0.0.0.0}"
      # MQTT SSL bind port
      bind_port: "${MQTT_SSL_BIND_PORT:8883}"

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.2.2

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.2.2. In order to upgrade to 3.3 you need to upgrade to 3.2.2 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.3.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • If you were using MQTT over SSL instead of default MQTT, please make sure you have a proper configuration (thingsboard.yml) of ports/addresses:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

transport:

. . .

  # Local MQTT transport parameters
  mqtt:
    # Enable/disable mqtt transport protocol.
    enabled: "${MQTT_ENABLED:true}"
    bind_address: "${MQTT_BIND_ADDRESS:0.0.0.0}"
    bind_port: "${MQTT_BIND_PORT:1883}"

. . .

    ssl:
      # Enable/disable SSL support
      enabled: "${MQTT_SSL_ENABLED:true}"
      # MQTT SSL bind address
      bind_address: "${MQTT_SSL_BIND_ADDRESS:0.0.0.0}"
      # MQTT SSL bind port
      bind_port: "${MQTT_SSL_BIND_PORT:8883}"
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.2.2

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.3.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.3.0. In order to upgrade to 3.3.1 you need to upgrade to 3.3.0 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.1/thingsboard-3.3.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.1/thingsboard-3.3.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.3.1.deb

1

sudo rpm -Uvh thingsboard-3.3.1.rpm

NOTE: Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.3.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.3.0. In order to upgrade to 3.3.1 you need to upgrade to 3.3.0 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.3.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

  database:
    ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
    ts:
      type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.3.0

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.3.2

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.3.1. In order to upgrade to 3.3.2 you need to upgrade to 3.3.1 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.2/thingsboard-3.3.2.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.2/thingsboard-3.3.2.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.3.2.deb

1

sudo rpm -Uvh thingsboard-3.3.2.rpm

NOTE: Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten. Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4

database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

Execute regular upgrade script:

1
2

# Execute regular upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.3.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.3.1. In order to upgrade to 3.3.2 you need to upgrade to 3.3.1 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.3.2.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <Klyff install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4

database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.3.1

Start the service

Doc info icon

If you use Redis for caching, you need to flush all stored keys before starting the Klyff.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for Klyff. If other applications use Redis, you need to locate the Klyff database and flush only that. The default database index is 0, configurable with REDIS_DB Klyff environment value.

redis-cli

select 0

flushdb

1

net start thingsboard

Upgrading to 3.3.3

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for Klyff version 3.3.2. In order to upgrade to 3.3.3 you need to upgrade to 3.3.2 first.

Doc info icon

Important note before upgrading to Klyff 3.3.3

Klyff UI was migrated to Angular 12. You need to re-build your custom widgets and rule nodes (which use UI) on Angular 12.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.3/thingsboard-3.3.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.3/thingsboard-3.3.3.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

$ sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.3.3.deb

1

sudo rpm -Uvh thingsboard-3.3.3.rpm

NOTE: Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Execute regular upgrade script:

1
2

# Execute regular upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.3.2

Start the service

1

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for Klyff version 3.3.2. In order to upgrade to 3.3.3 you need to upgrade to 3.3.2 first.

Doc info icon

Important note before upgrading to Klyff 3.3.3

Klyff UI was migrated to Angular 12. You need to re-build your custom widgets and rule nodes (which use UI) on Angular 12.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.3.3.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard

  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).

  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.

  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.

  • Finally, run upgrade.bat script to upgrade Klyff to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.3.2

Start the service

1

net start thingsboard

Upgrading to 3.3.4

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.3.3. In order to upgrade to 3.3.4 you need to upgrade to 3.3.3 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.4/thingsboard-3.3.4.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.4/thingsboard-3.3.4.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.3.4.deb

1

sudo rpm -Uvh thingsboard-3.3.4.rpm
Doc info icon

NOTE:
Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.3.3

Start the service

1

sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.3.3. In order to upgrade to 3.3.4 you need to upgrade to 3.3.3 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.3.4.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.3.3

Start the service

1

net start thingsboard

Upgrading to 3.3.4.1

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.3.4. In order to upgrade to 3.3.4.1 you need to upgrade to 3.3.4 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.4.1/thingsboard-3.3.4.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.4.1/thingsboard-3.3.4.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.3.4.1.deb

1

sudo rpm -Uvh thingsboard-3.3.4.1.rpm
Doc info icon

NOTE:
Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Start the service

1

sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.3.4. In order to upgrade to 3.3.4.1 you need to upgrade to 3.3.4 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.3.4.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.

Start the service

1

net start thingsboard

Upgrading to 3.4

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.3.4.1. In order to upgrade to 3.4 you need to upgrade to 3.3.4.1 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4/thingsboard-3.4.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4/thingsboard-3.4.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.4.deb

1

sudo rpm -Uvh thingsboard-3.4.rpm
Doc info icon

NOTE:
Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.3.4

Start the service

1

sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.3.4.1. In order to upgrade to 3.4 you need to upgrade to 3.3.4.1 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.4.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.3.4

Start the service

1

net start thingsboard

Upgrading to 3.4.1

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4. In order to upgrade to 3.4.1 you need to upgrade to 3.4 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.1/thingsboard-3.4.1.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.1/thingsboard-3.4.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.4.1.deb

1

sudo rpm -Uvh thingsboard-3.4.1.rpm
Doc info icon

NOTE:
Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.4.0

Start the service

1

sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4. In order to upgrade to 3.4.1 you need to upgrade to 3.4 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.4.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.4.0

Start the service

1

net start thingsboard

Upgrading to 3.4.2

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4.1. In order to upgrade to 3.4.2 you need to upgrade to 3.4.1 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.2/thingsboard-3.4.2.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.2/thingsboard-3.4.2.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.4.2.deb

1

sudo rpm -Uvh thingsboard-3.4.2.rpm
Doc info icon

NOTE:
Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Execute regular upgrade script:

1

sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.4.1

Start the service

1

sudo service thingsboard start
Doc info icon

Update the JWT signing key if you use the default one “thingsboardDefaultSigningKey” on production environments. See JWT security settings for details.

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4.1. In order to upgrade to 3.4.2 you need to upgrade to 3.4.1 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.4.2.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1

C:\thingsboard>upgrade.bat --fromVersion=3.4.1

Start the service

1

net start thingsboard
Doc info icon

Update the JWT signing key if you use the default one “thingsboardDefaultSigningKey” on production environments. See JWT security settings for details.

Upgrading to 3.4.3

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4.2. In order to upgrade to 3.4.3 you need to upgrade to 3.4.2 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.3/thingsboard-3.4.3.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.3/thingsboard-3.4.3.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.4.3.deb

1

sudo rpm -Uvh thingsboard-3.4.3.rpm
Doc info icon

NOTE:
Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Start the service

1

sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4.2. In order to upgrade to 3.4.3 you need to upgrade to 3.4.2 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.4.3.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.

Start the service

1

net start thingsboard

Upgrading to 3.4.4

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4.3. In order to upgrade to 3.4.4 you need to upgrade to 3.4.3 first.

Klyff package download

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.4/thingsboard-3.4.4.deb

1

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.4/thingsboard-3.4.4.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1

sudo service thingsboard stop

1

sudo dpkg -i thingsboard-3.4.4.deb

1

sudo rpm -Uvh thingsboard-3.4.4.rpm
Doc info icon

NOTE:
Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

Start the service

1

sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4.3. In order to upgrade to 3.4.4 you need to upgrade to 3.4.3 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.4.4.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1

net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.

Start the service

1

net start thingsboard

Next steps