Updated on 2024-05-20 GMT+08:00

Connecting to an Instance Using a Private IP Address

You can use the private IP address to connect to the GeminiDB Redis instance.

This section uses the Linux OS as an example to describe how to connect to a GeminiDB Redis instance using the Redis-cli client. You can connect to a DB instance through SSL to secure your data.

To ensure data reliability, use the load balancer address or domain name to access instances.

Precautions

  • The instances must be in the same VPC and subnet as the ECS.
  • The ECS must be in a security group that has access to the instances. For details, see Configuring Security Group Rules.
  • After the SSL connection is enabled, download the SSL certificate for your applications to access to the GeminiDB Redis instance.
  • If the SSL connection is used, ensure that the Redis client, for example, Redis-cli 6.x, supports SSL.
  • To connect to a DB instance through an unencrypted connection, the SSL connection must be disabled. For details about how to disable SSL, see Configuring an SSL Connection.

Prerequisites

An ECS has been created. The following uses a Linux ECS as an example. For details, see Purchasing an ECS in Getting Started with Elastic Cloud Server.

SSL

  1. Log in to the ECS. For details, see Logging In to an ECS in Getting Started with Elastic Cloud Server.
  2. Obtain the Redis client.

    Method 1

    Run the following command to download the Redis client.

    wget https://download.redis.io/releases/redis-6.2.6.tar.gz

    Method 2

    Download the Redis client and upload the Redis client installation package to the ECS.

  3. Upload the SSL certificate to the ECS.
  4. Check the OpenSSL version supported by the ECS OS.

    openssl version

    • The SSL function provided by GeminiDB Redis supports only TLS 1.3 or later.
    • The OpenSSL version in the ECS OS must be 1.1.1 or later so that redis-cli can support TLS 1.3 or later.
    • If the OS version is earlier than 1.1.1, perform the following steps to install OpenSSL:

      wget https://www.openssl.org/source/openssl-1.1.1m.tar.gz

      tar -zxvf openssl-1.1.1m.tar.gz

      cd openssl-1.1.1m/

      ./config --prefix=/usr/local/openssl-1.1.1m_install_dir

      make

      make install

      After OpenSSL is installed, go to 5.

    • If the OS is 1.1.1 or later, go to 5.

  5. Decompress the client tool package.

    tar -xzf redis-6.2.6.tar.gz

  6. Connect to the DB instance in the src directory.

    • If the required OpenSSL version has been installed by performing 4 and the version is earlier than 1.1.1, you can connect to the DB instance using the following method:

      cd redis-6.2.6

      make BUILD_TLS=yes OPENSSL_PREFIX=/usr/local/openssl-1.1.1m_install_dir

      cd src

      LD_PRELOAD=/usr/local/openssl-1.1.1m_install_dir/lib/libssl.so.1.1:/usr/local/openssl-1.1.1m_install_dir/lib/libcrypto.so.1.1 ./redis-cli -h <DB_HOST> -p <DB_PORT> -a <DB_PWD> --tls --cacert <CACERT_PATH>

      Example:

      LD_PRELOAD=/usr/local/openssl-1.1.1m_install_dir/lib/libssl.so.1.1:/usr/local/openssl-1.1.1m_install_dir/lib/libcrypto.so.1.1 ./redis-cli -h 192.168.0.208 -p 8635 -a <DB_PWD> --tls --cacert ./cacert.crt

    • If the OpenSSL version in the ECS OS is 1.1.1 or later, you can connect to the DB instance using the following method:

      cd redis-6.2.6

      make BUILD_TLS=yes

      cd src

      ./redis-cli -h <DB_HOST> -p <DB_PORT> -a <DB_PWD> --tls --cacert <CACERT_PATH>

      Example:

      ./redis-cli -h 192.168.0.208 -p 8635 -a <DB_PWD> --tls --cacert ./cacert.crt

    Table 1 Parameter description

    Parameter

    Description

    <DB_HOST>

    Private IP address of the instance to be connected.

    To obtain this IP address, go to the Instance Management page and click the target instance name. The IP address can be found in the Private IP Address field under Node Information on the Basic Information page.

    If the instance you purchased has multiple nodes, select the private IP address of any node.

    <DB_PORT>

    Port for accessing the target instance. Configure this parameter based on service requirements.

    To obtain the instance port number, perform the following steps:

    Click the target instance to go to the Basic Information page. In the Network Information area, you can find the database port.

    <DB_PWD>

    Specifies the administrator password set when you buy a GeminiDB Redis instance.

    <CACERT_PATH>

    Path of the SSL certificate.

  7. Check the results. If the following information is displayed, the connection is successful.

    IP:port>

Non-SSL Connection

  1. Log in to the ECS. For details, see Logging In to an ECS in Getting Started with Elastic Cloud Server.
  2. Obtain the Redis client.

    Method 1

    Run the following command to download the Redis client.

    wget http://download.redis.io/releases/redis-5.0.7.tar.gz

    Method 2

    Download the Redis client installation package and upload it to the ECS.

  3. Decompress the client tool package.

    tar -xzf redis-5.0.7.tar.gz

  4. Connect to the DB instance in the src directory.

    cd redis-5.0.7

    make

    cd src

    ./redis-cli -h <DB_HOST> -p <DB_PORT> -a <DB_PWD>

    Example:

    ./redis-cli -h 192.xx.xx.xx -p 8635 -a <DB_PWD>

    Table 2 Parameter description

    Parameter

    Description

    <DB_HOST>

    The private IP address of the instance to be connected.

    To obtain this IP address, go to the Instance Management page and click the target DB instance name. The IP address can be found in the Private IP Address field under Node Information on the Basic Information page.

    If the instance you purchased has multiple nodes, select the private IP address of any node.

    <DB_PORT>

    Port for accessing the target instance. Configure this parameter based on service requirements.

    To obtain the instance port number, perform the following steps:

    Click the target instance to go to the Basic Information page. In the Network Information area, you can find the database port.

    <DB_PWD>

    Specifies the administrator password set when you buy a GeminiDB Redis instance.

  5. Check the results. If the following information is displayed, the connection is successful.

    IP:port>