Postgres Operator

https://github.com/zalando/postgres-operator
Admin
Postgres operator creates and manages PostgreSQL clusters running in Kubernetes
Tokens:28,484
Snippets:453
Trust Score:8.3
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### OpenShift Manual Deployment Setup

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Installs the Postgres Operator on OpenShift, requiring specific RBAC rules and configuration changes.

```bash
oc create -f manifests/operator-service-account-rbac-openshift.yaml
```

--------------------------------

### Run Local Multi-Namespace Setup

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Test the operator locally with a multi-namespace configuration.

```bash
./run_operator_locally.sh --rebuild-operator
```

--------------------------------

### Deploying operator with Helm

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Install the operator chart using local build settings.

```bash
helm install postgres-operator ./charts/postgres-operator --namespace zalando-operator --set image.tag=${TAG} --set image.pullPolicy=Never
```

--------------------------------

### Configure AWS S3 Backup Settings

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Configuration examples for setting up S3 backups via ConfigMap or OperatorConfiguration.

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: postgres-operator
data:
  aws_region: eu-central-1
  kube_iam_role: postgres-pod-role
  wal_s3_bucket: your-backup-path
```

```yaml
apiVersion: "acid.zalan.do/v1"
kind: OperatorConfiguration
metadata:
  name: postgresql-operator-configuration
configuration:
  aws_or_gcp:
    aws_region: eu-central-1
    kube_iam_role: postgres-pod-role
    wal_s3_bucket: your-backup-path
```

--------------------------------

### Install Postgres Operator UI with Helm

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Installs the Postgres Operator UI using its Helm chart. Requires Helm v3.

```bash
helm install postgres-operator-ui postgres-operator-ui-charts/postgres-operator-ui
```

--------------------------------

### Install Delve Debugger

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Install the Delve debugger locally for Go applications.

```bash
go get -u github.com/derekparker/delve/cmd/dlv
```

--------------------------------

### Install Postgres Operator with Helm

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Installs the Postgres Operator using its Helm chart. Requires Helm v3.

```bash
helm install postgres-operator postgres-operator-charts/postgres-operator
```

--------------------------------

### Build UI Image

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Uses the Makefile to build the operator UI Docker image without requiring a local Node.js installation.

```bash
make docker
```

--------------------------------

### Run Postgres Operator Locally with Minikube

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Automates starting the operator with minikube by applying the minimal cluster manifest.

```bash
./run_operator_locally.sh
```

--------------------------------

### Develop PostgreSQL Operator UI Frontend

Source: https://github.com/zalando/postgres-operator/blob/master/ui/app/README.rst

Starts a development server that watches source code changes and continuously recompiles the webpack bundle for faster iteration.

```bash
$ npm start
```

--------------------------------

### Build PostgreSQL Operator UI Application

Source: https://github.com/zalando/postgres-operator/blob/master/ui/app/README.rst

Installs dependencies and builds the JavaScript application bundle using webpack. The output is saved to ``operator_ui/static/build/app*.js``.

```bash
$ npm install
$ npm run build
```

--------------------------------

### Manual Deployment of Postgres Operator

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Installs the Postgres Operator by applying YAML manifests. Ensure manifests are adjusted for your K8s environment.

```bash
kubectl create -f manifests/configmap.yaml  # configuration
kubectl create -f manifests/operator-service-account-rbac.yaml  # identity and permissions
kubectl create -f manifests/postgres-operator.yaml  # deployment
kubectl create -f manifests/api-service.yaml  # operator API to be used by UI
```

--------------------------------

### Configure team API role settings in YAML

Source: https://github.com/zalando/postgres-operator/blob/master/docs/reference/operator_parameters.md

Example of setting multiple Postgres parameters for team member roles using the teams_api_role_configuration key.

```yaml
teams_api_role_configuration: "log_statement:all,search_path:'data,public'"
```

--------------------------------

### GET /databases

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Retrieves a list of all databases per cluster.

```APIDOC
## GET /databases

