{"id":27958304,"url":"https://github.com/pgdogdev/helm","last_synced_at":"2026-05-22T02:23:32.495Z","repository":{"id":284045727,"uuid":"953591560","full_name":"pgdogdev/helm","owner":"pgdogdev","description":"Helm chart for deploying PgDog.","archived":false,"fork":false,"pushed_at":"2026-01-17T18:22:39.000Z","size":129,"stargazers_count":10,"open_issues_count":3,"forks_count":22,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-01-18T07:26:43.279Z","etag":null,"topics":["helm","kubernetes","pgdog","pooler","postgresql"],"latest_commit_sha":null,"homepage":"https://pgdog.dev","language":"Go Template","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pgdogdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-23T17:58:18.000Z","updated_at":"2026-01-17T18:22:05.000Z","dependencies_parsed_at":"2025-05-07T18:34:53.789Z","dependency_job_id":"1d029283-adbc-453f-9505-bb1cff30830c","html_url":"https://github.com/pgdogdev/helm","commit_stats":null,"previous_names":["pgdogdev/helm"],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/pgdogdev/helm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgdogdev%2Fhelm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgdogdev%2Fhelm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgdogdev%2Fhelm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgdogdev%2Fhelm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pgdogdev","download_url":"https://codeload.github.com/pgdogdev/helm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pgdogdev%2Fhelm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28642695,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T18:04:35.752Z","status":"ssl_error","status_checked_at":"2026-01-21T18:03:55.054Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["helm","kubernetes","pgdog","pooler","postgresql"],"created_at":"2025-05-07T18:21:50.867Z","updated_at":"2026-05-22T02:23:32.487Z","avatar_url":"https://github.com/pgdogdev.png","language":"Go Template","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PgDog Helm Chart\n\nProduction-ready [Helm](https://helm.sh) chart for PgDog with\nhigh availability, security, and resource management features.\n\n## Features\n\n✅ Resource limits with guaranteed QoS (1GB:1CPU ratio)\n\n✅ PodDisruptionBudget for high availability\n\n✅ Pod anti-affinity for spreading across nodes\n\n✅ ExternalSecrets integration for secure credential management\n\n✅ ServiceAccount and RBAC with minimal permissions\n\n✅ Pinned image versions for production deployments\n\n## Quick Start\n\n1. Install Helm\n2. Configure `kubectl` to point to your K8s cluster\n3. Add our Helm repository:\n   `helm repo add pgdogdev https://helm.pgdog.dev`\n4. Configure databases and users in `values.yaml`\n5. Install:\n   `helm install \u003cname\u003e pgdogdev/pgdog -f values.yaml`\n\nAll resources will be created in `\u003cname\u003e` namespace.\n\n### Configuration\n\nConfiguration is done via `values.yaml`. All PgDog settings from\n`pgdog.toml` and `users.toml` are supported. General settings\n(`[general]` section) are top level. Use camelCase format instead\nof snake_case, for example: `checkout_timeout` becomes\n`checkoutTimeout`.\n\n#### Basic Example\n\n```yaml\nworkers: 2\ndefaultPoolSize: 15\nopenMetricsPort: 9090\nlogFormat: json\nlogLevel: info\n```\n\n### Docker Image\n\nBy default, the chart uses the `appVersion` from `Chart.yaml` as the image\ntag. This ensures the chart deploys a known-compatible version of PgDog\nwithout requiring explicit configuration.\n\nTo override with a specific version:\n\n```yaml\nimage:\n  repository: ghcr.io/pgdogdev/pgdog\n  tag: \"v1.2.3\" # Pin to specific version\n  pullPolicy: IfNotPresent\n```\n\nTo pin to an exact build, use a digest instead of a tag:\n\n```yaml\nimage:\n  repository: ghcr.io/pgdogdev/pgdog\n  digest: \"sha256:abc123def456...\" # Immutable reference\n  pullPolicy: IfNotPresent\n```\n\nWhen `digest` is specified, it takes precedence over `tag`.\n\n**Legacy format** (still supported for backward compatibility):\n\n```yaml\nimage:\n  name: ghcr.io/pgdogdev/pgdog:main\n  pullPolicy: Always\n```\n\n### Databases \u0026 Users\n\nAdd databases to `databases` list:\n\n```yaml\ndatabases:\n  - name: \"prod\"\n    host: \"10.0.0.1\"\n```\n\nAdd users to `users` list:\n\n```yaml\nusers:\n  - name: \"alice\"\n    database: \"prod\"\n    password: \"hunter2\" # See ExternalSecrets for secure storage\n```\n\n**⚠️ For production**: Use ExternalSecrets instead of plain text\npasswords (see ExternalSecrets section below).\n\n### Mirroring\n\nAdd mirrors to `mirrors` list. For example:\n\n```yaml\nmirrors:\n  - sourceDb: \"prod\"\n    destinationDb: \"staging\"\n```\n\n### High Availability\n\n#### PodDisruptionBudget\n\nEnsures minimum pod availability during voluntary disruptions\n(enabled by default):\n\n```yaml\npodDisruptionBudget:\n  enabled: true\n  minAvailable: 1 # At least 1 pod always available\n```\n\n#### Pod Anti-Affinity\n\nSpreads pods across nodes for better reliability (enabled by\ndefault):\n\n```yaml\npodAntiAffinity:\n  enabled: true\n  type: soft # \"soft\" (preferred) or \"hard\" (required)\n```\n\n### Config Change Restarts\n\nBy default, ConfigMap changes are not automatically picked up by\nrunning pods. Enable `restartOnConfigChange` to trigger a rolling\nrestart whenever the rendered config changes:\n\n```yaml\nrestartOnConfigChange: true\n```\n\nThis injects a `checksum/config` pod annotation that changes when the\nconfig template output changes, causing Kubernetes to roll the pods.\n\n### ExternalSecrets Integration\n\nSecurely manage credentials using ExternalSecrets operator:\n\n**Option 1: Create ExternalSecret with chart**\n\n```yaml\nexternalSecrets:\n  enabled: true\n  create: true\n  secretStoreRef:\n    name: aws-secrets-manager\n    kind: SecretStore\n  remoteRefs:\n    - secretKey: users.toml\n      remoteRef:\n        key: pgdog/users\n```\n\n**Option 2: Use existing ExternalSecret**\n\n```yaml\nexternalSecrets:\n  enabled: true\n  create: false\n  secretName: \"my-secret\" # Name of Secret you created\n```\n\n### ServiceAccount \u0026 RBAC\n\nRBAC with minimal permissions is enabled by default:\n\n```yaml\nserviceAccount:\n  create: true\n  annotations: {}\n\nrbac:\n  create: true\n```\n\n### Resource Management\n\nDefault resources use Guaranteed QoS with 1GB:1CPU ratio:\n\n```yaml\nresources:\n  requests:\n    cpu: 1000m # 1 CPU\n    memory: 1Gi # 1GB\n  limits:\n    cpu: 1000m\n    memory: 1Gi\n```\n\nYou can set `noCpuLimits: true` to omit CPU limits. This allows containers to use idle CPU on the host.\n\n```yaml\nnoCpuLimits: true\nresources:\n  requests:\n    cpu: 500m\n    memory: 512Mi\n  limits:\n    memory: 512Mi\n```\n\n### Prometheus (optional)\n\nPrometheus metrics can be collected with a sidecar. Enable by\nconfiguring `prometheusPort`:\n\n```yaml\nprometheusPort: 9091\n\n# Resources for Prometheus sidecar\nprometheusResources:\n  requests:\n    cpu: 100m\n    memory: 100Mi\n  limits:\n    cpu: 100m\n    memory: 100Mi\n```\n\nMake sure it's different from `openMetricsPort`. You can configure\nPrometheus in `templates/prom/config.yaml`.\n\n#### Grafana Remote Write\n\nTo send metrics to Grafana Cloud or a Grafana instance, configure\nthe remote write settings:\n\n```yaml\ngrafanaRemoteWrite:\n  url: \"https://prometheus-prod-XX-XXX.grafana.net/api/prom/push\"\n  basicAuth:\n    username: \"123456\" # Grafana Cloud user ID\n    password: \"your-api-key\" # Grafana Cloud API key\n  queueConfig:\n    capacity: 10000\n    maxShards: 50\n    minShards: 1\n    maxSamplesPerSend: 5000\n    batchSendDeadline: 5s\n    minBackoff: 30ms\n    maxBackoff: 5s\n```\n\nThe `queueConfig` settings use Prometheus defaults and can be tuned\nfor performance. Remote write is automatically enabled when `url` is\nset.\n\n### Plugins\n\nAdd plugins to the `plugins` list. Each plugin requires a `name`; `config` is\noptional and accepts inline TOML content. When `config` is provided, a\n`\u003cname\u003e.toml` file is added to the ConfigMap and mounted at\n`/etc/pgdog/\u003cname\u003e.toml`.\n\n```yaml\nplugins:\n  - name: pgdog_routing\n    config: |\n      [routing]\n      key = \"value\"\n  - name: pgdog_auth\n```\n\n### TCP Keep-Alive Configuration\n\nConfigure socket-level TCP keep-alive behavior (optional):\n\n```yaml\ntcpKeepalive: true\ntcpTime: 7200000 # 2 hours (ms) before first keepalive probe\ntcpInterval: 75000 # 75 seconds (ms) between keepalive probes\ntcpRetries: 9 # Number of keepalive probes before connection is dropped\n```\n\nThese settings control the TCP keep-alive behavior for database\nconnections. All time values are in milliseconds. If not specified,\nsystem defaults are used.\n\n## Contributions\n\nContributions are welcome. Please open a pull request / issue with\nrequested changes.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpgdogdev%2Fhelm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpgdogdev%2Fhelm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpgdogdev%2Fhelm/lists"}