Kubernetes

FerretDB uses PostgreSQL with DocumentDB extension as the database engine.

Ensure to have a running Kubernetes cluster before proceeding with the installation.

You can deploy PostgreSQL with DocumentDB extension using any of our provided images. Please see the Docker installation docs to learn more about the available images.

tip

We strongly recommend specifying the full image tag (e.g., 17-0.103.0-ferretdb-2.2.0) to ensure consistency across deployments. For more information on the best FerretDB image to use, see the DocumentDB release notes.

Create a postgres.yaml file with the following content:

apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: postgres
spec:
  serviceName: 'postgres'
  replicas: 1
  selector:
    matchLabels:
      app: postgres
  template:
    metadata:
      labels:
        app: postgres
    spec:
      containers:
        - name: postgres
          image: ghcr.io/ferretdb/postgres-documentdb:17-0.103.0-ferretdb-2.2.0
          ports:
            - containerPort: 5432
          env:
            - name: POSTGRES_USER
              value: <username>
            - name: POSTGRES_PASSWORD
              value: <password>
            - name: POSTGRES_DB
              value: postgres
          volumeMounts:
            - name: data
              mountPath: /var/lib/postgresql/data
  volumeClaimTemplates:
    - metadata:
        name: data
      spec:
        accessModes: ['ReadWriteOnce']
        resources:
          requests:
            storage: 1Gi

---
apiVersion: v1
kind: Service
metadata:
  name: postgres
  labels:
    app: postgres
spec:
  selector:
    app: postgres
  ports:
    - port: 5432
      targetPort: 5432

Ensure to update the <username> and <password>. Also, the POSTGRES_DB should be set as postgres – this is required to properly initialize the DocumentDB extension.

Apply the postgres.yaml file to create the PostgreSQL instance:

kubectl apply -f postgres.yaml

This will create a service named postgres that FerretDB can use to connect to the Postgres instance. Check the status of the pods to ensure that the PostgreSQL instance is running:

kubectl get pods -l app=postgres
kubectl get svc -l app=postgres

See FerretDB Kubernetes installation for more details on connecting to FerretDB.