### Description
Returns all databases per cluster.

### Method
GET

### Endpoint
/databases
```

--------------------------------

### Node Affinity Merge Logic (AND)

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Example of node affinity configuration when node_readiness_label_merge is set to AND, resulting in merged matchExpressions.

```yaml
  affinity:
    nodeAffinity:
      requiredDuringSchedulingIgnoredDuringExecution:
        nodeSelectorTerms:
        - matchExpressions:
          - key: environment
            operator: In
            values:
            - pci
          - key: status1
            operator: In
            values:
            - ready
          - key: status2
            ...
```

--------------------------------

### GET /clusters/

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Lists all teams and clusters known to the operator.

```APIDOC
## GET /clusters/

### Description
Returns a list of teams and clusters known to the operator.

### Method
GET

### Endpoint
/clusters/
```

--------------------------------

### Verify Postgres Operator UI Pod Status

Source: https://github.com/zalando/postgres-operator/blob/master/charts/postgres-operator-ui/templates/NOTES.txt

Use this command to check if the postgres-operator-ui pods have started successfully in the specified namespace.

```bash
kubectl --namespace={{ .Release.Namespace }} get pods -l "app.kubernetes.io/name={{ template "postgres-operator-ui.name" . }}"
```

--------------------------------

### Node Affinity Merge Logic (OR)

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Example of node affinity configuration when node_readiness_label_merge is set to OR, resulting in appended expressions blocks.

```yaml
  affinity:
    nodeAffinity:
      requiredDuringSchedulingIgnoredDuringExecution:
        nodeSelectorTerms:
        - matchExpressions:
          - key: environment
            ...
        - matchExpressions:
          - key: storage
            ...
        - matchExpressions:
          - key: status1
            ...
          - key: status2
            ...
```

--------------------------------

### Define Init Containers

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Specify custom init containers in the cluster manifest to run actions before primary containers start. Ensure enable_init_containers is set to true in the operator configuration.

```yaml
spec:
  initContainers:
    - name: "container-name"
      image: "company/image:tag"
      env:
        - name: "ENV_VAR_NAME"
          value: "any-k8s-env-things"
```

--------------------------------

### Deploy UI on Kubernetes

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Applies UI manifests to the cluster, optionally updating the image tag via sed.

```bash
sed -e "s/\(image\:.*\:\).*$/\1$TAG/" manifests/deployment.yaml | kubectl apply -f manifests/
kubectl get all -l application=postgres-operator-ui
```

--------------------------------

### GET /workers/all/queue

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Retrieves the state of the workers queue.

```APIDOC
## GET /workers/all/queue

### Description
Returns the state of the workers queue, showing cluster events to process.

### Method
GET

### Endpoint
/workers/all/queue
```

--------------------------------

### Run Unit Tests

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Execute the full suite of unit tests.

```bash
make test
```

--------------------------------

### Deploying Docker image to local clusters

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Commands to build and load the operator image into minikube or kind environments.

```bash
# minikube
eval $(minikube docker-env)
make docker

# kind
make docker
kind load docker-image ghcr.io/zalando/postgres-operator:${TAG} --name <kind-cluster-name>
```

--------------------------------

### GET /clusters/$team

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Lists clusters for a specific team.

```APIDOC
## GET /clusters/$team

### Description
Returns a list of clusters for the given team.

### Method
GET

### Endpoint
/clusters/$team

### Parameters
#### Path Parameters
- **team** (string) - Required - The team name
```

--------------------------------

### Local UI Testing

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Commands for building the UI image, applying manifests, and running the UI locally using the provided script.

```bash
# compile and build operator UI
make docker

# build in image in minikube docker env
eval $(minikube docker-env)
docker build -t ghcr.io/zalando/postgres-operator-ui:v1.15.1 .

# apply UI manifests next to a running Postgres Operator
kubectl apply -f manifests/

