From 3efc03672f09a945f6eb9d38f1db64967c288fad Mon Sep 17 00:00:00 2001 From: tbaka Date: Thu, 3 Apr 2025 10:13:39 -0500 Subject: [PATCH 1/3] update redis distro and instructions --- docs/marketplace-docs/guides/redis/index.md | 54 ++++++++++++++++----- 1 file changed, 43 insertions(+), 11 deletions(-) diff --git a/docs/marketplace-docs/guides/redis/index.md b/docs/marketplace-docs/guides/redis/index.md index 49209274ff3..6b764fcba2a 100644 --- a/docs/marketplace-docs/guides/redis/index.md +++ b/docs/marketplace-docs/guides/redis/index.md @@ -2,7 +2,7 @@ title: "Deploy Redis through the Linode Marketplace" description: "This guide shows how you can install Redis database, a open-source, in-memory, data structure store, with optional write and persistence of data on a disk." published: 2020-03-13 -modified: 2022-03-08 +modified: 2025-04-03 keywords: ['redis','data store','cluster','database'] tags: ["linode platform","database","marketplace","cloud-manager"] external_resources: @@ -18,6 +18,8 @@ marketplace_app_name: "Redis" [Redis](https://redis.io/) is an open-source, in-memory, data-structure store, with the optional ability to write and persist data to a disk, which can be used as a key-value database, cache, and message broker. Redis features built-in transactions, replication, and support for a variety of data structures such as strings, hashes, lists, sets, and others. +The One-Click App for Redis installs Redis version 7.2.7. + ## Deploying a Marketplace App {{% content "deploy-marketplace-apps-shortguide" %}} @@ -30,28 +32,58 @@ marketplace_app_name: "Redis" ## Configuration Options -- **Supported distributions:** Debian 11, Ubuntu 20.04 LTS -- **Recommended minimum plan:** All plan types and sizes can be used, though consider using a [High Memory Compute Instance](https://www.linode.com/products/high-memory/) for larger databases in a production environment. +- **Supported distributions:** Ubuntu 24.04 LTS +- **Suggested minimum plan:** All plan types and sizes can be used, though consider using a [High Memory Compute Instance](https://www.linode.com/products/high-memory/) for larger databases in a production environment. ### Redis Options -{{% content "marketplace-limited-user-fields-shortguide" %}} +{{% content "marketplace-required-limited-user-fields-shortguide" %}} + +### Self Signed SSL/TLS Options + +- **Country or Region:** Enter the country or region for you or your organization. + +- **State or Province:** Enter the state or province for you or your organization. + +- **Locality:** Enter the town or other locality for you or your organization. -{{% content "marketplace-custom-domain-fields-shortguide" %}} -- **Email address for the SOA record:** The start of authority (SOA) email address for this server. This is a required field if you want the installer to create DNS records. +- **Organization:** Enter the name of your organization. + +- **Email Address:** Enter the email address you wish to use for your certificate file. + +- **CA Common Name:** The common name that will be shared as the authority for all SSL certificates. Example: "Redis CA" + +- **Client Count:** Generate up to ten SSL certificates for external clients connecting to Redis. {{% content "marketplace-special-character-limitations-shortguide" %}} ## Getting Started after Deployment -### Access the Redis CLI +### Obtain the Credentials -1. Log in to your new Compute Instance through [Lish](/docs/products/compute/compute-instances/guides/lish/) or [SSH](/docs/guides/connect-to-server-over-ssh/) using either the `root` user or limited user and the associated password you entered when creating the instance. +Once the app is deployed, you need to obtain the credentials from the server. + +To obtain credentials: + +1. Log in to your new Compute Instance using one of the methods below: + + - **Lish Console**: Log in to Cloud Manager, click the **Linodes** link in the left menu, and select the Compute Instance you just deployed. Click **Launch LISH Console**. Log in as the `root` user. To learn more, see [Using the Lish Console](/docs/products/compute/compute-instances/guides/lish/). + - **SSH**: Log in to your Compute Instance over SSH using the `root` user. To learn how, see [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/). + +1. Run the following command to access the credentials file: + + ```command + cat /home/$USERNAME/.credentials + ``` + +This returns passwords that were automatically generated when the instance was deployed. Save them. Once saved, you can safely delete the file. + + +### Access the Redis CLI -1. To use the redis-cli, run either of the commands below: +1. Once you have logged in and obtained the credentials, you can use the redis-cli. Redis is configured to require authentication for the default user, and a valid client SSL certificate. - - `redis-cli`: This opens the interactive mode where you can type in whichever commands you wish. - - `redis-cli [argument]`, where *[argument]* is the argument or command you wish to run. For instance, running `redis-cli ping` should result in the output of `PONG` if redis is configured properly. + - `redis-cli --tls --cacert /etc/redis/ssl/ca/ca.crt --cert /etc/redis/ssl/certs/client1.crt --key /etc/redis/ssl/keys/client1.key.pem -a $REDIS_DEFAULT_USER_PASSWORD`: This opens the interactive mode where you can type in whichever commands you wish. For more information about the redis-cli and the commands you have available, see [redis-cli, the Redis command line interface](https://redis.io/topics/rediscli). From d0f08d4ea51c0f88b33cd23c29ead45b93f8a635 Mon Sep 17 00:00:00 2001 From: tbaka Date: Fri, 4 Apr 2025 11:58:35 -0500 Subject: [PATCH 2/3] redis updates --- docs/marketplace-docs/guides/redis/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/marketplace-docs/guides/redis/index.md b/docs/marketplace-docs/guides/redis/index.md index 6b764fcba2a..291a539e7f2 100644 --- a/docs/marketplace-docs/guides/redis/index.md +++ b/docs/marketplace-docs/guides/redis/index.md @@ -83,7 +83,7 @@ This returns passwords that were automatically generated when the instance was d 1. Once you have logged in and obtained the credentials, you can use the redis-cli. Redis is configured to require authentication for the default user, and a valid client SSL certificate. - - `redis-cli --tls --cacert /etc/redis/ssl/ca/ca.crt --cert /etc/redis/ssl/certs/client1.crt --key /etc/redis/ssl/keys/client1.key.pem -a $REDIS_DEFAULT_USER_PASSWORD`: This opens the interactive mode where you can type in whichever commands you wish. + - `redis-cli --tls --cacert /etc/redis/ssl/ca/ca.crt --cert /etc/redis/ssl/certs/client1.crt --key /etc/redis/ssl/keys/client1.key.pem -a $REDIS_DEFAULT_USER_PASSWORD`: This opens the interactive mode where you can type in whichever commands you wish. For more information about the redis-cli and the commands you have available, see [redis-cli, the Redis command line interface](https://redis.io/topics/rediscli). From 23a64a32cce12c641a3dcc449cb1022a5759178c Mon Sep 17 00:00:00 2001 From: Magda Sulik Date: Thu, 10 Apr 2025 15:33:12 +0200 Subject: [PATCH 3/3] editorial review --- docs/marketplace-docs/guides/redis/index.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/marketplace-docs/guides/redis/index.md b/docs/marketplace-docs/guides/redis/index.md index 291a539e7f2..04582fd7fe9 100644 --- a/docs/marketplace-docs/guides/redis/index.md +++ b/docs/marketplace-docs/guides/redis/index.md @@ -51,9 +51,9 @@ The One-Click App for Redis installs Redis version 7.2.7. - **Email Address:** Enter the email address you wish to use for your certificate file. -- **CA Common Name:** The common name that will be shared as the authority for all SSL certificates. Example: "Redis CA" +- **CA Common Name:** Enter a common name to be shared as the authority for all SSL certificates, for example *Redis CA*. -- **Client Count:** Generate up to ten SSL certificates for external clients connecting to Redis. +- **Client Count:** Generate up to ten SSL certificates for external clients connecting to Redis. {{% content "marketplace-special-character-limitations-shortguide" %}} @@ -80,12 +80,14 @@ This returns passwords that were automatically generated when the instance was d ### Access the Redis CLI +After you log in and obtain the credentials, you can use the Redis CLI. Redis is configured to require authentication for the default user, and a valid client SSL certificate. -1. Once you have logged in and obtained the credentials, you can use the redis-cli. Redis is configured to require authentication for the default user, and a valid client SSL certificate. +To access the Redis CLI, run the command: - - `redis-cli --tls --cacert /etc/redis/ssl/ca/ca.crt --cert /etc/redis/ssl/certs/client1.crt --key /etc/redis/ssl/keys/client1.key.pem -a $REDIS_DEFAULT_USER_PASSWORD`: This opens the interactive mode where you can type in whichever commands you wish. +`redis-cli --tls --cacert /etc/redis/ssl/ca/ca.crt --cert /etc/redis/ssl/certs/client1.crt --key /etc/redis/ssl/keys/client1.key.pem -a $REDIS_DEFAULT_USER_PASSWORD` -For more information about the redis-cli and the commands you have available, see [redis-cli, the Redis command line interface](https://redis.io/topics/rediscli). +This opens the interactive mode where you can type commands. To learn more on the Redis CLI and available commands, see [Redis CLI +](https://redis.io/topics/rediscli). ### Determining How to Use Redis