Skip to main content

Deploying and Accessing NineData Cluster

This document describes how to deploy the NineData cluster using the NiUP command-line tool, and how to access the NineData Cluster after deployment.

Installation Contents Description

NiUP will automatically install the following components: Container Service (Docker), Kubernetes (K3S), Image Repository, Metadata Database (MySQL), NineData Service.

Minimum Hardware Requirements

  • CPU: X86 architecture with 4 cores
  • Memory: 8 GB
  • Storage Space: 40 GB

It is recommended to deploy on two or more servers.

Operating System Requirements

Linux kernel version 3.10 or above, CentOS 7 is recommended.


  • Contact support personnel to obtain the installation package and copy it to the server where NineData needs to be deployed.
  • If deploying on two or more hosts simultaneously, ensure that there is internal network connectivity between the hosts.

Step One: Generate Configuration File

  1. Log in to the host where NineData will be deployed. If deploying on a remote machine, remotely log in to the target host.

    ssh -p<remote_host_port> <remote_host_username>@<remote_host_name/IP>
    // Example: ssh -p22 root@
  2. Navigate to the installation directory of NineData and unzip the niup.tar.gz installation package. In this example, it's in the "private_install" directory under the current user's home directory.

    cd ~/private_install
    tar -zxvf niup.tar.gz
  3. Enter the installation package directory cd niup, and execute the following command to generate the installation configuration file.

    ./niup config cluster ninedata

    In this command, niup config cluster is a fixed command, and ninedata is the cluster name. You can specify a different name.

  4. Follow the prompts to complete the configuration. See the table below for details:

    StepsPrompt TextDescriptionExample
    1Enter the data disk directory. Default is the root directory:Specify the directory for storing NineData system files. Press Enter to default to the root directory /.~/ninedata
    2Enter the console access address (can be left empty):Specify the IP address for accessing the NineData cluster. Press Enter to default to the local machine IP address.
    2-1Enter the console access port:After entering the IP address in 2, you need to customize the port for accessing the NineData service.80
    3Enter machine information. Leave IP empty to finish input:Provide host information.None
    3-1Enter IP:Enter the intranet address of the first host to deploy the NineData cluster and press Enter.
    3-2Enter Port:Enter the SSH login port of the first host to deploy the NineData cluster, default is 22, then press Enter.22
    3-3Continue adding machines? (y/N):Would you like to continue adding hosts? Since we are deploying a dual-node setup, input y and press Enter, then repeat 3-1 and 3-2. If you no longer need to add hosts, input N and press Enter.y
    3-4Enter the SSH connection username:Enter the SSH login username of the host, then press Enter.root
    3-5Enter the SSH connection method, 'pwd' for password-based, 'pem' for key-based:Enter the SSH login method, supporting password (pwd) and key (pem). Press Enter after input.pwd
    3-6Enter the SSH login password:After inputting pwd in 3-5, enter the SSH login password here and press Enter.123456
    3-7Enter the absolute file path of the PEM fileAfter inputting pem in 3-5, enter the absolute path where the SSH key is located here./home/ninedata/.ssh/id_rsa
    4Enter database connection URL:Enter the address of the MySQL database used to store NineData metadata. To ensure database availability, please input your own MySQL access address during actual configuration. Press Enter to automatically deploy a single-node MySQL container for testing on the host.rm-**
    4-1Enter connection port:Enter the access port of the MySQL database, then press Enter.3306
    4-2Enter connection username:Enter the username of the MySQL database, then press Enter.root
    4-3Enter connection password:Enter the access password of the MySQL database, then press Enter.Test123456
    5Starting to input object storage information, Leave it blank to skip:Configure information for the storage repository component (MinIO).None
    5-1Enter the storage deployment machine (default is the current machine):Configure the installation location of the MinIO component. You can enter the intranet IP address of either of the two hosts. Press Enter to default to the current host.
    5-2Enter the username, Leave it blank to skip:Configure the username of the MinIO component. Press Enter to skip the configuration.minio_user
    5-3Enter the password, Leave it blank to skip:Configure the password of the MinIO component. Press Enter to skip the configuration.Test123456
    5-4Enter the storage access domain, Leave it blank to skip:Configure the domain for accessing MinIO. Press Enter to skip the
  5. Once the configuration file is generated, you can view and modify it in the <installation_directory>/niup/config/<cluster_name>-config.yaml configuration file. See the example below:


Step Two: One-click Deployment

  1. Execute the following command in the command line to start one-click deployment.

    ./niup install cluster ninedata

    After execution, wait for the command line to display the following prompt indicating successful deployment.

    Cluster [ninedata] was installed successfully
  2. At this point, the components will start automatically in the background. You can check the startup status of each component by executing kubectl get pod -ALL command on both host's command lines. Once all components are started, you can start using the NineData service by entering its access address in the browser.

Step Three: Accessing NineData cluster

  1. Open the NiUP configuration file. For the path to find this configuration file, Please refer to the Fifth step of Step One.

  2. In the configuration file, find the domain and domain_port parameters, as shown in the image below.


  3. The format of the access address for the NineData cluster console is <host_IP_address>:<port_number>. <host_IP_address> corresponds to the domain parameter in the installation package configuration file, and <port_number> corresponds to the domain_port parameter. So, in this example, the access address for the NineData cluster console is:

  4. On the login page, enter the administrator account and password for the NineData cluster. The initial administrator account and password are as follows:

    • Administrator Account: admin
    • Administrator Password: admin