# install python dependencies to run UI locally
pip3 install -r requirements
./run_local.sh
```

--------------------------------

### Configure default prepared database

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Creates a default database and schema by providing an empty preparedDatabases section.

```yaml
spec:
  preparedDatabases: {}
```

--------------------------------

### GET /workers/$id/queue

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Retrieves the state of the queue for a specific worker.

```APIDOC
## GET /workers/$id/queue

### Description
Returns the state of the queue for the specified worker ID.

### Method
GET

### Endpoint
/workers/$id/queue

### Parameters
#### Path Parameters
- **id** (integer) - Required - The worker ID (0 up to 'workers' - 1)
```

--------------------------------

### Clone the Postgres Operator Repository

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Sets up the GOPATH and clones the repository into the correct directory structure.

```bash
export GOPATH=~/go
mkdir -p ${GOPATH}/src/github.com/zalando/
cd ${GOPATH}/src/github.com/zalando/
git clone https://github.com/zalando/postgres-operator.git
```

--------------------------------

### GET /clusters/$team/$namespace/$clustername/history/

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Retrieves the history of cluster changes.

```APIDOC
## GET /clusters/$team/$namespace/$clustername/history/

### Description
Returns the history of cluster changes triggered by manifest changes.

### Method
GET

### Endpoint
/clusters/$team/$namespace/$clustername/history/
```

--------------------------------

### GET /workers/$id/logs

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Retrieves the logs of operations performed by a specific worker.

```APIDOC
## GET /workers/$id/logs

### Description
Returns the log of operations performed by a given worker.

### Method
GET

### Endpoint
/workers/$id/logs

### Parameters
#### Path Parameters
- **id** (integer) - Required - The worker ID
```

--------------------------------

### Build Test Runner Image

Source: https://github.com/zalando/postgres-operator/blob/master/e2e/README.md

Builds the `postgres-operator-e2e-tests` Docker image and downloads the kind runtime. Run this in the `e2e` directory.

```bash
make
```

--------------------------------

### Retrieve Connection String for Minikube

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Set environment variables for connecting to the master pod using psql on Minikube.

```bash
export HOST_PORT=$(minikube service acid-minimal-cluster --url | sed 's,.*/,,' )
export PGHOST=$(echo $HOST_PORT | cut -d: -f 1)
export PGPORT=$(echo $HOST_PORT | cut -d: -f 2)
```

--------------------------------

### GET /clusters/$team/$namespace/$clustername

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Retrieves detailed status of a specific cluster.

```APIDOC
## GET /clusters/$team/$namespace/$clustername

### Description
Returns detailed status of the cluster, including CRD specs, services, endpoints, statefulsets, errors, and assigned worker.

### Method
GET

### Endpoint
/clusters/$team/$namespace/$clustername

### Parameters
#### Path Parameters
- **team** (string) - Required - The team name
- **namespace** (string) - Required - The namespace
- **clustername** (string) - Required - The cluster name
```

--------------------------------

### GET /clusters/$team/$namespace/$clustername/logs/

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Retrieves logs of operations performed on a specific cluster.

```APIDOC
## GET /clusters/$team/$namespace/$clustername/logs/

### Description
Returns logs of all operations performed to the cluster so far.

### Method
GET

