Skip to content

docker-compose-setup.md

Latest commit

 

History

History
89 lines (59 loc) · 3.08 KB

docker-compose-setup.md

File metadata and controls

89 lines (59 loc) · 3.08 KB
layout docwithnav
assignees
ashvayka
title Cluster setup with Docker Compose
description ThingsBoard IoT platform cluster setup with Docker Compose guide
  • TOC {:toc}

This guide will help you to setup ThingsBoard in cluster mode using Docker Compose tool.

Prerequisites

ThingsBoard Microservices are running in dockerized environment. Before starting please make sure Docker Engine and Docker Compose are installed in your system.

{% include templates/install/docker-install.md %}

{% include templates/install/docker-install-note.md %}

Step 1. Pull ThingsBoard CE Images

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

docker pull thingsboard/tb-node:{{ site.release.ce_full_ver }}
docker pull thingsboard/tb-web-ui:{{ site.release.ce_full_ver }}
docker pull thingsboard/tb-js-executor:{{ site.release.ce_full_ver }}
docker pull thingsboard/tb-http-transport:{{ site.release.ce_full_ver }}
docker pull thingsboard/tb-mqtt-transport:{{ site.release.ce_full_ver }}
docker pull thingsboard/tb-coap-transport:{{ site.release.ce_full_ver }}
docker pull thingsboard/tb-lwm2m-transport:{{ site.release.ce_full_ver }}
docker pull thingsboard/tb-snmp-transport:{{ site.release.ce_full_ver }}

Step 2. 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 3. Clone ThingsBoard CE repository

git clone -b {{ site.release.branch }} https://github.com/thingsboard/thingsboard.git --depth 1
cd thingsboard/docker

{: .copy-code}

Step 4. Configure ThingsBoard database

{% include templates/install/configure-db-docker-compose.md %}

Step 5. Choose ThingsBoard queue service

{% include templates/install/install-queue-docker-compose.md %}

{% capture contenttogglespecqueue %} Kafka (default, recommended for on-prem, production installations)%,%kafka%,%templates/install/cluster-queue-kafka.md%br% Confluent Cloud (Event Streaming Platform based on Kafka)%,%confluent-cloud%,%templates/install/cluster-queue-confluent-cloud.md{% endcapture %} {% include content-toggle.liquid content-toggle-id="ubuntuThingsboardQueue" toggle-spec=contenttogglespecqueue %}

Step 6. Enable monitoring (optional)

{% include templates/install/configure-monitoring-docker-compose.md %}

Step 7. Running

Create and check required host volumes

{% include templates/install/docker/docker-compose-setup-volumes.md %}

Install and run ThingsBoard

{% assign dockerComposeFileLocation = "" %} {% assign peEdition = false %} {% include templates/install/docker/docker-compose-setup-running.md %}

Post-installation steps

{% include templates/install/generate_certificate_docker-compose.md %}

Upgrading to new ThingsBoard version

{% include templates/install/upgrade-thingsboard.md %}

Next steps

{% assign currentGuide = "InstallationGuides" %}{% include templates/guides-banner.md %}