Deploy Redis on Northflank | Deploy Databases On Northflank | Databases And Persistence | Northflank Application docs

Databases And Persistence / Deploy Databases On Northflank /

Deploy Redis on Northflank

This guide explains how to quickly and easily deploy and use Redis on Northflank.

Available versionsDescriptionBackupsTLS
7.0.9, 7.0.7, 6.2.11, 6.2.8Redis implements a distributed, in-memory key-value database with optional durability.DiskYes

Deploy Redis

  1. Choose addon from the create new menu in the top right corner of the dashboard

  2. Select Redis and enter a name

  3. Choose a version or leave as default (most recent version)

  4. Choose whether to deploy with TLS. This can be changed later.

  5. Choose whether to make the database publicly accessible. This will give your addon a URL and make it available online. TLS must be enabled to select this.

  6. If you have secret groups in your project, choose ones to link to the addon so that the database can be used in services and jobs that inherit variables from the secret group. To link the database to a secret group:

    • Show secret groups and configure the secret groups you wish to use
    • Select suggested secrets from the database to link, or select all
    • Set any required aliases for specific secrets to make them accessible by that name within your application
  7. Select the required resources for your database. You can scale the database after creation, but available storage and replicas cannot be decreased once increased.

  8. Create addon and Redis will begin provisioning, this may take a few minutes.

Connect to Redis

You can manually copy the connection secrets for your Redis database from the connection details page into runtime variables or build arguments of your workloads on Northflank.

However, it is much easier to link your database's connection details to a new or existing secret group.

The necessary secrets to connect your workload will vary depending on the application in your workload.

Some clients may use a connection string, while some clients may not support the connection string format .

The connection string REDIS_MASTER_URL takes the format [redis|rediss]://[user:password@][host][:port]. There is also REDIS_CONNECT_COMMAND for command-line clients.

You can supply connections details and secrets such as host, password, and port to your workload if your application is configured to use these instead of a connection string.

Available ports

PortProtocolURI prefix

Automatically inherit database connection details into your workload

  1. Create a new secret group of runtime variables to connect in the running workload
  2. Show addons and configure your addon with either REDIS_MASTER_URL or select connection details and secrets
  3. Set the aliases required in your workload to access the secrets
  4. Enable apply secrets to specific services/jobs and select the workloads you want to access the database
  5. Create secret group
  6. Go to one of the workloads that inherits from the group and check the environment page, you should see the inherited variables from the secret group

The connection string or secrets will now be available in your workload under the configured aliases, and your application will be able to connect to the database using them.

Access Redis

You can use the connect command to access Redis using the Redis CLI, or connect a GUI tool using the HOST secret. The addon must be forwarded to connect using the host name.

Secure local access

To forward Redis for local access using the Northflank CLI, copy and execute the forward addon command from the local access section of the overview.

You can then use the REDIS_CONNECT_COMMAND from the connection details page to access your Redis deployment using the command-line client, or use the connection details in your local development environment.

External access

To access your Redis database externally, ensure deploy with TLS and publicly accessible are enabled on the settings page under networking. The connection details will be updated to include an external connect command, and the host will now resolve externally.

Redis specifications

Maximum connections

By default, a maximum of 10,000 concurrent connections are allowed on a Redis addon.

Your addon will be able to handle more concurrent connections by increasing the available CPU and memory available. You can do this by selecting the compute plan on the addon's resources page.

© 2023 Northflank Ltd. All rights reserved.