### Endpoint
/clusters/$team/$namespace/$clustername/logs/
```

--------------------------------

### Deploy Operator UI

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Deploy the operator UI using one of the provided methods: manual apply, kustomization, or Helm chart.

```bash
# manual deployment
kubectl apply -f ui/manifests/
```

```bash
# or kustomization
kubectl apply -k github.com/zalando/postgres-operator/ui/manifests
```

```bash
# or helm chart
helm install postgres-operator-ui ./charts/postgres-operator-ui
```

--------------------------------

### Deploy a PostgreSQL cluster via kubectl

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Apply the manifest file to the Kubernetes cluster to initiate the deployment.

```bash
kubectl create -f manifests/minimal-postgres-manifest.yaml
```

--------------------------------

### Execute Manual Basebackup

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Command to trigger a manual basebackup for the Postgres data directory.

```bash
envdir "/run/etc/wal-e.d/env" /scripts/postgres_backup.sh "/home/postgres/pgdata/pgroot/data"
```

--------------------------------

### Connect to Postgres Cluster with psql

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Connect to the PostgreSQL cluster using the psql client with the previously set environment variables.

```bash
psql -U postgres
```

--------------------------------

### Check allowed extensions

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Queries the list of extensions permitted for creation without superuser rights.

```bash
SHOW extwlist.extensions;
```

--------------------------------

### Build the Operator Docker Image

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Builds the Docker image using the current git tag.

```bash
export TAG=$(git describe --tags --always --dirty)
make docker
```

--------------------------------

### Build and Run All Tests

Source: https://github.com/zalando/postgres-operator/blob/master/e2e/README.md

Invokes both the build and test steps for the end-to-end tests. This command is run from the parent directory of `e2e`.

```bash
make e2e
```

--------------------------------

### Create a Postgres Cluster

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Submit a minimal Postgres cluster manifest to create a new PostgreSQL cluster.

```bash
# create a Postgres cluster
kubectl create -f manifests/minimal-postgres-manifest.yaml
```

--------------------------------

### Cleanup Kind Cluster

Source: https://github.com/zalando/postgres-operator/blob/master/e2e/README.md

Removes the kind cluster and its associated resources, allowing for a fresh start. This is useful for resolving issues like the 'no nodes found' error when the cluster configuration file is out of sync.

```bash
e2e/run.sh cleanup
```

--------------------------------

### Connect to PostgreSQL via psql

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Retrieve credentials from a Kubernetes secret and connect to the database with SSL enabled.

```bash
export PGPASSWORD=$(kubectl get secret postgres.acid-minimal-cluster.credentials.postgresql.acid.zalan.do -o 'jsonpath={.data.password}' | base64 -d)
export PGSSLMODE=require
psql -U postgres -h localhost -p 6432
```

--------------------------------

### Check Deployed Cluster Resources

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Verify the creation of PostgreSQL cluster components by checking PostgreSQL resources, pods, and services.

```bash
# check the deployed cluster
kubectl get postgresql
```

```bash
# check created database pods
kubectl get pods -l application=spilo -L spilo-role
```

```bash
# check created service resources
kubectl get svc -l application=spilo -L spilo-role
```

--------------------------------

### Execute Commands within Kind Environment

Source: https://github.com/zalando/postgres-operator/blob/master/e2e/README.md

Provides a script to execute commands within the kind Kubernetes environment. Useful for inspecting cluster state using `kubectl` or watching object changes.

```bash
./exec_into_env.sh

# use kubectl
kubectl get pods

# watch relevant objects
./scripts/watch_objects.sh

# get operator logs
./scripts/get_logs.sh
```

--------------------------------

### Generate Mocks

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Run this command to generate necessary mocks for unit testing.

```bash
make mocks
```

--------------------------------

### Configure WAL Archiving Settings

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Default environment variables for WAL-E/WAL-G backup scheduling and retention within the Spilo docker image.

```bash
BACKUP_NUM_TO_RETAIN: 5
BACKUP_SCHEDULE:      '00 01 * * *'
USE_WALG_BACKUP:      false (true for Azure and SSH)
USE_WALG_RESTORE:     false (true for S3, Azure and SSH)
```

--------------------------------

### List Available Backups

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Command to verify if Spilo can detect existing backups using WAL-G.

```bash
envdir "/run/etc/wal-e.d/env" wal-g backup-list
```

--------------------------------

### Inspect Kind Cluster with Context Flag

Source: https://github.com/zalando/postgres-operator/blob/master/e2e/README.md

A shorthand command to inspect the kind cluster's pods using `kubectl` by specifying the cluster context directly. This avoids the need to manually set the `KUBECONFIG` environment variable for single commands.

```bash
kubectl get pods --context kind-kind
```

--------------------------------

### Configure Pod Environment for WAL-G

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

ConfigMap to enable WAL-G for backup and restore operations within the Spilo environment.

```yml
apiVersion: v1
kind: ConfigMap
metadata:
  name: pod-env-overrides
  namespace: postgres-operator-system
