Подключение к базе данных в кластере Redis

К хосту базы данных Redis можно подключиться:

• Без использования шифрования (для кластеров с любыми версиями Redis):

  • Напрямую через порт 6379.

  • C использованием Redis Sentinel через порт 26379. Это система управления хостами Redis с возможностями мониторинга, отправки уведомлений о состояниях хостов, переключения мастера и передачи клиентам актуальных адресов хостов.

    Не все клиентские приложения Redis поддерживают подключение через Sentinel, однако вы можете подключиться к хосту напрямую. Обратите внимание, что при этом вам придется самостоятельно отслеживать роли всех хостов. Если в прямом подключении нет необходимости, используйте Sentinel для более надежной работы с хостами кластера.

• С использованием шифрования (для кластеров с Redis версии 6 и старше c включенным SSL-шифрованием).

  При включенном шифровании соединений можно подключиться только напрямую к хосту Redis через порт 6380. Для подключения к нешардированному кластеру на запись рекомендуется использовать особые FQDN.

Подключение к кластеру

Хостам кластера Redis нельзя назначать публичные IP-адреса. Доступ к хостам возможен только из той же облачной сети, в которой находится хост.

Чтобы подключиться к хосту кластера Redis:

1. Создайте виртуальную машину с публичным IP-адресом в той же виртуальной сети, что и хост.
2. Подключитесь к созданной виртуальной машине через SSH и из нее подключитесь к Redis с помощью одного из примеров строк подключений.

Настройка групп безопасности

Группы безопасности могут препятствовать подключению к кластеру. В этом случае внесите изменения в правила групп.

Настройки правил будут различаться в зависимости от выбранного способа подключения:

1. Настройте все группы безопасности кластера так, чтобы они разрешали входящий трафик из группы безопасности, в которой находится ВМ, на порт 6379 для подключения напрямую или 26379 при подключении с помощью Sentinel. Если кластер создан с поддержкой SSL-шифрования, то укажите только порт 6380 (подключение по Sentinel не поддерживается для таких кластеров). Для этого в этих группах создайте следующее правило для входящего трафика:

   • протокол: TCP;
   • диапазон портов: 6379 (26379 для Sentinel) или только 6380 для кластера с поддержкой SSL-шифрования;
   • тип источника: Группа безопасности;
   • источник: группа безопасности, в которой находится ВМ. Если она совпадает с настраиваемой группой, то укажите Текущая.

2. Настройте группу безопасности, в которой находится ВМ так, чтобы можно было подключаться к ВМ и был разрешен трафик между ВМ и хостами кластера.

   Пример правил для ВМ:

   • Для входящего трафика:

     • протокол: TCP;
     • диапазон портов: 22;
     • тип источника: CIDR;
     • источник: 0.0.0.0/0.

     Это правило позволяет подключаться к ВМ по протоколу SSH.

   • Для исходящего трафика:

     • протокол: Any;
     • диапазон портов: 0-65535;
     • тип назначения: CIDR;
     • назначение: 0.0.0.0/0.

     Это правило разрешает любой исходящий трафик, что позволяет не только подключаться к кластеру, но и устанавливать сертификаты и утилиты, необходимые для подключения к кластеру.

Подробнее о группах безопасности см. в разделе Группы безопасности.

Получение SSL-сертификата

Чтобы использовать шифрованное SSL-соединение, получите SSL-сертификат:

sudo mkdir ~/.redis && \
sudo wget "https://storage.yandexcloud.net/cloud-certs/CA.pem" -O ~/.redis/YandexInternalRootCA.crt && \
sudo chmod 655 ~/.redis/YandexInternalRootCA.crt

Для использования графических IDE скачайте сертификат и укажите путь к нему в настройках подключения.

Подключение из графических IDE

Подключение проверялось в следующем окружении:

• MacOS Big Sur 11.3.
• DBeaver Enterprise: 21.0.

