Create a ClickHouse Data Source

Add a ClickHouse data source to NineData for Database DevOps, backup and restore, data replication, database comparison, and other supported features. This guide covers connection mode, credentials, environment settings, SSL settings, and the connection test.

Before you begin

• The server IP address of NineData has been added to the data source allowlist. The server IP address can be viewed by selecting the target region in Access Region on the Create Datasource page.

  

• Make sure data source quota is available; otherwise, the data source cannot be added. Check the remaining quota in the NineData Console header.

Procedure

1. Sign in to the NineData Console.

2. On the left navigation pane, click Datasource > Datasource.

3. Select the Datasource tab, and then select Create Datasource. In the data source type selector, choose Database > (the type of data source to be added). On the Create Datasource page, configure the parameters based on the table below.
   tip

   If you make a mistake during the operation, select the icon at the top of the Create Datasource page and choose again.

4. Configure the data source parameters:

   Parameter	Description
   Name	Enter a data source name. Use a meaningful name so it is easy to find and manage later.
   Connection	Select how NineData connects to the data source. Supported methods are IP Address, Gateway, and SSH Tunnel. IP Address: Connect through a public network address. Gateway: Use a NineData gateway for private-network access. Connect the host that runs the data source first. For instructions, see Add Gateway. SSH Tunnel: Connect through an SSH tunnel. Select how NineData connects to the data source. Supported methods are IP Address and SSH Tunnel. IP Address: Connect through a public network address. SSH Tunnel: Connect through an SSH tunnel.
   Configuration items when Connection is IP Address	Host: The public network connection address and port of the data source.
   Configuration items when Connection is Gateway	Gateway: Select the NineData gateway installed on the host where the data source is located. Host: Enter localhost if the data source is on the same host as the gateway, or enter the internal IP address of the host where the data source is located.
   Configuration items when Connection is SSH Tunnel	SSH Host: Enter the public IP address or domain name and SSH port of the server where the target data source is located. The default SSH port is 22. SSH Authentication Method: Select the SSH authentication method. Password: Connect with SSH Username and Password. SSH Username: Enter the login username of the server where the target data source is located. Password: Enter the login password of the server where the target data source is located. Key (recommended): Connect with SSH Username and Key File. SSH Username: Enter the login username of the server where the target data source is located. Key File: Click Upload to upload the private key file, which is a key file without a suffix. If you have not created one yet, see Generate SSH Tunnel Key File. Password: Enter the password set when the key file was generated. If no password was set during key generation, leave this field blank. Note: After configuring SSH, click Connection Test to test the tunnel. Possible results: Connection Successfully: The SSH tunnel is established. Error message: The connection failed. Troubleshoot the cause based on the error message and try again. Host: Enter localhost if the data source is on the same host as the SSH server, or enter the internal IP address of the host where the data source is located.
   DB Account	The username of the data source.
   DB Password	The password of the data source.
   Access Region	Select the region closest to the data source to help reduce network latency.
   Environment	Choose an environment based on the business purpose of the data source. This serves as an environment identifier of the data source. Default provides PROD and DEV environments, and supports you to create a custom environment. Note: Under the organization mode, the database environment can also be applied to permission policy management, for example, the default Prod Admin role only supports access to data sources in the PROD environment and cannot access data sources in other environments. For more information, see Manage Roles.
   SSL	Configure SSL encryption for the data source. If the data source requires SSL-encrypted connections, enable this option; otherwise, the connection fails. For SSL configuration, see the official documentation: Configure ClickHouse Encrypted Connection.

5. After you configure all parameters, click Connection Test next to Create Datasource to test connectivity. When Connection Successfully is displayed, click Create Datasource to create the data source. Otherwise, review the connection settings and run the test again.

Result

After the connection test succeeds and you create the data source, it appears in the data source list. Use it in NineData features that support ClickHouse.

Appendix: Add NineData IP addresses to the ClickHouse database whitelist

When you add a data source located in On-Premise/Other Cloud, add the NineData service IP address to the ClickHouse database whitelist so NineData can access the database.

The following example uses ClickHouse 22.1.

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 used for NineData access, such as <default>. Under that account, find the <networks> parameter and add each allowed IP address or address range in an <ip> tag pair. Use multiple <ip> tag pairs for multiple IP addresses or address ranges.

   Example:

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

3. Save the configuration file.