valkey-bundle

Chainguard Container for valkey-bundle

Valkey bundle with pre-installed modules for extended functionality.

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/valkey-bundle: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 valkey-bundle image is based on the upstream Valkey project and includes several popular Valkey modules pre-installed:

• valkey-bloom: Probabilistic data structures (Bloom filters, Cuckoo filters, Count-Min Sketch, Top-K)
• valkey-json: Native JSON data type support
• valkey-search: Full-text search and secondary indexing
• valkey-ldap: LDAP authentication support

This image differs from the standard valkey image in the following ways:

• Includes pre-loaded modules for extended functionality
• Uses bundle-docker-entrypoint.sh as the entrypoint to automatically load modules

For Valkey 8.0, the bloom module uses valkey-bloom built with --features valkey_8_0 for compatibility. For Valkey <9.0, the bloom module uses an older version of valkey-search for compatibility.

Getting Started

To run valkey-bundle with Docker:

docker run -p 6379:6379 cgr.dev/ORGANIZATION/valkey-bundle:latest

You should see output indicating that Valkey has started with the modules loaded.

To verify the modules are loaded, connect with the Valkey CLI:

docker run --rm -it cgr.dev/ORGANIZATION/valkey-bundle:latest valkey-cli -h host.docker.internal MODULE LIST

This will display a list of loaded modules including bloom, json, and search.

Using Valkey Modules

JSON Module

The JSON module provides native support for storing, updating, and querying JSON documents directly in Valkey. This eliminates the need to serialize/deserialize JSON data in your application code, enabling atomic operations on nested JSON structures and efficient memory usage through binary storage.

Example: Store and retrieve JSON data:

valkey-cli JSON.SET user:1 $ '{"name":"Alice","age":30}'

OK

valkey-cli JSON.GET user:1 $.name

"[\"Alice\"]"

Bloom Filter Module

The Bloom module provides probabilistic data structures for efficient membership testing and cardinality estimation. Bloom filters allow you to check if an element "possibly exists" or "definitely does not exist" in a set, using significantly less memory than storing the actual elements.

Example: Create a Bloom filter and test membership:

valkey-cli BF.ADD myfilter item1

(integer) 1

valkey-cli BF.EXISTS myfilter item1

(integer) 1

Search Module

The Search module adds full-text search and secondary indexing capabilities to Valkey. It enables complex queries across your data without external search infrastructure, supporting text search, numeric filtering, geo-spatial queries, and aggregations.

Example: Create a search index on JSON documents:

valkey-cli FT.CREATE idx:users ON JSON PREFIX 1 user: SCHEMA $.name AS name TEXT $.age AS age NUMERIC

OK

valkey-cli FT.SEARCH idx:users "@name:Alice"

Users and Directories

By default, this image runs as a non-root user named valkey with a uid of 65532. The default working directory is /data, which is writable by the valkey user.

Documentation and Resources

• Valkey Documentation
• Valkey GitHub Repository
• Valkey-Bundle GitHub Repository

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system 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 development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

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.