Skip to content

Install Percona Distribution for PostgreSQL on Minikube

Installing the Percona Operator for PostgreSQL on minikube is the easiest way to try it locally without a cloud provider. Minikube runs Kubernetes on GNU/Linux, Windows, or macOS system using a system-wide hypervisor, such as VirtualBox, KVM/QEMU, VMware Fusion or Hyper-V. Using it is a popular way to test the Kubernetes application locally prior to deploying it on a cloud.

The following steps are needed to run Percona Operator for PostgreSQL on minikube:

  1. Install minikube, using a way recommended for your system. This includes the installation of the following three components:

    1. kubectl tool,
    2. a hypervisor, if it is not already installed,
    3. actual minikube package

    After the installation, run minikube start command. Being executed, this command will download needed virtualized images, then initialize and run the cluster. After minikube is successfully started, you can optionally run the Kubernetes dashboard, which visually represents the state of your cluster. Executing minikube dashboard will start the dashboard and open it in your default web browser.

  2. The first thing to do is to add the pgo namespace to Kubernetes, not forgetting to set the correspondent context for further steps:

    $ kubectl create namespace pgo
    $ kubectl config set-context $(kubectl config current-context) --namespace=pgo


    To use different namespace, you should edit all occurrences of the namespace: pgo line in both deploy/cr.yaml and deploy/operator.yaml configuration files.

    If you use Kubernetes dashboard, choose your newly created namespace to be shown instead of the default one:


  3. Deploy the operator with the following command:

    $ kubectl apply -f
    Expected output
    serviceaccount/pgo-deployer-sa created created
    configmap/pgo-deployer-cm created created
    job.batch/pgo-deploy created

    The last line of the command output mentions the pgo-deploy Kubernetes Job created to carry on the Operator deployment process. It can take several minutes to be completed. You can track it with the following command:

    $ kubectl get job/pgo-deploy
    Expected output
    pgo-deploy   1/1           81s        5m53s

    When it reaches the COMPLETIONS count of 1/1, you can safely delete the job as follows:

    $ kubectl delete  job/pgo-deploy


    Deleting the pgo-deploy job will be needed before upgrading the Operator.

  4. Deploy Percona Distribution for PostgreSQL:

    $ kubectl apply -f

    This deploys PostgreSQL on one node, because deploy/cr-minimal.yaml is for minimal non-production deployment. For more configuration options please see deploy/cr.yaml and Custom Resource Options.

    Creation process will take some time. The process is over when both operator and replica set pod have reached their Running status:

    $ kubectl get pods
    Expected output
    NAME                                                    READY   STATUS      RESTARTS   AGE
    backrest-backup-minimal-cluster-dcvkw                   0/1     Completed   0          68s
    minimal-cluster-6dfd645d94-42xsr                        1/1     Running     0          2m5s
    minimal-cluster-backrest-shared-repo-77bd498dfd-9msvp   1/1     Running     0          2m23s
    minimal-cluster-pgbouncer-594bf56d-kjwrp                1/1     Running     0          84s
    pgo-deploy-lnbv7                                        0/1     Completed   0          4m14s
    postgres-operator-6c4c558c5-dkk8v                       4/4     Running     0          3m37s

    You can also track the progress via the Kubernetes dashboard:


  5. During previous steps, the Operator has generated several secrets, including the password for the pguser user, which you will need to access the cluster.

    Use kubectl get secrets command to see the list of Secrets objects (by default Secrets object you are interested in has minimal-cluster-pguser-secret name). Then you can use kubectl get secret minimal-cluster-pguser-secret -o yaml to look through the YAML file with generated secrets (the actual password will be base64-encoded), or just get the needed password with the following command:

    $ kubectl get secrets minimal-cluster-users -o yaml -o jsonpath='{.data.pguser}' | base64 --decode | tr '\n' ' ' && echo " "
  6. Check connectivity to a newly created cluster.

    Run new Pod to use it as a client and connect its console output to your terminal (running it may require some time to deploy). When you see the command line prompt of the newly created Pod, run psql tool using the password obtained from the secret. The following command will do this, naming the new Pod pg-client:

    $ kubectl run -i --rm --tty pg-client --image=perconalab/percona-distribution-postgresql:14.9 --restart=Never -- bash -il
    [postgres@pg-client /]$ PGPASSWORD='pguser_password' psql -h minimal-cluster -p 5432 -U pguser pgdb

    This command will connect you to the PostgreSQL interactive terminal.

    $ psql (14.9)
    Type "help" for help.

Last update: 2024-03-11