- Step 1. Review the architecture page
- Step 2. Clone ThingsBoard CE Kubernetes scripts repository
- Step 3. Configure ThingsBoard database
- Step 4. Choose deployment type
- Step 5. Running
- Next steps
This guide will help you to setup ThingsBoard in cluster mode using OpenShift.
ThingsBoard Microservices run on the Kubernetes cluster. To deploy OpenShift cluster locally you’ll need to have Docker CE to run OpenShift containers and OpenShift Origin itself. Please follow these instructions to install all required software.
Log in to OpenShift cluster
To access OpenShift cluster you’ll have to login first. By default, you may login as the
` $ oc login -u developer -p developer `
On the first start-up you should create the
To create it, please execute next command:
` $ oc new-project thingsboard `
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 CE Kubernetes scripts repository
1 git clone https://github.com/thingsboard/thingsboard-ce-k8s.git
.env file set the value of
PLATFORM field to
Step 3. 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
high-availability/postgres-ha.yaml for postgres with replication,
common/cassandra.yml for details).
Step 4. Choose deployment type
Before performing initial installation you can configure the type of ThingsBoard deployment.
In order to set deployment type change the value of
DEPLOYMENT_TYPE variable in
.env file to one of the following:
basic- startup with a single instance of Zookeeper, Kafka and Redis;
high-availability- startup with Zookeeper, Kafka, and Redis in cluster modes;
NOTE: According to the deployment type corresponding kubernetes resources will be deployed (see the content of the directories
high-availability for details).
If you selected
DATABASE you can also configure the number of Cassandra nodes (
StatefulSet.spec.replicas property in
common/cassandra.yml config file) and the
It is recommended to have 3 Cassandra nodes with
CASSANDRA_REPLICATION_FACTOR equal to 1.
NOTE: If you want to configure
CASSANDRA_REPLICATION_FACTOR please read Cassandra documentation first.
Also, to run PostgreSQL in
high-availability deployment mode you’ll need to install
Step 5. Running
Execute the following command to run installation:
` $ ./k8s-install-tb.sh –loadDemo `
--loadDemo- optional argument. Whether to load additional demo data.
Execute the following command to deploy third-party resources:
` $ ./k8s-deploy-thirdparty.sh `
Type ‘yes’ when prompted, if you are running ThingsBoard in
DEPLOYMENT_TYPE for the first time or don’t have configured Redis cluster.
Execute the following command to deploy ThingsBoard resources:
` $ ./k8s-deploy-resources.sh `
To see how to reach your ThingsBoard application on cluster, login as developer user (default password is developer too), open
thingsboard project, then go to
Application -> Routes menu and you’ll see all your configured routes.
The root route should look like
When you open it, you should see ThingsBoard login page.
Use the following default credentials:
- System Administrator: [email protected] / sysadmin
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:
` $ oc get pods -l app=tb-node `
2) Fetch logs of the tb-node pod:
` $ oc logs -f [tb-node-pod-name] `
tb-node-pod-name- tb-node pod name obtained from the list of the running tb-node pods.
oc get pods to see the state of all the pods.
oc get services to see the state of all the services.
oc get deployments to see the state of all the deployments.
See oc Cheat Sheet command reference for details.
Execute the following command to delete all ThingsBoard microservices:
` $ ./k8s-delete-resources.sh `
Execute the following command to delete all third-party microservices:
` $ ./k8s-delete-thirdparty.sh `
Execute the following command to delete all resources (including database):
` $ ./k8s-delete-all.sh `
In case when database upgrade is needed, execute the following commands:
1 2 3 $ ./k8s-delete-resources.sh $ ./k8s-upgrade-tb.sh --fromVersion=[FROM_VERSION] $ ./k8s-deploy-resources.sh
FROM_VERSION- from which version upgrade should be started. See Upgrade Instructions for valid
Getting started guides - These guides provide quick overview of main ThingsBoard features. Designed to be completed in 15-30 minutes.
Connect your device - Learn how to connect devices based on your connectivity technology or solution.
Data visualization - These guides contain instructions how to configure complex ThingsBoard dashboards.
Data processing & actions - Learn how to use ThingsBoard Rule Engine.
IoT Data analytics - Learn how to use rule engine to perform basic analytics tasks.
Hardware samples - Learn how to connect various hardware platforms to ThingsBoard.
Advanced features - Learn about advanced ThingsBoard features.
Contribution and Development - Learn about contribution and development in ThingsBoard.