disk storage

Author: eguzki

api/v1alpha1/limitador_types.go

@@ -146,13 +146,14 @@ type LimitadorList struct {
 type RateLimitHeadersType string
 
 // StorageType defines the valid options for storage
-// +kubebuilder:validation:Enum=memory;redis;redis_cached
+// +kubebuilder:validation:Enum=memory;redis;redis_cached;disk
 type StorageType string
 
 const (
 	StorageTypeInMemory    StorageType = "memory"
 	StorageTypeRedis       StorageType = "redis"
 	StorageTypeRedisCached StorageType = "redis_cached"
+	StorageTypeDisk        StorageType = "disk"
 )
 
 // Storage contains the options for Limitador counters database or in-memory data storage
@@ -162,6 +163,9 @@ type Storage struct {
 
 	// +optional
 	RedisCached *RedisCached `json:"redis-cached,omitempty"`
+
+	// +optional
+	Disk *DiskSpec `json:"disk,omitempty"`
 }
 
 func (s *Storage) Validate() bool {
@@ -238,6 +242,44 @@ type RedisCached struct {
 	Options *RedisCachedOptions `json:"options,omitempty"`
 }
 
+// PersistentVolumeClaimResources defines the resources configuration
+// of the backup data destination PersistentVolumeClaim
+type PersistentVolumeClaimResources struct {
+	// Storage Resource requests to be used on the PersistentVolumeClaim.
+	// To learn more about resource requests see:
+	// https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+	Requests resource.Quantity `json:"requests"` // Should this be a string or a resoure.Quantity? it seems it is serialized as a string
+}
+
+type PVCGenericSpec struct {
+	// +optional
+	StorageClassName *string `json:"storageClassName,omitempty"`
+	// Resources represents the minimum resources the volume should have.
+	// Ignored when VolumeName field is set
+	// +optional
+	Resources *PersistentVolumeClaimResources `json:"resources,omitempty"`
+	// VolumeName is the binding reference to the PersistentVolume backing this claim.
+	// +optional
+	VolumeName *string `json:"volumeName,omitempty"`
+}
+
+// DiskOptimizeType defines the valid options for "optimize" option of the disk persistence type
+// +kubebuilder:validation:Enum=throughput;disk
+type DiskOptimizeType string
+
+const (
+	DiskOptimizeTypeThroughput DiskOptimizeType = "throughput"
+	DiskOptimizeTypeDisk       DiskOptimizeType = "disk"
+)
+
+type DiskSpec struct {
+	// +optional
+	PVC *PVCGenericSpec `json:"persistentVolumeClaim,omitempty"`
+
+	// +optional
+	Optimize *DiskOptimizeType `json:"optimize,omitempty"`
+}
+
 type Listener struct {
 	// +optional
 	HTTP *TransportProtocol `json:"http,omitempty"`

controllers/limitador_controller.go

@@ -110,6 +110,10 @@ func (r *LimitadorReconciler) reconcileSpec(ctx context.Context, limitadorObj *l
 		return ctrl.Result{}, err
 	}
 
+	if err := r.reconcilePVC(ctx, limitadorObj); err != nil {
+		return ctrl.Result{}, err
+	}
+
 	if err := r.reconcileDeployment(ctx, limitadorObj); err != nil {
 		return ctrl.Result{}, err
 	}
@@ -232,6 +236,28 @@ func (r *LimitadorReconciler) reconcileService(ctx context.Context, limitadorObj
 	return nil
 }
 
+func (r *LimitadorReconciler) reconcilePVC(ctx context.Context, limitadorObj *limitadorv1alpha1.Limitador) error {
+	logger, err := logr.FromContext(ctx)
+	if err != nil {
+		return err
+	}
+
+	pvc := limitador.PVC(limitadorObj)
+	// controller reference
+	if err := r.SetOwnerReference(limitadorObj, pvc); err != nil {
+		return err
+	}
+
+	// Not reconciling updates PVCs for now.
+	err = r.ReconcilePersistentVolumeClaim(ctx, pvc, reconcilers.CreateOnlyMutator)
+	logger.V(1).Info("reconcile pvc", "error", err)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func (r *LimitadorReconciler) reconcileLimitsConfigMap(ctx context.Context, limitadorObj *limitadorv1alpha1.Limitador) error {
 	logger, err := logr.FromContext(ctx)
 	if err != nil {

pkg/limitador/k8s_objects.go

@@ -6,11 +6,13 @@ import (
 	appsv1 "k8s.io/api/apps/v1"
 	v1 "k8s.io/api/core/v1"
 	policyv1 "k8s.io/api/policy/v1"
+	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/util/intstr"
 	"sigs.k8s.io/yaml"
 
 	limitadorv1alpha1 "github.com/kuadrant/limitador-operator/api/v1alpha1"
+	"github.com/kuadrant/limitador-operator/pkg/helpers"
 )
 
 const (
@@ -181,6 +183,10 @@ func ServiceName(limitadorObj *limitadorv1alpha1.Limitador) string {
 	return fmt.Sprintf("limitador-%s", limitadorObj.Name)
 }
 
+func PVCName(limitadorObj *limitadorv1alpha1.Limitador) string {
+	return fmt.Sprintf("limitador-%s", limitadorObj.Name)
+}
+
 func PodDisruptionBudget(limitadorObj *limitadorv1alpha1.Limitador) *policyv1.PodDisruptionBudget {
 	return &policyv1.PodDisruptionBudget{
 		ObjectMeta: metav1.ObjectMeta{
@@ -216,6 +222,50 @@ func Labels(limitador *limitadorv1alpha1.Limitador) map[string]string {
 	}
 }
 
+func PVC(limitador *limitadorv1alpha1.Limitador) *v1.PersistentVolumeClaim {
+	pvc := &v1.PersistentVolumeClaim{
+		TypeMeta: metav1.TypeMeta{
+			Kind:       "PersistentVolumeClaim",
+			APIVersion: "v1",
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name:   PVCName(limitador),
+			Labels: Labels(limitador),
+		},
+		Spec: v1.PersistentVolumeClaimSpec{
+			AccessModes: []v1.PersistentVolumeAccessMode{
+				v1.PersistentVolumeAccessMode("ReadWriteOnce"),
+			},
+		},
+	}
+
+	if limitador.Spec.Storage == nil || limitador.Spec.Storage.Disk == nil {
+		helpers.TagObjectToDelete(pvc)
+		return pvc
+	}
+
+	if limitador.Spec.Storage.Disk.PVC != nil {
+		pvc.Spec.StorageClassName = limitador.Spec.Storage.Disk.PVC.StorageClassName
+		if limitador.Spec.Storage.Disk.PVC.VolumeName != nil {
+			pvc.Spec.VolumeName = *limitador.Spec.Storage.Disk.PVC.VolumeName
+		}
+
+		// Default value for resources
+		resources := resource.MustParse("1Gi")
+		if limitador.Spec.Storage.Disk.PVC.Resources != nil {
+			resources = limitador.Spec.Storage.Disk.PVC.Resources.Requests
+		}
+
+		pvc.Spec.Resources = v1.ResourceRequirements{
+			Requests: v1.ResourceList{
+				v1.ResourceStorage: resources,
+			},
+		}
+	}
+
+	return pvc
+}
+
 func deploymentContainerCommand(storage *limitadorv1alpha1.Storage, storageConfigSecret *v1.Secret, rateLimitHeaders *limitadorv1alpha1.RateLimitHeadersType) []string {
 	command := []string{"limitador-server"}
 

pkg/reconcilers/base_reconciler.go

@@ -155,6 +155,10 @@ func (b *BaseReconciler) ReconcilePodDisruptionBudget(ctx context.Context, desir
 	return b.ReconcileResource(ctx, &policyv1.PodDisruptionBudget{}, desired, mutatefn)
 }
 
+func (b *BaseReconciler) ReconcilePersistentVolumeClaim(ctx context.Context, desired *corev1.PersistentVolumeClaim, mutatefn MutateFn) error {
+	return b.ReconcileResource(ctx, &corev1.PersistentVolumeClaim{}, desired, mutatefn)
+}
+
 func (b *BaseReconciler) GetResource(ctx context.Context, objKey types.NamespacedName, obj client.Object) error {
 	logger, err := logr.FromContext(ctx)
 	if err != nil {