Add Complete PgBouncer Docs (#718)

* Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * update-version Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * scaling done Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * autoScaler Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * reconfiguration Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * restart Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * monitoring Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * all completed until custom version Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * update version svg Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * completed till update-version Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * Horizontal scaling done Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * vertical scaling done fully Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * autoscaling all done Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * all done for reconfiguration Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * restart done Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * duplication removed Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * build fixed Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * remove reconfigure tls Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * image added for monitoring Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * pgbouncer wiki change Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * autoscaling issue fixed Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * test Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * test 2 Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * test 3 Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * update version camel case removed Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * monitoring part is done Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * image changes for monitoring Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> * camecase solved Signed-off-by: Hiranmoy Das Chowdhury <[email protected]> --------- Signed-off-by: Hiranmoy Das Chowdhury <[email protected]>
kubedb · Dec 13, 2024 · 6d67a6e · 6d67a6e
1 parent 0440c8f
commit 6d67a6e
Show file tree

Hide file tree

Showing 56 changed files with 3,850 additions and 348 deletions.
diff --git a/docs/examples/pgbouncer/autoscaling/compute/pgbouncer-autoscale.yaml b/docs/examples/pgbouncer/autoscaling/compute/pgbouncer-autoscale.yaml
@@ -0,0 +1,23 @@
+apiVersion: kubedb.com/v1
+kind: PgBouncer
+metadata:
+  name: pgbouncer-autoscale
+  namespace: demo
+spec:
+  replicas: 1
+  version: "1.18.0"
+  database:
+    syncUsers: true
+    databaseName: "postgres"
+    databaseRef:
+      name: "ha-postgres"
+      namespace: demo
+  connectionPool:
+    poolMode: session
+    port: 5432
+    reservePoolSize: 5
+    maxClientConnections: 87
+    defaultPoolSize: 2
+    minPoolSize: 1
+    authType: md5
+  deletionPolicy: WipeOut
diff --git a/docs/examples/pgbouncer/autoscaling/compute/pgbouncer-autoscaler.yaml b/docs/examples/pgbouncer/autoscaling/compute/pgbouncer-autoscaler.yaml
@@ -0,0 +1,21 @@
+apiVersion: autoscaling.kubedb.com/v1alpha1
+kind: PgBouncerAutoscaler
+metadata:
+  name: pgbouncer-autoscale-ops
+  namespace: demo
+spec:
+  databaseRef:
+    name: pgbouncer-autoscale
+  compute:
+    pgbouncer:
+      trigger: "On"
+      podLifeTimeThreshold: 5m
+      resourceDiffPercentage: 20
+      minAllowed:
+        cpu: 400m
+        memory: 400Mi
+      maxAllowed:
+        cpu: 1
+        memory: 1Gi
+      controlledResources: ["cpu", "memory"]
+      containerControlledValues: "RequestsAndLimits"
diff --git a/docs/examples/pgbouncer/reconfigure/pb-custom-config.yaml b/docs/examples/pgbouncer/reconfigure/pb-custom-config.yaml
@@ -0,0 +1,22 @@
+apiVersion: kubedb.com/v1
+kind: PgBouncer
+metadata:
+  name: pb-custom
+  namespace: demo
+spec:
+  replicas: 1
+  version: "1.18.0"
+  database:
+    syncUsers: true
+    databaseName: "postgres"
+    databaseRef:
+      name: "ha-postgres"
+      namespace: demo
+  connectionPool:
+    poolMode: session
+    port: 5432
+    reservePoolSize: 5
+    maxClientConnections: 87
+    defaultPoolSize: 2
+    minPoolSize: 1
+  deletionPolicy: WipeOut
diff --git a/docs/examples/pgbouncer/reconfigure/pbops-reconfigure-apply.yaml b/docs/examples/pgbouncer/reconfigure/pbops-reconfigure-apply.yaml
@@ -0,0 +1,17 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: PgBouncerOpsRequest
+metadata:
+  name: pbops-reconfigure-apply
+  namespace: demo
+spec:
+  type: Reconfigure
+  databaseRef:
+    name: pb-custom
+  configuration:
+    pgbouncer:
+      applyConfig:
+        pgbouncer.ini: |-
+          [pgbouncer]
+          auth_type=scram-sha-256
+  timeout: 5m
+  apply: IfReady
diff --git a/docs/examples/pgbouncer/reconfigure/pbops-reconfigure.yaml b/docs/examples/pgbouncer/reconfigure/pbops-reconfigure.yaml
@@ -0,0 +1,15 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: PgBouncerOpsRequest
+metadata:
+  name: pbops-reconfigure
+  namespace: demo
+spec:
+  type: Reconfigure
+  databaseRef:
+    name: pb-custom
+  configuration:
+    pgbouncer:
+      configSecret:
+        name: new-custom-config
+  timeout: 5m
+  apply: IfReady
diff --git a/docs/examples/pgbouncer/restart/ops.yaml b/docs/examples/pgbouncer/restart/ops.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: PgBouncerOpsRequest
+metadata:
+  name: restart-pgbouncer
+  namespace: demo
+spec:
+  type: Restart
+  databaseRef:
+    name: pgbouncer
+  timeout: 3m
+  apply: Always
diff --git a/docs/examples/pgbouncer/restart/pgbouncer.yaml b/docs/examples/pgbouncer/restart/pgbouncer.yaml
@@ -0,0 +1,23 @@
+apiVersion: kubedb.com/v1
+kind: PgBouncer
+metadata:
+  name: pgbouncer
+  namespace: demo
+spec:
+  replicas: 1
+  version: "1.18.0"
+  database:
+    syncUsers: true
+    databaseName: "postgres"
+    databaseRef:
+      name: "ha-postgres"
+      namespace: demo
+  connectionPool:
+    poolMode: session
+    port: 5432
+    reservePoolSize: 5
+    maxClientConnections: 87
+    defaultPoolSize: 2
+    minPoolSize: 1
+    authType: md5
+  deletionPolicy: WipeOut
diff --git a/docs/examples/pgbouncer/scaling/horizontal-scaling-down-ops.yaml b/docs/examples/pgbouncer/scaling/horizontal-scaling-down-ops.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: PgBouncerOpsRequest
+metadata:
+  name: pgbouncer-horizontal-scale-down
+  namespace: demo
+spec:
+  type: HorizontalScaling
+  databaseRef:
+    name: pb-horizontal
+  horizontalScaling:
+    replicas: 2
diff --git a/docs/examples/pgbouncer/scaling/horizontal-scaling-ops.yaml b/docs/examples/pgbouncer/scaling/horizontal-scaling-ops.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: PgBouncerOpsRequest
+metadata:
+  name: pgbouncer-horizontal-scale-up
+  namespace: demo
+spec:
+  type: HorizontalScaling
+  databaseRef:
+    name: pb-horizontal
+  horizontalScaling:
+    replicas: 3
diff --git a/docs/examples/pgbouncer/scaling/pb-horizontal.yaml b/docs/examples/pgbouncer/scaling/pb-horizontal.yaml
@@ -0,0 +1,23 @@
+apiVersion: kubedb.com/v1
+kind: PgBouncer
+metadata:
+  name: pb-horizontal
+  namespace: demo
+spec:
+  replicas: 1
+  version: "1.18.0"
+  database:
+    syncUsers: true
+    databaseName: "postgres"
+    databaseRef:
+      name: "ha-postgres"
+      namespace: demo
+  connectionPool:
+    poolMode: session
+    port: 5432
+    reservePoolSize: 5
+    maxClientConnections: 87
+    defaultPoolSize: 2
+    minPoolSize: 1
+    authType: md5
+  deletionPolicy: WipeOut
diff --git a/docs/examples/pgbouncer/scaling/pb-vertical-ops.yaml b/docs/examples/pgbouncer/scaling/pb-vertical-ops.yaml
@@ -0,0 +1,20 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: PgBouncerOpsRequest
+metadata:
+  name: pgbouncer-scale-vertical
+  namespace: demo
+spec:
+  type: VerticalScaling
+  databaseRef:
+    name: pb-vertical
+  verticalScaling:
+    pgbouncer:
+      resources:
+        requests:
+          memory: "2Gi"
+          cpu: "1"
+        limits:
+          memory: "2Gi"
+          cpu: "1"
+  timeout: 5m
+  apply: IfReady
diff --git a/docs/examples/pgbouncer/scaling/pb-vertical.yaml b/docs/examples/pgbouncer/scaling/pb-vertical.yaml
@@ -0,0 +1,23 @@
+apiVersion: kubedb.com/v1
+kind: PgBouncer
+metadata:
+  name: pb-vertical
+  namespace: demo
+spec:
+  replicas: 1
+  version: "1.18.0"
+  database:
+    syncUsers: true
+    databaseName: "postgres"
+    databaseRef:
+      name: "ha-postgres"
+      namespace: demo
+  connectionPool:
+    poolMode: session
+    port: 5432
+    reservePoolSize: 5
+    maxClientConnections: 87
+    defaultPoolSize: 2
+    minPoolSize: 1
+    authType: md5
+  deletionPolicy: WipeOut
diff --git a/docs/examples/pgbouncer/sync-users/pgbouncer-sync.yaml b/docs/examples/pgbouncer/sync-users/pgbouncer-sync.yaml
@@ -0,0 +1,15 @@
+apiVersion: kubedb.com/v1
+kind: PgBouncer
+metadata:
+  name: pgbouncer-sync
+  namespace: demo
+spec:
+  version: "1.23.1"
+  replicas: 1
+  database:
+    syncUsers: true
+    databaseName: "postgres"
+    databaseRef:
+      name: "ha-postgres"
+      namespace: demo
+  deletionPolicy: WipeOut
diff --git a/docs/examples/pgbouncer/sync-users/secret.yaml b/docs/examples/pgbouncer/sync-users/secret.yaml
@@ -0,0 +1,11 @@
+apiVersion: v1
+kind: Secret
+metadata:
+  labels:
+    app.kubernetes.io/instance: ha-postgres
+    app.kubernetes.io/name: postgreses.kubedb.com
+  name: sync-secret
+  namespace: demo
+stringData:
+  password: "12345"
+  username: "john"
diff --git a/docs/examples/pgbouncer/update-version/pb-update.yaml b/docs/examples/pgbouncer/update-version/pb-update.yaml
@@ -0,0 +1,23 @@
+apiVersion: kubedb.com/v1
+kind: PgBouncer
+metadata:
+  name: pb-update
+  namespace: demo
+spec:
+  replicas: 1
+  version: "1.18.0"
+  database:
+    syncUsers: true
+    databaseName: "postgres"
+    databaseRef:
+      name: "ha-postgres"
+      namespace: demo
+  connectionPool:
+    poolMode: session
+    port: 5432
+    reservePoolSize: 5
+    maxClientConnections: 87
+    defaultPoolSize: 2
+    minPoolSize: 1
+    authType: md5
+  deletionPolicy: WipeOut
diff --git a/docs/examples/pgbouncer/update-version/pbops-update.yaml b/docs/examples/pgbouncer/update-version/pbops-update.yaml
@@ -0,0 +1,11 @@
+apiVersion: ops.kubedb.com/v1alpha1
+kind: PgBouncerOpsRequest
+metadata:
+  name: pgbouncer-version-update
+  namespace: demo
+spec:
+  type: UpdateVersion
+  databaseRef:
+    name: pb-update
+  updateVersion:
+    targetVersion: 1.23.1
diff --git a/docs/guides/pgbouncer/README.md b/docs/guides/pgbouncer/README.md
@@ -23,14 +23,21 @@ KubeDB operator now comes bundled with PgBouncer crd to handle connection poolin
 
 ## PgBouncer Features
 
-| Features                           | Availability |
-|------------------------------------|:------------:|
-| Clustering                         |   &#10003;   |
-| Multiple PgBouncer Versions        |   &#10003;   |
-| Customizable Pooling Configuration |   &#10003;   |
-| Custom docker images               |   &#10003;   |
-| Builtin Prometheus Discovery       |   &#10003;   |
-| Using Prometheus operator          |   &#10003;   |
+| Features                                                    | Availability |
+|-------------------------------------------------------------| :----------: |
+| Multiple PgBouncer Versions                                 |   &#10003;   |
+| Custom Configuration                                        |   &#10003;   |
+| Externally manageable Auth Secret                           |   &#10003;   |
+| Reconfigurable Health Checker                               |   &#10003;   |
+| Integrate with externally managed PostgreSQL                |   &#10003;   |
+| Sync Postgres Users to PgBouncer                            |   &#10003;   |
+| Custom docker images                                        |   &#10003;   |
+| TLS: Add ( [Cert Manager]((https://cert-manager.io/docs/))) |   &#10003;   |
+| Monitoring with Prometheus & Grafana                        |   &#10003;   |
+| Builtin Prometheus Discovery                                |   &#10003;   |
+| Using Prometheus operator                                   |   &#10003;   |
+| Alert Dashboard                                             |   &#10003;   |
+| Grafana Dashboard                                           |   &#10003;   |
 
 ## User Guide
 

diff --git a/docs/guides/pgbouncer/autoscaler/_index.md b/docs/guides/pgbouncer/autoscaler/_index.md
@@ -0,0 +1,10 @@
+---
+title: Autoscaling
+menu:
+  docs_{{ .version }}:
+    identifier: pb-auto-scaling
+    name: Autoscaling
+    parent: pb-pgbouncer-guides
+    weight: 46
+menu_name: docs_{{ .version }}
+---
diff --git a/docs/guides/pgbouncer/autoscaler/compute/_index.md b/docs/guides/pgbouncer/autoscaler/compute/_index.md
@@ -0,0 +1,10 @@
+---
+title: Compute Autoscaling
+menu:
+  docs_{{ .version }}:
+    identifier: pb-compute-auto-scaling
+    name: Compute Autoscaling
+    parent: pb-auto-scaling
+    weight: 10
+menu_name: docs_{{ .version }}
+---