valkey-operator

module
v1.1.1-0...-4ee1ab4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 28, 2026 License: Apache-2.0

README

ValkeyOperator

Coverage Status Go Report Card

ValkeyOperator is a production-ready kubernetes operator to deploy and manage high available Valkey Sentinel and Valkey Cluster instances. This repository contains multi Custom Resource Definition (CRD) designed for the lifecycle of Valkey standalone, sentinel or cluster instance.

Features

  • Standalone/Sentinel/Cluster valkey arch supported.
  • Valkey ACL supported.
  • Nodeport/LB access supported; nodeport assignement also supported.
  • IPv4/IPv6 supported.
  • Online scale up/down.
  • Graceful version upgrade.
  • Nodeselector, toleration and affinity supported.
  • Generated StatefulSets, PodDisruptionBudgets and Services can be patched through spec.overwrites.
  • High available in production environment.

Quickstart

If you have a Kubernetes cluster and kubectl configured to access it, the easiest way to install ValkeyOperator is via Helm:

# Install the ValkeyOperator (cert-manager integration is enabled by default)
# Requires cert-manager to be installed: https://cert-manager.io/docs/installation/
helm install valkey-operator charts/valkey-operator \
  --namespace valkey-system --create-namespace

# Deploy a Valkey cluster
kubectl apply -f https://raw.githubusercontent.com/chideat/valkey-operator/main/docs/examples/basic/cluster.yaml

# Check the cluster status
kubectl get valkey valkey-cluster -w

Note: The Helm chart uses cert-manager to manage webhook TLS by default. Ensure cert-manager is installed before running helm install. Alternatively, disable webhooks with --set webhook.enabled=false if you don't need them.

Using Kustomize
# Install the ValkeyOperator
kubectl apply -k https://github.com/chideat/valkey-operator/config/default

For detailed installation and configuration instructions, see the User Guide.

Supported Versions

Valkey Version Kubernetes Versions Status
7.2.x 1.33, 1.34, 1.35 Stable
8.0.x 1.33, 1.34, 1.35 Stable
8.1.x 1.33, 1.34, 1.35 Stable
9.0.x 1.33, 1.34, 1.35 Stable
9.1.x 1.33, 1.34, 1.35 Stable

The v2.1.0 release candidate passed the end-to-end suite on Kubernetes v1.33.12 and v1.34.11 (kind) for every Valkey version above, and on Kubernetes v1.35.6 for Valkey 7.2, 8.1 and 9.1.

Documentation

ValkeyOperator is covered by comprehensive documentation:

For a complete list of features and configuration options, see the documentation directory.

In addition, practical examples and configuration samples can be found in this repository.

Contributing

This project follows the typical GitHub pull request model. Before starting any work, please either comment on an existing issue, or file a new one. For more details, please refer to the CONTRIBUTING.md file.

Releasing

To release a new version of the ValkeyOperator, create a versioned tag (e.g. v0.1.0) of the repo, and the release pipeline will generate a new draft release, along side release artefacts.

License

Licensed under Apache 2.0

Directories

Path Synopsis
api
rds/v1alpha1
Package v1alpha1 contains API Schema definitions for the rds v1alpha1 API group +kubebuilder:object:generate=true +groupName=rds.valkey.buf.red
Package v1alpha1 contains API Schema definitions for the rds v1alpha1 API group +kubebuilder:object:generate=true +groupName=rds.valkey.buf.red
v1alpha1
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=valkey.buf.red
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group +kubebuilder:object:generate=true +groupName=valkey.buf.red
cmd
helper command
internal
builder/overwrite
Package overwrite merges spec.overwrites into the objects the builders generate.
Package overwrite merges spec.overwrites into the objects the builders generate.
ops
testutil
Package testutil provides configurable fakes for the pkg/types interfaces, shared across unit tests instead of being re-implemented per package.
Package testutil provides configurable fakes for the pkg/types interfaces, shared across unit tests instead of being re-implemented per package.
pkg
test

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL