Skip to content

Memcached Operator Documentation ​

The Memcached Operator is a Kubernetes operator for managing Memcached clusters, built with the Operator SDK and controller-runtime. It is part of the CobaltCore (C5C3) ecosystem -- a Kubernetes-native OpenStack distribution for operating Hosted Control Planes on bare-metal infrastructure.

The operator automates the deployment, configuration, and lifecycle management of Memcached instances on Kubernetes. Users declare their desired Memcached topology via a Custom Resource, and the operator reconciles the underlying StatefulSets, Services, PodDisruptionBudgets, ServiceMonitors, and NetworkPolicies.

Capabilities ​

  • Declarative management of Memcached clusters via a Custom Resource
  • Automated creation and reconciliation of StatefulSets, Services, PodDisruptionBudgets, ServiceMonitors, and NetworkPolicies
  • Stable DNS names for every pod, published as a per-pod server list in status.serverList
  • Memcached configuration through CRD fields (memory, connections, threads, item size, verbosity)
  • Built-in Prometheus monitoring via a memcached-exporter sidecar
  • High-availability primitives: pod anti-affinity, topology spread constraints, PodDisruptionBudgets, graceful shutdown
  • Security: least-privilege RBAC, pod security contexts, optional SASL authentication, optional TLS encryption, NetworkPolicy generation
  • Validation and defaulting webhooks

Tech Stack ​

ComponentTechnology
LanguageGo 1.27.4+
ScaffoldingOperator SDK / Kubebuilder
Runtimecontroller-runtime
CRD API groupmemcached.c5c3.io
API versionsv1beta1 (active), v1alpha1 (deprecated)
Memcached imagememcached:1.6
Exporter imageprom/memcached-exporter:v0.15.4
Testingenvtest, Chainsaw

Documentation ​

Explanation ​

Background knowledge and architectural context for the operator.

DocumentDescription
Architecture OverviewOperator architecture, reconciliation loop, design principles, and CobaltCore context

How-To Guides ​

Step-by-step instructions for common tasks.

DocumentDescription
InstallationInstall the operator and its prerequisites
UpgradeUpgrade the operator to a new version
Migration to v1beta1Migrate Memcached CRs from v1alpha1 to v1beta1
TroubleshootingDiagnose and resolve common issues
ExamplesExample Memcached CR configurations for common scenarios

Reference ​

Detailed technical reference material.

DocumentDescription
CRD ReferenceComplete field reference for the Memcached Custom Resource Definition
Backend Reference DocsDetailed per-feature implementation references covering reconciliation, webhooks, testing, security, and more

The reference/backend/ directory contains in-depth implementation references for individual features, including: