Quickstart

This section describes how to test an EDB Postgres Distributed (PGD) cluster on your laptop/computer using EDB Postgres Distributed for Kubernetes (PG4K-PGD) on a single local Kubernetes cluster built with Kind.

By following the instructions on this page you should be able to start an EDB Postgres Distributed cluster on your local Kubernetes installation and experiment with it.

Part 1 - Setup the local Kubernetes playground

This section is about installing Kind, a tool for running local Kubernetes clusters using Docker container "nodes" (Kind stands for "Kubernetes IN Docker" indeed). If you already have access to a Kubernetes cluster, you may skip to the next section.

Install kind on your environment following the instructions in the Kind Quickstart, then create a Kubernetes cluster with:

kind create cluster --name pgd

Part 2 - Install EDB Postgres Distributed for Kubernetes

Now that you have a Kubernetes installation up and running on your laptop, you can proceed with the installation of EDB Postgres Distributed for Kubernetes.

Please refer to the "Installation" section and then proceed with the deployment of a PGD cluster.

Part 3 - Deploy a PGD cluster

As with any other deployment in Kubernetes, to deploy a PGD cluster you need to apply a configuration file that defines your desired PGDGroup resources that make up a PGD cluster.

Some sample files are included (see Examples of configuration). The flexible_3regions.yaml manifest contains the definition of a PGD cluster with 2 Data Groups and a global witness node spread across 3 regions. Each Data Group consists of 2 data nodes and a local witness node.

You can deploy the flexible-3-regions example by saving it first and running:

kubectl apply -f flexible_3regions.yaml

You can check that the pods are being created with the get pods command:

kubectl get pods

The pods are being created as part of PGD nodes, and as described in the architecture document, they are implemented on top of PG4K Clusters.

We can list the clusters then, which will give us the PGD nodes:

$ kubectl get clusters 
NAME         AGE     INSTANCES   READY   STATUS                     PRIMARY
region-a-1   2m50s   1           1       Cluster in healthy state   region-a-1-1
region-a-2   118s    1           1       Cluster in healthy state   region-a-2-1
region-a-3   91s     1           1       Cluster in healthy state   region-a-3-1
…
…

Ultimately, the PGD nodes are created as part of the PGD groups that make up our PGD cluster.

$ kubectl get pgdgroups
NAME       DATA INSTANCES   WITNESS INSTANCES   PHASE                AGE
region-a   2                1                   PGDGroup - Healthy   4m50s
region-b   2                1                   PGDGroup - Healthy   4m50s
region-c   0                1                   PGDGroup - Healthy   4m50s

Notice how the region-c group is only a witness node.

• On this page
• Part 1 - Setup the local Kubernetes playground
• Part 2 - Install EDB Postgres Distributed for Kubernetes
• Part 3 - Deploy a PGD cluster