Trendz 1.15.0 docs

_config.yml

@@ -102,4 +102,4 @@ release:
   pe_dart_client_ver: 4.0.0
   broker_full_ver: 2.2.0
   broker_branch: release-2.2.0
-  trendz_ver: 1.14.0
+  trendz_ver: 1.15.0

_data/installation-options/installation-options-trendz.yml

@@ -19,7 +19,7 @@ trendz:
     imageHeight: 36
   2:
     title: Ubuntu Server
-    description: This guide describes how to install Trendz Analytics on Ubuntu 18.04 LTS / Ubuntu 20.04 LTS.
+    description: This guide describes how to install Trendz Analytics on Ubuntu 22.04 LTS / Ubuntu 24.04 LTS.
     link: /docs/trendz/install/ubuntu/
     icon: /images/install/platform/ubuntu.svg
     alt: Ubuntu logo
@@ -28,7 +28,7 @@ trendz:
     imageHeight: 36
   3:
     title: CentOS/RHEL Server
-    description: This guide describes how to install Trendz Analytics on RHEL/CentOS 7/8.
+    description: This guide describes how to install Trendz Analytics on RHEL/CentOS 8/9.
     link: /docs/trendz/install/rhel/
     icon: /images/install/platform/centos-redhat.svg
     alt: CentOS and Red Hat logos
@@ -45,12 +45,12 @@ trendz:
     imageWidth: 35
     imageHeight: 36
   5:
-    title: Trendz Cloud
-    description: Activate Trendz Analytics Cloud with your account to explore powerful data visualization and analytics.
+    title: Cloud
+    description: Activate Trendz Analytics with your ThingsBoard Cloud account.
     link: /docs/trendz/install/cloud/
     icon: /images/install/platform/trendz-cloud.svg
-    alt: Trendz Cloud logo
-    imageTitleAttribute: Activate Trendz Analytics Cloud
+    alt: ThingsBoard Cloud logo
+    imageTitleAttribute: Activate Trendz Analytics on ThingsBoard Cloud
     imageWidth: 58
     imageHeight: 36
   6:

_data/pages_info.yml

@@ -4690,11 +4690,8 @@
 "/docs/trendz/install/kubernetes/":
   url: "/docs/trendz/install/kubernetes/"
   redirect_from: []
-"/docs/trendz/install/python-executor-configuration-linux/":
-  url: "/docs/trendz/install/python-executor-configuration-linux/"
-  redirect_from: []
-"/docs/trendz/install/python-executor-configuration-windows/":
-  url: "/docs/trendz/install/python-executor-configuration-windows/"
+"/docs/trendz/install/python-executor-configuration/":
+  url: "/docs/trendz/install/python-executor-configuration/"
   redirect_from: []
 "/docs/trendz/install/rhel/":
   url: "/docs/trendz/install/rhel/"

_data/trendz/docs-home.yml

@@ -99,7 +99,7 @@ toc:
   section:
     - title: Trendz AI Assistant
       path: /docs/trendz/ai-assistance-overview/
-    - title: AI Assistant Widget
+    - title: Advanced analytics Chat Assistant widget
       path: /docs/trendz/ai-assistance-widget/
     - title: AI Widget Summary
       path: /docs/trendz/ai-widget-summary/
@@ -109,7 +109,7 @@ toc:
       path: /docs/trendz/custom-ai-model-configuration/
 - title: Share views
   section:
-    - title: Trendz widget bundle
+    - title: Advanced analytics Bundle
       path: /docs/trendz/trendz-bundle/
     - title: Add on dashboard
       path: /docs/trendz/embed-visuals/

_data/trendz/globals.yml

@@ -3,6 +3,7 @@ tocs:
 - getting-started
 - guides
 - installation
+- how-to-activate-trendz
 docs-header:
 - toc: getting-started
   title: Getting Started
@@ -11,4 +12,6 @@ docs-header:
 - toc: guides
   title: Guides
 - toc: installation
-  title: Installation
+  title: Installation
+- toc: how-to-activate-trendz
+  title: How To Activate Trendz

_data/trendz/how-to-activate-trendz.yml

@@ -0,0 +1,11 @@
+bigheader: "How to Activate Trendz"
+abstract: "Guide how to activate Trendz Analytics"
+toc:
+- title: How to Activate Trendz
+  path: /docs/trendz/activation/how-to/
+- title: ThingsBoard Cloud
+  path: /docs/trendz/activation/public-cloud/
+- title: ThingsBoard Private Cloud
+  path: /docs/trendz/activation/private-cloud/
+- title: Self-Hosted ThingsBoard (PE)
+  path: /docs/trendz/activation/self-hosted/

_data/trendz/installation.yml

@@ -3,7 +3,7 @@ abstract: "Documentation for installation and configuration of Trendz Analytics.
 toc:
 - title: Installation options
   path: /docs/trendz/install/installation-options/