data:
  # Any env variable used by spilo can be added
  USE_WALG_BACKUP: "true"
  USE_WALG_RESTORE: "true"
  CLONE_USE_WALG_RESTORE: "true"
  WALG_AZ_PREFIX: "azure://container-name/$(SCOPE)/$(PGVERSION)" # Enables Azure Backups (SCOPE = Cluster name) (PGVERSION = Postgres version)
```

--------------------------------

### Enable HugePages support

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Configure HugePages requests and limits in the manifest. Kubernetes will fail to schedule the pod if the requested HugePages cannot be allocated.

```yaml
spec:
  resources:
    requests:
      hugepages-2Mi: 250Mi
      hugepages-1Gi: 1Gi
    limits:
      hugepages-2Mi: 500Mi
      hugepages-1Gi: 2Gi
```

--------------------------------

### Define Custom Clone Environment Variables

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

ConfigMap demonstrating the use of CLONE_ prefix for propagating environment variables to the clone process.

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: postgres-pod-config
data:
  AWS_REGION: "eu-west-1"
  AWS_ACCESS_KEY_ID: "****"
  AWS_SECRET_ACCESS_KEY: "****"
  ...
  CLONE_AWS_REGION: "eu-west-1"
  CLONE_AWS_ACCESS_KEY_ID: "****"
  CLONE_AWS_SECRET_ACCESS_KEY: "****"
  ...
```

--------------------------------

### Port-forward to UI Service

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Access the UI by port-forwarding the UI pod and navigating to localhost:8081 in your browser.

```bash
kubectl port-forward svc/postgres-operator-ui 8081:80
```

--------------------------------

### Establish port-forward to master pod

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Identify the master pod and create a local port-forwarding tunnel for database access.

```bash
# get name of master pod of acid-minimal-cluster
export PGMASTER=$(kubectl get pods -o jsonpath={.items..metadata.name} -l application=spilo,cluster-name=acid-minimal-cluster,spilo-role=master -n default)

# set up port forward
kubectl port-forward $PGMASTER 6432:5432 -n default
```

--------------------------------

### Deploy Operator with RBAC

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Apply the necessary manifests to deploy the operator with service account and RBAC policies.

```bash
kubectl create -f manifests/configmap.yaml
kubectl create -f manifests/operator-service-account-rbac.yaml
kubectl create -f manifests/postgres-operator.yaml
kubectl create -f manifests/minimal-postgres-manifest.yaml
```

--------------------------------

### Deploying operator with kubectl

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Apply configuration and RBAC manifests before deploying the operator with a custom image tag.

```bash
kubectl create -f manifests/configmap.yaml
kubectl create -f manifests/operator-service-account-rbac.yaml
sed -e "s/\(image\:.*\:\).*$/\1$TAG/" -e "s/\(imagePullPolicy\:\).*$/\1 Never/" manifests/postgres-operator.yaml | kubectl create  -f -

# check if the operator is coming up
kubectl get pod -l name=postgres-operator
```

--------------------------------

### Configure Owner References and Finalizers via ConfigMap

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Enable owner references and finalizers using the postgres-operator ConfigMap.

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: postgres-operator
data:
  enable_finalizers: "false"
  enable_owner_references: "true"
