pgsprovider

Overview ¶

pkg/provider/postgres/provider.go

PostgreSQL provider for Orkestra.

Handles the "postgres" block in Katalog declarations. Uses pgx/v5 — the standard PostgreSQL driver for Go.

Supported resource kinds:

database   — PostgreSQL database (create, drop)
role       — Database role/user (create, update password and privileges, drop)
extension  — PostgreSQL extension (CREATE EXTENSION IF NOT EXISTS, drop)

Installation:

go get github.com/jackc/pgx/v5

Registration:

p, err := pgsprovider.NewFromAuth(ctx, auth)
registry.Register(p)

Auth keys (providers[].auth block):

host     — server hostname or IP (default: localhost)
port     — server port (default: 5432)
user     — superuser name (must be able to CREATE DATABASE/ROLE)
password — superuser password (or set PGPASSWORD env var)
sslmode  — disable | require | verify-ca | verify-full (default: require)

Katalog:

providers:
  - name: postgres
    required: true
    auth:
      host: "$PG_HOST"
      user: "$PG_USER"
      password: "$PG_PASSWORD"

operatorBox:
  providers:
    postgres:
      - database:
          name: "{{ .metadata.name }}"
          owner: "{{ .spec.dbUser }}"

      - role:
          name: "{{ .spec.dbUser }}"
          password: "{{ .spec.dbPassword }}"
          privileges: "LOGIN NOSUPERUSER"
          credentials:
            secretName: "{{ .metadata.name }}-pg-creds"   # PG_PASSWORD key

      - extension:
          name: pgcrypto
          database: "{{ .metadata.name }}"