Deploy FerretDB in Google Kubernetes Engine (GKE) Using KubeDB


KubeDB is the Kubernetes Native Database Management Solution which simplifies and automates routine database tasks such as Provisioning, Monitoring, Upgrading, Patching, Scaling, Volume Expansion, Backup, Recovery, Failure detection, and Repair for various popular databases on private and public clouds. The databases supported by KubeDB include MongoDB, Elasticsearch, MySQL, MariaDB, Redis, PostgreSQL, FerretDB, Percona XtraDB, and Memcached. Additionally, KubeDB also supports ProxySQL, PgBouncer, Pgpool, ZooKeeper and the streaming platform Kafka, RabbitMQ. You can find the guides to all the supported databases in KubeDB . In this tutorial we will deploy FerretDB in Google Kubernetes Engine (GKE) Using KubeDB. We will cover the following steps:

  1. Install KubeDB
  2. Deploy FerretDB
  3. Connect with FerretDB
  4. Read/Write Sample Data

Get Cluster ID

We need the cluster ID to get the KubeDB License. To get cluster ID, we can run the following command:

$ kubectl get ns kube-system -o jsonpath='{.metadata.uid}'

Get License

Go to Appscode License Server to get the license.txt file. For this tutorial we will use KubeDB.

License Server

Install KubeDB

We will use helm to install KubeDB. Please install helm here if it is not already installed. Now, let’s install KubeDB.

$ helm search repo appscode/kubedb
NAME                              	CHART VERSION	APP VERSION	DESCRIPTION                                       
appscode/kubedb                   	v2024.6.4    	v2024.6.4  	KubeDB by AppsCode - Production ready databases...
appscode/kubedb-autoscaler        	v0.31.0      	v0.31.0    	KubeDB Autoscaler by AppsCode - Autoscale KubeD...
appscode/kubedb-catalog           	v2024.6.4    	v2024.6.4  	KubeDB Catalog by AppsCode - Catalog for databa...
appscode/kubedb-community         	v0.24.2      	v0.24.2    	KubeDB Community by AppsCode - Community featur...
appscode/kubedb-crd-manager       	v0.1.0       	v0.1.0     	KubeDB CRD Manager by AppsCode                    
appscode/kubedb-crds              	v2024.6.4    	v2024.6.4  	KubeDB Custom Resource Definitions                
appscode/kubedb-dashboard         	v0.22.0      	v0.22.0    	KubeDB Dashboard by AppsCode                      
appscode/kubedb-enterprise        	v0.11.2      	v0.11.2    	KubeDB Enterprise by AppsCode - Enterprise feat...
appscode/kubedb-grafana-dashboards	v2024.6.4    	v2024.6.4  	A Helm chart for kubedb-grafana-dashboards by A...
appscode/kubedb-kubestash-catalog 	v2024.6.4    	v2024.6.4  	KubeStash Catalog by AppsCode - Catalog of Kube...
appscode/kubedb-metrics           	v2024.6.4    	v2024.6.4  	KubeDB State Metrics                              
appscode/kubedb-one               	v2023.12.28  	v2023.12.28	KubeDB and Stash by AppsCode - Production ready...
appscode/kubedb-ops-manager       	v0.33.0      	v0.33.0    	KubeDB Ops Manager by AppsCode - Enterprise fea...
appscode/kubedb-opscenter         	v2024.6.4    	v2024.6.4  	KubeDB Opscenter by AppsCode                      
appscode/kubedb-provider-aws      	v2024.6.4    	v0.8.0     	A Helm chart for KubeDB AWS Provider for Crossp...
appscode/kubedb-provider-azure    	v2024.6.4    	v0.8.0     	A Helm chart for KubeDB Azure Provider for Cros...
appscode/kubedb-provider-gcp      	v2024.6.4    	v0.8.0     	A Helm chart for KubeDB GCP Provider for Crossp...
appscode/kubedb-provisioner       	v0.46.0      	v0.46.0    	KubeDB Provisioner by AppsCode - Community feat...
appscode/kubedb-schema-manager    	v0.22.0      	v0.22.0    	KubeDB Schema Manager by AppsCode                 
appscode/kubedb-ui                	v2024.6.3    	0.6.8      	A Helm chart for Kubernetes                       
appscode/kubedb-ui-server         	v2021.12.21  	v2021.12.21	A Helm chart for kubedb-ui-server by AppsCode     
appscode/kubedb-webhook-server    	v0.22.0      	v0.22.0    	KubeDB Webhook Server by AppsCode