```

--------------------------------

### Kustomization Deployment of Postgres Operator

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Applies a Kustomization manifest to deploy the Postgres Operator. Requires kubectl 1.14 or newer.

```bash
kubectl apply -k github.com/zalando/postgres-operator/manifests
```

--------------------------------

### Build the Operator Binary

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Compiles the operator binary for out-of-cluster testing.

```bash
make
```

--------------------------------

### Migrate from databases to preparedDatabases

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Updates the database owner naming convention to match the preparedDatabases requirements.

```yaml
# before
spec:
  databases:
    foo: db_owner

# after
spec:
  databases:
    foo: foo_owner
  preparedDatabases:
    foo:
      schemas:
        my_existing_schema: {}
```

--------------------------------

### Configure custom connection pooler settings

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Define specific pooler parameters such as instance count, mode, schema, and resource limits.

```yaml
spec:
  connectionPooler:
    # how many instances of connection pooler to create
    numberOfInstances: 2

    # in which mode to run, session or transaction
    mode: "transaction"

    # schema, which operator will create in each database
    # to install credentials lookup function for connection pooler
    schema: "pooler"

    # user, which operator will create for connection pooler
    user: "pooler"

    # resources for each instance
    resources:
      requests:
        cpu: 500m
        memory: 100Mi
      limits:
        cpu: "1"
        memory: 100Mi
```

--------------------------------

### Configure standby cluster with remote primary and S3 WAL archive

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Combine a remote primary host with an S3 WAL path for increased redundancy.

```yaml
spec:
  standby:
    standby_host: "acid-minimal-cluster.default"
    standby_port: "5433"
    s3_wal_path: "s3://<bucketname>/spilo/<source_db_cluster>/<UID>/wal/<PGVERSION>"
```

--------------------------------

### Run All Tests

Source: https://github.com/zalando/postgres-operator/blob/master/e2e/README.md

Executes all end-to-end tests. This command can be run from the `e2e` directory.

```bash
./run.sh main
```

--------------------------------

### Check UI Pod Status (YAML)

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Check if the UI pod is running when deployed using YAML manifests.

```bash
# if you've created the operator using yaml manifests
kubectl get pod -l name=postgres-operator-ui
```

--------------------------------

### Check Patroni Logs

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Retrieve logs from the cluster pod for debugging.

```bash
kubectl logs acid-minimal-cluster-0
```

--------------------------------

### Execute In-place Major Version Upgrade

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Run this command inside the primary pod to manually trigger an in-place major version upgrade.

```bash
python3 /scripts/inplace_upgrade.py N
```

--------------------------------

### Set Password and SSL Mode for psql

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Retrieve the database password from Kubernetes secrets and set the SSL mode for a secure connection.

```bash
export PGPASSWORD=$(kubectl get secret postgres.acid-minimal-cluster.credentials.postgresql.acid.zalan.do -o 'jsonpath={.data.password}' | base64 -d)
export PGSSLMODE=require
```

--------------------------------

### Define WAL Archiving and Restore Commands

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Postgres configuration commands for pushing and restoring WAL files using envdir.

```bash
archive_command:  `envdir "{WALE_ENV_DIR}" {WALE_BINARY} wal-push "%p"`
restore_command:  `envdir "{{WALE_ENV_DIR}}" /scripts/restore_command.sh "%f" "%p"`
```

--------------------------------

### Configure local PostgreSQL socket sharing

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Define an additional volume and mount it in the sidecar to share the PostgreSQL socket for a specific cluster.

```yaml
spec:
  additionalVolumes:
  - name: postgresql-run
    mountPath: /var/run/postgresql
    targetContainers:
    - all
    volumeSource:
      emptyDir: {}
  sidecars:
  - name: "container-name"
    image: "company/image:tag"
    volumeMounts:
    - mountPath: /var/run
      name: postgresql-run
```

--------------------------------

### Configure Owner References and Finalizers via OperatorConfiguration

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Enable owner references and finalizers using the OperatorConfiguration custom resource.

```yaml
apiVersion: "acid.zalan.do/v1"
kind: OperatorConfiguration
metadata:
  name: postgresql-operator-configuration
