Skip to content

Installation

Install the operator with Helm:

helm install pgcopydb-operator oci://ghcr.io/ydixken/pgcopydb-operator/charts/pgcopydb-operator \
  --namespace pgcopydb-system --create-namespace

The chart installs the Migration CRD, the controller manager, and its RBAC. The chart README is the full values reference. The chart's Artifact Hub page renders it with the CRD and the example resources. Check the install:

kubectl get crd migrations.pgcopydb-operator.io
kubectl -n pgcopydb-system get deploy

The chart can also install a ServiceMonitor for the scrape, alert rules, and Grafana dashboards. Each has its own value. See Monitoring.

CRD lifecycle

The CRD renders as a regular chart template, so helm upgrade updates it in place. Two values control it:

  • crds.install (default true): render the CRD. When something else owns the CRD, set it to false, for example a second operator install in another namespace.

[!warning] crds.keep: false lets helm uninstall delete the CRD and every Migration resource with it. Set it to false only when that data loss is acceptable.

  • crds.keep (default true): annotate the CRD with helm.sh/resource-policy: keep. helm uninstall then leaves the CRD in place.

API versions

The CRD serves two versions: v1beta1 and the deprecated v1alpha1. v1beta1 is the storage version. The schemas are identical, so existing v1alpha1 manifests keep working. The API server answers them with a deprecation warning. Switch your manifests to apiVersion: pgcopydb-operator.io/v1beta1.

Next: Quickstart.