Getting started with Managed Service for Redis

To get started with the service:

1. Create a cluster.
2. Connect to the cluster.

Getting startedGetting started

1. Go to the management console and log in to Yandex Cloud or sign up if not signed up yet.

2. If you do not have a folder yet, create one:

   1. In the management console, select the appropriate cloud in the list on the left.

   2. At the top right, click Create folder.

   3. Enter the folder name. The naming requirements are as follows:

      • The name must be from 3 to 63 characters long.
      • It may contain lowercase Latin letters, numbers, and hyphens.
      • The first character must be a letter and the last character cannot be a hyphen.

   4. (Optional) Enter a description of the folder.

   5. Select Create a default network. This will create a network with subnets in each availability zone. Within this network, a default security group will be created, inside which all network traffic is allowed.

   6. Click Create.

3. Make sure your account has the vpc.user role and managed-redis.editor role or higher for creating a cluster.

4. If no public access is set up for a cluster, you can only connect to it from inside Yandex Cloud. To connect to a cluster, create a VM in the same cloud network as the Redis cluster (with Linux).

5. Connect to the VM over SSH.

6. Install the redis-cli utility on the VM. For example (for Ubuntu 20.04 LTS):

   sudo apt install redis-tools
   

Create a clusterCreate a cluster

1. In the management console, select the folder where you want to create a cluster Redis.
2. Select Managed Service for Redis.
3. Click Create cluster.
4. Set the cluster parameters and click Create cluster. For more information, see Creating clusters.
5. Wait until the cluster is ready: its status on the Managed Service for Redis dashboard will change to Running and its state, to Alive. This may take some time.

Connect to the clusterConnect to the cluster

1. If TLS support is enabled in your cluster, get an SSL certificate:

   Linux (Bash)/macOS (Zsh)

   Windows (PowerShell)

   mkdir -p ~/.redis && \
   wget "https://storage.yandexcloud.net/cloud-certs/CA.pem" \
        --output-document ~/.redis/YandexInternalRootCA.crt && \
   chmod 0655 ~/.redis/YandexInternalRootCA.crt
   

   The certificate is saved to the ~/.redis/YandexInternalRootCA.crt file.

   mkdir $HOME\.redis; curl.exe -o $HOME\.redis\YandexInternalRootCA.crt https://storage.yandexcloud.net/cloud-certs/CA.pem
   

   The certificate is saved to the $HOME\.redis\YandexInternalRootCA.crt file.

2. If using security groups for a cloud network, configure them to enable all relevant traffic between the cluster and the connecting host.

3. Connect to the cluster using redis-cli.

   Note

   To connect to an SSL-enabled cluster, download an archive with the utility's source code and build a version of the utility with TLS support using the make BUILD_TLS=yes command.

   To see code examples with the host FQDN filled in, open the cluster page in the management console and click Connect.

   Non-sharded cluster

   Sharded cluster

   To connect using Sentinel (without SSL):

   1. Get the address of the master host by using Sentinel and any Redis host:

      redis-cli -h <FQDN_of_any_Redis_host> \
        -p 26379 \
        sentinel get-master-addr-by-name <Redis_cluster_name> | head -n 1
      

   2. Connect to the host with this address:

      redis-cli \
          -h c-<cluster_ID>.rw.mdb.yandexcloud.net \
          -a <password> \
          -p 6380 \
          --tls \
          --cacert ~/.redis/YandexInternalRootCA.crt
      

   To connect directly to the master (without SSL):

   redis-cli -h c-<cluster_ID>.rw.mdb.yandexcloud.net \
     -p 6379 \
     -a <Redis_password>
   

   To connect directly to the master (with SSL):

   redis-cli -h c-<cluster_ID>.rw.mdb.yandexcloud.net \
     -p 6380 \
     -a <Redis_password> \
     --tls \
     --cacert ~/.redis/YandexInternalRootCA.crt
   

   To connect without SSL:

   redis-cli -h <FQDN_of_master_host_in_any_shard> \
     -p 6379 \
     -a <Redis_password>
   

   To connect with SSL:

   redis-cli -h <FQDN_of_master_host_in_any_shard> \
     -p 6380 \
     -a <Redis_password> \
     --tls \
     --cacert ~/.redis/YandexInternalRootCA.crt
   

4. Once connected, send the PING command. Redis should return PONG in response.

What's nextWhat's next

• Read about service concepts.
• Learn more about creating a cluster and connecting to a cluster.
• Read questions and answers.