Подключаться из графических IDE к хостам кластера можно только через SSH-туннель с помощью созданной ВМ. Перед подключением подготовьте сертификат.

Примеры строк подключения

Примеры для Linux проверялись в следующем окружении:

• Виртуальная машина в Облаке c Ubuntu 20.04 LTS.
• Bash: 5.0.16.
• Python: 3.8.2; pip3: 20.0.2.
• PHP: 7.4.3.
• OpenJDK: 11.0.8; Maven: 3.6.3.
• Node.JS: 10.19.0, npm: 6.14.4.
• Go: 1.13.8.
• Ruby: 2.7.0p0.
• unixODBC: 2.3.6.

Примеры для Windows проверялись в следующем окружении:

• Локальная машина с Windows 10 Pro build 19042.1052.
• PowerShell: 5.1.19041.
• cURL: 7.55.1 WinSSL.

Пример команды с заполненным FQDN хоста доступен в консоли управления по нажатию кнопки Подключиться на странице кластера.

Bash

Перед подключением установите зависимости:

sudo apt update && sudo apt install -y redis-tools

redis-cli -h  <FQDN хоста-мастера Redis> -a <пароль>

redis-cli -h  <FQDN хоста-мастера Redis> -a <пароль> -p 6380 --tls --cacert ~/.redis/YandexInternalRootCA.crt

После подключения к кластеру выполните команды:

1. SET foo bar
2. GET foo

При успешном подключении к кластеру и выполнении тестового запроса будет выведена строка bar.

Python

Перед подключением установите зависимости:

sudo apt update && sudo apt install -y python3 python3-pip && \
pip3 install redis

from redis.sentinel import Sentinel

sentinels = ['<FQDN хоста 1 Redis>',
         ...
         '<FQDN хоста N Redis>']
name = '<имя кластера Redis>'
pwd = '<пароль>'

sentinel = Sentinel([(h, 26379) for h in sentinels], socket_timeout=0.1)
master = sentinel.master_for(name, password=pwd)
slave = sentinel.slave_for(name, password=pwd)

master.set('foo', 'bar')
print(slave.get('foo'))

import redis

r = redis.StrictRedis(
    host='<FQDN хоста-мастера Redis>',
    port=6379,
    password='<пароль>',
)

r.set('foo', 'bar')
print(r.get('foo'))

python3 connect.py

import redis

r = redis.StrictRedis(
    host='<FQDN хоста-мастера Redis>',
    port=6380,
    password='<пароль>',
    ssl=True, 
    ssl_ca_certs='~/.redis/YandexInternalRootCA.crt',
)

r.set('foo', 'bar')
print(r.get('foo'))

python3 connect.py

При успешном подключении к кластеру и выполнении тестового запроса будет выведена строка bar.

PHP

Перед подключением установите зависимости:

sudo apt update && sudo apt install -y php php-dev php-pear && \
sudo pear channel-discover pear.nrk.io && \
sudo pear install nrk/Predis

<?php
  require 'Predis/Autoloader.php';
  Predis\Autoloader::register();

  $sentinels = ['<FQDN хоста 1 Redis>:26379>',...,'<FQDN хоста N Redis>:26379>'];
  $options = [
    'replication' => 'sentinel',
    'service' => '<имя кластера Redis>',
    'parameters' => [
      'password' => '<пароль>'
    ]
  ];

  $conn = new Predis\Client($sentinels, $options);

  $conn->set('foo', 'bar');
  var_dump($conn->get('foo'));

  $conn->disconnect();
?>

<?php
  require 'Predis/Autoloader.php';
  Predis\Autoloader::register();

  $host = ['<FQDN хоста-мастера Redis>:6379'];
  $options = [
    'parameters' => [
      'password' => '<пароль>'
    ]
  ];

  $conn = new Predis\Client($host, $options);

  $conn->set('foo', 'bar');
  var_dump($conn->get('foo'));

  $conn->disconnect();
?>

php connect.php