$ helm install kubedb oci:// \
  --version v2024.6.4 \
  --namespace kubedb --create-namespace \
  --set-file global.license=/path/to/the/license.txt \
  --set global.featureGates.FerretDB=true \
  --wait --burst-limit=10000 --debug

Let’s verify the installation:

$ kubectl get pods --all-namespaces -l ""
NAMESPACE   NAME                                            READY   STATUS    RESTARTS      AGE
kubedb      kubedb-kubedb-autoscaler-75cf766448-qjlhc       1/1     Running   0             2m47s
kubedb      kubedb-kubedb-ops-manager-7c4b676b49-qxgp8      1/1     Running   0             2m47s
kubedb      kubedb-kubedb-provisioner-75475bd9f4-vz9t9      1/1     Running   0             2m47s
kubedb      kubedb-kubedb-webhook-server-589bfbb687-xdrz9   1/1     Running   0             2m47s
kubedb      kubedb-petset-operator-5d94b4ddb8-tpck5         1/1     Running   0             2m47s
kubedb      kubedb-petset-webhook-server-8647cc4564-fvsg2   2/2     Running   0             2m47s
kubedb      kubedb-sidekick-5d9947bd9-wgnnd                 1/1     Running   0             2m47s

We can list the CRD Groups that have been registered by the operator by running the following command:

$ kubectl get crd -l
NAME                                               CREATED AT              2024-06-10T10:36:23Z                   2024-06-10T10:38:11Z                        2024-06-10T10:38:11Z                   2024-06-10T10:36:23Z    2024-06-10T10:38:05Z   2024-06-10T10:38:05Z                         2024-06-10T10:38:05Z            2024-06-10T10:38:05Z           2024-06-10T10:36:23Z                    2024-06-10T10:36:23Z                               2024-06-10T10:38:08Z                2024-06-10T10:36:23Z            2024-06-10T10:38:11Z          2024-06-10T10:36:23Z                    2024-06-10T10:38:11Z                                  2024-06-10T10:38:11Z                   2024-06-10T10:36:23Z               2024-06-10T10:38:14Z          2024-06-10T10:38:14Z                 2024-06-10T10:38:14Z                  2024-06-10T10:38:14Z                                2024-06-10T10:38:14Z                 2024-06-10T10:36:23Z               2024-06-10T10:36:23Z               2024-06-10T10:38:18Z          2024-06-10T10:38:18Z                 2024-06-10T10:38:18Z                  2024-06-10T10:38:18Z                                2024-06-10T10:38:18Z                 2024-06-10T10:36:23Z             2024-06-10T10:36:23Z                 2024-06-10T10:38:21Z            2024-06-10T10:38:21Z                   2024-06-10T10:38:21Z                    2024-06-10T10:38:21Z                                  2024-06-10T10:38:21Z                   2024-06-10T10:36:23Z           2024-06-10T10:36:23Z               2024-06-10T10:36:23Z                  2024-06-10T10:36:23Z              2024-06-10T10:38:25Z         2024-06-10T10:38:25Z                2024-06-10T10:38:25Z                              2024-06-10T10:38:08Z                 2024-06-10T10:38:25Z                2024-06-10T10:36:23Z                2024-06-10T10:36:23Z                     2024-06-10T10:38:25Z                2024-06-10T10:36:23Z            2024-06-10T10:38:28Z                                 2024-06-10T10:38:28Z                    2024-06-10T10:38:28Z    2024-06-10T10:38:28Z            2024-06-10T10:38:28Z                          2024-06-10T10:38:28Z                   2024-06-10T10:36:23Z                  2024-06-10T10:38:11Z          2024-06-10T10:36:23Z             2024-06-10T10:36:23Z                    2024-06-10T10:36:23Z                    2024-06-10T10:38:25Z               2024-06-10T10:36:23Z

Deploy FerretDB with KubeDB Managed PostgreSQL

We are going to deploy FerretDB using KubeDB. First, let’s create a namespace in which we will deploy FerretDB.

$ kubectl create namespace demo
namespace/demo created

Here is the yaml of the FerretDB CR we are going to use:

kind: FerretDB
  name: ferret
  namespace: demo
  version: "1.18.0"
  storageType: Durable
      - ReadWriteOnce
        storage: 1Gi
    externallyManaged: false
  deletionPolicy: WipeOut

Let’s save this yaml configuration into ferret.yaml Then create the above FerretDB CR

