Deploy Valkey through the Linode Marketplace

Valkey is an open-source (BSD) key/value datastore that supports diverse workloads such as caching and message queues, and can act as a primary database. The Akamai Connected Cloud One-Click App for Valkey is configured as a standalone system daemon with TLS support.

Valkey natively supports a broad collection of data types, extensibility with built-in scripting support for Lua, and module plugins to create new commands, data types, and more.

Deploying a Marketplace App

The Linode Marketplace lets you easily deploy software on a Compute Instance using Cloud Manager. See Get Started with Marketplace Apps for complete steps.

1. Log in to Cloud Manager and select the Marketplace link from the left navigation menu. This displays the Linode Create page with the Marketplace tab pre-selected.

2. Under the Select App section, select the app you would like to deploy.

3. Complete the form by following the steps and advice within the Creating a Compute Instance guide. Depending on the Marketplace App you selected, there may be additional configuration options available. See the Configuration Options section below for compatible distributions, recommended plans, and any additional configuration options available for this Marketplace App.

4. Click the Create Linode button. Once the Compute Instance has been provisioned and has fully powered on, wait for the software installation to complete. If the instance is powered off or restarted before this time, the software installation will likely fail.

To verify that the app has been fully installed, see Get Started with Marketplace Apps > Verify Installation. Once installed, follow the instructions within the Getting Started After Deployment section to access the application and start using it.

Configuration Options

• Supported distributions: Ubuntu 22.04 LTS
• Suggested minimum plan: All plan types and sizes can be used. For best results, a minimum of 8GB Dedicated CPU or Shared Compute Instance is recommended.

Valkey Options

Limited Sudo User

You need to fill out the following fields to automatically create a limited sudo user, with a strong generated password for your new Compute Instance. This account will be assigned to the sudo group, which provides elevated permissions when running commands with the sudo prefix.

• Limited sudo user: Enter your preferred username for the limited user. No Capital Letters, Spaces, or Special Characters.

  Locating The Generated Sudo Password

  A password is generated for the limited user and stored in a .credentials file in their home directory, along with application specific passwords. This can be viewed by running: cat /home/$USERNAME/.credentials

  For best results, add an account SSH key for the Cloud Manager user that is deploying the instance, and select that user as an authorized_user in the API or by selecting that option in Cloud Manager. Their SSH pubkey will be assigned to both root and the limited user.

• Disable root access over SSH: To block the root user from logging in over SSH, select Yes. You can still switch to the root user once logged in, and you can also log in as root through Lish.

  Accessing The Instance Without SSH

  If you disable root access for your deployment and do not provide a valid Account SSH Key assigned to the authorized_user, you will need to login as the root user via the Lish console and run cat /home/$USERNAME/.credentials to view the generated password for the limited user.

• Number of clients connecting to Valkey: The number of clients that will be connecting to the cluster. The application will create SSL certificates for your client that need to connect to the cluster. This should be an integer equal or greater than 1.

• Valkey Version: Version of Valkey to install.

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.

• 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: “Valkey CA”

Getting Started After Deployment

Connect to the compute instance using either root or the sudo user created during deployment if you provided account SSH keys. In order to access the TLS-encrypted Valkey database, path arguments must be provided to valkey-cli. The directory paths are provided in the MOTD:

*********************************************************
Akamai Connected Cloud Valkey Marketplace App
Credentials File: /home/$SUDO_USER/.credentials
Valkey Configuration Directory: /etc/valkey/
Valkey Configuration File: /etc/valkey/valkey.conf
Valkey SSL directories: /etc/valkey/ssl/[ca,certs,keys,reqs]
Valkey Install directory: /var/valkey
Valkey Data Directory: /var/valkey/data
Valkey SRC: /var/valkey/lib/[...]
Valkey DEFAULT Configuration File: /var/valkey/lib/valkey.conf
Documentation: https://www.linode.com/docs/products/tools/marketplace/guides/valkey/
*********************************************************
To delete this message of the day: rm /etc/motd

Access the Valkey database from the compute instance using the valkey-cli command, for example:

--tls --cacert /etc/valkey/ssl/ca/ca.crt --cert /etc/valkey/ssl/certs/client1.crt --key /etc/valkey/ssl/keys/client1.key.pem

This enters the Valkey interface and allows you to authenticate as either the default user or the sudo user. The sudo user is created during deployment using the passwords provided in the /home/$SUDO_USER/.credentials file.

Valkey is deployed to listen only on 127.0.0.1 loopback. Additional configurations to Valkey and the firewall may be necessary to connect to external clients and resources.

More Information

Additional resources are available from the Valkey community.

• Valkey
• Valkey Github Repo

More Information

You may wish to consult the following resources for additional information on this topic. While these are provided in the hope that they will be useful, please note that we cannot vouch for the accuracy or timeliness of externally hosted materials.

• About Valkey
• Valkey Documentation