-- title: Trendz Cloud
+- title: Cloud
   path: /docs/trendz/install/cloud/
 - title: On-premises
   section:
@@ -26,14 +26,6 @@ toc:
   - title: Kubernetes
     path: /docs/trendz/install/trndz-upgrade-instructions-kubernetes/
 - title: Python Executor Configuration
-  section:
-  - title: Windows
-    path: /docs/trendz/install/python-executor-configuration-windows/
-  - title: Linux or Mac OS
-    path: /docs/trendz/install/python-executor-configuration-linux/
-- title: Connect Trendz to Thingsboard
-  path: /docs/trendz/connect-thingsboard/
+  path: /docs/trendz/install/python-executor-configuration/
 - title: Configuration properties
   path: /docs/trendz/configuration-properties/
-- title: Post-installation steps
-  path: /docs/trendz/post-installation-steps/

_includes/docs/pe/user-guide/install/trendz-ad.md

@@ -0,0 +1,8 @@
+{% capture trendz-ad %}
+Note: from ThingsBoard version 4.3.0 **Trendz Analytics** became ThingsBoard addon. The Trendz home page will appear in the left ThingsBoard menu after the upgrade.
+<br>
+You can find out how to read more what is **Trendz Analytics** and how it complements the ThingsBoard analytics functionality [here](/docs/trendz/what-is-trendz/).
+<br>
+You can find out how to install Trendz Analytics [here](/docs/trendz/install/installation-options/).
+{% endcapture %}
+{% include templates/info-banner.md content=trendz-ad %}

_includes/templates/trendz/install/authentication.md

@@ -0,0 +1,9 @@
+You can access Trendz UI by default at http://localhost:8888
+
+For first authentication, you need to use **Tenant Administrator** credentials from your **ThingsBoard**.
+
+Trendz uses ThingsBoard as an authentication service. During first sign in ThingsBoard service should be also available
+to validate credentials.
+
+After the first login to Trendz, you need to discover topology to allow Trendz to know about assets, devices, their profiles and relations.
+You could read more about how Trendz uses this topology [here](/docs/trendz/business-entities).

_includes/templates/trendz/install/docker-compose-separate-file-linux.md

@@ -0,0 +1,10 @@
+Create a docker compose file for Trendz Analytics service:
+
+```text
+sudo nano docker-compose.yml
+```
+{: .copy-code}
+
+Add the following configuration to the YAML file.
+
+{% include templates/trendz/install/docker-compose.md %}

_includes/templates/trendz/install/docker-compose-separate-file-windows.md

@@ -0,0 +1,10 @@
+Create a docker compose file for Trendz Analytics service:
+
+```text
+docker-compose.yml
+```
+{: .copy-code}
+
+Add the following configuration to the YAML file.
+
+{% include templates/trendz/install/docker-compose.md %}

_includes/templates/trendz/install/docker-compose-the-same-file-linux.md

