PgCat Deployment Guide (Helm + Kubernetes)

1. Overview

2. Requirements

3. Helm Chart Installation

Add the Helm repository

helm repo add pgcat https://postgresml.github.io/pgcat/
helm repo update

Install PgCat

helm install pgcat pgcat/pgcat \
  --namespace pgcat \
  --create-namespace \
  -f values.yaml

helm upgrade pgcat pgcat/pgcat -n pgcat -f values.yaml

helm uninstall pgcat -n pgcat

4. Configuration Model

configuration:

Minimal Required Structure

5. Example Working Configuration (values.yaml)

configuration:
  general:
    enable_prometheus_exporter: true
    prometheus_exporter_port: 9930

  pools:
    - name: main
      pool_mode: transaction

      shards:
        - database: postgres
          servers:
            - host: my-primary-db.example.com
              port: 5432
              role: primary
            - host: my-replica-db.example.com
              port: 5432
              role: replica

      users:
        - username: default
          password: default
          pool_size: 20
          statement_timeout: 0

replicaCount: 2

Notes

6. Connecting Applications to PgCat

postgres://default:default@pgcat.pgcat.svc.cluster.local:6432/postgres

7. Validating the Rendered Configuration

helm template pgcat pgcat/pgcat -f values.yaml | grep -A80 pgcat.toml

Could not parse config file: TOML parse error

8. Operational Considerations

Running Multiple Replicas

Config Changes

helm upgrade pgcat pgcat/pgcat -n pgcat -f values.yaml

Logging Issues

9. Usage in Migration Scenarios

Example workflow

10. Summary

Related Documentations