Getting started with Yandex Managed Service for Valkey™

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 from the list on the left.

   2. At the top right, click Create folder.

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

      • It must be 2 to 63 characters long.
      • It may contain lowercase Latin letters, numbers, and hyphens.
      • It must start with a letter and cannot end with 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. Assign the vpc.user role and the managed-redis.editor role or higher to your Yandex Cloud account. These roles allow you to create a cluster.

   Note

   If unable to manage roles, contact your cloud or organization administrator.

4. Create a Linux VM.

   Specify the following parameters:

   • Boot disk image: Ubuntu 24.04 from Marketplace.

   • Public IP address: Auto.

   • Security groups: Leave the field empty.

     The VM will be assigned the default security group with the default-sg prefix. This security group enables SSH connections to the VM and allows any outgoing traffic.

   Set the other parameters as you need.

5. Create a security group in the same network as the VM. This security group will be assigned to the Valkey™ cluster when creating it.

   In the security group, add a rule that allows connections to a non-sharded Valkey™ cluster. Configuire the rule to allow incoming traffic from the default security group assigned to the VM.

Create a clusterCreate a cluster

Create a non-sharded Valkey™ cluster without public access. You can only connect to such a cluster from a VM in the cluster network.

To create a cluster:

1. In the management console, select the folder where you want to create a Valkey™ cluster.

2. Select Yandex Managed Service for Valkey™.

3. Click Create cluster.

4. Specify the following cluster parameters:

   • Basic parameters:

     • Cluster name: Cluster name. It must be unique within the folder.
     • Cluster sharding: Keep this option disabled.
     • Enable TLS support.
     • Enable Use FQDN instead of IP addresses.

   • Network settings:

     • Network: Specify the network with the previously created VM.
     • Security groups: Specify the previously created security group for the cluster.

   • Hosts → Public access: Make sure to disable this option, i.e., set its value to No, for all cluster hosts.

   • DBMS settings → Password: User password.

     The password must be between 8 and 128 characters long. The password must meet the [a-zA-Z0-9@=+?*.,!&#$^<>_-]* regular expression.

5. Click Create cluster.

6. Wait until the cluster is ready: its status on the Yandex Managed Service for Valkey™ dashboard will change to Running and its state, to Alive. This may take some time.

For more information about creating a cluster, see Creating a Valkey™ cluster.

Connect to the clusterConnect to the cluster

1. Use SSH to connect to the previously created VM.

2. Install the redis-cli utility:

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

3. Connect directly to the master host:

   Connecting without SSL

   Connecting via SSL

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

   1. Get an SSL certificate:

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

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

   2. Run this command:

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

   You can request the cluster ID with the list of clusters in the folder.

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

4. Once connected, send the PING command. Valkey™ should respond with PONG.

What's nextWhat's next

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