Cluster setup using Minikube

This guide walks you through setting up ThingsBoard Professional Edition in cluster mode using Kubernetes and Minikube with microservices architecture. Docker container images are available on Docker Hub.

For a simpler single-node installation, see Docker (Linux, macOS). For production cluster deployments, see Docker Compose (Cluster).

ThingsBoard microservices run on a Kubernetes cluster. You need:

• Minikube installed
• kubectl command-line tool configured to communicate with your cluster

By default the ingress addon is disabled in Minikube. Enable it:

minikube addons enable ingress

Verify that you can pull the images from Docker Hub:

docker pull thingsboard/tb-pe-node:4.3.1.1PE
docker pull thingsboard/tb-pe-web-report:4.3.1.1PE
docker pull thingsboard/tb-pe-web-ui:4.3.1.1PE
docker pull thingsboard/tb-pe-js-executor:4.3.1.1PE
docker pull thingsboard/tb-pe-http-transport:4.3.1.1PE
docker pull thingsboard/tb-pe-mqtt-transport:4.3.1.1PE
docker pull thingsboard/tb-pe-coap-transport:4.3.1.1PE
docker pull thingsboard/tb-pe-lwm2m-transport:4.3.1.1PE
docker pull thingsboard/tb-pe-snmp-transport:4.3.1.1PE

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

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

Edit the ThingsBoard node configuration:

nano tb-node.yml

Find the TB_LICENSE_SECRET environment variable and replace PUT_YOUR_LICENSE_SECRET_HERE with your actual license secret:

- name: TB_LICENSE_SECRET
  value: "PUT_YOUR_LICENSE_SECRET_HERE"

Edit the .env file to set the database type:

nano .env

Set the DATABASE variable to one of:

You may optionally install Trendz Analytics.

docker pull thingsboard/trendz:1.15.1
docker pull thingsboard/trendz-python-executor:1.15.1

Edit trendz/trendz-secret.yml and replace YOUR_RDS_ENDPOINT_URL and YOUR_RDS_PASSWORD, then apply:

kubectl apply -f ./trendz/trendz-secret.yml
kubectl apply -f ./trendz/trendz-create-db.yml

Check the logs:

kubectl logs job/trendz-create-db -n thingsboard

./k8s-deploy-trendz.sh

You should see Trendz installed successfully! in the console output.

1. Run the installation script:

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

   The --loadDemo flag loads sample tenant account, dashboards, and devices for evaluation and testing.

2. Deploy third-party resources:

   ./k8s-deploy-thirdparty.sh

   Type yes when prompted if you are running ThingsBoard in high-availability deployment type for the first time or don’t have a configured Redis cluster.

3. Deploy ThingsBoard resources:

   ./k8s-deploy-resources.sh

After all resources start, get the cluster IP:

minikube ip

Open http://{your-cluster-ip} in your browser. You should see the ThingsBoard login page. Use the following default credentials:

• System Administrator: [email protected] / sysadmin
• Tenant Administrator: [email protected] / tenant
• Customer User: [email protected] / customer

You can change passwords for each account in the account profile page.

See Getting Started for your next steps after login.

List running ThingsBoard node pods:

kubectl get pods -l app=tb-node

Stream logs of a specific pod:

kubectl logs -f TB_NODE_POD_NAME

Replace TB_NODE_POD_NAME with the pod name from the list above.

Other useful commands:

See the kubectl Cheat Sheet for more commands.

Delete ThingsBoard microservices:

./k8s-delete-resources.sh

Delete third-party services:

./k8s-delete-thirdparty.sh

Delete all resources including database:

./k8s-delete-all.sh

Pull the latest changes from the repository:

git pull origin master

Then run the upgrade:

./k8s-delete-resources.sh
./k8s-upgrade-tb.sh
./k8s-deploy-resources.sh

Pull the latest changes and run the upgrade:

git pull origin master
./k8s-upgrade-trendz.sh