Installation v1

Suggest edits

You can deploy EDB Postgres Distributed for Kubernetes using the provided Helm chart.

Info

For more details on the Helm chart, see the Helm chart repo documentation.

These installation instructions cover using helm to deploy of a set of default images with the latest available version. If want to specify a different operand or proxy image, see Identify your installation images and repositories, before continuing with the installation.

Prerequisites

  • Install Helm. Follow these instructions to install it in your system.

  • Install kubectl. See Install Tools for instructions.

  • Create at least one Kubernetes cluster.

Add the repository

Use helm to add the repository containing all images:

helm repo add edb \
  https://enterprisedb.github.io/edb-postgres-for-kubernetes-charts/

Set the environment variables

Set the environment variables for the REPOSITORY_NAME and EDB_SUBSCRIPTION_TOKEN:

  1. Set REPOSITORY_NAME to the name of the repository. In this example, the images come from the k8s_enterprise_pgd repository:

    export REPOSITORY_NAME=k8s_enterprise_pgd

  2. Set EDB_SUBSCRIPTION_TOKEN to use your personal token:

    export EDB_SUBSCRIPTION_TOKEN=<my_registry_token>

Deploy the images

Important

You need access to the private EDB repository where both the operator and operand images are stored. Access requires a valid EDB subscription plan.

To identify your access credentials, see Accessing EDB private image registries.

Given that the container images for both the operator and the selected operand are in EDB's private registry, you need your credentials to enable helm to retrieve them.

Make sure to replace your repo and token in the following command:

helm upgrade --dependency-update \
  --install edb-pg4k-pgd \
  --wait \
  --namespace pgd-operator-system \
  --create-namespace \
  edb/edb-postgres-distributed-for-kubernetes \
  --set image.imageCredentials.username=${REPOSITORY_NAME} \
  --set image.imageCredentials.password=${EDB_SUBSCRIPTION_TOKEN}

Create a certificate issuer

Be sure to create a cert issuer before you start deploying PGD clusters. The Helm chart prompts you to do this, but in case you miss it, you can, for example, run:

kubectl apply -f \
  https://raw.githubusercontent.com/EnterpriseDB/edb-postgres-for-kubernetes-charts/main/hack/samples/issuer-selfsigned.yaml

With the operators and a self-signed cert issuer deployed, you can start creating PGD clusters. See the Quick start for an example.

Red Hat OpenShift

If you're trying to install EDB Postgres Distributed for Kubernetes on Red Hat OpenShift, see Red Hat OpenShift, which contains information on the certified operator maintained by EDB.

← Prev

Architecture

↑ Up

EDB CloudNativePG Global Cluster

Next →

Quick start