Redis Sentinel (cluster)
Deploy Redis as a Redis Sentinel cluster for high availability. Redis is an open source in-memory data store used as a key-value database, cache, and message broker.
Cluster deploymentThe app is deployed with three or five Linode instances to create a highly available Redis cluster, each with the plan type and size you select.
Each of these Linode instances will appear on your invoice as separate items. To deploy Redis on a single instance, see the Redis guide.
1. Deploy Redis Sentinel cluster
clusterFollow the deployment instructions from the Get started section to configure the app, deploy it, and verify software installation.
For information on the app-specific configurations, see the Configuration options section.
Base distribution and plan
- Supported distribution: Ubuntu 24.04 LTS
- Recommended plans:
- All plan types and sizes can be used.
- For larger databases in a production environment, use a High Memory Compute Instance.
Configuration options
Configure the required options to deploy your instance. For additional customization, add advanced options.
The table maps the Cloud Manager UI fields to their corresponding API/CLI keys (stackscript_data) required for automated deployments.
StackScript ID: 1132204
| UI field | API/CLI key | Description |
|---|---|---|
| Required options | ||
| Linode API token | token_password | A valid Linode API token with grants to deploy Linode instances. Follow Manage personal access tokens to get the token on your account with Read/Write access to Linodes. |
| Limited sudo user | sudo_username | Your preferred username for the limited sudo user entered without any capital letters, spaces, or special characters. When adding a limited sudo user, the user is created with a strong generated password for your new Linode instance, and the account is assigned to the sudo group, which provides elevated permissions when running commands with the sudo prefix.Note: For easier and more secure access with the sudo user, add an account SSH key for the Cloud Manager user during deployment and select that user as an |
| SSL Information | sslheader | Set to Yes by default. This requires providing details for a self-signed TLS/SSL certificate, like country, town, organization, and email address. |
| Country or region | country_name | Applies to a self-signed TLS/SSL certificate. The country or region for you or your organization. When using the API/CLI, specify it as a two-letter ISO country or region code. |
| State or province | state_or_province_name | Applies to a self-signed TLS/SSL certificate. The state or province for you or your organization. |
| Locality | locality_name | Applies to a self-signed TLS/SSL certificate. The town or other locality for you or your organization. |
| Organization | organization_name | Applies to a self-signed TLS/SSL certificate. The name of your organization. |
| Email address | email_address | Applies to a self-signed TLS/SSL certificate. The email address to use for certificate generation and notices. |
| Advanced options | ||
| Disable root access over SSH | disable_root | Applies to a limited sudo user. To block the root user from logging in over SSH, select Yes. Defaults to No. Note: When you disable the root user from logging in over SSH and don't provide a valid Account SSH Key assigned to the |
| CA Common Name | ca_common_name | Applies to a self-signed TLS/SSL certificate. The common name for the self-signed Certificate Authority. Defaults to Redis CA. |
| Common Name | common_name | Applies to a self-signed TLS/SSL certificate. The common name used for the domain. Defaults to Redis Server. |
| Cluster Settings | clusterheader | Set to Yes by default. Details of the cluster settings, including the cluster size and whether to add account SSH keys to all nodes. |
| Add Account SSH Keys to All Nodes | add_ssh_keys | When set to yes, any SSH Keys that are added to the root user account (in the SSH Keys section). They're also added to your limited user account on all deployed Linode instances. Possible values are: yes or no. Defaults to yes. |
| Redis cluster size | cluster_size | The number of Linode instances created for this cluster. Possible values are 3 or 5. Defaults to 3. |
Note: After the app deployment completes, the password for your limited sudo user is generated and stored in the
.deployment-secrets.txtfile in the home directory, along with Redis credentials. Log in to your instance asrootthrough the Lish console or SSH, then runcat /home/$USERNAME/.deployment-secrets.txtto view its contents.
Use API, CLI, or Terraform
In addition to deploying the app to a new Linode instance via Cloud Manager, you can also use the Linode API, CLI, or Terraform. When running the operation, you need to provide the StackScript ID, supported Linux distribution, and app-specific fields along with the standard Linode deployment configurations.
Note: Generate a personal access token to authenticate your API, CLI, or Terraform requests.
curl --location 'https://api.linode.com/v4/linode/instances' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer abc123def456hij789klm' \
--data-raw '{
"region": "us-east",
"type": "g6-standard-4",
"image": "linode/ubuntu24.04",
"label": "my-redis-sentinel-cluster-one-click-app",
"root_pass": "@C0mpl3x#P@ssw0rd",
"stackscript_id": 1132204,
"stackscript_data": {
"token_password": "abc123def456hij789klm",
"sudo_username": "jsmith",
"country_name": "US",
"state_or_province_name": "Massachusetts",
"locality_name": "Cambridge",
"organization_name": "Akamai Technologies",
"email_address": "jsmith@example.com"
}
}'linode-cli linodes create \
--region us-east \
--type g6-standard-4 \
--label my-redis-sentinel-cluster-one-click-app \
--image linode/ubuntu24.04 \
--root_pass @C0mpl3x#P@ssw0rd \
--stackscript_id 1132204 \
--stackscript_data '{"token_password":"abc123def456hij789klm", "sudo_username":"jsmith", "country_name":"US", "state_or_province_name":"Massachusetts", "locality_name":"Cambridge", "organization_name":"Akamai Technologies", "email_address":"jsmith@example.com"}'resource "linode_instance" "my-linode" {
region = "us-east"
type = "g6-standard-4"
label = "my-redis-sentinel-cluster-one-click-app"
image = "linode/ubuntu24.04"
root_pass = "@C0mpl3x#P@ssw0rd"
stackscript_id = 1132204
stackscript_data = {
"token_password" = "abc123def456hij789klm"
"sudo_username" = "jsmith"
"country_name" = "US"
"state_or_province_name" = "Massachusetts"
"locality_name" = "Cambridge"
"organization_name" = "Akamai Technologies"
"email_address" = "jsmith@example.com"
}
}2. Access the Redis CLI
-
Log in to your instance through the Lish console or SSH using either the
rootuser or limited user and the associated password you entered when creating the instance. -
To use
redis-cli, run either of these commands:redis-cli: This opens an interactive mode where you can type in whichever commands you want.redis-cli [argument], where [argument] is the argument or command you want to run. For example, runningredis-cli pingshould outputPONGif Redis is configured properly.
For more information about redis-cli and the available commands, see redis-cli and the Redis command line interface.
Additional resources
You can use several Redis configuration types. For example, you can configure Redis as a standalone Redis installation or a Redis cluster with a primary (master) and two replicas.
As a next step, you should determine which type of deployment you require for your use case by reviewing these resources:
- Learn about Redis clusters by going through their related tutorial.
- Redis Sentinel is another deployment configuration focused on high availability. See the Redis Sentinel documentation for more details.
- Read the Redis Quick Start to learn about securing Redis and installing client libraries to use Redis with your applications.
- Refer to the Redis configuration documentation to learn about the Redis configuration file.
Once you've determined how you'd like to configure your Redis deployment, connect to your Linode via SSH to complete your configuration.
Note that we can't vouch for the accuracy or timeliness of externally hosted resources.
Updated 19 days ago
