Create ClickHouse Data Source

NineData supports adding various types and environments of data sources to the console for unified management. You can use database DevOps, backup and recovery, data replication, and database comparison features for data sources that have been added. This article introduces how to add a ClickHouse data source to NineData.

Prerequisites

• The server IP address of NineData has been added to the data source allowlist. Please refer to the image below for instructions on how to obtain the server IP address.

  

• Make sure you have available data source quota; otherwise, the data source cannot be added. You can quickly check your remaining quota at the top-right corner of the NineData console.

Operation Steps

1. Log in to the NineData Console.

2. On the left navigation pane, click > .

3. Click  tab, and click  on the page. In the popup window for selecting the data source type, choose > (the type of data source to be added), and configure the parameters based on the table below on the page.
   tip

   If you make a mistake during the operation, you can click the icon at the top of the page to make a new selection.

4. Configure the parameters of the data source:

   Parameter	Description
   	Enter the name of the data source. To facilitate subsequent search and management, please use meaningful names.
   	Select the access method of the data source. Supports access through , , SSH Tunnel three methods. : Access the data source through a public network address. : A secure and fast intranet access method provided by NineData. First, you need to connect the host where the data source is located. For the connection method, please refer to Add Gateway. SSH Tunnel: Access the data source through an SSH tunnel.
   Select Configuration Items	: The public network connection address and port of the data source.
   Select Configuration Items	: Select the NineData gateway installed on the host where the data source is located. : Can be written as localhost (the data source is on the local machine) or the intranet IP of the host where the data source is located.
   Select SSH Tunnel Configuration Items	: Enter the public IP or domain name of the server where the target data source is located, as well as the corresponding port number (the default port number for SSH service is 22). : Select the SSH authentication method. : Connect through (i.e., the server's login name) and (i.e., the server's login password). : Enter the login username of the server where the target data source is located. : Enter the login password of the server where the target data source is located. (Recommended): Connect through and . : Enter the login username of the server where the target data source is located. : Click to upload the private key file, which is a key file without a suffix. If you have not created one yet, please refer to Generate SSH Tunnel Key File. : Enter the password set when generating the key file. If you did not set a password during the key generation process, leave this field blank. Note: After the SSH configuration is completed, you need to click on the on the right, and there may be the following two results: Prompt : Indicates that the SSH Tunnel has been established. Prompt error message: Indicates a connection failure. You need to troubleshoot the cause of the error based on the error message and retry. : Can be written as localhost (the data source is on the local machine) or the intranet IP of the host where the data source is located.
   	The username of the data source.
   	The password of the data source.
   	Select the region closest to your data source location to effectively reduce network latency.
   	Choose according to the actual business purpose of the data source, as an environmental identifier of the data source. Default provides and environments, and supports you to Create Custom Environment. Note: Under the Organization Mode, the database environment can also be applied to permission policy management, for example, the default role only supports access to data sources in the environment and cannot access data sources in other environments. For more information, please refer to Manage Roles.
   	Whether to use SSL encryption to access the data source. If the data source enforces SSL encrypted connections, this switch must be turned on, otherwise, the connection will fail. The configuration method for SSL, please refer to the official documentation: Configure ClickHouse Encrypted Connection.

5. After all configurations are completed, click on the next to to test whether the data source can be accessed normally. If prompted with , you can click to complete the addition of the data source. Otherwise, please recheck the connection settings until the connection test is successful.

Appendix: Add NineData's IP Address to ClickHouse Database Whitelist

When adding a data source located in , you need to add the IP address of the NineData service to the ClickHouse database whitelist to allow NineData to provide services.

This section takes ClickHouse version 22.1 as an example to introduce how to add an IP whitelist.

1. Open the ClickHouse configuration file users.xml with a text editor. This file is usually located at: /etc/clickhouse-server/users.xml.

2. Find the account that needs to be used to access NineData, such as <default>, and under it, find the <networks> parameter. Enter the IP address or address segment that needs to be allowed to access into the <ip> tag pair, and multiple IP addresses or address segments are wrapped with multiple <ip> tag pairs.

   Example:

   <users>
       <default>
           <networks>
               <ip>121.199.39.25</ip>
               <ip>123.57.58.208</ip>
           </networks>
       </default>
   </users>

3. Save the configuration file.