ubuntu/valkey repository overview

ubuntu/valkey is a rock for valkey maintained by Canonical⁠.

This is an OCI image that bundles Valkey together with the metrics exporter. Valkey is an open source, flexible distributed key-value datastore that is optimized for caching and other realtime workloads.

[Learn more about valkey⁠]

⁠Tags and Architectures

NOTE: These tags follow a specific naming convention that respects the concept of channels⁠.

⁠Get started

This rock's entrypoint is Pebble, a container-optimized init process that enables the orchestration of a collection of local service processes as an organized set.

[Learn more about Pebble⁠]

⁠Inspect

To view the Pebble services⁠ and checks⁠ defined in this rock:

docker run --rm ubuntu/valkey:7.2.7-24.04_stable plan

⁠Run

To run this rock, use any of the usual container runtimes, for example, docker:

docker run --name valkey-container \
    -p 6379:6379 \
    ubuntu/valkey:7.2.7-24.04_stable

Access the Valkey server at http://localhost:6379.

Commands can be run using valkey-cli inside the container, e.g., to check Valkey's status:

$ docker exec valkey-container valkey-cli ping

⁠Get logs

To view the logs of the running container, run:

docker exec valkey-container pebble logs

Or, for a specific service:

docker exec valkey-container pebble logs <service>

⁠Monitor health checks

Rocks may have predefined health checks that you can list by running:

docker exec valkey-container pebble checks

The overall health of your container can be inspected via:

docker exec valkey-container pebble health

⁠Configuration

⁠Environment variables

⁠Volumes

⁠Ports

[Report a bug⁠] [Contribute⁠]

Canonical is the provider of this container image. It is the user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within, as well as with Canonical’s IP Policy⁠.