Skip to content

Latest commit

 

History

History
142 lines (104 loc) · 3.82 KB

README.md

File metadata and controls

142 lines (104 loc) · 3.82 KB

CloudNativePG + DragonflyDB Demo

This project demonstrates how to run a PostgreSQL database using CloudNativePG and accelerate read performance with DragonflyDB in Kubernetes.

A simple FastAPI application implements the cache-aside pattern, using Postgres as the system of record and DragonflyDB as a Redis-compatible cache.

Prereqs

  • A running Kubernetes cluster
  • kubectl
  • Helm

Files

  • postgres.yaml: Namespace, CloudNativePG cluster, and app DB credentials
  • app.yaml: FastAPI deployment + service
  • Dockerfile, main.py, requirements.txt: app source

1) Install CloudNativePG operator (Helm)

helm repo add cnpg https://cloudnative-pg.github.io/charts
helm repo update
helm install cnpg \
  --namespace cnpg-system \
  --create-namespace \
  cnpg/cloudnative-pg

2) Create the Postgres cluster

Apply the CloudNativePG cluster manifest:

kubectl apply -f postgresql-cluster.yaml

Wait for the Postgres pods to get ready. This step can take upto 5 minutes:

kubectl -n demo get pods

3) Install DragonflyDB (Helm)

export VERSION=v1.36.0 # DragonflyDB version that you want to install

helm upgrade --install dragonfly \
  oci://ghcr.io/dragonflydb/dragonfly/helm/dragonfly \
  --version "$VERSION" \
  --namespace demo \
  --create-namespace

4) Build and push the application image

The Kubernetes cluster must be able to pull the application image from a container registry.

You can either build and push the image yourself, or use a prebuilt image provided for this demo.

Option A: Build and push your own image (recommended)

Set the image name to a registry accessible by your cluster (Docker Hub, GHCR, ECR, etc.):

export APP_IMAGE=<YOUR_REGISTRY/REPO>:demo-api

Build and push the image:

docker build -t "$APP_IMAGE" .
docker push "$APP_IMAGE"

Update the image reference in app.yaml:

sed -i.bak "s|<YOUR_REGISTRY/REPO>:demo-api|${APP_IMAGE}|g" app.yaml

Option B: Use the prebuilt demo image

To skip the build step, you can use the prebuilt image:

majid0079/cnpg-dragonflydb-sampleapp:demo-api

Update app.yaml to reference above mentioned image instead of <YOUR_REGISTRY/REPO>:demo-api.

5) Apply the app manifests

kubectl apply -f app.yaml

Wait for app pods to get ready:

kubectl -n demo get pods

6) Test the API

Port-forward the app service:

kubectl -n demo port-forward svc/demo-api 8080:80

In another terminal, create a todo:

curl -X POST localhost:8080/todos -H 'Content-Type: application/json' -d '{"title":"learn cnpg + dragonfly"}'

List todos (first response from DB, next from cache):

curl localhost:8080/todos

Output:

→ curl localhost:8080/todos
{"source":"db(postgres)","items":[{"id":2,"title":"learn cnpg + dragonfly"},{"id":1,"title":"learn cnpg + dragonfly"}]}%

→ curl localhost:8080/todos
{"source":"cache(dragonfly)","items":[{"id":2,"title":"learn cnpg + dragonfly"},{"id":1,"title":"learn cnpg + dragonfly"}]}%

→ curl localhost:8080/todos
{"source":"cache(dragonfly)","items":[{"id":2,"title":"learn cnpg + dragonfly"},{"id":1,"title":"learn cnpg + dragonfly"}]}%
  • When you call the GET endpoint for the first time, the data is fetched from Postgres (db(postgres)).
  • Subsequent calls are served from DragonflyDB (cache(dragonfly)) until the cache entry expires.
  • Once the TTL (30 seconds by default, defined in main.py) expires, the next request falls back to Postgres and refreshes the cache.

Notes

  • CloudNativePG creates a pg-rw service for read/write connections. The app uses that by default.
  • DragonflyDB is Redis-compatible, so the app uses the redis client.

Cleanup

kubectl delete -f app.yaml
kubectl delete -f postgresql-cluster.yaml
helm uninstall cnpg -n cnpg-system
helm uninstall dragonfly -n demo