Skip to main content

14.3.2 Local Deployment

This document describes how to install TDengine IDMP on your local machine.

14.3.2.1 Prerequisites​

  • Ensure that your local machine meets the minimum requirements for TDengine IDMP. For details, see Planning Your Deployment.
  • Install TDengine TSDB-Enterprise version 3.3.7.0 or higher. For instructions, see Deploy TDengine TSDB-Enterprise.
  • Install Java 21 or later.
  • Install glibc 2.25 or later.
  • On Debian and Ubuntu systems, install the python3-venv package.

14.3.2.2 Install TDengine IDMP​

Select your operating system to display the appropriate installation procedure.

tip

Your machine must be connected to the internet when you install TDengine IDMP. Dependencies are downloaded and installed during the TDengine IDMP installation process.

  1. In a web browser, access the TDengine Download Center.

  2. Select the installation package for your operating system and download it.

  3. Follow the instructions in the Download Center to install TDengine IDMP.

important

Do not start TDengine IDMP until you have configured the TDengine TSDB-Enterprise connection as described in the following section.

14.3.2.3 Configure TSDB Connection​

  1. Configure the TDengine TSDB-Enterprise connection in TDengine IDMP:

    1. Open the TDengine IDMP configuration file with a text editor. The default location is:

      • Linux/macOS: /usr/local/taos/idmp/config/application.yml
      • Windows: C:\TDengine\idmp\config\application.yml

    2. Under the tda.default-connection section, set the TDengine TSDB-Enterprise connection details as shown in the following example:

      tda:
        default-connection:
          enable: true
          auth-type: UserPassword
          url: http://<hostname>:<port>
          username: <username>
          password: <password>

      • url: Specify the URL and port number of your taosAdapter instance.

      • username: Enter a TDengine TSDB-Enterprise user.

      • password: Enter the password for the TDengine TSDB-Enterprise user.

    Complete Configuration Reference
    • For complete IDMP configuration file documentation, please refer to: TDengine IDMP Configuration File Reference.

    • To configure the base path for the gateway reverse proxy, you first need to explicitly specify this base path by setting the TDA_REST_BASE_PATH environment variable. Meanwhile, the gateway side needs to complete two configurations: 1. Configure the routing forwarding rule pointing to http://<target address>/idmp_config; 2. Configure the path rewriting rule to ensure that the aforementioned base path contained in the request URL is removed before forwarding the request to the backend service.

  2. (Optional) Run the following command to test the connection to TDengine TSDB-Enterprise:

    curl --request POST \
      --user <username>:<password> \
      --url http://<hostname>:<port>/rest/sql \
      --data 'show databases;'

    If the connection is successful, the list of databases in TDengine TSDB-Enterprise will be displayed.

14.3.2.4 Start TDengine IDMP​

Run the following command to start TDengine IDMP:

sudo svc-tdengine-idmp start

You can also use other svc-tdengine-idmp commands to check the service status, stop the service, and perform other operations:

sudo svc-tdengine-idmp status # Check service status
sudo svc-tdengine-idmp stop   # Stop service

You can manually manage the TDengine IDMP service using systemctl. For example:

sudo systemctl start tdengine-idmp
sudo systemctl stop tdengine-idmp
sudo systemctl status tdengine-idmp
sudo systemctl restart tdengine-idmp
info

Root permissions are required to run these commands.

Once TDengine IDMP starts successfully, it includes the following three services:

  • tdengine-idmp-h2: Stores metadata and configuration for TDengine IDMP.
  • tdengine-idmp-chat: Handles AI-related tasks and analytics.
  • tdengine-idmp: The core service responsible for managing and providing data access.

14.3.2.5 Uninstall TDengine IDMP​

Run the following command to uninstall TDengine IDMP:

rmidmp -e [yes | no]

To retain data, log, and configuration files, specify no. To delete these files, specify yes.

14.3.2.6 Upgrade TDengine IDMP​

To upgrade TDengine IDMP, you download the installation package for the new version of TDengine IDMP, stop all TDengine IDMP services, install the new version, and start TDengine IDMP services again. It is not necessary to uninstall the previous version before upgrading, and all existing configuration, logs, and data are retained after upgrade.

  1. Back up the contents of the following directories:

    • data/idmp: User data directory
    • idmp/venv: Python virtual environment
    • idmp/config: Configuration directory
    • logs: Log directory

  2. Stop all TDengine IDMP services:

    sudo svc-tdengine-idmp stop

  3. Install the new version of TDengine IDMP:

    tar -zxvf tdengine-idmp-enterprise--linux-x64.tar.gz
    cd tdengine-idmp-enterprise-
    sudo ./install.sh

  4. Start TDengine IDMP services:

    sudo svc-tdengine-idmp start

  5. Log in to TDengine IDMP and verify that the desired version has been installed.