diff --git a/_includes/templates/trendz/install/docker-compose.md b/_includes/templates/trendz/install/docker-compose.md index b194a98d09..3648a97c7f 100644 --- a/_includes/templates/trendz/install/docker-compose.md +++ b/_includes/templates/trendz/install/docker-compose.md @@ -3,7 +3,7 @@ services: trendz: profiles: ['trendz'] restart: always - image: "thingsboard/trendz:1.14.0" + image: "thingsboard/trendz:{{ site.release.trendz_ver }}" ports: - "8888:8888" environment: @@ -20,7 +20,7 @@ services: trendz-python-executor: profiles: ['trendz'] restart: always - image: "thingsboard/trendz-python-executor:1.14.0" + image: "thingsboard/trendz-python-executor:{{ site.release.trendz_ver }}" ports: - "8181:8181" environment: diff --git a/docs/pe/user-guide/ui/trendz-settings.md b/docs/pe/user-guide/ui/trendz-settings.md index aab457367a..fbcdb910bc 100644 --- a/docs/pe/user-guide/ui/trendz-settings.md +++ b/docs/pe/user-guide/ui/trendz-settings.md @@ -3,6 +3,11 @@ layout: docwithnav-pe title: Trendz settings description: ThingsBoard IoT platform Trendz settings +trendz-settings: + 0: + image: /images/user-guide/ui/trendz/trendz-settings.png + title: 'Trendz settings page.' + trendz-settings-sync-status: 0: image: /images/user-guide/ui/trendz/trendz-settings-sync-status-1.png @@ -13,17 +18,53 @@ trendz-settings-sync-status: --- +* TOC +{:toc} + On the **Trendz Settings** page, you can configure the connection to the [Trendz Analytics add-on](/docs/trendz/what-is-trendz). -Log in to ThingsBoard as a System Administrator. +## Prerequisites + +* Trendz addon should be activated for ThingsBoard instance on which you want to use Trendz. You can find out how to activate it [here](/docs/trendz/activation/self-managed). +* Trendz should be installed and accessible from ThingsBoard. You can find out how to install Trendz [here](/docs/trendz/install/installation-options). -![image](/images/user-guide/ui/trendz/trendz-settings.png) +## How to Access + +* Log in to ThingsBoard as a System Administrator. +* Click **Trendz settings** tab in the left menu. + +{% include images-gallery.html imageCollection="trendz-settings" %} + +## Trendz Configuration Here you can set up **Trendz Configuration**: * **Trendz Internal URL** - URL used by ThingsBoard to communicate with Trendz. * **ThingsBoard Internal URL** - URL used by Trendz to communicate with ThingsBoard. +### Examples + +Url examples for different installation types: + +* **Ubuntu / Windows / CentOS / RHEL (Trendz and ThingsBoard installed on the same machine)**: + - Trendz Internal URL - `http://localhost:8888` + - ThingsBoard Internal URL - `http://localhost:8080` + +* **Docker (Trendz and ThingsBoard are in the same docker compose files)**: + - Trendz Internal URL - `http://trendz:8888` + - ThingsBoard Internal URL - `http://thingsboard-pe:8080` + +* **Kubernetes (ThingsBoard and Trendz are in the same cluster)**: + - Trendz Internal URL - `http://trendz-app:8888` + - ThingsBoard Internal URL - `http://tb-node:8080` + +If Trendz and ThingsBoard are unreachable for each other in the private network, you can use your public URLs. For example, if ThingsBoard and Trendz under the same domain **mydomain**: + - Trendz Internal URL - `https://mydomain` + - ThingsBoard Internal URL - `https://mydomain` + +## Actions + You can do the next **Actions** on this page: + * **Save Configuration** - Saves the URLs entered in the text boxes for Trendz and ThingsBoard. * **Retry Discovery** - Initiates synchronization with Trendz using the **saved configuration**. * **Retry Healthcheck** - (Visible only if Trendz is synced with ThingsBoard) Checks if the Trendz sync contains any errors at the current moment. diff --git a/docs/trendz/install/trndz-upgrade-instructions-kubernetes.md b/docs/trendz/install/trndz-upgrade-instructions-kubernetes.md index 60799bfb93..228872b796 100644 --- a/docs/trendz/install/trndz-upgrade-instructions-kubernetes.md +++ b/docs/trendz/install/trndz-upgrade-instructions-kubernetes.md @@ -43,15 +43,15 @@ kubectl scale deployment trendz-app-deployment --replicas=1 ### Step 4. Create flag-file Create a file “.upgradeversion” inside the directory by calling the command that must be executed by Trendz pod. -Run the command: +Run the command (replace 1.14.0 with Trendz version **from** which you are updating): ```text kubectl exec -- sh -c "echo '1.14.0' > /data/.upgradeversion" -``` +``` + You can get the pod name by the command: ```text kubectl get pods -l app=trendz-app-pod-label -``` -Use another version instead of '1.14.0 if another is needed +``` ### Step 5. Change image version diff --git a/images/user-guide/ui/trendz/trendz-settings-preview.png b/images/user-guide/ui/trendz/trendz-settings-preview.png new file mode 100644 index 0000000000..0835b9397a Binary files /dev/null and b/images/user-guide/ui/trendz/trendz-settings-preview.png differ