diff --git a/dragonfly-operator-system/README.md b/dragonfly-operator-system/README.md index d431dd0..e9697f7 100644 --- a/dragonfly-operator-system/README.md +++ b/dragonfly-operator-system/README.md @@ -1,5 +1,25 @@ # Dragonfly Operator +Dragonfly operator is the preferred way to add Redis support to your application. + +Following alternatives were considered: + +* Vanilla Redis' replication is clunky and there is no reliable operator for Kubernetes + to use vanilla redis +* KeyDB Cluster was unable to guarantee strong consistency + +# For users + +For examples refer to [../passmower/dragonfly.yaml] + +Use storage class `redis` for persistent instances. +To achieve high availabilllity use 2+ replicas with correctly configured +`topologySpreadConstraints`. + +# For administrators + +The operator was deployed with following snippet: + ``` kubectl apply -f https://raw.githubusercontent.com/dragonflydb/dragonfly-operator/v1.1.6/manifests/dragonfly-operator.yaml ```