Help Center/ MapReduce Service/ Developer Guide (LTS)/ ClickHouse Development Guide (Security Mode)/ Preparing a ClickHouse Application Development Environment/ Preparing a ClickHouse Application Development and Runtime Environment
Updated on 2024-08-10 GMT+08:00
View PDF
Share

Preparing a ClickHouse Application Development and Runtime Environment

Preparing the Development Environment

Table 1 describes the environment required for application development.

Table 1 Development environment

Item

Description

Operating System (OS)
  • Development environment: Windows 7 or later.
  • Operating environment: Linux

If the program needs to be commissioned locally, the operating environment must be able to communicate with network on the cluster service plane.

JDK installation

Basic configurations of the development and operating environments. The version requirements are as follows:

The server and client support only built-in OpenJDK 1.8.0_272.

Customers' applications that need to reference the JAR files of SDK to run in the application processes support Oracle JDK, IBM JDK, and OpenJDK.

  • x86 client: Oracle JDK 1.8; IBM JDK 1.8.5.11
  • TaiShan client: OpenJDK 1.8.0_272
NOTE:

For security purposes, the server supports only TLS V1.2 or later.

By default, the IBM JDK supports only TLS V1.0. If the IBM JDK is used, set the startup parameter com.ibm.jsse2.overrideDefaultTLS to true. After the setting, the IBM JDK supports TLS V1.0, TLS V1.1, and TLS V1.2. For details, see https://www.ibm.com/support/knowledgecenter/SSYKE2_8.0.0/com.ibm.java.security.component.80.doc/security-component/jsse2Docs/matchsslcontext_tls.html#matchsslcontext_tls.

Installing and configuring IntelliJ IDEA

Basic configuration of the development environment. You are advised to use version 2019.1 or other compatible versions.

NOTE:
  • If you use IBM JDK, ensure that the JDK configured in IntelliJ IDEA is IBM JDK.
  • If you use Oracle JDK, ensure that the JDK configured in IntelliJ IDEA is Oracle JDK.
  • If you use Open JDK, ensure that the JDK configured in IntelliJ IDEA is Open JDK.
  • Do not use the same workspace and the sample project in the same path for different IntelliJ IDEA programs.

Apache Maven installation

Basic configuration of the development environment. This operation is used for project management throughout the lifecycle of software development.

Developer account preparation

Cluster user for application development. Create the user and grant permissions to the user by referring to Preparing MRS Application Development User.

7-zip

This tool is used to decompress *.zip and *.rar files. 7-Zip 16.04 is supported.

Preparing the Operating Environment

During application development, you need to prepare the environment for code running and commissioning to verify that the application is running properly.

  • If the local Windows development environment can communicate with the cluster service plane network, download the cluster client to the local host; obtain the cluster configuration file required by the commissioning application; configure the network connection, and commission the application in Windows.
    1. Log in to FusionInsight Manager and choose Cluster > Dashboard > More > Download Client. Set Select Client Type to Configuration Files Only. Select the platform type based on the type of the node where the client is to be installed (select x86_64 for the x86 architecture and aarch64 for the Arm architecture) and click OK. After the client files are packaged and generated, download the client to the local PC as prompted and decompress it.

      For example, if the client file package is FusionInsight_Cluster_1_Services_Client.tar, decompress it to obtain FusionInsight_Cluster_1_Services_ClientConfig_ConfigFiles.tar. Then, decompress FusionInsight_Cluster_1_Services_ClientConfig_ConfigFiles.tar to the D:\FusionInsight_Cluster_1_Services_ClientConfig_ConfigFiles directory on the local PC. The directory name cannot contain spaces.

    2. Copy all items from the hosts file in the decompression directory to the hosts file on the node where the client is installed. Ensure that the network communication between the local PC and hosts listed in the hosts file is normal.
      • If the host where the client is installed is not a node in the cluster, configure network connections for the client to prevent errors when you run commands on the client.
      • The local hosts file in a Windows environment is stored in, for example, C:\WINDOWS\system32\drivers\etc\hosts.
  • If you use the Linux environment for commissioning, prepare the Linux node where the cluster client is to be installed and obtain related configuration files.
    1. Install the client on the node. For example, install the client in the /opt/client directory.

      Ensure that the difference between the client time and the cluster time is less than 5 minutes.

      For details about how to use a client on the master or core nodes inside a cluster, see Using an MRS Client on Nodes Inside a Cluster. For details about how to use a client outside a cluster, see Using an MRS Client on Nodes Outside a Cluster.

    2. Check the network connection of the client node.

      During the client installation, the system automatically configures the hosts file on the client node. You are advised to check whether the /etc/hosts file contains the host names of the nodes in the cluster. If they are not contained, manually copy the content in the hosts file in the decompression directory to the hosts file on the node where the client is deployed.