configuration:
  kubernetes:
    enable_finalizers: false
    enable_owner_references: true
```

--------------------------------

### Verify S3 Environment Variables

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Expected environment variable settings for S3 connectivity and pathing.

```bash
AWS_ENDPOINT='https://s3.eu-central-1.amazonaws.com:443'
WALE_S3_ENDPOINT='https+path://s3.eu-central-1.amazonaws.com:443'
WALE_S3_PREFIX=$WAL_S3_BUCKET/spilo/{WAL_BUCKET_SCOPE_PREFIX}{SCOPE}{WAL_BUCKET_SCOPE_SUFFIX}/wal/{PGVERSION}
```

--------------------------------

### Enable logical backups in Postgres manifest

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Add the enableLogicalBackup field to the postgresql resource spec to activate automated SQL dump cron jobs.

```yaml
apiVersion: "acid.zalan.do/v1"
kind: postgresql
metadata:
  name: demo-cluster
spec:
  enableLogicalBackup: true
```

--------------------------------

### String Formatting Utility

Source: https://github.com/zalando/postgres-operator/blob/master/ui/operator_ui/templates/index.html

Extends the String prototype to add a 'format' method. This method allows for easy string interpolation by replacing placeholders like {0}, {1}, etc., with provided arguments. Use this for dynamic string construction.

```javascript
String.prototype.format = function() {
  var formatted = this;
  for(arg in arguments) {
    formatted = formatted.replace("{" + arg + "}", arguments[arg]);
  }
  return formatted;
};
```

--------------------------------

### Configure Node Readiness Labels in OperatorConfiguration

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Define node readiness labels using a structured map within the OperatorConfiguration resource.

```yaml
apiVersion: "acid.zalan.do/v1"
kind: OperatorConfiguration
metadata:
  name: postgresql-configuration
configuration:
  kubernetes:
    node_readiness_label:
      status1: ready
      status2: ready
```

--------------------------------

### Watch database pod status

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Monitor the creation and role assignment of database pods using labels.

```bash
kubectl get pods -l application=spilo -L spilo-role -w
```

--------------------------------

### Enable connection poolers in cluster manifest

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Use these flags to enable connection pooling for master and replica services.

```yaml
spec:
  enableConnectionPooler: true
  enableReplicaConnectionPooler: true
```

--------------------------------

### Test CRD-based configuration locally

Source: https://github.com/zalando/postgres-operator/blob/master/docs/reference/operator_parameters.md

Commands to register the CRD, apply default configurations, and verify the operator configuration object.

```bash
  kubectl create -f manifests/operatorconfiguration.crd.yaml # registers the CRD
  kubectl create -f manifests/postgresql-operator-default-configuration.yaml

  kubectl create -f manifests/operator-service-account-rbac.yaml
  kubectl create -f manifests/postgres-operator.yaml # set the env var as mentioned above

  kubectl get operatorconfigurations postgresql-operator-default-configuration -o yaml
```

--------------------------------

### Check UI Pod Status (Helm)

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Check if the UI pod is running when deployed using a Helm chart.

```bash
# if you've created the operator using helm chart
kubectl get pod -l app.kubernetes.io/name=postgres-operator-ui
```

--------------------------------

### Set deployment namespace via kubectl

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Commands to create a new namespace and update the current kubectl context to target it for operator deployment.

```bash
kubectl create namespace test
kubectl config set-context $(kubectl config current-context) --namespace=test
```

--------------------------------

### Define compute resources in manifest

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Specify CPU and memory requests and limits for Postgres containers. The operator enforces minimum limits of 250m CPU and 250Mi memory if lower values are provided.

```yaml
spec:
  resources:
    requests:
      cpu: 10m
      memory: 100Mi
    limits:
      cpu: 300m
      memory: 300Mi