$ kubectl apply -f ferret.yaml created

In this yaml,

  • spec.version field specifies the version of FerretDB. Here, we are using FerretDB 1.18.0. You can list the KubeDB supported versions of FerretDB by running $ kubectl get ferretdbversions command.
  • spec.storageType specifies the type of storage that will be used for FerretDB. It can be Durable or Ephemeral. Default value of this field is Durable.
  • spec.backend denotes the backend database information for FerretDB instance.
  • spec.terminationPolicy field is Wipeout means it will be deleted without restrictions.

Once these are handled correctly and the FerretDB object is deployed, you will see that the following objects are created:

$ kubectl get all -n demo
NAME                              READY   STATUS    RESTARTS   AGE
pod/ferret-0                      1/1     Running   0          23s
pod/ferret-pg-backend-0           2/2     Running   0          91s
pod/ferret-pg-backend-1           2/2     Running   0          47s
pod/ferret-pg-backend-arbiter-0   1/1     Running   0          34s

NAME                                TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)                      AGE
service/ferret                      ClusterIP    <none>        27017/TCP                    95s
service/ferret-pg-backend           ClusterIP   <none>        5432/TCP,2379/TCP            95s
service/ferret-pg-backend-pods      ClusterIP   None            <none>        5432/TCP,2380/TCP,2379/TCP   95s
service/ferret-pg-backend-standby   ClusterIP   <none>        5432/TCP                     95s

NAME                                         READY   AGE
statefulset.apps/ferret-pg-backend           2/2     91s
statefulset.apps/ferret-pg-backend-arbiter   1/1     34s

NAME                                                   TYPE                  VERSION   AGE       1.18.0    23s   13.13     91s

NAME                                    VERSION   STATUS   AGE   13.13     Ready    95s

Let’s check if the ferret is ready to use,

$ kubectl get ferretdb -n demo ferret
ferret   demo        1.18.0    Ready    117s

We have successfully deployed FerretDB in GKE.

Connect with FerretDB

We will use port forwarding to connect with FerretDB.

Port-forward the Service

KubeDB will create few Services to connect with the database. Let’s check the Services by following command,

$ kubectl get service -n demo | grep ferret
ferret                      ClusterIP    <none>        27017/TCP                    2m31s
ferret-pg-backend           ClusterIP   <none>        5432/TCP,2379/TCP            2m31s
ferret-pg-backend-pods      ClusterIP   None            <none>        5432/TCP,2380/TCP,2379/TCP   2m31s
ferret-pg-backend-standby   ClusterIP   <none>        5432/TCP                     2m31s

Here, we are going to use Service named ferret. Now, let’s port-forward the ferret Service to the local machine’s port 27017.

$ kubectl port-forward -n demo svc/ferret 27017
Forwarding from -> 27017
Forwarding from [::1]:27017 -> 27017

Access the Credentials

KubeDB also create Secret for the ferret instance. Let’s check by following command,

$ kubectl get secret -n demo | grep ferret
ferret-pg-backend-auth   2      2m53s

Now, we are going to use ferret-pg-backend-auth to get the credentials.

$ kubectl get secrets -n demo ferret-pg-backend-auth -o jsonpath='{.data.username}' | base64 -d

$ kubectl get secrets -n demo ferret-pg-backend-auth -o jsonpath='{.data.password}' | base64 -d

Insert Sample Data

In this section, we will to log in via MongoDB Shell and insert some sample data.

$ mongosh 'mongodb://postgres:6QWXX*d8FcuGf95S@localhost:27017/ferretdb?authMechanism=PLAIN'
Current Mongosh Log ID:	666ae3d956fa285b80a26a12
Connecting to:		mongodb://<credentials>@localhost:27017/ferretdb?authMechanism=PLAIN&directConnection=true&serverSelectionTimeoutMS=2000&appName=mongosh+2.2.6
Using MongoDB:		7.0.42
Using Mongosh:		2.2.6

For mongosh info see:

   The server generated these startup warnings when booting
   2024-06-10T12:19:37.648Z: Powered by FerretDB v1.18.0 and PostgreSQL 13.13 on x86_64-pc-linux-musl, compiled by gcc.
   2024-06-10T12:19:37.648Z: Please star us on GitHub:
   2024-06-10T12:19:37.648Z: The telemetry state is undecided.
   2024-06-10T12:19:37.648Z: Read more about FerretDB telemetry and how to opt out at

