dragonfly

Files (1)

• SKILL.md

SKILL.md (first lines)

# DragonflyDB Operator

## Overview

Dragonfly operator manages Dragonfly (Redis-compatible) in-memory data store instances on Kubernetes. API: `dragonflydb.io/v1alpha1`. Single CRD: `Dragonfly` (plural: `dragonflies`). Deployed via Helm chart `oci://ghcr.io/dragonflydb/dragonfly-operator/helm/dragonfly-operator`. Latest operator: **v1.5.0** (Mar 2026). Deployed chart: v1.5.0.

## CRD Fields

| Field | Type | Since | Description |
|-------|------|-------|-------------|
| `replicas` | int | — | Total instances (1 = standalone primary, 2 = 1 primary + 1 replica) |
| `image` | string | — | Dragonfly image (default: `docker.dragonflydb.io/dragonflydb/dragonfly:v1.21.2`) |
| `args` | []string | — | Dragonfly server args (e.g. `--maxmemory=2gb`) |
| `resources` | ResourceRequirements | — | Container CPU/memory |
| `affinity` | Affinity | — | Pod affinity (nodeAffinity, podAntiAffinity, etc.) |
| `nodeSelector` | map | v1.1.1 | Node selector for pod scheduling |
| `tolerations` | []Toleration | — | Pod tolerations |
| `topologySpreadConstraints` | []TopologySpreadConstraint | v1.1.1 | Spread pods across topology domains |
| `annotations` | object | — | Annotations on Dragonfly pods |
| `labels` | object | — | Labels on Dragonfly pods |
| `env` | []EnvVar | — | Environment variables |
| `authentication.passwordFromSecret` | SecretKeySelector | — | Password from Secret key |
| `authentication.clientCaCertSecret` | SecretReference | — | Client CA certificate Secret |
| `tlsSecretRef` | SecretReference | — | TLS cert Secret for server TLS |
| `snapshot.cron` | string | — | Cron schedule for snapshots (e.g. `"\*/5 * * * *"`) |
| `snapshot.persistentVolumeClaimSpec` | PVC Spec | — | PVC for snapshot storage |
| `aclFromSecret` | SecretKeySelector | v1.1.1 | ACL file from Secret |
| `serviceAccountName` | string | — | Pod service account |
| `serviceSpec.type` | string | — | Service type (ClusterIP, LoadBalancer, etc.) |
| `serviceSpec.name` | string | v1.1.3 | Custom service name |
| `serviceSpec.annotations` | object | — | Service annotations |
| `priorityClassName` | string | v1.1.1 | Pod priority class |
| `skipFSGroup` | bool | v1.1.2 | Skip FSGroup assignment (OpenShift) |
| `memcachedPort` | int | v1.1.2 | Memcached port (alternative to `--memcached_port` arg) |
| `additionalContainers` | []Container | — | Sidecar containers |
| `additionalVolumes` | []Volume | — | Extra volumes |

## Dragonfly Spec Patterns

```yaml
apiVersion: dragonflydb.io/v1alpha1
kind: Dragonfly
metadata:
  name: my-cache
spec:
  replicas: 1                    # 1 = standalone primary
  args:
    - --maxmemory=2gb
    - --logtostderr
    - --cluster_mode=emulated    # Enable cluster-compatible mode
    - --lock_on_hashtags         # Hashtag-based locking
    - --default_lua_flags=allow-undeclared-keys

  resources:
    requests:
      cpu: 500m
      memory: 1Gi
    limits:
      cpu: "1"
      memory: 2Gi

  affinity:
    nodeAffinity:
      requiredDuringSchedulingIgnoredDuringExecution:
        nodeSelectorTerms:
          - matchExpressions:
              - key: kubernetes.io/hostname
                operator: In
                values:
                  - worker-01

  authentication:
    passwordFromSecret:
      name: dragonfly-password
      key: password

  snapshot:
    cron: "*/5 * * * *"
    persistentVolumeClaimSpec:
      accessModes:
        - ReadWriteOnce
      storageClassName: ceph-block
      resources:
        requests:
          storage: 2Gi

  serviceSpec:
    type: ClusterIP
    annotations:
      external-dns.alpha.kubernetes.io/hostname: dragonfly.example.com
```

## Replication Model

- `replicas=1` — standalone primary
- `replicas=2` — 1 primary + 1 replica
- `replicas=3` — 1 primary + 2 replicas
- **Always exactly 1 primary** regardless of replica count
- Operator manages automatic failover if primary fails
- Service `<name>.<ns>.svc.cluster.local` always points to current primary

## Authentication

| Method | Config | Description |
|--------|--------|-------------|
| Password | `authentication.passwordFromSecret` | Basic password auth (maps to `--requirepass`) |
| Client CA | `authentication.clientCaCertSecret` | TLS client cert verification |
| ACL file | `aclFromSecret` | ACL rules file from Secret (v1.1.1+) |

Password can also be set via `args: ["--requirepass=<pw>"]` or `env: [{name: DFLY_requirepass, value: "<pw>"}]`.

## TLS

```yaml
spec:
  tlsSecretRef:
    name: dragonfly-tls    # Secret must have tls.crt, tls.key
```

From Aidas-dev/k8s-agent-skills, MIT.

More from Aidas-dev/k8s-agent-skills