@@ -0,0 +1,24 @@
+Open the Docker Compose file with ThingsBoard services:
+
+```text
+sudo nano docker-compose.yml
+```
+
+{: .copy-code}
+
+Make sure that:
+
+* the following services are present in the file:
+    * trendz
+    * trendz-python-executor
+    * trendz-postgres
+* the following volumes are present in the file:
+    * trendz-conf
+    * trendz-data
+    * trendz-python-executor-conf
+    * trendz-python-executor-data
+    * trendz-postgres-data
+
+If any of them are missing, update your Docker Compose file according to the [ThingsBoard Docker installation instructions](/docs/user-guide/install/pe/docker#step-2-choose-thingsboard-queue-service).
+
+Your Docker Compose file should be similar to the one shown in the instructions.

_includes/templates/trendz/install/docker-compose-the-same-file-windows.md

@@ -0,0 +1,23 @@
+Open the Docker Compose file with ThingsBoard services:
+
+```text
+docker-compose.yml
+```
+{: .copy-code}
+
+Make sure that:
+
+* the following services are present in the file:
+    * trendz
+    * trendz-python-executor
+    * trendz-postgres
+* the following volumes are present in the file:
+    * trendz-conf
+    * trendz-data
+    * trendz-python-executor-conf
+    * trendz-python-executor-data
+    * trendz-postgres-data
+
+If any of them are missing, update your Docker Compose file according to the [ThingsBoard Docker installation instructions](/docs/user-guide/install/pe/docker-windows#step-2-choose-thingsboard-queue-service).
+
+Your Docker Compose file should be similar to the one shown in the instructions.

_includes/templates/trendz/install/docker-compose.md

@@ -0,0 +1,75 @@
+```yml
+services:
+  trendz:
+    profiles: ['trendz']
+    restart: always
+    image: "thingsboard/trendz:1.14.0"
+    ports:
+      - "8888:8888"
+    environment:
+      SPRING_DATASOURCE_URL: jdbc:postgresql://trendz-postgres:5432/trendz
+      SPRING_DATASOURCE_USERNAME: postgres
+      SPRING_DATASOURCE_PASSWORD: postgres
+      SCRIPT_ENGINE_DOCKER_PROVIDER_URL: trendz-python-executor:8181
+      SCRIPT_ENGINE_TIMEOUT: 30000
+    volumes:
+      - trendz-conf:/trendz-config-files
+      - trendz-data:/data
+    depends_on:
+      - trendz-postgres
+  trendz-python-executor:
+    profiles: ['trendz']
+    restart: always
+    image: "thingsboard/trendz-python-executor:1.14.0"
+    ports:
+      - "8181:8181"
+    environment:
+      EXECUTOR_MANAGER: 1
+      EXECUTOR_SCRIPT_ENGINE: 6
+      THROTTLING_QUEUE_CAPACITY: 10
+      THROTTLING_THREAD_POOL_SIZE: 6
+      NETWORK_BUFFER_SIZE: 5242880
+    volumes:
+      - trendz-python-executor-conf:/python-executor-config-files
+      - trendz-python-executor-data:/data
+  trendz-postgres:
+    profiles: ['trendz']
+    restart: always
+    image: "postgres:16"
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_DB: trendz
+      POSTGRES_PASSWORD: postgres
+    volumes:
+      - trendz-postgres-data:/var/lib/postgresql/data
+volumes:
+  trendz-conf:
+    name: trendz-conf
+    driver: local
+  trendz-data:
+    name: trendz-data
+    driver: local
+  trendz-python-executor-conf:
+    name: trendz-python-executor-conf
+    driver: local
+  trendz-python-executor-data:
+    name: trendz-python-executor-data
+    driver: local
+  trendz-postgres-data:
+    name: trendz-postgres-data
+    driver: local
+```
+{: .copy-code}
+
+Where:
+
+- `8888:8888` - connect local port 8888 to exposed internal HTTP port 8888
+- `trendz-conf:/trendz-config-files` - mounts the volume `trendz-conf` to Trendz directory with the configuration files
+- `trendz-data:/data` - mounts the volume `trendz-data` to Trendz data directory
+- `trendz-postgres-data:/var/lib/postgresql/data` - mounts the volume `trendz-postgres-data` to Postgres data directory
+- `trendz` - name of the Trendz Docker service
+- `--restart always` - automatically start Trendz in case of system reboot and restart in case of failure.
+- `thingsboard/trendz:{{ site.release.trendz_ver }}` - Trendz docker image
+- `thingsboard/trendz-python-executor:{{ site.release.trendz_ver }}` - Trendz python script executor docker image
+- `SCRIPT_ENGINE_TIMEOUT` - Python script execution timeout

_includes/templates/trendz/install/docker-detach-stop-start-commands.md

@@ -0,0 +1,23 @@
+You can detach from session terminal using `Ctrl-p` `Ctrl-q` key sequence - the container will keep running in the background.
+
+In case of any issues, you can examine service logs for errors.
+For example, to see Trendz container logs, execute the following command:
+
+```
+docker compose logs -f trendz
+```
+{: .copy-code}
+
+To stop the container:
+
+```
+docker compose stop trendz
+```
+{: .copy-code}
+
+To start the container:
+
+```
+docker compose start trendz
+```
+{: .copy-code}

_includes/templates/trendz/install/docker-requirements-linux.md

@@ -0,0 +1,2 @@
+* **Have Docker CE**. You can find out how to install it [here](https://docs.docker.com/engine/installation/)
+* **Have Docker Compose**. You can find out how to install it [here](https://docs.docker.com/compose/install/)

_includes/templates/trendz/install/docker-requirements-windows.md

@@ -0,0 +1 @@
+* **Have Docker Desktop for Windows**. You can find out how to install it [here]((https://docs.docker.com/desktop/setup/install/windows-install/))

_includes/templates/trendz/install/docker-start-trendz-service.md

@@ -0,0 +1,9 @@
+Set the terminal in the directory which contains the `docker-compose.yml` file and execute the following commands to up this docker compose directly:
+
+```
+docker compose --profile trendz up -d && docker compose logs -f trendz
+```
+{: .copy-code}
+
+After executing this command you can open `http://{your-host-ip}:8888` in your browser (for ex. `http://localhost:8888`).
+You should see Trendz login page.

_includes/templates/trendz/install/hardware-requirements.md

@@ -0,0 +1,4 @@
+Depends on the amount of analyzed data and the number of devices connected to the system.
+To run Trendz Analytics on a single machine, you will need at least 1Gb of free RAM.
+
+In small and medium installations, Trendz can be installed **on the same** server with ThingsBoard.