Skip to content

Commit 9ae90f7

Browse files
ashvaykaashvayka
authored
Merge pull request thingsboard#681 from volodymyr-babak/edge-update
Edge update
2 parents fde5ad1 + 1076c76 commit 9ae90f7

12 files changed

+67
-43
lines changed

‎_includes/templates/edge/beta-warning.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎_includes/templates/edge/ce-cloud.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Server UI will be available using the URL: [Live Demo](https://demo.thingsboard.io/signup).
22
Please use your [Live Demo](https://demo.thingsboard.io/signup) tenant credentials to log in.
33

4+
{% include templates/edge/oauth2-not-supported.md %}
5+
46
We are going to refer to this URL as **http://SERVER_URL** below in tutorial.
57

68
ThingsBoard **Edge** UI will be available using the URL: [http://localhost:8080](http://localhost:8080).

‎_includes/templates/edge/edge-service-port-warn.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{% capture edge_service_port_warn %}
2+
**NOTE**: This port must be accessible by edge to be able to communicate. Please update your firewall settings or docker configuration if required.
3+
4+
{% endcapture %}
5+
{% include templates/warn-banner.md content=edge_service_port_warn %}

‎_includes/templates/edge/getting-started/prerequisites.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ To provision ThingsBoard **Edge** on {{currentThingsBoardVersion}} server please
1414
Once ThingsBoard **Edge** provisioned on {{currentThingsBoardVersion}} server please follow [Installation Guide](/docs/edge/install/installation-options/) - this guide will help you to install ThingsBoard **Edge** and connect it to {{currentThingsBoardVersion}} server.
1515

1616
{% if currentThingsBoardVersion == "ThingsBoard Professional Edition" %}
17-
{% include templates/edge/on-premise-cloud.md %}
17+
{% capture contenttogglespec %}
18+
Cloud<br/><small>Connect edge to https://thingsboard.cloud</small>%,%ce%,%templates/edge/pe-cloud.md%br%
19+
On-premise server<br/><small>Connect edge to on-premise instance</small>%,%pe%,%templates/edge/on-premise-cloud.md{% endcapture %}
20+
{% include content-toggle.html content-toggle-id="cloudType" toggle-spec=contenttogglespec %}
1821
{% endif %}
1922
{% if currentThingsBoardVersion == "ThingsBoard Community Edition" %}
2023
{% capture contenttogglespec %}
2124
Live Demo<br/><small>Connect edge to https://demo.thingsboard.io</small>%,%ce%,%templates/edge/ce-cloud.md%br%
2225
On-premise server<br/><small>Connect edge to on-premise instance</small>%,%pe%,%templates/edge/on-premise-cloud.md{% endcapture %}
23-
{% include content-toggle.html content-toggle-id="cloudType" toggle-spec=contenttogglespec %}
26+
{% include content-toggle.html content-toggle-id="cloudType" toggle-spec=contenttogglespec %}
2427
{% endif %}
2528

2629
{% include templates/edge/bind-port-changed-banner.md %}

‎_includes/templates/edge/install/open-edge-ui.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Once started, you will be able to open ThingsBoard **Edge** UI using the following link [http://localhost:8080](http://localhost:8080).
32

43
{% include templates/edge/bind-port-changed-banner.md %}

‎_includes/templates/edge/install/ubuntu-configure-edge.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,44 @@ sudo nano /etc/tb-edge/conf/tb-edge.conf
44
```
55
{: .copy-code}
66

7-
Add the following lines to the configuration file. Don't forget **to replace**:
7+
Update the following lines in the configuration file. Don't forget **to replace**:
88
* "PUT_YOUR_POSTGRESQL_PASSWORD_HERE" with your **real postgres user password**.
99
* "PUT_YOUR_CLOUD_IP" with an IP address of the machine where ThingsBoard **Professional Edition/Community Edition** server is running:
10-
* Use **thingsboard.cloud** in case you are connecting edge to [**ThingsBoard Cloud**](https://thingsboard.cloud/signup).
10+
* Use **thingsboard.cloud** in case you are connecting edge to [**ThingsBoard Cloud**](https://thingsboard.cloud/signup).
11+
12+
**NOTE**: **thingsboard.cloud** uses SSL protocol for edge communication.
13+
Please uncomment **export CLOUD_RPC_SSL_ENABLED=true** as well.
14+
1115
* Use **localhost** in case edge is running on the same machine where cloud instance is running.
1216
* Use **X.X.X.X** IP address in case edge is connecting to the cloud instance in the same network or in the docker.
1317
* Or use **demo.thingsboard.io** if you are connecting edge to [**ThingsBoard Live Demo**](https://demo.thingsboard.io/signup) for evaluation.
1418
* "PUT_YOUR_EDGE_KEY_HERE" and "PUT_YOUR_EDGE_SECRET_HERE" with Edge **key and secret** respectively (edge credentials you can find in cloud instance):
1519

1620
```bash
1721
# UNCOMMENT NEXT LINES AND PUT YOUR CLOUD CONNECTION SETTINGS:
18-
export CLOUD_ROUTING_KEY=PUT_YOUR_EDGE_KEY_HERE
19-
export CLOUD_ROUTING_SECRET=PUT_YOUR_EDGE_SECRET_HERE
20-
# UNCOMMENT NEXT LINES IF YOU CHANGE DEFAULT CLOUD RPC HOST/PORT SETTINGS:
21-
export CLOUD_RPC_HOST=PUT_YOUR_CLOUD_IP
22-
export CLOUD_RPC_PORT=7070
22+
# export CLOUD_ROUTING_KEY=PUT_YOUR_EDGE_KEY_HERE
23+
# export CLOUD_ROUTING_SECRET=PUT_YOUR_EDGE_SECRET_HERE
24+
25+
# UNCOMMENT NEXT LINES IF EDGE CONNECTS TO PE 'THINGSBOARD.CLOUD' SERVER:
26+
# export CLOUD_RPC_HOST=thingsboard.cloud
27+
# export CLOUD_RPC_SSL_ENABLED=true
28+
29+
# UNCOMMENT NEXT LINES IF EDGE CONNECTS TO CE 'DEMO.THINGSBOARD.IO' SERVER:
30+
# export CLOUD_RPC_HOST=demo.thingsboard.io
31+
32+
# UNCOMMENT NEXT LINES IF YOU CHANGED DEFAULT CLOUD RPC HOST/PORT SETTINGS:
33+
# export CLOUD_RPC_HOST=PUT_YOUR_CLOUD_IP
34+
# export CLOUD_RPC_PORT=7070
35+
36+
# UNCOMMENT NEXT LINES IF YOU ARE RUNNING EDGE ON THE SAME MACHINE WHERE THINGSBOARD SERVER IS RUNNING:
37+
# export HTTP_BIND_PORT=18080
38+
# export MQTT_BIND_PORT=11883
39+
# export COAP_BIND_PORT=15683
40+
2341
# UNCOMMENT NEXT LINES IF YOU HAVE CHANGED DEFAULT POSTGRESQL DATASOURCE SETTINGS:
24-
export SPRING_DATASOURCE_URL=jdbc:postgresql://localhost:5432/tb_edge
25-
export SPRING_DATASOURCE_USERNAME=postgres
26-
export SPRING_DATASOURCE_PASSWORD=PUT_YOUR_POSTGRESQL_PASSWORD_HERE
42+
# export SPRING_DATASOURCE_URL=jdbc:postgresql://localhost:5432/tb_edge
43+
# export SPRING_DATASOURCE_USERNAME=postgres
44+
# export SPRING_DATASOURCE_PASSWORD=PUT_YOUR_POSTGRESQL_PASSWORD_HERE
2745
```
2846
{: .copy-code}
2947

‎_includes/templates/edge/install/windows-configure-edge.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,24 @@ spring:
3434
Locate "# Cloud configuration" block and replace **PUT_YOUR_EDGE_KEY_HERE** and **PUT_YOUR_EDGE_SECRET_HERE** with Edge **key and secret** respectively.
3535
3636
Please replace **PUT_YOUR_CLOUD_IP** with an IP address of the machine where ThingsBoard CE/PE version is running:
37-
* Use **thingsboard.cloud** in case you are connecting edge to [**ThingsBoard Cloud**](https://thingsboard.cloud/signup).
37+
* Use **thingsboard.cloud** in case you are connecting edge to [**ThingsBoard Cloud**](https://thingsboard.cloud/signup).
38+
39+
**NOTE**: **thingsboard.cloud** uses SSL protocol for edge communication.
40+
Please change **CLOUD_RPC_SSL_ENABLED** to **true** as well.
41+
3842
* Use **localhost** in case edge is running on the same machine where cloud instance is running.
3943
* Use **X.X.X.X** IP address in case edge is connecting to the cloud instance in the same network or in the docker.
4044
* Or use **demo.thingsboard.io** if you are connecting edge to [**ThingsBoard Live Demo**](https://demo.thingsboard.io/signup) for evaluation.
41-
45+
4246
```yml
4347
# Cloud configuration
4448
cloud:
4549
routingKey: "${CLOUD_ROUTING_KEY:PUT_YOUR_EDGE_KEY_HERE}"
4650
secret: "${CLOUD_ROUTING_SECRET:PUT_YOUR_EDGE_SECRET_HERE}"
4751
rpc:
4852
host: "${CLOUD_RPC_HOST:PUT_YOUR_CLOUD_IP}"
53+
ssl:
54+
enabled: "${CLOUD_RPC_SSL_ENABLED:false}"
4955
```
5056
5157
{% capture local-deployment %}

‎_includes/templates/edge/oauth2-not-supported.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{% capture oauth2-not-supported %}
2+
At the moment Edge doesn't support OAuth 2.0 login. To be able to login into Edge with your OAuth 2.0 user, you must set password for this user in the ThingsBoard server.
3+
{% endcapture %}
4+
{% include templates/info-banner.md content=oauth2-not-supported %}

‎_includes/templates/edge/obtain-pe-cloud.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1-
Please visit [Install PE](/docs/user-guide/install/pe/installation-options/) to install **3.3** version or higher of server that supports edge functionality.
1+
The easiest way is to use [**ThingsBoard Cloud**](https://thingsboard.cloud/signup) server.
22
<br/>
3-
At the moment [**ThingsBoard Cloud**](https://thingsboard.cloud/signup) doesn't support edge functionality. This will be available in **October 2021**.
3+
The alternative option is to install ThingsBoard Professional Edition server that supports edge functionality on-premise.
4+
Please visit [Install PE](/docs/user-guide/install/pe/installation-options/) to install **3.3** version or higher of server that supports edge functionality.

‎_includes/templates/edge/pe-cloud.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Server UI will be available using the URL: [Cloud](https://thingsboard.cloud/signup).
2+
Please use your [Cloud](https://thingsboard.cloud/signup) tenant credentials to log in.
3+
4+
{% include templates/edge/oauth2-not-supported.md %}
5+
6+
We are going to refer to this URL as **http://SERVER_URL** below in tutorial.
7+
8+
ThingsBoard **Edge** UI will be available using the URL: [http://localhost:8080](http://localhost:8080).
9+
You may use your [Demo](https://thingsboard.cloud/signup) tenant credentials to log in.

‎docs/edge/enable-edge.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ export EDGES_RPC_PORT=**NEW_EDGES_RPC_PORT**
4444
```
4545
{: .copy-code}
4646

47-
**NOTE**: This port must be accessible by edge to be able to communicate. Please update your firewall settings or docker configuration if required.
47+
{% include templates/edge/edge-service-port-warn.md %}
4848

4949
{% include templates/edge/ssl-grpc-note.md %}
5050

@@ -108,7 +108,7 @@ locate "EDGES_RPC_PORT" parameter. Replace "7070" with "**NEW_EDGES_RPC_PORT**".
108108
port: "${EDGES_RPC_PORT:NEW_EDGES_RPC_PORT}"
109109
```
110110
111-
**NOTE**: This port must be accessible by edge to be able to communicate. Please update your firewall settings or docker configuration if required.
111+
{% include templates/edge/edge-service-port-warn.md %}
112112
113113
{% include templates/edge/ssl-grpc-note.md %}
114114

‎docs/edge/provision-edge-on-server-ce.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ addEdge:
1212
title: 'Click on the "+" icon in the top right corner. Select "Add new edge".'
1313
2:
1414
image: /images/edge/installation-add-edge-item-3-ce.png
15-
title: 'Input edge name and license key (from Step 1). For example, "My New Edge" and "Bsn3L4B089aXXZEiwf2glidK". Additionally, please update cloud endpoint if required - this URL should be accessible by the edge. If edge is running in a docker container "localhost" is always <b>wrong</b>. It must be IP address of the machine where ThingsBoard <b>CE</b> is running and accessible by the edge container. If you are using ThingsBoard <b>Live Demo</b> server to evaluate edge please set it as <b>https://demo.thingsboard.io</b>. Click "Add" to add the edge.'
15+
title: 'Input edge name and license key (from Step 1). For example, "My New Edge" and "XXXXXXYYYYYYZZZZZZ". Additionally, please update cloud endpoint if required - this URL should be accessible by the edge. If edge is running in a docker container "localhost" is always <b>wrong</b>. It must be IP address of the machine where ThingsBoard <b>CE</b> is running and accessible by the edge container. If you are using ThingsBoard <b>Live Demo</b> server to evaluate edge please set it as <b>https://demo.thingsboard.io</b>. Click "Add" to add the edge.'
1616
3:
1717
image: /images/edge/installation-add-edge-item-4-ce.png
1818
title: 'Now your edge should be listed first, since table sort edges using created time by default.'

0 commit comments

Comments
 (0)