Professional Edition
ThingsBoard Documentation
Cloud Professional Edition Community Edition Edge IoT Gateway License Server Trendz Analytics Mobile Application PE Mobile Application
Try it now Pricing
ThingsBoard Professional Edition cluster setup with Kubernetes and Minikube guide
Getting Started Documentation Guides Installation Architecture API FAQ

On this page

ThingsBoard Professional Edition cluster setup with Kubernetes and Minikube guide

This guide will help you to setup ThingsBoard in cluster mode with Kubernetes and Minikube. For this purpose, we will use docker container images available on Docker Hub.

Prerequisites

ThingsBoard Microservices run on the Kubernetes cluster. You need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster. If you don’t have Minikube installed, please follow these instructions.

Enable ingress addon

Ingress addon disabled by default in the Minikube, and available only in cluster providers. To enable ingress, please execute the following command:

1
minikube addons enable ingress

Checkout ThingsBoard PE images from docker store

Please checkout all ThingsBoard PE Images from Docker Hub. You will need to open all verified images and click on “Proceed to checkout” to accept ThingsBoard PE license agreement.

Listing all images mandatory for checkout for your convenience below:

image

Populate basic information about yourself and click “Get Content”

image

Make sure your have logged in to docker hub using command line and run the following commands to verify that you can pull the images from the store using your account.

1
2
3
4
5
6
7
8
9
docker pull store/thingsboard/tb-pe-node:3.3.2PE
docker pull store/thingsboard/tb-pe-web-report:3.3.2PE
docker pull store/thingsboard/tb-pe-web-ui:3.3.2PE
docker pull store/thingsboard/tb-pe-js-executor:3.3.2PE
docker pull store/thingsboard/tb-pe-http-transport:3.3.2PE
docker pull store/thingsboard/tb-pe-mqtt-transport:3.3.2PE
docker pull store/thingsboard/tb-pe-coap-transport:3.3.2PE
docker pull store/thingsboard/tb-pe-lwm2m-transport:3.3.2PE
docker pull store/thingsboard/tb-pe-snmp-transport:3.3.2PE

Step 1. Review the architecture page

Starting ThingsBoard v2.2, it is possible to install ThingsBoard cluster using new microservices architecture and docker containers. See microservices architecture page for more details.

Step 2. Clone ThingsBoard PE Kubernetes scripts

1
2
git clone -b release-3.3.2 https://github.com/thingsboard/thingsboard-pe-k8s.git
cd thingsboard-pe-k8s/minikube

Step 3. Upload Docker credentials

Make sure your have logged in to docker hub using command line.

Then, we need to create thingsboard namespace, where secret must be stored:

1
kubectl apply -f tb-namespace.yml

To upload Docker credentials, please execute next command:

1
./k8s-upload-docker-credentials.sh

Script above will create the secret in the thingsboard namespace from host file $HOME/.docker/config.json.

Or you can use the following command, as alternative for k8s-upload-docker-credentials.sh:

1
kubectl create -n thingsboard secret docker-registry regcred --docker-server=https://index.docker.io/v1/ --docker-username=$YOUR_USERNAME --docker-password=$YOUR_PASSWORD --docker-email=$YOUR_EMAIL

Step 4. Obtain your license key

We assume you have already chosen your subscription plan or decided to purchase a perpetual license. If not, please navigate to pricing page to select the best license option for your case and get your license. See How-to get pay-as-you-go subscription or How-to get perpetual license for more details.

IMPORTANT NOTE: Make sure you have purchased a license key for at least two instances of ThingsBoard PE. Otherwise you need to modify local copy of docker-compose.yml to use only one ThingsBoard instance. We will reference the license key you have obtained during this step as PUT_YOUR_LICENSE_SECRET_HERE later in this guide.

Step 5. Configure your license key

1
nano tb-node.yml

and put the license secret parameter:

1
2
3
4
# tb-node StatefulSet configuration

- name: TB_LICENSE_SECRET
  value: "PUT_YOUR_LICENSE_SECRET_HERE"

Step 6. Configure ThingsBoard database

Before performing initial installation you can configure the type of database to be used with ThingsBoard. In order to set database type change the value of DATABASE variable in .env file to one of the following:

  • postgres - use PostgreSQL database;
  • hybrid - use PostgreSQL for entities database and Cassandra for timeseries database;

NOTE: According to the database type corresponding kubernetes resources will be deployed (see postgres.yml, cassandra.yml for details).

Step 7. Running

Execute the following command to run installation:

1
./k8s-install-tb.sh --loadDemo

Where:

  • --loadDemo - optional argument. Whether to load additional demo data.

Execute the following command to deploy third-party resources:

1
./k8s-deploy-thirdparty.sh

Execute the following command to deploy ThingsBoard resources:

1
./k8s-deploy-resources.sh

After a while when all resources will be successfully started you can open http://{your-cluster-ip} in your browser (for ex. http://192.168.99.101). You can see your cluster IP using command:

1
minikube ip

You should see ThingsBoard login page.

Use the following default credentials:

If you installed DataBase with demo data (using --loadDemo flag) you can also use the following credentials:

In case of any issues you can examine service logs for errors. For example to see ThingsBoard node logs execute the following command:

1) Get the list of the running tb-node pods:

1
kubectl get pods -l app=tb-node

2) Fetch logs of the tb-node pod:

1
kubectl logs -f [tb-node-pod-name]

Where:

  • tb-node-pod-name - tb-node pod name obtained from the list of the running tb-node pods.

Or use kubectl get pods to see the state of all the pods. Or use kubectl get services to see the state of all the services. Or use kubectl get deployments to see the state of all the deployments. See kubectl Cheat Sheet command reference for details.

Execute the following command to delete all ThingsBoard microservices:

1
./k8s-delete-resources.sh

Execute the following command to delete all third-party microservices:

1
./k8s-delete-thirdparty.sh

Execute the following command to delete all resources (including database):

1
./k8s-delete-all.sh

Upgrading

In case you would like to upgrade, please pull the latest changes from master branch:

1
git pull origin master

and then execute the following commands:

1
2
3
./k8s-delete-resources.sh
./k8s-upgrade-tb.sh --fromVersion=[FROM_VERSION]
./k8s-deploy-resources.sh

Where:

  • FROM_VERSION - from which version upgrade should be started. See Upgrade Instructions for valid fromVersion values.

Next steps