...
|
...
|
@@ -4,15 +4,15 @@ This folder containing scripts and Kubernetes resources configurations to run Th |
4
|
4
|
|
5
|
5
|
## Prerequisites
|
6
|
6
|
|
7
|
|
-ThingsBoard Microservices are running on Kubernetes cluster.
|
|
7
|
+ThingsBoard Microservices run on the Kubernetes cluster.
|
8
|
8
|
You need to have a Kubernetes cluster, and the kubectl command-line tool must be configured to communicate with your cluster.
|
9
|
|
-If you do not already have a cluster, you can create one by using [Minikube](https://kubernetes.io/docs/setup/minikube),
|
|
9
|
+If you do not have a cluster already, you can create one by using [Minikube](https://kubernetes.io/docs/setup/minikube),
|
10
|
10
|
or you can choose any other available [Kubernetes cluster deployment solutions](https://kubernetes.io/docs/setup/pick-right-solution/).
|
11
|
11
|
|
12
|
12
|
### Enable ingress addon
|
13
|
13
|
|
14
|
|
-By default ingress addon is disable in the Minikube, and available only in cluster providers.
|
15
|
|
-To enable ingress, please execute next command:
|
|
14
|
+By default ingress addon is disabled in the Minikube, and available only in cluster providers.
|
|
15
|
+To enable ingress, please execute the following command:
|
16
|
16
|
|
17
|
17
|
`
|
18
|
18
|
$ minikube addons enable ingress
|
...
|
...
|
@@ -21,21 +21,21 @@ $ minikube addons enable ingress |
21
|
21
|
## Installation
|
22
|
22
|
|
23
|
23
|
Before performing initial installation you can configure the type of database to be used with ThingsBoard and the type of deployment.
|
24
|
|
-In order to set database type change the value of `DATABASE` variable in `.env` file to one of the following:
|
|
24
|
+To set database type change the value of `DATABASE` variable in `.env` file to one of the following:
|
25
|
25
|
|
26
|
26
|
- `postgres` - use PostgreSQL database;
|
27
|
27
|
- `cassandra` - use Cassandra database;
|
28
|
28
|
|
29
|
29
|
**NOTE**: According to the database type corresponding kubernetes resources will be deployed (see `postgres.yml`, `cassandra.yml` for details).
|
30
|
30
|
|
31
|
|
-In order to set deployment type change the value of `DEPLOYMENT_TYPE` variable in `.env` file to one of the following:
|
|
31
|
+To set deployment type change the value of `DEPLOYMENT_TYPE` variable in `.env` file to one of the following:
|
32
|
32
|
|
33
|
|
-- `basic` - start up with single instance of Zookeeper, Kafka and Redis;
|
34
|
|
-- `high-availability` - start up with Zookeeper, Kafka and Redis in cluster modes;
|
|
33
|
+- `basic` - startup with a single instance of Zookeeper, Kafka and Redis;
|
|
34
|
+- `high-availability` - startup with Zookeeper, Kafka, and Redis in cluster modes;
|
35
|
35
|
|
36
|
|
-**NOTE**: According to the deployment type corresponding kubernetes resources will be deployed (see content of the directories `./basic` and `./high-availability` for details).
|
|
36
|
+**NOTE**: According to the deployment type corresponding kubernetes resources will be deployed (see the content of the directories `./basic` and `./high-availability` for details).
|
37
|
37
|
|
38
|
|
-Execute the following command to run installation:
|
|
38
|
+Execute the following command to run the installation:
|
39
|
39
|
|
40
|
40
|
`
|
41
|
41
|
$ ./k8s-install-tb.sh --loadDemo
|
...
|
...
|
@@ -47,7 +47,7 @@ Where: |
47
|
47
|
|
48
|
48
|
## Running
|
49
|
49
|
|
50
|
|
-Execute the following command to deploy thirdparty resources:
|
|
50
|
+Execute the following command to deploy third-party resources:
|
51
|
51
|
|
52
|
52
|
`
|
53
|
53
|
$ ./k8s-deploy-thirdparty.sh
|
...
|
...
|
@@ -61,8 +61,8 @@ Execute the following command to deploy resources: |
61
|
61
|
$ ./k8s-deploy-resources.sh
|
62
|
62
|
`
|
63
|
63
|
|
64
|
|
-After a while when all resources will be successfully started you can open `http://{your-cluster-ip}` in you browser (for ex. `http://192.168.99.101`).
|
65
|
|
-You should see ThingsBoard login page.
|
|
64
|
+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`).
|
|
65
|
+You should see the ThingsBoard login page.
|
66
|
66
|
|
67
|
67
|
Use the following default credentials:
|
68
|
68
|
|
...
|
...
|
@@ -73,16 +73,16 @@ If you installed DataBase with demo data (using `--loadDemo` flag) you can also |
73
|
73
|
- **Tenant Administrator**: tenant@thingsboard.org / tenant
|
74
|
74
|
- **Customer User**: customer@thingsboard.org / customer
|
75
|
75
|
|
76
|
|
-In case of any issues you can examine service logs for errors.
|
|
76
|
+In case of any issues, you can examine service logs for errors.
|
77
|
77
|
For example to see ThingsBoard node logs execute the following commands:
|
78
|
78
|
|
79
|
|
-1) Get list of the running tb-node pods:
|
|
79
|
+1) Get the list of the running tb-node pods:
|
80
|
80
|
|
81
|
81
|
`
|
82
|
82
|
$ kubectl get pods -l app=tb-node
|
83
|
83
|
`
|
84
|
84
|
|
85
|
|
-2) Fetch logs of tb-node pod:
|
|
85
|
+2) Fetch logs of the tb-node pod:
|
86
|
86
|
|
87
|
87
|
`
|
88
|
88
|
$ kubectl logs -f [tb-node-pod-name]
|
...
|
...
|
@@ -103,7 +103,7 @@ Execute the following command to delete all ThingsBoard microservices: |
103
|
103
|
$ ./k8s-delete-resources.sh
|
104
|
104
|
`
|
105
|
105
|
|
106
|
|
-Execute the following command to delete all thirdparty microservices:
|
|
106
|
+Execute the following command to delete all third-party microservices:
|
107
|
107
|
|
108
|
108
|
`
|
109
|
109
|
$ ./k8s-delete-thirdparty.sh
|
...
|
...
|
|