For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/en/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/en/guides/public-cloud/databases/valkey-prepare-for-incoming-connections.md.

Configure incoming connections of a Public Cloud Databases for Valkey service

View as Markdown

Find out how to configure your Valkey service to accept incoming connections

Objective

Public Cloud Databases allow you to focus on building and deploying cloud applications while OVHcloud takes care of the database infrastructure and maintenance in operational conditions.

This guide explains how to configure your Valkey instance to accept incoming connections.

Requirements

  • A Public Cloud project in your OVHcloud account
  • A Valkey service running on your OVHcloud Public Cloud Databases (this guide can help you to meet this requirement)

OVHcloud Console Access

  • Direct link:
  • Navigation path: Public Cloud > Select your project > Databases

Instructions

Configure your Valkey instance to accept incoming connections

Before making a connection, we need to verify that our Valkey instance is correctly configured.

In the left-hand menu of your Public Cloud project, click Valkey under Databases, then click the name of your Valkey service.

Step 1: Verify your user roles and password

Select the Users tab. Verify that you have a user with sufficient rights and a password. A default user exists on every new service.

The password of a user is displayed only once, when the user is created, and cannot be retrieved later. If you don't remember the user's password, you can either create a new user or regenerate the password of an existing user: click on the ... button on the row of the user, then on Reset password. Be careful! By doing so you will need to update all the places where you already use this user/password pair.

To create a new user, click on Add a user, fill in the form in the Add a user panel, then click on Create.

  • Username: the name of the user.
  • Keys: the key patterns the user can access, for example cache:*.
  • Categories: the command categories allowed (+) or denied (-), for example +@read, +@write, +@connection.
  • Commands: individual commands allowed (+) or denied (-), for example -flushall.
  • Channels: the pub/sub channel patterns the user can access, for example news:*.

In our example, we create a user called app-user with the following rights:

  • Keys:
    • cache:* (only keys starting with cache:)
  • Categories:
    • +@read (read commands)
    • +@write (write commands)
    • +@connection (connection commands such as PING, HELLO or AUTH)
    • +@pubsub (pub/sub commands, needed in addition to a channel pattern to publish or subscribe)
  • Commands:
    • -flushall (forbids the FLUSHALL command)
  • Channels:
    • news:* (only channels starting with news:)

With these rights, any access to a key outside cache:* is refused with the error NOPERM No permissions to access a key.

Once created or updated, the user must have the READY status in the OVHcloud Console.

To change the rights of an existing user, click on the ... button on the row of the user, then on Edit. The new rights apply immediately, without reconnecting. You can also manage them with the API.

Info

Follow the Valkey ACL documentation and the Valkey commands documentation to learn more.

Follow this guide to learn more about users and roles capabilities and limitations.

Step 2: Authorise incoming connections from the service

Warning

For security reasons the default network configuration doesn't allow any incoming connections. It is thus critical you authorise the suitable IP addresses in order to successfully access your database.

Select the Configuration tab, then locate the IP restrictions section.

Click Add, enter an IP address or a CIDR block in the IP block (CIDR) field and a description to identify its origin, then click Save. In our example, we enter 203.0.113.10/32.

You can remove an authorised IP from the same section, then save your changes.

Warning

You can enter 0.0.0.0/0 to allow connections from any address. Your service then becomes reachable from the entire Internet, and only the username/password pair protects your data. Please use it carefully.

Collect required information

Select the Overview tab to find the connection details in the Connection details card: host, port, protocol, connection URI and the CA certificate of the service (Download (.pem)).

The URI has the form valkeys://<username>:<password>@<host>:<port>. TLS is mandatory: connections without TLS are refused. The server certificate is signed by a public certification authority, so you do not need to download a CA certificate to connect.

Select the Users tab to get the username.

Go further

Connect using the CLI

Connect using Python

Connect using PHP

Visit our dedicated Discord channel: https://discord.gg/ovhcloud. Ask questions, provide feedback and interact directly with the team that builds our databases services.

For training or technical assistance implementing our solutions, contact your sales representative or visit our Professional Services page to request a quote and have your project analysed by our experts.

Join our community of users.

Was this page helpful?