```

--------------------------------

### Define custom pg_hba configuration

Source: https://github.com/zalando/postgres-operator/blob/master/docs/reference/cluster_manifest.md

Provides the default pg_hba line that must be included when defining custom authentication rules to maintain PAM functionality.

```text
hostssl all +pamrole all pam
```

--------------------------------

### Configure In-Place Restore Manifest

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Defines the manifest for the new cluster, referencing the original cluster name and UID to restore to a specific point in time.

```yaml
metadata:
  name: acid-minimal-cluster
  # [...]
spec:
  # [...]
  clone:
    cluster: "acid-minimal-cluster"  # the same as metadata.name above!
    uid: "<original_UID>"
    timestamp: "2022-04-01T10:11:12.000+00:00"
```

--------------------------------

### Configure Makefile for Debugging

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Add compiler flags to include debugging symbols in the build.

```makefile
-gcflags "-N -l"
```

--------------------------------

### Define Pod Environment ConfigMap for WAL-G

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Create a ConfigMap to override environment variables for enabling WAL-G backup and restore.

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: pod-env-overrides
  namespace: postgres-operator-system
data:
  # Any env variable used by spilo can be added
  USE_WALG_BACKUP: "true"
  USE_WALG_RESTORE: "true"
  CLONE_USE_WALG_RESTORE: "true"
```

--------------------------------

### Configure standby cluster with S3 WAL path

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Use the s3_wal_path parameter to stream changes from an S3 bucket.

```yaml
spec:
  standby:
    s3_wal_path: "s3://<bucketname>/spilo/<source_db_cluster>/<UID>/wal/<PGVERSION>"
```

--------------------------------

### Run End-to-End Tests

Source: https://github.com/zalando/postgres-operator/blob/master/docs/developer.md

Execute the automated end-to-end test suite.

```bash
make e2e
```

--------------------------------

### Configure Node Readiness Labels in ConfigMap

Source: https://github.com/zalando/postgres-operator/blob/master/docs/administrator.md

Define node readiness labels as a comma-separated string of key-value pairs within the operator ConfigMap.

```yaml
apiVersion: v1
kind: ConfigMap
metadata:
  name: postgres-operator
data:
  node_readiness_label: "status1:ready,status2:ready"
```

--------------------------------

### Configure Kubeconfig for Kind Cluster

Source: https://github.com/zalando/postgres-operator/blob/master/e2e/README.md

Sets the `KUBECONFIG` environment variable to use the kubeconfig file generated by the e2e tests, allowing `kubectl` commands to target the kind cluster. It also sets the correct context.

```bash
# save the old config in case you have it
export KUBECONFIG_SAVED=$KUBECONFIG

# use the one created by e2e tests
export KUBECONFIG=/tmp/kind-config-postgres-operator-e2e-tests

# this kubeconfig defines a single context
kubectl config use-context kind-postgres-operator-e2e-tests
```

--------------------------------

### Enable logical backups in cluster manifest

Source: https://github.com/zalando/postgres-operator/blob/master/docs/user.md

Add this parameter to the spec section to enable periodic SQL dump backups via a K8s cron job.

```yaml
spec:
  enableLogicalBackup: true
```

--------------------------------

### Run Individual Test

Source: https://github.com/zalando/postgres-operator/blob/master/e2e/README.md

Executes a specific end-to-end test case. Ensure `NOCLEANUP` is set to `True` to keep the kind cluster running. Run this command from the `e2e` directory.

```bash
NOCLEANUP=True ./run.sh main tests.test_e2e.EndToEndTestCase.test_lazy_spilo_upgrade
```

--------------------------------

### Add Postgres Operator UI Helm Repository

Source: https://github.com/zalando/postgres-operator/blob/master/docs/quickstart.md

Adds the Helm repository for the Postgres Operator UI. Requires Helm v3.

```bash
helm repo add postgres-operator-ui-charts https://opensource.zalando.com/postgres-operator/charts/postgres-operator-ui
```
Tokens:
Raw