Chainguard Container for redis

Chainguard image for Redis, an in-memory database that persists on disk. Redis is a key-value store, supporting an array of different values, including Strings, Lists, Sets, Sorted Sets, Hashes, Streams, HyperLogLogs, and Bitmaps.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/redis:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Compatibility Notes

The Chainguard Redis image is comparable to the official Redis image on Docker Hub.

Unlike many other Chainguard images, the Redis image includes a shell, allowing you to interact with the Redis database using the Redis command-line interface, redis-cli.

By default this image runs as a non-root user named redis with a uid of 65532. Typically, Redis does not have a default data directory and instead defaults to whatever the working directory is for the Redis process. The Chainguard Redis image provides a default working directory of /data that is writeable by the redis user.

Important license update

Redis version 7.4 and subsequent releases are no longer licensed under BSD-3-Clause; instead, the Redis project has adopted a dual licensing model. This means users have the choice to adopt either the Redis Source Available License v2 (RSALv2) or the Server Side Public License v1 (SSPLv1).

Please give careful consideration to these licensing conditions when using Redis. For more details, refer to the upstream license information.

Getting Started

Redis Version

This will automatically pull the image to your local system and execute the command redis --version:

To run the Chainguard Redis image with Docker using default configuration you could run the following command:

docker run -p 6379:6379 --rm cgr.dev/ORGANIZATION/redis

This command forwards port 6379 (the default port for Redis) on the host machine to port 6379 on the container:

1:C 25 Oct 2024 17:12:32.419 * oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
1:C 25 Oct 2024 17:12:32.419 * Redis version=7.4.1, bits=64, commit=74b289a0, modified=1, pid=1, just started
1:C 25 Oct 2024 17:12:32.419 # Warning: no config file specified, using the default config. In order to specify a config file use /usr/bin/redis-server /path/to/redis.conf
1:M 25 Oct 2024 17:12:32.420 * monotonic clock: POSIX clock_gettime
1:M 25 Oct 2024 17:12:32.420 * Running mode=standalone, port=6379.
1:M 25 Oct 2024 17:12:32.421 * Server initialized
1:M 25 Oct 2024 17:12:32.421 * Ready to accept connections tcp

Following that, you can open another terminal and use redis-cli locally. Any commands you run through it will be forwarded to the redis process in the container:

$ redis-cli set test 10
OK
$ redis-cli get test
"10"
$ redis-cli
127.0.0.1:6379>

Alternatively, to test out Redis within the container, you can run the following command to access the container's shell:

docker run -it --entrypoint sh cgr.dev/ORGANIZATION/redis

Then run the redis-server command to start the redis process, and include the --daemonize yes option to prevent it from taking over the terminal:

/data $ redis-server --daemonize yes

Following that, you can run redis-cli, the Redis command-line interface, and begin testing the database:

/data $ redis-cli
127.0.0.1:6379> set test 20
OK
127.0.0.1:6379> get test
"20"

Configuration

If you supply a different configuration file or change the user, UID, or WORKDIR instruction, you'll need to ensure the user running the redis process has permissions to access the relevant redis.conf and dumb.rb files.

When running in Docker using a volume, the Chainguard Redis image will automatically use a custom configuration instead of the default one. Here's an example that mounts a host volume containing a custom Redis configuration to the /data directory in the container:

docker run -d -v $(pwd):/data -p 6379:6379 cgr.dev/ORGANIZATION/redis

Again, this example forwards the local port 6379 to the container's port 6379, the redis process's default port.

Following that, you can run redis-cli commands from your local machine which are then forwarded to the container:

$ redis-cli set foo bar
OK
$ redis-cli get foo
"bar"

You can also open the redis-cli prompt locally and forward commands to the container from there:

$ redis-cli
127.0.0.1:6379> get foo
"bar"

Documentation and Resources

• Official Redis Documentation
• (eBook) How To Manage a Redis Database
• (Tutorial) How to Port a Sample Application to Chainguard Images — this article works through porting a small but complete application (built on NodeJS and Redis) to use Chainguard Images
• Vulnerability Comparison: redis

What are Chainguard Containers?

Chainguard Containers are minimal container images that are secure by default.

In many cases, the Chainguard Containers tagged as :latest contain only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager. Chainguard Containers are built with Wolfi, our Linux undistro designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a -dev variant.

Although the -dev container image variants have similar security features as their more minimal versions, they feature additional software that is typically not necessary in production environments. We recommend using multi-stage builds to leverage the -dev variants, copying application artifacts into a final minimal container that offers a reduced attack surface that won’t allow package installations or logins.

Learn More

To better understand how to work with Chainguard Containers, please visit Chainguard Academy and Chainguard Courses.

In addition to Containers, Chainguard offers VMs and Libraries. Contact Chainguard to access additional products.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.