🚀 Valkey Operator v1.0.9

Production-ready Valkey operations for Kubernetes and OpenShift, with global Valtrix console integration.

---

📑 Table of Contents

• ✨ Highlights
• 📊 Version Matrix
• 🏗️ Core Concepts
• 🖼️ Global Valtrix Web UI
  • 🎨 Dynamic Multi-Tenant Experience
  • 👑 Admin vs 👤 User Perspectives
• 🎡 OpenShift OperatorHub Experience
• 🛠️ Quick Install (OpenShift)
• 🌐 Deploy Global Valtrix
• 📦 Deploy a Valkey Cluster
• 📖 Valtrix Configuration Reference
• ⚡ Operational Commands
• 🔍 Troubleshooting
• ⬆️ Upgrade Notes
• 🆔 Release Identity
• 📜 License

---

✨ Highlights

Valkey Operator v1.0.9 delivers a stable API and an end-to-end platform experience for running sharded Valkey clusters:

• ✅ API promoted to valkey.arencloud.com/v1
• 🌍 Global Valtrix support through ValtrixConfig
• 🛡️ OpenShift-native route exposure for Valtrix
• ⚙️ Built-in support for Valkey node actions (restart/failover controls)
• 📦 Release-aligned related images (operator/exporter/tools/valtrix)
• 🚀 Catalog and bundle support for OpenShift OperatorHub workflows

---

📊 Version Matrix (v1.0.9)

Component	Image
Operator	quay.io/arencloud/valkey-operator:v1.0.9
Valtrix	quay.io/arencloud/valtrix:v1.0.9
Exporter	quay.io/arencloud/valkey-exporter:v1.0.9
Tools	quay.io/arencloud/valkey-tools:v1.0.9
Base Runtime	registry.access.redhat.com/hi/valkey:9

---

🏗️ Core Concepts

🔹 ValkeyCluster (v1)

Defines a sharded Valkey deployment (shards + replicas), persistence, resources, and associated management sidecars.

🔹 ValkeyNode (v1)

Internal node-level status/resource managed by the operator.

🔹 ValtrixConfig (v1)

Singleton/global Valtrix configuration designed for operator-namespace deployment and cluster-wide discovery.

---

🖼️ Global Valtrix Web UI

The Valtrix Console is a single, unified entry point for all Valkey operations. It automatically adapts its interface, data visibility, and action controls based on the identity of the logged-in user through native OpenShift RBAC integration.

---

🎨 Dynamic Multi-Tenant Experience

Unlike traditional dashboards, Valtrix doesn't require separate instances for different teams. One deployment serves the entire cluster, providing a tailored experience:

• 🛡️ Identity-Aware: Uses OpenShift OAuth to identify the user.
• 🏢 Namespace Isolation: Automatically filters clusters, nodes, and logs based on namespace-level permissions.
• ⚡ Permission-Gated Actions: Buttons for "Restart", "Failover", or "Delete" only appear if the user has the required Role or ClusterRole.

---

👑 Admin vs 👤 User Perspectives

Below is a side-by-side conceptual comparison of how the Global UI transforms based on who is logged in.

🖥️ Global Dashboard

The Dashboard adapts instantly. Admins see the total fleet health across the entire OpenShift cluster, while Users see a streamlined view of only their projects.

👑 Cluster Admin View	👤 Usual User View
💡 Full visibility of all shards and clusters.	💡 Focused view of authorized resources.

---

💎 Cluster & Node Inventory

Resource discovery is permission-based. The same "Clusters" page dynamically filters its content.

👑 Cluster Admin View	👤 Usual User View
🚀 Management of the entire fleet.	📦 Scoped to specific namespaces.

---

🔍 Governance & API

Auditability and exploration remain intact but isolated.

👑 Cluster Admin View	👤 Usual User View
🛡️ Cluster-wide governance.	📑 Personalized activity stream.

---

🎡 OpenShift OperatorHub Experience

The Valkey Operator is fully integrated with the OpenShift Operator Lifecycle Manager (OLM), providing a seamless "click-to-deploy" experience directly from the OpenShift Web Console.

---

🔍 Operator Discovery & Installation

The operator is discovered via the valkey-operator-catalog. Once installed, it appears in the Installed Operators section, managing its own lifecycle and dependencies.

📦 Installed Operator View	📄 Operator Details
💡 Status, Version, and Capability level.	💡 Detailed description and provided APIs.

---

💎 Managing Valkey Resources

Administrators can manage ValkeyCluster and ValtrixConfig resources using native OpenShift forms and YAML editors, providing a consistent management interface alongside other OpenShift workloads.