<?php
  require 'Predis/Autoloader.php';
  Predis\Autoloader::register();

  $host = ['<FQDN хоста-мастера Redis>:6380'];
  $options = [
    'parameters' => [
      'scheme' => 'tls',
      'ssl'    => ['cafile' => '~/.redis/YandexInternalRootCA.crt', 'verify_peer' => true, 'verify_peer_name' => false],
      'password' => '<пароль>'
    ]
  ];

  $conn = new Predis\Client($host, $options);

  $conn->set('foo', 'bar');
  var_dump($conn->get('foo'));

  $conn->disconnect();
?>

php connect.php

При успешном подключении к кластеру и выполнении тестового запроса будет выведена строка bar.

Java

Перед подключением:

1. Установите зависимости:

   sudo apt update && sudo apt install -y default-jdk maven
   

2. Создайте директорию для проекта Maven:

   cd ~/ && mkdir -p project/src/java/com/example && cd project/
   

3. Создайте конфигурационный файл для Maven:

   pom.xml

   <?xml version="1.0" encoding="UTF-8"?>
   <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0</modelVersion>
       <groupId>com.example</groupId>
       <artifactId>app</artifactId>
       <packaging>jar</packaging>
       <version>0.1.0</version>
       <properties>
           <maven.compiler.source>1.8</maven.compiler.source>
           <maven.compiler.target>1.8</maven.compiler.target>
       </properties>
       <dependencies>
           <dependency>
               <groupId>redis.clients</groupId>
               <artifactId>jedis</artifactId>
               <version>3.3.0</version>
           </dependency>
           <dependency>
               <groupId>org.slf4j</groupId>
               <artifactId>slf4j-simple</artifactId>
               <version>1.7.30</version>
           </dependency>
       </dependencies>
       <build>
           <finalName>${project.artifactId}-${project.version}</finalName>
           <sourceDirectory>src</sourceDirectory>
           <resources>
               <resource>
                   <directory>src</directory>
               </resource>
           </resources>
           <plugins>
               <plugin>
                   <groupId>org.apache.maven.plugins</groupId>
                   <artifactId>maven-assembly-plugin</artifactId>
                   <executions>
                       <execution>
                           <goals>
                               <goal>attached</goal>
                           </goals>
                           <phase>package</phase>
                           <configuration>
                               <descriptorRefs>
                                   <descriptorRef>jar-with-dependencies</descriptorRef>
                               </descriptorRefs>
                               <archive>
                                   <manifest>
                                       <mainClass>com.example.App</mainClass>
                                   </manifest>
                               </archive>
                           </configuration>
                       </execution>
                   </executions>
                </plugin>
                <plugin>
                   <groupId>org.apache.maven.plugins</groupId>
                   <artifactId>maven-jar-plugin</artifactId>
                   <version>3.1.0</version>
                   <configuration>
                       <archive>
                           <manifest>
                               <mainClass>com.example.App</mainClass>
                           </manifest>
                       </archive>
                   </configuration>
               </plugin>
           </plugins>
       </build>
   </project>
   

   Актуальные версии зависимостей для Maven:

   • jedis.
   • slf4j-simple.

package com.example;

import java.util.HashSet;
import redis.clients.jedis.JedisSentinelPool;
import redis.clients.jedis.Jedis;

public class App {
public static void main(String[] args) {
  String redisName    = "<имя кластера Redis>";
  String redisPass    = "<пароль>";

  HashSet sentinels = new HashSet();
  sentinels.add("<FQDN хоста 1 Redis>:26379");
  ...
  sentinels.add("<FQDN хоста N Redis>:26379");

  try {
    JedisSentinelPool pool = new JedisSentinelPool(redisName, sentinels);
    Jedis conn = pool.getResource();

    conn.auth(redisPass);
    conn.set("foo", "bar");
    System.out.println(conn.get("foo"));

    pool.close();
  }
  catch(Exception ex) {ex.printStackTrace();}
}
}

package com.example;

import redis.clients.jedis.Jedis;

public class App {
public static void main(String[] args) {
  String redisHost    = "<FQDN хоста-мастера Redis>";
  String redisPass    = "<пароль>";

  try {
    Jedis conn = new Jedis(redisHost);

    conn.auth(redisPass);
    conn.set("foo", "bar");
    System.out.println(conn.get("foo"));

    conn.close();
  }
  catch(Exception ex) {ex.printStackTrace();}
}
}

mvn clean package && \
java -jar target/app-0.1.0-jar-with-dependencies.jar

package com.example;

import redis.clients.jedis.Jedis;

public class App {
public static void main(String[] args) {
  String redisHost    = "<FQDN хоста-мастера Redis:6380>";
  String redisPass    = "<пароль>";

  try {
    Jedis conn = new Jedis("rediss://" + redisHost);

    conn.auth(redisPass);
    conn.set("foo", "bar");
    System.out.println(conn.get("foo"));

    conn.close();
  }
  catch(Exception ex) {ex.printStackTrace();}
}
}

mvn clean package && \
java -jar target/app-0.1.0-jar-with-dependencies.jar

Node.js

Перед подключением установите зависимости:

sudo apt update && sudo apt install -y nodejs npm && \
npm install ioredis

"use strict"
const Redis = require('ioredis');

const conn = new Redis({
  sentinels: [
    { host: "<FQDN хоста 1 Redis>", port: 26379 },
    ...,
    { host: "<FQDN хоста N Redis>", port: 26379 },
  ],
  name: "<имя кластера Redis>",
  password: "<пароль>",
});

conn.set("foo", "bar", function (err) {
  if (err) {
    console.error(err);
    conn.disconnect();
  }
});

conn.get("foo", function (err, result) {
  if (err) {
    console.error(err);
  } else {
    console.log(result);
  }

  conn.disconnect();
});

"use strict"
const Redis = require('ioredis');

const conn = new Redis({
  host: "<FQDN хоста-мастера Redis>",
  port: 6379,
  password: "<пароль>",
});

conn.set("foo", "bar", function (err) {
  if (err) {
    console.error(err);
    conn.disconnect();
  }
});

conn.get("foo", function (err, result) {
  if (err) {
    console.error(err);
  } else {
    console.log(result);
  }

  conn.disconnect();
});

node app.js

"use strict"
const fs = require('fs');
const Redis = require('ioredis');

const conn = new Redis({
  host: "<FQDN хоста-мастера Redis>",
  port: 6380,
  password: "<пароль>",
  tls: {
      ca: fs.readFileSync('~/.redis/YandexInternalRootCA.crt')
  }
});

conn.set("foo", "bar", function (err) {
  if (err) {
    console.error(err);
    conn.disconnect();
  }
});

conn.get("foo", function (err, result) {
  if (err) {
    console.error(err);
  } else {
    console.log(result);
  }

  conn.disconnect();
});

node app.js

При успешном подключении к кластеру и выполнении тестового запроса будет выведена строка bar.

Go

Перед подключением установите зависимости:

sudo apt update && sudo apt install -y golang git && \
go mod init github.com/go-redis/redis && \
go get github.com/go-redis/redis/v7

package main

import (
        "fmt"
        "github.com/go-redis/redis/v7"
)

func main() {
        conn := redis.NewUniversalClient(
                &redis.UniversalOptions{
                        Addrs:      []string{
                                      "<FQDN хоста 1 Redis>:26379",
                                      ...,
                                      "<FQDN хоста N Redis>:26379"},
                        MasterName: "<имя кластера Redis>",
                        Password:   "<пароль>",
                        ReadOnly:   false,
                },
        )
        err := conn.Set("foo", "bar", 0).Err()
        if err != nil {
                panic(err)
        }

        result, err := conn.Get("foo").Result()
        if err != nil {
          panic(err)
        }
        fmt.Println(result)

        conn.Close()
}

package main

import (
        "fmt"
        "github.com/go-redis/redis/v7"
)

