Skip to main content

Connect Huawei Cloud DCS Redis through the NineData Gateway

Huawei Cloud Distributed Cache Service Redis instances do not provide public internet endpoints, so NineData cannot connect to them directly over the public internet. Use the NineData Gateway to connect to the instances through a private network.

Prerequisites​

  • You have purchased a Huawei Cloud ECS instance in the same Virtual Private Cloud (VPC) as the Huawei Cloud Distributed Cache Service Redis instance. Verify the VPC for both resources in Huawei Cloud:

    • Virtual Private Cloud (VPC) of the Huawei Cloud Distributed Cache Service Redis instance.

      Huawei Cloud VPC diagram

    • Virtual Private Cloud (VPC) of the Huawei Cloud ECS instance.

      Huawei Cloud ECS VPC diagram

  • The Huawei Cloud ECS instance must have access to the public internet.

Notes​

Through the gateway, NineData currently supports only Redis data sources whose Architecture Type is Standalone. For master-slave or other multi-node Redis deployments, a Redis failover may cause the connected data source to change from the master node to a slave node.

Procedure​

Step 1: Deploy the Gateway​

  1. Log in to the Huawei Cloud ECS instance.

  2. Log in to the NineData Console, then go to Datasource > Gateway.

  3. Click Create Gateway.

  4. Configure the parameters in the table.

    ParameterDescription
    NameEnter a gateway name. Use a meaningful name so you can find and manage the gateway later.
    EnvironmentSelect the operating system of the gateway host. NineData displays the corresponding installation method. Supported operating systems:
    • Windows(x86_64)
    • Linux(x86_64)
    • macOS
    Access RegionSelect the region closest to the gateway host to reduce network latency.
    AdvancedNo configuration required.

  5. Follow the installation instructions shown on the page to install and configure the gateway on the Huawei Cloud ECS instance. After configuration is complete, the connection diagram on the right side of the page changes from Waiting for the local gateway to launch... to The local gateway is connected successfully.

  6. Click Create Datasource. In the dialog, select the data source you want to add, then continue to Step Two.

Step 2: Connect to Redis Data Source​

  1. On the Create Datasource page, configure the parameters in the table.

    Parameter
    		Description
    NameEnter the name of the data source, use a meaningful name so you can find and manage the data source later.
    Architecture TypeSelect Standalone.
    ConnectionSelect Gateway.
    GatewaySelect the gateway ID deployed in Step One.
    HostThe access address and port of the Redis data source. You can view it in the Connection Information area on the overview page of the Huawei Cloud Distributed Cache Service Redis instance. Redis connection information
    DB AccountEnter the login username for Redis, leave it blank if not set.
    DB PasswordEnter the login password for Redis, leave it blank if not set.
    Access RegionSelect the region closest to the location of your Redis host to effectively reduce network latency.
    EnvironmentSelect the environment that matches the business purpose of the data source. The default provides the PROD and DEV environments, and also 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.
    EncryptionSpecify whether to use encrypted transmission to access the data source (disabled by default). If the data source requires encrypted connections, enable this option or the connection fails.
    Use the switch on the right to enable or disable encrypted transmission. Click > to the left of Encryption to expand the detailed settings.
    • SSL Options: Supports the following two methods.
      • If Available: Automatically detects the server SSL status. If SSL is enabled, NineData connects over SSL first; otherwise, it uses a non-SSL connection.
      • Require: Always connects to the data source over SSL. If the server does not support SSL or the SSL connection cannot be established, the connection fails.
    • Verify Server Certificate (SSL CA): If the server uses a certificate issued by a self-signed CA, upload the root certificate of that CA.
    • Authenticate Client: If the server requires a client certificate, upload the client certificate and key. The server verifies the uploaded information to secure the connection.

  2. After configuring the parameters, click Connection Test next to Create Datasource to verify that NineData can reach the data source. When Connection Successfully appears, click Create Datasource to add the data source. If the test fails, review the connection settings and run the test again.

Step 3: Manage Huawei Cloud Distributed Cache Service Redis Instances with SQL Console​

  1. Log in to the NineData Console.

  2. Go to DevOps > SQL Console.

    tip

    If you have logged in to the data source before and have not closed it, you will automatically enter the data source page.

  3. Click the text box under SQL Console. In the data source list, select the Huawei Cloud Distributed Cache Service Redis instance you added, then click Query to open the SQL Console.

  4. Run a test query against a key to confirm that the instance is accessible.

    SQL Console test query

Result​

After the gateway is deployed and the Redis data source is added, you can open the SQL Console and run queries against the Huawei Cloud Distributed Cache Service Redis instance through the NineData Gateway.