Clear Linux* OS valkey container image

What is this image?

clearlinux/valkey is a Docker image with valkey running on top of the official clearlinux base image.

Valkey is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes with radius queries and streams.

For other Clear Linux* OS based container images, see: https://hub.docker.com/u/clearlinux

Why use a clearlinux based image?

Clear Linux* OS is an open source, rolling release Linux distribution optimized for performance and security, from the Cloud to the Edge, designed for customization, and manageability.

Clear Linux* OS based container images use:

• Optimized libraries that are compiled with latest compiler versions and flags.
• Software packages that follow upstream source closely and update frequently.
• An aggressive security model and best practices for CVE patching.
• A multi-staged build approach to keep a reduced container image size.
• The same container syntax as the official images to make getting started easy.

To learn more about Clear Linux* OS, visit: https://clearlinux.org.

Deployment:

Deploy with Docker

The easiest way to get started with this image is by simply pulling it from Docker Hub.

1. Pull the image from Github Container Registry:

   docker pull ghcr.io/clearlinux/valkey
   

2. Start a container using the examples below:

   docker run --name some-valkey --network some-network -d ghcr.io/clearlinux/valkey valkey-server --protected-mode no
   

3. connecting via redis-cli

   docker run -it --network some-network --rm ghcr.io/clearlinux/valkey redis-cli -h some-valkey
   

Deploy with Kubernetes

This image can also be deployed on a Kubernetes cluster, such as minikube.The following example YAML files are provided in the repository as reference for Kubernetes deployment:

• redis-deployment.yaml: example using default configuration to create a basic redis service.
• redis-deployment-conf.yaml: example using your own custom configuration to create a redis service.

Steps to deploy redis on a Kubernetes cluster:

1. If you want to deploy valkey-deployment.yaml

   kubectl create -f valkey-deployment.yaml
   

   Or if you want to deploy valkey-deployment-conf.yaml

   kubectl create -f valkey-deployment-conf.yaml
   

2. Install valkey bundle and connect to the service, where 30001 is the port number defined in your service.

   swupd bundle-add valkey
   redis-cli -h <nodeIP> -p 30001
   

Build and modify:

The Dockerfiles for all Clear Linux* OS based container images are available at https://github.com/clearlinux/dockerfiles. These can be used to build and modify the container images.

1. Clone the clearlinux/dockerfiles repository.

   git clone https://github.com/clearlinux/dockerfiles.git
   

2. Change to the directory of the application:

   cd valkey/
   

3. Build the container image:

   docker build -t ghcr.io/clearlinux/valkey .
   

   Refer to the Docker documentation for default build arguments. Additionally:

   • swupd_args - specifies arguments to pass to the Clear Linux* OS software manager. See the swupd man pages for more information.

Licenses

All licenses for the Clear Linux* Project and distributed software can be found at https://clearlinux.org/terms-and-policies