dragonfly-operator-system: Update README

This commit is contained in:
Lauri Võsandi 2024-08-14 07:08:26 +03:00
parent f902bbfe02
commit e5e4a07d01

View File

@ -1,16 +1,21 @@
# Dragonfly Operator # Dragonfly Operator
Dragonfly operator is the preferred way to add Redis support to your application. Dragonfly operator is the preferred way to add Redis support to your application
as it is modern Go rewrite and it supports high availability.
Following alternatives were considered: Following alternatives were considered, but are discouraged:
* Vanilla Redis without replication is unusable during pod reschedule or Kubernetes worker outage
* Vanilla Redis' replication is clunky and there is no reliable operator for Kubernetes * Vanilla Redis' replication is clunky and there is no reliable operator for Kubernetes
to use vanilla redis to use vanilla redis
* KeyDB Cluster was unable to guarantee strong consistency * KeyDB Cluster was unable to guarantee strong consistency
# For users # For users
For examples refer to [../passmower/dragonfly.yaml] Refer to [official documentation on usage](https://www.dragonflydb.io/docs/getting-started/kubernetes-operator#create-a-dragonfly-instance-with-replicas)
For example deployment see
[here](https://git.k-space.ee/k-space/kube/src/branch/master/passmower/dragonfly.yaml)
Use storage class `redis` for persistent instances. Use storage class `redis` for persistent instances.
To achieve high availabilllity use 2+ replicas with correctly configured To achieve high availabilllity use 2+ replicas with correctly configured
@ -23,3 +28,7 @@ The operator was deployed with following snippet:
``` ```
kubectl apply -f https://raw.githubusercontent.com/dragonflydb/dragonfly-operator/v1.1.6/manifests/dragonfly-operator.yaml kubectl apply -f https://raw.githubusercontent.com/dragonflydb/dragonfly-operator/v1.1.6/manifests/dragonfly-operator.yaml
``` ```
To upgrade refer to
[github.com/dragonflydb/dragonfly-operator](https://github.com/dragonflydb/dragonfly-operator/releases),
bump version and reapply