Charmed Valkey documentation¶
Warning
The charm is under active development and is not yet production-ready. APIs, configuration options, and integration endpoints may change. Contact us for feature requests.
Charmed Valkey is an open-source Juju charm that will automate the deployment, scaling, configuration and operations of Valkey clusters across clouds, virtual machines and bare metal, using the Juju orchestration framework.
Valkey is a community-driven, open-source, high-performance key-value data store compatible with Redis® clients and ecosystem tooling.
The charm aims to simplify Valkey operations from Day 0 to Day 2, offering secure defaults integration interfaces, and lifecycle automation.
In this documentation¶
Tutorial Get started - a hands-on introduction to Valkey for new users |
How-to guides Step-by-step guides covering key operations and common tasks |
How this documentation is organised¶
This documentation uses the Diátaxis documentation structure.
The Tutorial takes you step-by-step through the initial Charmed Valkey setup and usage.
How-to guides assume you have basic familiarity with Valkey and Juju.
Reference includes factual data required for using Charmed Valkey.
Explanation provides deeper understanding of important concepts and ideas.
Project and community¶
Charmed Valkey is a member of the Ubuntu family. It’s an open source project that warmly welcomes community contributions, suggestions, fixes and constructive feedback.
License and trademarks¶
Valkey and the Valkey logo are trademarks of LF Projects, LLC.
The Charmed Valkey operator is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.