ferretdb> show dbs
kubedb_system  80.00 KiB

ferretdb> use musicdb
switched to db musicdb

musicdb>{"Avicii": "The Nights"})
  acknowledged: true,
  insertedId: ObjectId('666ae4b156fa285b80a26a15')

musicdb>{"Bon Jovi": "It's My Life"})
  acknowledged: true,
  insertedId: ObjectId('666ae4b956fa285b80a26a16')

  { _id: ObjectId('666ae4b156fa285b80a26a15'), Avicii: 'The Nights' },
    _id: ObjectId('666ae4b956fa285b80a26a16'),
    'Bon Jovi': "It's My Life"

musicdb> show dbs
kubedb_system  80.00 KiB
musicdb        80.00 KiB

musicdb> exit

Here, we’ve stored some sample data in our ferret-pg-backend PostgreSQL using mongosh.

Verify Data in PostgreSQL Backend Engine

Now, We are going to exec into the PostgreSQL pod to verify if the data has been stored successfully.

$ kubectl exec -it -n demo ferret-pg-backend-0 -- bash
Defaulted container "postgres" out of: postgres, pg-coordinator, postgres-init-container (init)
ferret-pg-backend-0:/$ psql
psql (13.13)
Type "help" for help.

postgres=# \l
                                   List of databases
     Name      |  Owner   | Encoding |  Collate   |   Ctype    |   Access privileges   
 ferretdb      | postgres | UTF8     | en_US.utf8 | en_US.utf8 | 
 kubedb_system | postgres | UTF8     | en_US.utf8 | en_US.utf8 | 
 postgres      | postgres | UTF8     | en_US.utf8 | en_US.utf8 | 
 template0     | postgres | UTF8     | en_US.utf8 | en_US.utf8 | =c/postgres          +
               |          |          |            |            | postgres=CTc/postgres
 template1     | postgres | UTF8     | en_US.utf8 | en_US.utf8 | =c/postgres          +
               |          |          |            |            | postgres=CTc/postgres
(5 rows)

postgres=# \c ferretdb
You are now connected to database "ferretdb" as user "postgres".

ferretdb=# \dn
     List of schemas
     Name      |  Owner   
 kubedb_system | postgres
 musicdb       | postgres
 public        | postgres
(3 rows)

ferretdb=# SET search_path TO musicdb;

ferretdb=# \dt
                    List of relations
 Schema  |            Name             | Type  |  Owner   
 musicdb | _ferretdb_database_metadata | table | postgres
 musicdb | music_9f9c4fd4              | table | postgres
(2 rows)

ferretdb=# SELECT * FROM music_9f9c4fd4;
 {"$s": {"p": {"_id": {"t": "objectId"}, "Avicii": {"t": "string"}}, "$k": ["_id", "Avicii"]}, "_id": "666ae4b156fa285b80a26a15", "Avicii": "The Nights"}
 {"$s": {"p": {"_id": {"t": "objectId"}, "Bon Jovi": {"t": "string"}}, "$k": ["_id", "Bon Jovi"]}, "_id": "666ae4b956fa285b80a26a16", "Bon Jovi": "It's My Life"}
(2 rows)

ferretdb=# exit

Deploy FerretDB with Externally Managed PostgreSQL

In this blog post, we demonstrated how to deploy FerretDB with KubeDB Managed PostgreSQL. However, if you prefer to use your own PostgreSQL as the backend engine, you have the flexibility to do so. Below, we provide the yaml configuration for integrating FerretDB with an externally managed PostgreSQL instance.

kind: FerretDB
  name: ferretdb-external
  namespace: demo
  version: "1.18.0"
    externallyManaged: true
    name: ha-postgres-auth
  storageType: Durable
    - ReadWriteOnce
        storage: 1Gi  
    externallyManaged: true
        name: ha-postgres
        namespace: demo
        pgPort: 5432
  deletionPolicy: WipeOut


  • spec.postgres.serivce is service information of users external postgres exist in the cluster.
  • is the name of the authentication secret of users external postgres database.


To speak with us, please leave a message on our website .

To receive product announcements, follow us on X .

To watch tutorials of various Production-Grade Kubernetes Tools Subscribe to our YouTube channel.

More about FerretDB on Kubernetes

If you have found a bug with KubeDB or want to request for new features, please file an issue .


Get Up and Running Quickly

Deploy, manage, upgrade Kubernetes on any cloud and automate deployment, scaling, and management of containerized applications.