Skip to content

docs: Fix CloudNativePG operator deployment issues #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chadmf merged 1 commit into from
Mar 31, 2026
Merged

docs: Fix CloudNativePG operator deployment issues #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions docs/install-kubernetes-manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,21 @@ For **Postgres on hosts** (VMs / bare metal), use **[TPA](install-tpa.md)** —
# Create namespace
oc create namespace postgresql-operator-system

# Install operator via OperatorHub (OpenShift) or Helm
oc apply -f https://get.enterprisedb.io/cnp/postgresql-operator-1.23.1.yaml
# Download and install operator with server-side apply (required for large CRDs)
curl -sL -o /tmp/edb-cnp-operator.yaml \
"https://get.enterprisedb.io/cnp/postgresql-operator-1.23.1.yaml"

oc apply --server-side --force-conflicts -f /tmp/edb-cnp-operator.yaml

# Wait for operator to be ready
oc wait --for=condition=Available deployment \
-l app.kubernetes.io/name=cloudnativepg \
-n postgresql-operator-system \
--timeout=300s
```

**Note:** The `--server-side --force-conflicts` flags are required because the operator CRDs are large and may exceed annotation size limits in client-side apply.

## 2. Deploy a PostgreSQL cluster (manual)

### Registry pull secret (EDB images)
Expand Down
56 changes: 40 additions & 16 deletions docs/quick-start-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,28 +92,45 @@ git clone https://github.com/Red-Hat-EnterpriseDB-Testing/EDB_Testing.git
cd EDB_Testing
```

### Step 2: Deploy EDB Postgres Operator (2 minutes)
### Step 2: (Optional) Create EDB Registry Pull Secret

**Only required if using EDB subscription images from `docker.enterprisedb.com`**

```bash
# Create pull secret for EDB registry
oc create secret docker-registry edb-pull-secret \
--docker-server=docker.enterprisedb.com \
--docker-username='YOUR_EDB_SUBSCRIPTION_USER' \
--docker-password='YOUR_EDB_TOKEN_OR_PASSWORD' \
-n edb-postgres
```

**Note:** This quick start uses the community CloudNativePG operator image, so this step is optional. However, if you plan to use EDB Postgres Advanced images (see [`db-deploy/sample-cluster/base/cluster-edb-registry.yaml`](../db-deploy/sample-cluster/base/cluster-edb-registry.yaml)), you'll need this pull secret.

### Step 3: Deploy EDB Postgres Operator (2 minutes)

```bash
# Deploy CloudNativePG operator
oc apply -k db-deploy/operator/
# Deploy CloudNativePG operator with server-side apply for large CRDs
oc apply --server-side --force-conflicts -k db-deploy/operator/

# Wait for operator to be ready
oc wait --for=condition=Ready pod \
-l app.kubernetes.io/name=cloudnativepg \
-n cnpg-system \
-n postgresql-operator-system \
--timeout=120s
```

**Expected output:**
```
namespace/cnpg-system created
customresourcedefinition.apiextensions.k8s.io/clusters.postgresql.cnpg.io created
deployment.apps/cnpg-controller-manager created
pod/cnpg-controller-manager-xxxxxxxxx-xxxxx condition met
namespace/postgresql-operator-system created
customresourcedefinition.apiextensions.k8s.io/clusters.postgresql.k8s.enterprisedb.io created
deployment.apps/postgresql-operator-controller-manager created
pod/postgresql-operator-controller-manager-xxxxxxxxx-xxxxx condition met
```

### Step 3: Deploy PostgreSQL Cluster (5 minutes)
**Note:** The `--server-side --force-conflicts` flags are required because the CRDs are large and may exceed annotation size limits.

### Step 4: Deploy PostgreSQL Cluster (5 minutes)

```bash
# Create namespace and cluster
Expand All @@ -133,7 +150,7 @@ postgresql 3m 2 2 Cluster in healthy state postgresql-1

Press `Ctrl+C` when `READY` shows `2`.

### Step 4: Verify PostgreSQL (2 minutes)
### Step 5: Verify PostgreSQL (2 minutes)

```bash
# Check cluster status
Expand All @@ -146,7 +163,7 @@ oc exec -n edb-postgres postgresql-1 -- \

**Expected:** PostgreSQL version output showing EDB Postgres Advanced.

### Step 5: Deploy AAP (5 minutes)
### Step 6: Deploy AAP (5 minutes)

```bash
# Set required environment variables
Expand All @@ -168,7 +185,7 @@ cd aap-deploy/openshift
oc get pods -n ansible-automation-platform -w
```

### Step 6: Access AAP (1 minute)
### Step 7: Access AAP (1 minute)

```bash
# Get AAP route
Expand Down Expand Up @@ -342,13 +359,20 @@ cd EDB_Testing
eval $(crc oc-env)
oc login -u kubeadmin https://api.crc.testing:6443

# Deploy operator
oc apply -k db-deploy/operator/
# (Optional) Create EDB pull secret if using EDB images
# oc create secret docker-registry edb-pull-secret \
# --docker-server=docker.enterprisedb.com \
# --docker-username='YOUR_EDB_SUBSCRIPTION_USER' \
# --docker-password='YOUR_EDB_TOKEN_OR_PASSWORD' \
# -n edb-postgres

# Deploy operator with server-side apply for large CRDs
oc apply --server-side --force-conflicts -k db-deploy/operator/

# Wait for operator
oc wait --for=condition=Ready pod \
-l app.kubernetes.io/name=cloudnativepg \
-n cnpg-system \
-n postgresql-operator-system \
--timeout=300s

# Deploy cluster (use CRC storage class)
Expand Down Expand Up @@ -677,7 +701,7 @@ Before going to production, complete:
oc describe pod postgresql-1 -n edb-postgres

# Check operator logs
oc logs -n cnpg-system -l app.kubernetes.io/name=cloudnativepg --tail=100
oc logs -n postgresql-operator-system -l app.kubernetes.io/name=cloudnativepg --tail=100
```

**Common causes:**
Expand Down
Loading