🚀 Valkey Cluster Management	📋 Resource Inventory
💡 Centralized view of all managed resources.	💡 Live status of Valkey instances.

---

🛠️ Quick Install (OpenShift)

1️⃣ Create namespace

oc create namespace valkey-operator

2️⃣ Create OperatorGroup (AllNamespaces)

apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: valkey-operator
  namespace: valkey-operator
spec: {}

Apply:

oc apply -f operatorgroup.yaml

3️⃣ Create Subscription

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: valkey-operator
  namespace: valkey-operator
spec:
  channel: stable
  installPlanApproval: Automatic
  name: valkey-operator
  source: valkey-operator-catalog
  sourceNamespace: openshift-marketplace

Apply:

oc apply -f subscription.yaml

4️⃣ Verify installation

oc -n valkey-operator get subscription valkey-operator
oc -n valkey-operator get csv
oc -n valkey-operator get pods

Expected CSV: valkey-operator.v1.0.9 in Succeeded phase.

---

🌐 Deploy Global Valtrix

apiVersion: valkey.arencloud.com/v1
kind: ValtrixConfig
metadata:
  name: global
  namespace: valkey-operator
spec:
  enabled: true
  image: quay.io/arencloud/valtrix:v1.0.9
  replicas: 1
  port: 8080
  enableNodeActions: true
  exposeRoute: true
  auth:
    mode: openshift

Apply:

oc apply -f valtrixconfig.yaml

Verify:

oc -n valkey-operator get valtrixconfig global -o wide
oc -n valkey-operator get deploy,svc,route | grep valtrix

---

📦 Deploy a Valkey Cluster

apiVersion: valkey.arencloud.com/v1
kind: ValkeyCluster
metadata:
  name: valkey-cluster-sample
  namespace: valkey
spec:
  image: registry.access.redhat.com/hi/valkey:9
  shards: 3
  replicas: 1
  persistence:
    size: 10Gi

Apply:

oc new-project valkey || true
oc apply -f valkeycluster.yaml

Verify:

oc -n valkey get valkeyclusters
oc -n valkey get pods
oc -n valkey get valkeynodes

---

📖 Valtrix Configuration Reference

ValtrixConfig.spec parameters:

• 🟢 enabled (bool): enable/disable global Valtrix deployment
• 🖼️ image (string): Valtrix image
• 👥 replicas (int): number of Valtrix replicas
• 🔌 port (int): container service port
• ⚡ enableNodeActions (bool): enables operational node actions
• 🛣️ exposeRoute (bool): auto-creates OpenShift route
• 🔑 auth.mode (none|openshift): auth model
• 👥 auth.requiredGroups ([]string): write action group allow-list
• 👤 auth.requiredUsers ([]string): write action user allow-list

---

⚡ Operational Commands

🩺 Health checks

oc -n valkey-operator get pods
oc -n valkey-operator logs deploy/controller-manager --tail=200
oc -n valkey-operator get valtrixconfig global -o yaml

🛣️ Route access

oc -n valkey-operator get route valtrix

🔄 Cluster lifecycle

oc -n valkey get valkeyclusters
oc -n valkey describe valkeycluster valkey-cluster-sample
oc -n valkey delete valkeycluster valkey-cluster-sample

---

🔍 Troubleshooting

🛑 CSV stuck / install not progressing

• Ensure only one OperatorGroup exists in valkey-operator.
• Prefer AllNamespaces scope (spec: {}) for v1.0.9.
• Check OLM logs:

  oc -n openshift-operator-lifecycle-manager logs deploy/olm-operator --tail=300

🌐 Valtrix route exists but app not reachable

• Verify pod readiness:

  oc -n valkey-operator get pods | grep valtrix

• Check Valtrix status on CR:

  oc -n valkey-operator get valtrixconfig global -o yaml

💾 Cluster pods failing on storage/config

• Inspect pod logs and generated config:

  oc -n valkey logs <pod-name> -c server
  oc -n valkey get pvc

---

⬆️ Upgrade Notes

From pre-v1 API versions:

• 🔄 Migrate manifests from valkey.arencloud.io/v1alpha1 to valkey.arencloud.com/v1
• 🗑️ Remove deprecated Valkey Admin resources (replaced by Valtrix flow)
• 📍 Ensure catalogs/subscriptions point to v1.0.9

---

🆔 Release Identity

• Operator version: 1.0.9
• Supported Platforms: OpenShift 4.18 - 4.21
• Channel: stable
• Suggested namespace: valkey-operator
• API group: valkey.arencloud.com
• API version: v1

---

📜 License

This project is distributed under the repository license terms.