func main() {
        conn := redis.NewUniversalClient(
                &redis.UniversalOptions{
                        Addrs:      []string{ "<FQDN хоста-мастера Redis>:6379" },
                        Password:   "<пароль>",
                        ReadOnly:   false,
                },
        )
        err := conn.Set("foo", "bar", 0).Err()
        if err != nil {
                panic(err)
        }

        result, err := conn.Get("foo").Result()
        if err != nil {
          panic(err)
        }
        fmt.Println(result)

        conn.Close()
}

go run connect.go

package main

import (
        "fmt"
        "github.com/go-redis/redis/v7"
        "crypto/tls"
        "crypto/x509"
        "io/ioutil"
)

const (
    cert = "~/.redis/YandexInternalRootCA.crt"
)

func main() {
        rootCertPool := x509.NewCertPool()
        pem, err := ioutil.ReadFile(cert)
        if err != nil {
            panic(err)
        }

        if ok := rootCertPool.AppendCertsFromPEM(pem); !ok {
            panic("Failed to append PEM.")
        }

        conn := redis.NewUniversalClient(
                &redis.UniversalOptions{
                        Addrs:      []string{ "<FQDN хоста-мастера Redis>:6380" },
                        Password:   "<пароль>",
                        ReadOnly:   false,
                        TLSConfig: &tls.Config{
                                RootCAs: rootCertPool,
                                InsecureSkipVerify: true,
                        },
                },
        )
        err = conn.Set("foo", "bar", 0).Err()
        if err != nil {
                panic(err)
        }

        result, err := conn.Get("foo").Result()
        if err != nil {
          panic(err)
        }
        fmt.Println(result)

        conn.Close()
}

go run connect.go

При успешном подключении к кластеру и выполнении тестового запроса будет выведена строка bar.

Ruby

Перед подключением установите зависимости:

sudo apt update && sudo apt install -y ruby && \
sudo gem install redis

require "redis"

SENTINELS = [{host: "<FQDN хоста 1 Redis>", port: 26379},
             ...,
             {host: "<FQDN хоста N Redis>", port: 26379}]

conn = Redis.new(
         host: "<имя кластера Redis>",
         sentinels: SENTINELS,
         role: "master",
         password: "<пароль>"
       )

conn.set("foo", "bar")
puts conn.get("foo")

conn.close()

require "redis"

conn = Redis.new(
         host: "<FQDN хоста-мастера Redis>",
         port: 6379,
         password: "<пароль>"
       )

conn.set("foo", "bar")
puts conn.get("foo")

conn.close() 

ruby connect.rb

require "redis"

conn = Redis.new(
         host: "<FQDN хоста-мастера Redis>",
         port: 6380,
         password: "<пароль>",
         ssl: true,
         ssl_params: { ca_file: '~/.redis/YandexInternalRootCA.crt' },
       )

conn.set("foo", "bar")
puts conn.get("foo")

conn.close() 

ruby connect.rb

При успешном подключении к кластеру и выполнении тестового запроса будет выведена строка bar.

Особые FQDN

Наравне с обычными FQDN, которые можно запросить со списком хостов в кластере, Managed Service for Redis предоставляет особые FQDN, которые можно использовать только при подключении к нешардированному кластеру.

Текущий мастер

FQDN вида c-<идентификатор кластера>.rw.mdb.yandexcloud.net в нешардированном кластере всегда указывает на текущий хост-мастер. Идентификатор кластера можно запросить со списком кластеров в каталоге.

При подключении к этому FQDN разрешено выполнять операции чтения и записи.

Пример подключения с SSL-шифрованием к хосту-мастеру для кластера с идентификатором c9qash3nb1v9ulc8j9nm:

redis-cli -h c-c9qash3nb1v9ulc8j9nm.rw.mdb.yandexcloud.net \
      -p 6380 \
      --tls \
      --cacert ~/.redis/YandexInternalRootCA.crt \
      -a <пароль Redis>